blob: dcfc41cdb5b08b946d2d2ce2801e3e661916a973 [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
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +020015#ifdef __BIONIC__
16/* work around "extern inline" (under std=gnu99) ctype definitions we don't use anyway */
17# ifdef NDEBUG
18# define NDEBUG_TMP NDEBUG
19# endif
20# undef NDEBUG
21# include <ctype.h>
22# ifdef NDEBUG_TMP
23# define NDEBUG NDEBUG_TMP
24# undef NDEBUG_TMP
25# endif
26#else
Rob Landley5d9c42a2006-06-24 17:55:02 +000027#include <ctype.h>
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +020028#endif
Rob Landleyb623a542006-05-31 22:09:03 +000029#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000030#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000031#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000032#include <inttypes.h>
33#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000034#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000035#include <signal.h>
Denys Vlasenko89f5bfd2011-05-12 23:03:18 +020036#if defined __UCLIBC__ /* TODO: and glibc? */
37/* use inlined versions of these: */
38# define sigfillset(s) __sigfillset(s)
39# define sigemptyset(s) __sigemptyset(s)
40# define sigisemptyset(s) __sigisemptyset(s)
41#endif
Denys Vlasenko5b9b1362010-02-02 03:08:57 +010042#include <stdint.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000043#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000044#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000045#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000046#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000047#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000048#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000049#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000050#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000051#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000052#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000053#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000054#include <sys/types.h>
Denys Vlasenkodd807c12011-02-07 14:58:57 +010055#ifndef major
56# include <sys/sysmacros.h>
57#endif
Rob Landleyc9c1a412006-07-12 19:17:55 +000058#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000059#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000060#include <time.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000061#include <sys/param.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000062#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020063# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000064#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000065#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020066# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000067#endif
Denys Vlasenko67905e22011-07-26 13:42:12 +020068/* Don't do this here:
69 * #include <sys/sysinfo.h>
70 * Some linux/ includes pull in conflicting definition
71 * of struct sysinfo (only in some toolchanins), which breaks build.
72 * Include sys/sysinfo.h only in those files which need it.
73 */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000074#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020075# include <selinux/selinux.h>
76# include <selinux/context.h>
77# include <selinux/flask.h>
78# include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000079#endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +010080#if ENABLE_FEATURE_UTMP
81# include <utmp.h>
82#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000083#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +020084# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000085#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +020086# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000087#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000088#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +020089# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000090#endif
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000091#include <pwd.h>
92#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000093#if ENABLE_FEATURE_SHADOWPASSWDS
Mike Frysinger52a42672009-07-09 01:33:20 -040094# if !ENABLE_USE_BB_SHADOW
95/* If using busybox's shadow implementation, do not include the shadow.h
96 * header as the toolchain may not provide it at all.
97 */
98# include <shadow.h>
99# endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000100#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +0100101/* Just in case libc doesn't define some of these... */
102#ifndef _PATH_PASSWD
103#define _PATH_PASSWD "/etc/passwd"
104#endif
105#ifndef _PATH_GROUP
106#define _PATH_GROUP "/etc/group"
107#endif
108#ifndef _PATH_SHADOW
109#define _PATH_SHADOW "/etc/shadow"
110#endif
111#ifndef _PATH_GSHADOW
112#define _PATH_GSHADOW "/etc/gshadow"
113#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200114#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100115# include <netinet/in.h>
116# include <arpa/inet.h>
117#elif defined __APPLE__
118# include <netinet/in.h>
119#else
120# include <arpa/inet.h>
121# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
122/* We #define socklen_t *after* includes, otherwise we get
123 * typedef redefinition errors from system headers
124 * (in case "is it defined already" detection above failed)
125 */
126# define socklen_t bb_socklen_t
127 typedef unsigned socklen_t;
128# endif
129#endif
Chris Rees330718e2011-01-24 17:07:06 +0100130#ifndef HAVE_CLEARENV
131# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
132#endif
133#ifndef HAVE_FDATASYNC
134# define fdatasync fsync
135#endif
136#ifndef HAVE_XTABS
137# define XTABS TAB3
138#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100139
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000140
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000141/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000142
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000143extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000144#if defined(__GLIBC__) && __GLIBC__ < 2
145int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +0000146#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000147/* klogctl is in libc's klog.h, but we cheat and not #include that */
148int klogctl(int type, char *b, int len);
149/* This is declared here rather than #including <libgen.h> in order to avoid
150 * confusing the two versions of basename. See the dirname/basename man page
151 * for details. */
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +0200152#if !defined __FreeBSD__ && !defined __BIONIC__
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000153char *dirname(char *path);
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200154#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100155#ifndef PATH_MAX
156# define PATH_MAX 256
157#endif
158#ifndef BUFSIZ
159# define BUFSIZ 4096
160#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000161
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000162
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200163/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200164#ifdef HAVE_UNLOCKED_STDIO
165# undef getc
166# define getc(stream) getc_unlocked(stream)
167# undef getchar
168# define getchar() getchar_unlocked()
169# undef putc
170# define putc(c, stream) putc_unlocked(c, stream)
171# undef putchar
172# define putchar(c) putchar_unlocked(c)
173# undef fgetc
174# define fgetc(stream) getc_unlocked(stream)
175# undef fputc
176# define fputc(c, stream) putc_unlocked(c, stream)
177#endif
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +0200178
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200179/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200180#ifdef HAVE_UNLOCKED_LINE_OPS
181# undef fgets
182# define fgets(s, n, stream) fgets_unlocked(s, n, stream)
183# undef fputs
184# define fputs(s, stream) fputs_unlocked(s, stream)
185#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200186
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000187/* Make all declarations hidden (-fvisibility flag only affects definitions) */
188/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000189PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000190
191
192#if ENABLE_USE_BB_PWD_GRP
193# include "pwd_.h"
194# include "grp_.h"
195#endif
196#if ENABLE_FEATURE_SHADOWPASSWDS
197# if ENABLE_USE_BB_SHADOW
198# include "shadow_.h"
199# endif
200#endif
201
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000202/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000203#define MAXINT(T) (T)( \
204 ((T)-1) > 0 \
205 ? (T)-1 \
206 : (T)~((T)1 << (sizeof(T)*8-1)) \
207 )
208
209#define MININT(T) (T)( \
210 ((T)-1) > 0 \
211 ? (T)0 \
212 : ((T)1 << (sizeof(T)*8-1)) \
213 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000214
Denis Vlasenko56254152006-10-07 16:24:46 +0000215/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000216/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000217 * (stat, lseek etc) mapped to "largefile" variants by libc.
218 * Practically it means that open() automatically has O_LARGEFILE added
219 * and all filesize/file_offset parameters and struct members are "large"
220 * (in today's world - signed 64bit). For full support of large files,
221 * we need a few helper #defines (below) and careful use of off_t
222 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000223#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000224/* CONFIG_LFS is on */
225# if ULONG_MAX > 0xffffffff
226/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000227typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000228# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000229/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
230# define BB_STRTOOFF bb_strtoul
231# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000232/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
233# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000234# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000235/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000236typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000237# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000238# define BB_STRTOOFF bb_strtoull
239# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000240# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000241# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000242#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000243/* CONFIG_LFS is off */
244# if UINT_MAX == 0xffffffff
245/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
246 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000247typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200248# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000249# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000250# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000251# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000252# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000253typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000254# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
255# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000256# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000257# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000258# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000259#endif
260/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000261#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000262
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +0200263#ifdef __BIONIC__
264/* bionic uses stat64 which has long long file sizes, whereas off_t is only long bits */
265typedef long long filesize_t;
266#define FILESIZE_FMT "ll"
267#else
268typedef off_t filesize_t;
269#define FILESIZE_FMT OFF_FMT
270#endif
271
Eric Andersenaad1a882001-03-16 22:47:14 +0000272/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000273#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000274#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000275#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000276#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000277#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000278#define SKIP ((int) 2)
279
280/* for mtab.c */
281#define MTAB_GETMOUNTPT '1'
282#define MTAB_GETDEVICE '2'
283
284#define BUF_SIZE 8192
285#define EXPAND_ALLOC 1024
286
Eric Andersenaad1a882001-03-16 22:47:14 +0000287/* Macros for min/max. */
288#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200289#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000290#endif
291
292#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200293#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000294#endif
295
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000296/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000297#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000298#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000299#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
300#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
301#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000302#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000303#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
304#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
305#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
306#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000307#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
308#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
309#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000310#endif
311#endif
312
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000313#if defined(__GLIBC__)
314/* glibc uses __errno_location() to get a ptr to errno */
315/* We can just memorize it once - no multithreading in busybox :) */
316extern int *const bb_errno;
317#undef errno
318#define errno (*bb_errno)
319#endif
320
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200321#if !(ULONG_MAX > 0xffffffff)
322/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
323uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
324#endif
325
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000326unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000327unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100328unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000329unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000330
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000331extern void chomp(char *s) FAST_FUNC;
332extern void trim(char *s) FAST_FUNC;
333extern char *skip_whitespace(const char *) FAST_FUNC;
334extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200335extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
336
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000337extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000338
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000339//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000340extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
341extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000342enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100343 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
344 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
345 FILEUTILS_RECUR = 1 << 2, /* -R */
346 FILEUTILS_FORCE = 1 << 3, /* -f */
347 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
348 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
349 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
350 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
351 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000352#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100353 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
354 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000355#endif
356};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100357#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000358extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000359/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
360 * the source, not copy (unless "source" is a directory).
361 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
362 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000363extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000364
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000365enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000366 ACTION_RECURSE = (1 << 0),
367 ACTION_FOLLOWLINKS = (1 << 1),
368 ACTION_FOLLOWLINKS_L0 = (1 << 2),
369 ACTION_DEPTHFIRST = (1 << 3),
370 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000371 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200372 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000373};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200374typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000375extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000376 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
377 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
378 void* userData, unsigned depth) FAST_FUNC;
379extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000380enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000381extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000382extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000383extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
384extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000385/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000386extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
387extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
388extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000389/* "short" copy can be detected by return value < size */
390/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000391extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200392
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000393extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200394char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000395/* xxxx_strip version can modify its parameter:
396 * "/" -> "/"
397 * "abc" -> "abc"
398 * "abc/def" -> "def"
399 * "abc/def/" -> "def" !!
400 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200401char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000402/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200403char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
404/* Simpler version: does not special case "/" string */
405const char *bb_basename(const char *name) FAST_FUNC;
406/* NB: can violate const-ness (similarly to strchr) */
407char *last_char_is(const char *s, int c) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000408
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100409void ndelay_on(int fd) FAST_FUNC;
410void ndelay_off(int fd) FAST_FUNC;
411void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000412void xdup2(int, int) FAST_FUNC;
413void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000414
415
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000416DIR *xopendir(const char *path) FAST_FUNC;
417DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000418
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100419char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100420char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
421char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100422/* !RETURNS_MALLOC: it's a realloc-like function */
423char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000424
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100425char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000426
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000427
Denis Vlasenko33196372008-02-23 01:25:38 +0000428enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000429 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000430 * otherwise would kill us, except for those resulting from bugs:
431 * SIGSEGV, SIGILL, SIGFPE.
432 * Other fatal signals not included (TODO?):
433 * SIGBUS Bus error (bad memory access)
434 * SIGPOLL Pollable event. Synonym of SIGIO
435 * SIGPROF Profiling timer expired
436 * SIGSYS Bad argument to routine
437 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000438 *
439 * The only known arch with some of these sigs not fitting
440 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
441 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000442 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000443 BB_FATAL_SIGS = (int)(0
444 + (1LL << SIGHUP)
445 + (1LL << SIGINT)
446 + (1LL << SIGTERM)
447 + (1LL << SIGPIPE) // Write to pipe with no readers
448 + (1LL << SIGQUIT) // Quit from keyboard
449 + (1LL << SIGABRT) // Abort signal from abort(3)
450 + (1LL << SIGALRM) // Timer signal from alarm(2)
451 + (1LL << SIGVTALRM) // Virtual alarm clock
452 + (1LL << SIGXCPU) // CPU time limit exceeded
453 + (1LL << SIGXFSZ) // File size limit exceeded
454 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
455 + (1LL << SIGUSR2)
456 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000457};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000458void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000459/* Unlike signal() and bb_signals, sets handler with sigaction()
460 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000461 * will be blocked; syscalls will not be restarted: */
462void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000463/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000464void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000465/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000466void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
467void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000468void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000469void sig_block(int sig) FAST_FUNC;
470void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000471/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000472int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000473/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000474int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000475/* Standard handler which just records signo */
476extern smallint bb_got_signal;
477void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000478
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000479
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000480void xsetgid(gid_t gid) FAST_FUNC;
481void xsetuid(uid_t uid) FAST_FUNC;
482void xchdir(const char *path) FAST_FUNC;
483void xchroot(const char *path) FAST_FUNC;
484void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000485void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200486void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000487void xunlink(const char *pathname) FAST_FUNC;
488void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200489void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200490int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100491int xopen_nonblocking(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000492int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
493int open_or_warn(const char *pathname, int flags) FAST_FUNC;
494int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
495int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200496int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000497void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
498int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
499off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200500int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000501off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000502
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100503uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
504 const char *override,
505 unsigned override_units,
506 int extend);
507
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000508void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000509/* In this form code with pipes is much more readable */
510struct fd_pair { int rd; int wr; };
511#define piped_pair(pair) pipe(&((pair).rd))
512#define xpiped_pair(pair) xpipe(&((pair).rd))
513
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000514/* Useful for having small structure members/global variables */
515typedef int8_t socktype_t;
516typedef int8_t family_t;
517struct BUG_too_small {
518 char BUG_socktype_t_too_small[(0
519 | SOCK_STREAM
520 | SOCK_DGRAM
521 | SOCK_RDM
522 | SOCK_SEQPACKET
523 | SOCK_RAW
524 ) <= 127 ? 1 : -1];
525 char BUG_family_t_too_small[(0
526 | AF_UNSPEC
527 | AF_INET
528 | AF_INET6
529 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000530#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000531 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000532#endif
533#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000534 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000535#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000536 /* | AF_DECnet */
537 /* | AF_IPX */
538 ) <= 127 ? 1 : -1];
539};
540
541
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100542void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
543time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200544
545
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000546int xsocket(int domain, int type, int protocol) FAST_FUNC;
547void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
548void xlisten(int s, int backlog) FAST_FUNC;
549void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000550ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000551 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000552/* SO_REUSEADDR allows a server to rebind to an address that is already
553 * "in use" by old connections to e.g. previous server instance which is
554 * killed or crashed. Without it bind will fail until all such connections
555 * time out. Linux does not allow multiple live binds on same ip:port
556 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
557 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000558void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
559int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000560int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000561/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000562unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000563typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000564 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000565 union {
566 struct sockaddr sa;
567 struct sockaddr_in sin;
568#if ENABLE_FEATURE_IPV6
569 struct sockaddr_in6 sin6;
570#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000571 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000572} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000573enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000574 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000575 LSA_SIZEOF_SA = sizeof(
576 union {
577 struct sockaddr sa;
578 struct sockaddr_in sin;
579#if ENABLE_FEATURE_IPV6
580 struct sockaddr_in6 sin6;
581#endif
582 }
583 )
584};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000585/* Create stream socket, and allocate suitable lsa.
586 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000587 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100588 * and if kernel doesn't support it, fall back to IPv4.
589 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000590 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000591#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000592int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000593#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000594int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000595#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
596#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000597int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000598/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000599 * numeric IP ("N.N.N.N") or numeric IPv6 address,
600 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000601 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000602/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000603int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
604int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000605/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
606 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
607 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
608 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000609int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000610/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000611int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000612/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100613len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200614/* Get remote address of connected or accepted socket */
615len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000616/* Return malloc'ed len_and_sockaddr with socket address of host:port
617 * Currently will return IPv4 or IPv6 sockaddrs only
618 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000619 * UNIX socket address being returned, IPX sockaddr etc...
620 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100621len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000622/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100623len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
624len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000625/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000626#if !ENABLE_FEATURE_IPV6
627#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
628#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
629#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100630len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
631len_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 +0000632#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000633/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000634 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000635 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200636void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000637/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000638int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000639/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100640char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000641/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100642char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000643/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100644char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000645/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100646char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
647char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000648// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000649// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000650struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000651// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000652// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000653
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000654
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000655void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000656ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000657 const struct sockaddr *to,
658 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000659 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000660ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000661 struct sockaddr *from,
662 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000663 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000664
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100665
666char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
667char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000668void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000669char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000670char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000671/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000672 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000673int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200674/* Note: does not use stdio, writes to fd 2 directly */
675int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100676char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000677// gcc-4.1.1 still isn't good enough at optimizing it
678// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000679//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000680//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000681//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000682//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000683#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000684#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000685#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000686#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000687#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000688
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100689typedef struct uni_stat_t {
690 unsigned byte_count;
691 unsigned unicode_count;
692 unsigned unicode_width;
693} uni_stat_t;
694/* Returns a string with unprintable chars replaced by '?' or
695 * SUBST_WCHAR. This function is unicode-aware. */
696const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
697/* Prints unprintable char ch as ^C or M-c to file
698 * (M-c is used only if ch is ORed with PRINTABLE_META),
699 * else it is printed as-is (except for ch = 0x9b) */
700enum { PRINTABLE_META = 0x100 };
701void fputc_printable(int ch, FILE *file) FAST_FUNC;
702
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000703/* dmalloc will redefine these to it's own implementation. It is safe
704 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100705void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
706void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
707void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000708void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000709/* After xrealloc_vector(v, 4, idx) it's ok to use
710 * at least v[idx] and v[idx+1], for all idx values.
711 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
712 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000713#define xrealloc_vector(vector, shift, idx) \
714 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
715void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
716
Eric Andersenaad1a882001-03-16 22:47:14 +0000717
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000718extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denys Vlasenko80542ba2011-05-08 21:23:43 +0200719extern 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 +0000720// NB: will return short read on error, not -1,
721// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000722extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
723extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
724extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000725extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
726extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000727// Reads one line a-la fgets (but doesn't save terminating '\n').
728// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000729// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200730extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000731/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100732extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000733/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100734extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100735/* Never returns NULL */
736extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000737/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
738#if ENABLE_FEATURE_SEAMLESS_LZMA \
739 || ENABLE_FEATURE_SEAMLESS_BZ2 \
740 || ENABLE_FEATURE_SEAMLESS_GZ \
741 /* || ENABLE_FEATURE_SEAMLESS_Z */
Denys Vlasenko6948f212010-05-30 04:18:13 +0200742extern void setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/) FAST_FUNC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000743#else
744# define setup_unzip_on_fd(...) ((void)0)
745#endif
Denis Vlasenkob6052722008-07-10 17:43:01 +0000746/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000747extern int open_zipped(const char *fname) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100748extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000749
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000750extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000751// NB: will return short write on error, not -1,
752// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000753extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
754extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000755extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200756extern ssize_t full_write1_str(const char *str) FAST_FUNC;
757extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000758extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000759
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200760/* Close fd, but check for failures (some types of write errors) */
761extern void xclose(int fd) FAST_FUNC;
762
Denis Vlasenko1de08302006-10-26 23:32:43 +0000763/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000764extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000765
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200766/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
767 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
768 * end of line. If end isn't NULL, length of the chunk is stored in it.
769 * Returns NULL if EOF/error.
770 */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000771extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000772/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100773extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000774/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100775extern 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 +0000776/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100777extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000778/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100779extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000780/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100781extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000782/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100783/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000784
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100785void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
786void die_if_ferror_stdout(void) FAST_FUNC;
787int fflush_all(void) FAST_FUNC;
788void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
789int fclose_if_not_stdin(FILE *file) FAST_FUNC;
790FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000791/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100792FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000793/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100794FILE* xfopen_stdin(const char *filename) FAST_FUNC;
795FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
796FILE* fopen_for_read(const char *path) FAST_FUNC;
797FILE* xfopen_for_read(const char *path) FAST_FUNC;
798FILE* fopen_for_write(const char *path) FAST_FUNC;
799FILE* xfopen_for_write(const char *path) FAST_FUNC;
800FILE* xfdopen_for_read(int fd) FAST_FUNC;
801FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000802
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000803int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
804void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000805
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000806/* Wrapper which restarts poll on EINTR or ENOMEM.
807 * On other errors complains [perror("poll")] and returns.
808 * Warning! May take (much) longer than timeout_ms to return!
809 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000810int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000811
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000812char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000813char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000814
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000815/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000816char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000817
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000818char *utoa(unsigned n) FAST_FUNC;
819char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000820/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000821char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
822char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000823/* Intelligent formatters of bignums */
Kevin Cernekeeccb07042010-10-25 02:00:24 +0200824void smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000825void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200826/* If block_size == 0, display size without fractional part,
827 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100828 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200829 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100830#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
831#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000832//TODO: provide pointer to buf (avoid statics)?
833const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000834 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000835/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000836char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200837/* Reverse */
838char* hex2bin(char *dst, const char *str, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000839
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200840/* Generate a UUID */
841void generate_uuid(uint8_t *buf) FAST_FUNC;
842
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000843/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000844struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000845 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000846 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000847};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000848#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000849/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200850
Denis Vlasenko13858992006-10-08 12:49:22 +0000851/* Using xatoi() instead of naive atoi() is not always convenient -
852 * in many places people want *non-negative* values, but store them
853 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200854 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
855 * It should really be named xatoi_nonnegative (since it allows 0),
856 * but that would be too long.
857 */
858int xatoi_positive(const char *numstr) FAST_FUNC;
859
Denis Vlasenko13858992006-10-08 12:49:22 +0000860/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000861uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000862
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000863
Eric Andersenaad1a882001-03-16 22:47:14 +0000864/* These parse entries in /etc/passwd and /etc/group. This is desirable
865 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000866 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000867long xuname2uid(const char *name) FAST_FUNC;
868long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000869/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000870unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000871/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000872struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000873 uid_t uid;
874 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000875};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000876/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000877int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000878/* always sets uid and gid, allows numeric; exits on failure */
879void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000880/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000881void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000882struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000883struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000884struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
885struct group* xgetgrgid(gid_t gid) FAST_FUNC;
886char* xuid2uname(uid_t uid) FAST_FUNC;
887char* xgid2group(gid_t gid) FAST_FUNC;
888char* uid2uname(uid_t uid) FAST_FUNC;
889char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100890char* uid2uname_utoa(uid_t uid) FAST_FUNC;
891char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000892/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000893const char* get_cached_username(uid_t uid) FAST_FUNC;
894const char* get_cached_groupname(gid_t gid) FAST_FUNC;
895void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000896/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100897enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000898#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000899void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000900#else
901#define die_if_bad_username(name) ((void)(name))
902#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000903
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200904#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200905void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
906void 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 +0200907#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200908# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
909# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200910#endif
911
Denys Vlasenkob72baeb2011-02-02 18:38:57 +0100912
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000913int execable_file(const char *name) FAST_FUNC;
914char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
915int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000916
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000917/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
918 * but it may exec busybox and call applet instead of searching PATH.
919 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000920#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100921int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000922#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100923 do { \
924 if (find_applet_by_name(prog) >= 0) \
925 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
926 execlp(prog, cmd, __VA_ARGS__); \
927 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000928#else
929#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100930#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000931#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200932int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000933
Pascal Bellard926031b2010-07-04 15:32:38 +0200934/* xvfork() can't be a _function_, return after vfork mangles stack
935 * in the parent. It must be a macro. */
936#define xvfork() \
937({ \
938 pid_t bb__xvfork_pid = vfork(); \
939 if (bb__xvfork_pid < 0) \
940 bb_perror_msg_and_die("vfork"); \
941 bb__xvfork_pid; \
942})
943#if BB_MMU
944pid_t xfork(void) FAST_FUNC;
945#endif
946
Denys Vlasenko8531d762010-03-18 22:44:00 +0100947/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000948pid_t spawn(char **argv) FAST_FUNC;
949pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000950
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000951pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100952pid_t wait_any_nohang(int *wstat) FAST_FUNC;
953/* wait4pid: unlike waitpid, waits ONLY for one process.
954 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000955 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000956 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000957 * IOW: rc = wait4pid(spawn(argv));
958 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +0100959 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000960 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000961int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100962/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200963int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000964/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000965int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000966
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000967/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000968 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000969 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000970 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000971 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
972 * rexec's itself on NOMMU with argv passed as command line.
973 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
974 * from the start. (It will detect it and not reexec again second time).
975 * You have to audit carefully that you don't do something twice as a result
976 * (opening files/sockets, parsing config files etc...)!
977 *
978 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
979 * (will do setsid()).
980 *
Pascal Bellard926031b2010-07-04 15:32:38 +0200981 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000982 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000983 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000984 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000985 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000986 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000987 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
988 * to /dev/null if they are not.
989 */
990enum {
991 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000992 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000993 DAEMON_CLOSE_EXTRA_FDS = 4,
994 DAEMON_ONLY_SANITIZE = 8, /* internal use */
995};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000996#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +0000997 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +0200998# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000999# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1000# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001001#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001002 extern bool re_execed;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001003 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001004 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001005 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1006 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1007 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001008# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001009# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001010# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1011# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001012#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001013void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1014void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001015/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001016int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001017
1018
Denys Vlasenkoe992bae2009-11-28 15:18:53 +01001019char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +00001020extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001021extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001022#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +00001023#define No_argument "\0"
1024#define Required_argument "\001"
1025#define Optional_argument "\002"
1026extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +00001027#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001028extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001029extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001030
1031
Denys Vlasenko9be47022011-05-16 12:21:31 +02001032/* Having next pointer as a first member allows easy creation
1033 * of "llist-compatible" structs, and using llist_FOO functions
1034 * on them.
1035 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001036typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001037 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001038 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001039} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001040void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1041void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1042void *llist_pop(llist_t **elm) FAST_FUNC;
1043void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1044void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1045llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001046llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001047/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001048 * llist_t *llist_add_to(llist_t *old_head, void *data)
1049 * etc does not result in smaller code... */
1050
Denis Vlasenko80edead2007-08-02 22:31:05 +00001051/* start_stop_daemon and udhcpc are special - they want
1052 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001053#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001054/* True only if we created pidfile which is *file*, not /dev/null etc */
1055extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001056void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001057#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001058#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001059enum { wrote_pidfile = 0 };
1060#define write_pidfile(path) ((void)0)
1061#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001062#endif
1063
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001064enum {
1065 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001066 LOGMODE_STDIO = (1 << 0),
1067 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001068 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1069};
1070extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001071extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001072extern int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001073extern uint8_t xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +00001074extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001075extern void xfunc_die(void) NORETURN FAST_FUNC;
1076extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001077extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1078extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1079extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1080extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1081extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001082extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001083extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1084extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001085extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001086extern void bb_perror_nomsg(void) FAST_FUNC;
1087extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1088extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001089
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001090/* We need to export XXX_main from libbusybox
1091 * only if we build "individual" binaries
1092 */
1093#if ENABLE_FEATURE_INDIVIDUAL
1094#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1095#else
1096#define MAIN_EXTERNALLY_VISIBLE
1097#endif
1098
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001099
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001100/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001101int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001102/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001103int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1104int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1105int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1106int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001107/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001108int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001109/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001110int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1111/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001112int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001113int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001114
Denis Vlasenko468aea22008-04-01 14:47:57 +00001115#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001116void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001117#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001118
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001119
1120/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001121int create_icmp_socket(void) FAST_FUNC;
1122int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001123/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001124/* This structure defines protocol families and their handlers. */
1125struct aftype {
1126 const char *name;
1127 const char *title;
1128 int af;
1129 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001130 char* FAST_FUNC (*print)(unsigned char *);
1131 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1132 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1133 void FAST_FUNC (*herror)(char *text);
1134 int FAST_FUNC (*rprint)(int options);
1135 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001136 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001137 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001138};
1139/* This structure defines hardware protocols and their handlers. */
1140struct hwtype {
1141 const char *name;
1142 const char *title;
1143 int type;
1144 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001145 char* FAST_FUNC (*print)(unsigned char *);
1146 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1147 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001148 int suppress_null_addr;
1149};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001150extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001151int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001152#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001153int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001154#else
1155#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001156#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001157const struct aftype *get_aftype(const char *name) FAST_FUNC;
1158const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1159const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001160
1161
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001162#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001163extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001164/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001165extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001166extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001167#endif
1168
Mike Frysinger9412ec72008-02-07 22:41:33 +00001169#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001170extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001171extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001172#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001173extern void erase_mtab(const char * name) FAST_FUNC;
1174extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1175extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001176#if ENABLE_DESKTOP
1177extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1178#else
1179# define bb_warn_ignoring_args(arg) ((void)0)
1180#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001181
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001182extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001183
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001184extern char *query_loop(const char *device) FAST_FUNC;
1185extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001186/* If *devname is not NULL, use that name, otherwise try to find free one,
1187 * malloc and return it in *devname.
1188 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001189extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001190
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001191/* Like bb_ask below, but asks on stdin with no timeout. */
1192char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001193//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001194char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001195int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001196
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001197int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001198
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001199/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001200 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001201 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001202enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001203 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1204 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1205// TODO: COLLAPSE and TRIM seem to always go in pair
1206 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1207 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001208 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001209 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001210// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1211 // NORMAL is:
1212 // * remove leading and trailing delimiters and collapse
1213 // multiple delimiters into one
1214 // * warn and continue if less than mintokens delimiters found
1215 // * grab everything into last token
1216 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001217};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001218typedef struct parser_t {
1219 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001220 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001221 char *line, *nline;
1222 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001223 int lineno;
1224} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001225parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001226parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001227/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001228int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1229#define config_read(parser, tokens, max, min, str, flags) \
1230 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001231void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001232
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001233/* Concatenate path and filename to new allocated buffer.
1234 * Add "/" only as needed (no duplicate "//" are produced).
1235 * If path is NULL, it is assumed to be "/".
1236 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001237char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001238/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001239char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001240
Denis Vlasenko4921b542007-02-03 02:17:41 +00001241
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001242int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001243
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001244int get_signum(const char *name) FAST_FUNC;
1245const char *get_signame(int number) FAST_FUNC;
1246void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001247
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001248char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001249/* Returns ptr to NUL */
1250char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001251
Denys Vlasenko681efe22011-03-08 21:00:36 +01001252#define LOGIN_FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001253extern void bb_do_delay(int seconds) FAST_FUNC;
1254extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001255extern 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 +01001256
1257/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1258 * Note that getpwuid result might need xstrdup'ing
1259 * if there is a possibility of intervening getpwxxx() calls.
1260 */
1261const char *get_shell_name(void);
1262
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001263#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001264extern void renew_current_security_context(void) FAST_FUNC;
1265extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001266extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001267 char *user, char *role, char *type, char *range) FAST_FUNC;
1268extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1269extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001270#else
1271#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001272#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001273extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001274
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001275
1276/* systemd support */
1277#define SD_LISTEN_FDS_START 3
1278int sd_listen_fds(void);
1279
1280
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001281/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001282 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001283 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001284 * TERM=(old value)
1285 * USER=pw->pw_name, LOGNAME=pw->pw_name
1286 * PATH=bb_default_[root_]path
1287 * HOME=pw->pw_dir
1288 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001289 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001290 * if not root (if pw->pw_uid != 0):
1291 * USER=pw->pw_name, LOGNAME=pw->pw_name
1292 * HOME=pw->pw_dir
1293 * SHELL=shell
1294 * else does nothing
1295 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001296#define SETUP_ENV_CHANGEENV (1 << 0)
1297#define SETUP_ENV_CLEARENV (1 << 1)
1298#define SETUP_ENV_TO_TMP (1 << 2)
1299extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001300extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001301/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001302#if !ENABLE_USE_BB_CRYPT
1303#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1304#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001305extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1306extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001307/*
1308 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001309 * Useful if you call crypt_make_salt many times in a row:
1310 * rnd = crypt_make_salt(buf1, 4, 0);
1311 * rnd = crypt_make_salt(buf2, 4, rnd);
1312 * rnd = crypt_make_salt(buf3, 4, rnd);
1313 * (otherwise we risk having same salt generated)
1314 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001315extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1316/* "$N$" + sha_salt_16_bytes + NUL */
1317#define MAX_PW_SALT_LEN (3 + 16 + 1)
1318extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1319
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001320
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001321/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001322#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1323#define update_passwd(filename, username, data, member) \
1324 update_passwd(filename, username, data)
1325#endif
1326extern int update_passwd(const char *filename,
1327 const char *username,
1328 const char *data,
1329 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001330
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001331int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1332int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1333int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1334int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1335const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001336
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001337extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1338extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001339
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001340char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001341/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001342int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001343
Denis Vlasenko202ac502008-11-05 13:20:58 +00001344int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1345
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001346/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001347int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1348int 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 +00001349#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001350int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1351int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001352#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1353#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1354#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001355int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1356int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001357#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1358#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1359#endif
1360
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001361char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1362void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1363void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001364#ifdef __GLIBC__
1365/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001366unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001367#undef makedev
1368#define makedev(a,b) bb_makedev(a,b)
1369#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001370
1371
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001372/* "Keycodes" that report an escape sequence.
1373 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001374 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001375 * Also, -1 is reserved for error indication and we don't use it. */
1376enum {
1377 KEYCODE_UP = -2,
1378 KEYCODE_DOWN = -3,
1379 KEYCODE_RIGHT = -4,
1380 KEYCODE_LEFT = -5,
1381 KEYCODE_HOME = -6,
1382 KEYCODE_END = -7,
1383 KEYCODE_INSERT = -8,
1384 KEYCODE_DELETE = -9,
1385 KEYCODE_PAGEUP = -10,
1386 KEYCODE_PAGEDOWN = -11,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001387
1388 KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1389 KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1390 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1391 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001392#if 0
1393 KEYCODE_FUN1 = -12,
1394 KEYCODE_FUN2 = -13,
1395 KEYCODE_FUN3 = -14,
1396 KEYCODE_FUN4 = -15,
1397 KEYCODE_FUN5 = -16,
1398 KEYCODE_FUN6 = -17,
1399 KEYCODE_FUN7 = -18,
1400 KEYCODE_FUN8 = -19,
1401 KEYCODE_FUN9 = -20,
1402 KEYCODE_FUN10 = -21,
1403 KEYCODE_FUN11 = -22,
1404 KEYCODE_FUN12 = -23,
1405#endif
Denys Vlasenko180f5852009-10-26 00:59:59 +01001406 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001407 /* How long is the longest ESC sequence we know?
1408 * We want it big enough to be able to contain
1409 * cursor position sequence "ESC [ 9999 ; 9999 R"
1410 */
1411 KEYCODE_BUFFER_SIZE = 16
1412};
1413/* Note: fd may be in blocking or non-blocking mode, both make sense.
1414 * For one, less uses non-blocking mode.
1415 * Only the first read syscall inside read_key may block indefinitely
1416 * (unless fd is in non-blocking mode),
1417 * subsequent reads will time out after a few milliseconds.
1418 * Return of -1 means EOF or error (errno == 0 on EOF).
1419 * buffer[0] is used as a counter of buffered chars and must be 0
1420 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001421 * timeout:
1422 * -2: do not poll for input;
1423 * -1: poll(-1) (i.e. block);
1424 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001425 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001426int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001427void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001428
1429
Denis Vlasenko38f63192007-01-22 09:03:07 +00001430#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001431/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001432# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001433# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001434unsigned size_from_HISTFILESIZE(const char *hp);
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001435# else
1436# define MAX_HISTORY 0
1437# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001438typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001439 int flags;
1440 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001441# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001442 int cnt_history;
1443 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001444 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001445# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001446 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001447 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001448# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001449 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001450# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001451} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001452enum {
1453 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001454 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1455 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1456 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1457 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001458 WITH_PATH_LOOKUP = 0x20,
1459 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1460};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001461line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001462/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denys Vlasenko046341e2011-02-04 17:53:59 +01001463/*
1464 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001465 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001466 * -1 on read errors or EOF, or on bare Ctrl-D,
1467 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001468 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001469 */
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001470int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001471#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001472#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001473int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001474#define read_line_input(state, prompt, command, maxsize, timeout) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001475 read_line_input(prompt, command, maxsize)
1476#endif
1477
1478
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001479#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001480# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001481enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001482# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001483/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001484enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001485# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001486#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001487
1488struct smaprec {
1489 unsigned long mapped_rw;
1490 unsigned long mapped_ro;
1491 unsigned long shared_clean;
1492 unsigned long shared_dirty;
1493 unsigned long private_clean;
1494 unsigned long private_dirty;
1495 unsigned long stack;
1496 unsigned long smap_pss, smap_swap;
1497 unsigned long smap_size;
1498 unsigned long smap_start;
1499 char smap_mode[5];
1500 char *smap_name;
1501};
1502
1503#if !ENABLE_PMAP
1504#define procps_read_smaps(pid, total, cb, data) \
1505 procps_read_smaps(pid, total)
1506#endif
1507int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1508 void (*cb)(struct smaprec *, void *), void *data);
1509
Denis Vlasenko512499c2007-08-26 18:23:13 +00001510typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001511 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001512 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001513 uint8_t shift_pages_to_bytes;
1514 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001515/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001516 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001517 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001518 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001519 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001520 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001521 /* Everything below must contain no ptrs to malloc'ed data:
1522 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001523 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001524 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001525 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001526 unsigned pid;
1527 unsigned ppid;
1528 unsigned pgid;
1529 unsigned sid;
1530 unsigned uid;
1531 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001532#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1533 unsigned ruid;
1534 unsigned rgid;
1535 int niceness;
1536#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001537 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001538#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001539 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001540#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001541 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001542 /* basename of executable in exec(2), read from /proc/N/stat
1543 * (if executable is symlink or script, it is NOT replaced
1544 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001545 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001546 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001547#if ENABLE_FEATURE_TOP_SMP_PROCESS
1548 int last_seen_on_cpu;
1549#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001550} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001551/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001552enum {
1553 PSSCAN_PID = 1 << 0,
1554 PSSCAN_PPID = 1 << 1,
1555 PSSCAN_PGID = 1 << 2,
1556 PSSCAN_SID = 1 << 3,
1557 PSSCAN_UIDGID = 1 << 4,
1558 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001559 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001560 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001561 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001562 PSSCAN_STATE = 1 << 9,
1563 PSSCAN_VSZ = 1 << 10,
1564 PSSCAN_RSS = 1 << 11,
1565 PSSCAN_STIME = 1 << 12,
1566 PSSCAN_UTIME = 1 << 13,
1567 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001568 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001569 /* NB: used by find_pid_by_name(). Any applet using it
1570 * needs to be mentioned here. */
1571 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1572 || ENABLE_PGREP || ENABLE_PKILL
1573 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001574 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001575 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001576 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001577 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001578 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1579 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1580 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001581 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001582};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001583//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1584void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1585procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001586/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001587/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001588void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001589pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1590pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001591int starts_with_cpu(const char *str) FAST_FUNC;
1592unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001593
1594
1595extern const char bb_uuenc_tbl_base64[];
1596extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001597void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001598enum {
1599 BASE64_FLAG_UU_STOP = 0x100,
1600 /* Sign-extends to a value which never matches fgetc result: */
1601 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1602};
1603void FAST_FUNC read_base64(FILE *src_stream, FILE *dst_stream, int flags);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001604
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001605typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001606 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1607 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001608 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001609 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1610} md5_ctx_t;
1611typedef struct md5_ctx_t sha1_ctx_t;
1612typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001613typedef struct sha512_ctx_t {
1614 uint64_t total64[2]; /* must be directly before hash[] */
1615 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001616 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001617} sha512_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001618void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1619void md5_hash(md5_ctx_t *ctx, const void *data, size_t length) FAST_FUNC;
1620void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1621void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1622#define sha1_hash md5_hash
1623void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1624void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1625#define sha256_hash md5_hash
1626#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001627void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1628void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1629void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001630
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001631extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001632uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001633uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1634uint32_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 +00001635
1636typedef struct masks_labels_t {
1637 const char *labels;
1638 const int masks[];
1639} masks_labels_t;
1640int print_flags_separated(const int *masks, const char *labels,
1641 int flags, const char *separator) FAST_FUNC;
1642int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001643
Magnus Dammf5914992009-11-08 16:34:43 +01001644typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01001645 unsigned last_size;
1646 unsigned last_update_sec;
1647 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01001648 unsigned start_sec;
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001649 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01001650} bb_progress_t;
1651
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001652#define is_bb_progress_inited(p) ((p)->curfile != NULL)
1653#define bb_progress_free(p) do { \
1654 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1655 (p)->curfile = NULL; \
1656} while (0)
1657void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1658void bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01001659 uoff_t beg_range,
1660 uoff_t transferred,
1661 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001662
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001663
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001664extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001665
1666/* Some older linkers don't perform string merging, we used to have common strings
1667 * as global arrays to do it by hand. But:
1668 * (1) newer linkers do it themselves,
1669 * (2) however, they DONT merge string constants with global arrays,
1670 * even if the value is the same (!). Thus global arrays actually
1671 * increased size a bit: for example, "/etc/passwd" string from libc
1672 * wasn't merged with bb_path_passwd_file[] array!
1673 * Therefore now we use #defines.
1674 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001675/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001676extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001677extern const char bb_msg_memory_exhausted[];
1678extern const char bb_msg_invalid_date[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001679#define bb_msg_read_error "read error"
1680#define bb_msg_write_error "write error"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001681extern const char bb_msg_unknown[];
1682extern const char bb_msg_can_not_create_raw_socket[];
1683extern const char bb_msg_perm_denied_are_you_root[];
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01001684extern const char bb_msg_you_must_be_root[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001685extern const char bb_msg_requires_arg[];
1686extern const char bb_msg_invalid_arg[];
1687extern const char bb_msg_standard_input[];
1688extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001689
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001690/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001691extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001692
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001693extern const char bb_path_wtmp_file[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001694
1695/* Busybox mount uses either /proc/mounts or /etc/mtab to
1696 * get the list of currently mounted filesystems */
1697#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1698
Tito Ragusaad3d72f2011-01-16 23:39:45 +01001699#define bb_path_passwd_file _PATH_PASSWD
1700#define bb_path_group_file _PATH_GROUP
1701#define bb_path_shadow_file _PATH_SHADOW
1702#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02001703
1704#define bb_path_motd_file "/etc/motd"
1705
1706#define bb_dev_null "/dev/null"
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001707extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001708/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1709 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001710extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1711#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1712#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001713
Denis Vlasenko703e2022007-01-22 14:12:08 +00001714extern const int const_int_0;
1715extern const int const_int_1;
1716
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001717
Denis Vlasenko85818632007-04-19 14:47:11 +00001718/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001719enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1720extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001721/* This struct is deliberately not defined. */
1722/* See docs/keep_data_small.txt */
1723struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001724/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001725 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001726 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001727extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001728/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001729#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001730#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001731 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001732 barrier(); \
1733} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001734
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001735/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1736 * use bb_default_login_shell and following defines.
1737 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1738 * don't forget to change increment constant. */
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001739extern const char bb_default_login_shell[];
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +02001740
1741#ifdef __BIONIC__
1742/* Since android does not have the /bin path, unlike most unix systems,
1743 * it needs an exception in the default shell path. */
1744# define LIBBB_DEFAULT_LOGIN_SHELL "-/system/bin/sh"
1745/* "/system/xbin/sh" */
1746# define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001747/* "sh" */
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +02001748# define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+13)
1749
1750#else
1751# define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
1752/* "/bin/sh" */
1753# define DEFAULT_SHELL (bb_default_login_shell+1)
1754/* "sh" */
1755# define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1756#endif
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001757
Jeremie Koenig816ed972010-05-27 15:46:29 +02001758/* The following devices are the same on all systems. */
1759#define CURRENT_TTY "/dev/tty"
1760#define DEV_CONSOLE "/dev/console"
1761
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +02001762#ifdef __BIONIC__
1763# define CURRENT_VC CURRENT_TTY
1764# define VC_1 "/dev/tty1"
1765# define VC_2 "/dev/tty2"
1766# define VC_3 "/dev/tty3"
1767# define VC_4 "/dev/tty4"
1768# define VC_5 "/dev/tty5"
1769# define VC_FORMAT "/dev/tty%d"
1770# define LOOP_FORMAT "/dev/block/loop%d"
1771# define LOOP_NAMESIZE (sizeof("/dev/block/loop") + sizeof(int)*3 + 1)
1772# define LOOP_NAME "/dev/block/loop"
1773# define FB_0 "/dev/graphics/fb0"
1774
1775#elif defined(__FreeBSD_kernel__)
Jeremie Koenig816ed972010-05-27 15:46:29 +02001776# define CURRENT_VC CURRENT_TTY
1777# define VC_1 "/dev/ttyv0"
1778# define VC_2 "/dev/ttyv1"
1779# define VC_3 "/dev/ttyv2"
1780# define VC_4 "/dev/ttyv3"
1781# define VC_5 "/dev/ttyv4"
1782# define VC_FORMAT "/dev/ttyv%d"
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +02001783# define LOOP_FORMAT "/dev/loop%d"
1784# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1785# define LOOP_NAME "/dev/loop"
1786# define FB_0 "/dev/fb0"
1787
1788#else //__GNU__
1789/*Linux 2.6, normal names */
Jeremie Koenig816ed972010-05-27 15:46:29 +02001790# define CURRENT_VC CURRENT_TTY
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +02001791# define VC_1 "/dev/tty0"
1792# define VC_2 "/dev/tty1"
1793# define VC_3 "/dev/tty2"
1794# define VC_4 "/dev/tty3"
1795# define VC_5 "/dev/tty4"
Matt Kraai439e3df2001-07-23 14:52:08 +00001796# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001797# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001798# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001799# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001800# define FB_0 "/dev/fb0"
Tanguy Pruvot8aeb3712011-06-30 08:59:26 +02001801
1802#endif //Platform
Matt Kraai439e3df2001-07-23 14:52:08 +00001803
Rob Landleyc57ec372006-04-10 17:07:15 +00001804
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001805#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1806
Rob Landleyb623a542006-05-31 22:09:03 +00001807
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001808/* We redefine ctype macros. Unicode-correct handling of char types
1809 * can't be done with such byte-oriented operations anyway,
1810 * we don't lose anything.
1811 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001812#undef isalnum
1813#undef isalpha
1814#undef isascii
1815#undef isblank
1816#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001817#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001818#undef isgraph
1819#undef islower
1820#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001821#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001822#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001823#undef isupper
1824#undef isxdigit
1825#undef toupper
1826#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001827
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001828/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001829 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001830
1831/* These work the same for ASCII and Unicode,
1832 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001833#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001834#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001835#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1836#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001837#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001838#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1839#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001840/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001841 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001842 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001843#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001844// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1845#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1846// 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 +02001847#define isalnum(a) bb_ascii_isalnum(a)
1848static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1849{
1850 unsigned char b = a - '0';
1851 if (b <= 9)
1852 return (b <= 9);
1853 b = (a|0x20) - 'a';
1854 return b <= 'z' - 'a';
1855}
1856#define isxdigit(a) bb_ascii_isxdigit(a)
1857static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1858{
1859 unsigned char b = a - '0';
1860 if (b <= 9)
1861 return (b <= 9);
1862 b = (a|0x20) - 'a';
1863 return b <= 'f' - 'a';
1864}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001865#define toupper(a) bb_ascii_toupper(a)
1866static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1867{
1868 unsigned char b = a - 'a';
1869 if (b <= ('z' - 'a'))
1870 a -= 'a' - 'A';
1871 return a;
1872}
1873#define tolower(a) bb_ascii_tolower(a)
1874static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1875{
1876 unsigned char b = a - 'A';
1877 if (b <= ('Z' - 'A'))
1878 a += 'a' - 'A';
1879 return a;
1880}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001881
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001882/* In ASCII and Unicode, these are likely to be very different.
1883 * Let's prevent ambiguous usage from the start */
1884#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1885#define isprint(a) isprint_is_ambiguous_dont_use(a)
1886/* NB: must not treat EOF as isgraph or isprint */
1887#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1888#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1889
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001890
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001891POP_SAVED_FUNCTION_VISIBILITY
1892
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001893#endif