blob: bae7efb00bd4eb580a7ff24c744e4015907962a1 [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
Eric Andersenaad1a882001-03-16 22:47:14 +00006 * Permission has been granted to redistribute this code under the GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Rob Landleyeb84a422006-09-20 21:41:13 +00008 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000010#ifndef LIBBB_H
11#define LIBBB_H 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
20#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000021#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000022#include <signal.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000023#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000024#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000025#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000026#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000027#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000028#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000029#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000030#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000031#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000032#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000033#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000034#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000035#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000036#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000037#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000038#include <unistd.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000039#include <utime.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000040/* Try to pull in PATH_MAX */
41#include <limits.h>
42#include <sys/param.h>
43#ifndef PATH_MAX
44#define PATH_MAX 256
45#endif
Rob Landley299a6b42006-05-27 21:42:58 +000046
Mike Frysinger22876c72008-02-07 22:10:07 +000047#ifdef HAVE_MNTENT_H
48#include <mntent.h>
49#endif
50
Mike Frysinger9412ec72008-02-07 22:41:33 +000051#ifdef HAVE_SYS_STATFS_H
52#include <sys/statfs.h>
53#endif
54
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000055#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000056#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000057#include <selinux/context.h>
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +000058#include <selinux/flask.h>
59#include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000060#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000061
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000062#if ENABLE_LOCALE_SUPPORT
Rob Landleyd921b2e2006-08-03 15:41:12 +000063#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000064#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000065#define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000066#endif
67
Denis Vlasenko98636eb2008-05-09 17:59:34 +000068#ifdef DMALLOC
69#include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000070#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000071
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000072#include <pwd.h>
73#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000074#if ENABLE_FEATURE_SHADOWPASSWDS
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000075# include <shadow.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000076#endif
77
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +000078/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +000079
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +000080extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000081#if defined(__GLIBC__) && __GLIBC__ < 2
82int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000083#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000084/* klogctl is in libc's klog.h, but we cheat and not #include that */
85int klogctl(int type, char *b, int len);
86/* This is declared here rather than #including <libgen.h> in order to avoid
87 * confusing the two versions of basename. See the dirname/basename man page
88 * for details. */
89char *dirname(char *path);
90/* Include our own copy of struct sysinfo to avoid binary compatibility
91 * problems with Linux 2.4, which changed things. Grumble, grumble. */
92struct sysinfo {
93 long uptime; /* Seconds since boot */
94 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
95 unsigned long totalram; /* Total usable main memory size */
96 unsigned long freeram; /* Available memory size */
97 unsigned long sharedram; /* Amount of shared memory */
98 unsigned long bufferram; /* Memory used by buffers */
99 unsigned long totalswap; /* Total swap space size */
100 unsigned long freeswap; /* swap space still available */
101 unsigned short procs; /* Number of current processes */
102 unsigned short pad; /* Padding needed for m68k */
103 unsigned long totalhigh; /* Total high memory size */
104 unsigned long freehigh; /* Available high memory size */
105 unsigned int mem_unit; /* Memory unit size in bytes */
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000106 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000107};
108int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +0000109
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000110
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000111/* Make all declarations hidden (-fvisibility flag only affects definitions) */
112/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000113PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000114
115
116#if ENABLE_USE_BB_PWD_GRP
117# include "pwd_.h"
118# include "grp_.h"
119#endif
120#if ENABLE_FEATURE_SHADOWPASSWDS
121# if ENABLE_USE_BB_SHADOW
122# include "shadow_.h"
123# endif
124#endif
125
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000126/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000127#define MAXINT(T) (T)( \
128 ((T)-1) > 0 \
129 ? (T)-1 \
130 : (T)~((T)1 << (sizeof(T)*8-1)) \
131 )
132
133#define MININT(T) (T)( \
134 ((T)-1) > 0 \
135 ? (T)0 \
136 : ((T)1 << (sizeof(T)*8-1)) \
137 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000138
Denis Vlasenko56254152006-10-07 16:24:46 +0000139/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000140/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000141 * (stat, lseek etc) mapped to "largefile" variants by libc.
142 * Practically it means that open() automatically has O_LARGEFILE added
143 * and all filesize/file_offset parameters and struct members are "large"
144 * (in today's world - signed 64bit). For full support of large files,
145 * we need a few helper #defines (below) and careful use of off_t
146 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000147#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000148/* CONFIG_LFS is on */
149# if ULONG_MAX > 0xffffffff
150/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000151typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000152# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000153/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
154# define BB_STRTOOFF bb_strtoul
155# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000156/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
157# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000158# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000159/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000160typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000161# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000162# define BB_STRTOOFF bb_strtoull
163# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000164# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000165# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000166#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000167/* CONFIG_LFS is off */
168# if UINT_MAX == 0xffffffff
169/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
170 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000171typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000172# define XATOOFF(a) xatoi_u(a)
173# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000174# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000175# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000176# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000177typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000178# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
179# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000180# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000181# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000182# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000183#endif
184/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000185#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000186
Eric Andersenaad1a882001-03-16 22:47:14 +0000187/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000188#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000189#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000190#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000191#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000192#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000193#define SKIP ((int) 2)
194
195/* for mtab.c */
196#define MTAB_GETMOUNTPT '1'
197#define MTAB_GETDEVICE '2'
198
199#define BUF_SIZE 8192
200#define EXPAND_ALLOC 1024
201
Eric Andersenaad1a882001-03-16 22:47:14 +0000202/* Macros for min/max. */
203#ifndef MIN
204#define MIN(a,b) (((a)<(b))?(a):(b))
205#endif
206
207#ifndef MAX
208#define MAX(a,b) (((a)>(b))?(a):(b))
209#endif
210
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000211/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000212#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000213#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000214#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
215#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
216#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000217#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000218#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
219#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
220#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
221#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000222#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
223#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
224#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000225#endif
226#endif
227
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000228#if defined(__GLIBC__)
229/* glibc uses __errno_location() to get a ptr to errno */
230/* We can just memorize it once - no multithreading in busybox :) */
231extern int *const bb_errno;
232#undef errno
233#define errno (*bb_errno)
234#endif
235
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000236unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000237unsigned long long monotonic_us(void) FAST_FUNC;
238unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000239
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000240extern void chomp(char *s) FAST_FUNC;
241extern void trim(char *s) FAST_FUNC;
242extern char *skip_whitespace(const char *) FAST_FUNC;
243extern char *skip_non_whitespace(const char *) FAST_FUNC;
244extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000245
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000246//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000247extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
248extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000249enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
250 FILEUTILS_PRESERVE_STATUS = 1,
251 FILEUTILS_DEREFERENCE = 2,
252 FILEUTILS_RECUR = 4,
253 FILEUTILS_FORCE = 8,
254 FILEUTILS_INTERACTIVE = 0x10,
255 FILEUTILS_MAKE_HARDLINK = 0x20,
256 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000257 FILEUTILS_DEREF_SOFTLINK = 0x80,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000258#if ENABLE_SELINUX
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000259 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
260 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000261#endif
262};
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000263#define FILEUTILS_CP_OPTSTR "pdRfilsL" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000264extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000265/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
266 * the source, not copy (unless "source" is a directory).
267 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
268 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000269extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000270
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000271enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000272 ACTION_RECURSE = (1 << 0),
273 ACTION_FOLLOWLINKS = (1 << 1),
274 ACTION_FOLLOWLINKS_L0 = (1 << 2),
275 ACTION_DEPTHFIRST = (1 << 3),
276 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000277 ACTION_QUIET = (1 << 5),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000278};
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000279extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000280 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
281 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
282 void* userData, unsigned depth) FAST_FUNC;
283extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000284enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000285extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000286extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000287extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
288extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000289/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000290extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
291extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
292extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000293/* "short" copy can be detected by return value < size */
294/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000295extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000296extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000297/* xxxx_strip version can modify its parameter:
298 * "/" -> "/"
299 * "abc" -> "abc"
300 * "abc/def" -> "def"
301 * "abc/def/" -> "def" !!
302 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000303extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000304/* "abc/def/" -> "" and it never modifies 'path' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000305extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000306
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000307int ndelay_on(int fd) FAST_FUNC;
308int ndelay_off(int fd) FAST_FUNC;
309int close_on_exec_on(int fd) FAST_FUNC;
310void xdup2(int, int) FAST_FUNC;
311void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000312
313
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000314DIR *xopendir(const char *path) FAST_FUNC;
315DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000316
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000317/* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC; */
318char *xmalloc_readlink(const char *path) FAST_FUNC;
319char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC;
320char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000321
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000322char *xmalloc_follow_symlinks(const char *path) FAST_FUNC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000323
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000324
Denis Vlasenko33196372008-02-23 01:25:38 +0000325enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000326 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000327 * otherwise would kill us, except for those resulting from bugs:
328 * SIGSEGV, SIGILL, SIGFPE.
329 * Other fatal signals not included (TODO?):
330 * SIGBUS Bus error (bad memory access)
331 * SIGPOLL Pollable event. Synonym of SIGIO
332 * SIGPROF Profiling timer expired
333 * SIGSYS Bad argument to routine
334 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000335 *
336 * The only known arch with some of these sigs not fitting
337 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
338 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000339 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000340 BB_FATAL_SIGS = (int)(0
341 + (1LL << SIGHUP)
342 + (1LL << SIGINT)
343 + (1LL << SIGTERM)
344 + (1LL << SIGPIPE) // Write to pipe with no readers
345 + (1LL << SIGQUIT) // Quit from keyboard
346 + (1LL << SIGABRT) // Abort signal from abort(3)
347 + (1LL << SIGALRM) // Timer signal from alarm(2)
348 + (1LL << SIGVTALRM) // Virtual alarm clock
349 + (1LL << SIGXCPU) // CPU time limit exceeded
350 + (1LL << SIGXFSZ) // File size limit exceeded
351 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
352 + (1LL << SIGUSR2)
353 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000354};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000355void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000356/* Unlike signal() and bb_signals, sets handler with sigaction()
357 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000358 * will be blocked; syscalls will not be restarted: */
359void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000360/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000361void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000362/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000363void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
364void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000365void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000366void sig_block(int sig) FAST_FUNC;
367void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000368/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000369int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000370/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000371int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000372/* Standard handler which just records signo */
373extern smallint bb_got_signal;
374void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000375
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000376
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000377void xsetgid(gid_t gid) FAST_FUNC;
378void xsetuid(uid_t uid) FAST_FUNC;
379void xchdir(const char *path) FAST_FUNC;
380void xchroot(const char *path) FAST_FUNC;
381void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000382void bb_unsetenv(const char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000383void xunlink(const char *pathname) FAST_FUNC;
384void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
385int xopen(const char *pathname, int flags) FAST_FUNC FAST_FUNC;
386int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
387int open_or_warn(const char *pathname, int flags) FAST_FUNC;
388int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
389int open_or_warn_stdin(const char *pathname) FAST_FUNC;
390void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
391int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
392off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
393off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000394
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000395void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000396/* In this form code with pipes is much more readable */
397struct fd_pair { int rd; int wr; };
398#define piped_pair(pair) pipe(&((pair).rd))
399#define xpiped_pair(pair) xpipe(&((pair).rd))
400
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000401/* Useful for having small structure members/global variables */
402typedef int8_t socktype_t;
403typedef int8_t family_t;
404struct BUG_too_small {
405 char BUG_socktype_t_too_small[(0
406 | SOCK_STREAM
407 | SOCK_DGRAM
408 | SOCK_RDM
409 | SOCK_SEQPACKET
410 | SOCK_RAW
411 ) <= 127 ? 1 : -1];
412 char BUG_family_t_too_small[(0
413 | AF_UNSPEC
414 | AF_INET
415 | AF_INET6
416 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000417#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000418 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000419#endif
420#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000421 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000422#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000423 /* | AF_DECnet */
424 /* | AF_IPX */
425 ) <= 127 ? 1 : -1];
426};
427
428
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000429int xsocket(int domain, int type, int protocol) FAST_FUNC;
430void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
431void xlisten(int s, int backlog) FAST_FUNC;
432void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000433ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000434 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000435/* SO_REUSEADDR allows a server to rebind to an address that is already
436 * "in use" by old connections to e.g. previous server instance which is
437 * killed or crashed. Without it bind will fail until all such connections
438 * time out. Linux does not allow multiple live binds on same ip:port
439 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
440 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000441void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
442int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000443int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000444/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000445unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000446typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000447 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000448 union {
449 struct sockaddr sa;
450 struct sockaddr_in sin;
451#if ENABLE_FEATURE_IPV6
452 struct sockaddr_in6 sin6;
453#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000454 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000455} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000456enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000457 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000458 LSA_SIZEOF_SA = sizeof(
459 union {
460 struct sockaddr sa;
461 struct sockaddr_in sin;
462#if ENABLE_FEATURE_IPV6
463 struct sockaddr_in6 sin6;
464#endif
465 }
466 )
467};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000468/* Create stream socket, and allocate suitable lsa.
469 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000470 * af == AF_UNSPEC will result in trying to create IPv6 socket,
471 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000472 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000473#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000474int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000475#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000476int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000477#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
478#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000479int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000480/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000481 * numeric IP ("N.N.N.N") or numeric IPv6 address,
482 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000483 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000484/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000485int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
486int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000487/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
488 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
489 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
490 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000491int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000492/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000493int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000494/* Get local address of bound or accepted socket */
495len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000496/* Return malloc'ed len_and_sockaddr with socket address of host:port
497 * Currently will return IPv4 or IPv6 sockaddrs only
498 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000499 * UNIX socket address being returned, IPX sockaddr etc...
500 * On error does bb_error_msg and returns NULL */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000501len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000502/* Version which dies on error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000503len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC;
504len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000505/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000506#if !ENABLE_FEATURE_IPV6
507#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
508#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
509#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000510len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
511len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000512#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000513/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000514 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000515 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000516void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000517/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000518int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000519/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000520char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000521/* This one doesn't append :PORTNUM */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000522char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000523/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000524char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000525/* inet_[ap]ton on steroids */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000526char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC;
527char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000528// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000529// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000530struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000531// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000532// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000533
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000534
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000535void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000536ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000537 const struct sockaddr *to,
538 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000539 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000540ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000541 struct sockaddr *from,
542 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000543 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000544
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000545char *xstrdup(const char *s) FAST_FUNC;
546char *xstrndup(const char *s, int n) FAST_FUNC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000547void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000548char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000549char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000550/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000551 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000552int bb_putchar(int ch) FAST_FUNC;
553char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000554/* Prints unprintable chars ch as ^C or M-c to file
555 * (M-c is used only if ch is ORed with PRINTABLE_META),
556 * else it is printed as-is (except for ch = 0x9b) */
557enum { PRINTABLE_META = 0x100 };
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000558void fputc_printable(int ch, FILE *file) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000559// gcc-4.1.1 still isn't good enough at optimizing it
560// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000561//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000562//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000563//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000564//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000565#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000566#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000567#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000568#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000569#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000570
571/* dmalloc will redefine these to it's own implementation. It is safe
572 * to have the prototypes here unconditionally. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000573void *malloc_or_warn(size_t size) FAST_FUNC;
574void *xmalloc(size_t size) FAST_FUNC;
575void *xzalloc(size_t size) FAST_FUNC;
576void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000577/* After xrealloc_vector(v, 4, idx) it's ok to use
578 * at least v[idx] and v[idx+1], for all idx values.
579 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
580 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000581#define xrealloc_vector(vector, shift, idx) \
582 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
583void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
584
Eric Andersenaad1a882001-03-16 22:47:14 +0000585
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000586extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
587extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000588// NB: will return short read on error, not -1,
589// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000590extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
591extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
592extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000593extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
594extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000595// Reads one line a-la fgets (but doesn't save terminating '\n').
596// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000597// Bytes are appended to pfx (which must be malloced, or NULL).
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000598extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000599/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denis Vlasenkob6052722008-07-10 17:43:01 +0000600extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000601/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000602extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000603/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000604extern int open_zipped(const char *fname) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000605extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000606/* Never returns NULL */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000607extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000608
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000609extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000610// NB: will return short write on error, not -1,
611// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000612extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
613extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000614extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000615extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000616
Denis Vlasenko1de08302006-10-26 23:32:43 +0000617/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000618extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000619
620extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenko69f4f9a2008-08-09 17:16:40 +0000621extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000622/* Reads up to (and including) TERMINATING_STRING: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000623extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000624/* Same, with limited max size, and returns the length (excluding NUL): */
625extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000626/* Chops off TERMINATING_STRING from the end: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000627extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000628/* Reads up to (and including) "\n" or NUL byte: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000629extern char *xmalloc_fgets(FILE *file) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000630/* Chops off '\n' from the end, unlike fgets: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000631extern char *xmalloc_fgetline(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000632/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denis Vlasenko5e476ba2008-07-15 21:29:44 +0000633/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000634
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000635extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
636extern void die_if_ferror_stdout(void) FAST_FUNC;
637extern void xfflush_stdout(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000638extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000639extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
640extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000641/* Prints warning to stderr and returns NULL on failure: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000642extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000643/* "Opens" stdin if filename is special, else just opens file: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000644extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
645extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000646extern FILE* fopen_for_read(const char *path) FAST_FUNC;
647extern FILE* xfopen_for_read(const char *path) FAST_FUNC;
648extern FILE* fopen_for_write(const char *path) FAST_FUNC;
649extern FILE* xfopen_for_write(const char *path) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000650
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000651int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
652void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000653
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000654/* Wrapper which restarts poll on EINTR or ENOMEM.
655 * On other errors complains [perror("poll")] and returns.
656 * Warning! May take (much) longer than timeout_ms to return!
657 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000658int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000659
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000660char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000661char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000662
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000663/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000664char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000665
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000666char *utoa(unsigned n) FAST_FUNC;
667char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000668/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000669char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
670char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000671/* Intelligent formatters of bignums */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000672void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
673void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000674//TODO: provide pointer to buf (avoid statics)?
675const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000676 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000677/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000678char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000679
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000680/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000681struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000682 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000683 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000684};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000685#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000686/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000687/* Using xatoi() instead of naive atoi() is not always convenient -
688 * in many places people want *non-negative* values, but store them
689 * in signed int. Therefore we need this one:
690 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000691int xatoi_u(const char *numstr) FAST_FUNC;
Denis Vlasenko13858992006-10-08 12:49:22 +0000692/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000693uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000694
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000695
Eric Andersenaad1a882001-03-16 22:47:14 +0000696/* These parse entries in /etc/passwd and /etc/group. This is desirable
697 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000698 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000699long xuname2uid(const char *name) FAST_FUNC;
700long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000701/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000702unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000703/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000704struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000705 uid_t uid;
706 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000707};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000708/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000709int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000710/* always sets uid and gid, allows numeric; exits on failure */
711void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000712/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000713void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000714struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000715struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000716struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
717struct group* xgetgrgid(gid_t gid) FAST_FUNC;
718char* xuid2uname(uid_t uid) FAST_FUNC;
719char* xgid2group(gid_t gid) FAST_FUNC;
720char* uid2uname(uid_t uid) FAST_FUNC;
721char* gid2group(gid_t gid) FAST_FUNC;
722char* uid2uname_utoa(long uid) FAST_FUNC;
723char* gid2group_utoa(long gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000724/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000725const char* get_cached_username(uid_t uid) FAST_FUNC;
726const char* get_cached_groupname(gid_t gid) FAST_FUNC;
727void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000728/* internally usernames are saved in fixed-sized char[] buffers */
729enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000730#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000731void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000732#else
733#define die_if_bad_username(name) ((void)(name))
734#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000735
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000736int execable_file(const char *name) FAST_FUNC;
737char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
738int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000739
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000740/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
741 * but it may exec busybox and call applet instead of searching PATH.
742 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000743#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000744int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000745#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
746#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000747 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000748 cmd, __VA_ARGS__)
749#else
750#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
751#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
752#endif
753
754/* NOMMU friendy fork+exec */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000755pid_t spawn(char **argv) FAST_FUNC;
756pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000757
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000758pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000759/* Unlike waitpid, waits ONLY for one process.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000760 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000761 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000762 * IOW: rc = wait4pid(spawn(argv));
763 * if (rc < 0) bb_perror_msg("%s", argv[0]);
764 * if (rc > 0) bb_error_msg("exit code: %d", rc);
765 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000766int wait4pid(pid_t pid) FAST_FUNC;
767pid_t wait_any_nohang(int *wstat) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000768#define wait_crashed(w) ((w) & 127)
769#define wait_exitcode(w) ((w) >> 8)
770#define wait_stopsig(w) ((w) >> 8)
771#define wait_stopped(w) (((w) & 127) == 127)
772/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000773pid_t spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000774struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000775 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000776 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000777 int xfunc_error_retval;
778 uint32_t option_mask32;
779 int die_sleep;
780 smallint saved;
781};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000782void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
783void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000784/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000785int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
786int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000787
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000788/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000789 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000790 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000791 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000792 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
793 * rexec's itself on NOMMU with argv passed as command line.
794 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
795 * from the start. (It will detect it and not reexec again second time).
796 * You have to audit carefully that you don't do something twice as a result
797 * (opening files/sockets, parsing config files etc...)!
798 *
799 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
800 * (will do setsid()).
801 *
Denis Vlasenko83518d12009-03-20 22:17:13 +0000802 * fork_or_rexec(argv) = bare-bones "fork" on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000803 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000804 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000805 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000806 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000807 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000808 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
809 * to /dev/null if they are not.
810 */
811enum {
812 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000813 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000814 DAEMON_CLOSE_EXTRA_FDS = 4,
815 DAEMON_ONLY_SANITIZE = 8, /* internal use */
816};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000817#if BB_MMU
Denis Vlasenko83518d12009-03-20 22:17:13 +0000818 pid_t fork_or_rexec(void) FAST_FUNC;
Denis Vlasenko367960b2007-08-18 14:20:21 +0000819 enum { re_execed = 0 };
Denis Vlasenko83518d12009-03-20 22:17:13 +0000820# define fork_or_rexec(argv) fork_or_rexec()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000821# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
822# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000823#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000824 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000825 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000826 extern bool re_execed;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000827 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
828 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
829 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000830# define fork() BUG_fork_is_unavailable_on_nommu()
831# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
832# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000833#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000834void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
835void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000836/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000837int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000838
839
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000840extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000841extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000842#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000843#define No_argument "\0"
844#define Required_argument "\001"
845#define Optional_argument "\002"
846extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000847#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000848extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000849extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000850
851
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000852typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000853 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000854 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000855} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000856void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
857void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
858void *llist_pop(llist_t **elm) FAST_FUNC;
859void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
860void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
861llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +0000862llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000863/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000864 * llist_t *llist_add_to(llist_t *old_head, void *data)
865 * etc does not result in smaller code... */
866
Denis Vlasenko80edead2007-08-02 22:31:05 +0000867/* start_stop_daemon and udhcpc are special - they want
868 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000869#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000870/* True only if we created pidfile which is *file*, not /dev/null etc */
871extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000872void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000873#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000874#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000875enum { wrote_pidfile = 0 };
876#define write_pidfile(path) ((void)0)
877#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000878#endif
879
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000880enum {
881 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000882 LOGMODE_STDIO = (1 << 0),
883 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000884 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
885};
886extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000887extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000888extern int die_sleep;
889extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000890extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000891extern void xfunc_die(void) NORETURN FAST_FUNC;
892extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000893extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
894extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
895extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
896extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
897extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +0000898extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000899extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
900extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000901extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000902extern void bb_perror_nomsg(void) FAST_FUNC;
903extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
904extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000905
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000906/* We need to export XXX_main from libbusybox
907 * only if we build "individual" binaries
908 */
909#if ENABLE_FEATURE_INDIVIDUAL
910#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
911#else
912#define MAIN_EXTERNALLY_VISIBLE
913#endif
914
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000915
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000916/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000917int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000918/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000919int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
920int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
921int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
922int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000923/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000924int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +0000925/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000926int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
927/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000928int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000929int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +0000930
Denis Vlasenko468aea22008-04-01 14:47:57 +0000931#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000932void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +0000933#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000934
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000935
Denis Vlasenko0112ff52008-10-25 23:23:00 +0000936/* "Keycodes" that report an escape sequence.
937 * We use something which fits into signed char,
938 * yet doesn't represent any valid Unicode characher.
939 * Also, -1 is reserved for error indication and we don't use it. */
940enum {
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +0000941 KEYCODE_UP = -2,
Denis Vlasenko0112ff52008-10-25 23:23:00 +0000942 KEYCODE_DOWN = -3,
943 KEYCODE_RIGHT = -4,
944 KEYCODE_LEFT = -5,
945 KEYCODE_HOME = -6,
946 KEYCODE_END = -7,
947 KEYCODE_INSERT = -8,
948 KEYCODE_DELETE = -9,
949 KEYCODE_PAGEUP = -10,
950 KEYCODE_PAGEDOWN = -11,
951#if 0
952 KEYCODE_FUN1 = -12,
953 KEYCODE_FUN2 = -13,
954 KEYCODE_FUN3 = -14,
955 KEYCODE_FUN4 = -15,
956 KEYCODE_FUN5 = -16,
957 KEYCODE_FUN6 = -17,
958 KEYCODE_FUN7 = -18,
959 KEYCODE_FUN8 = -19,
960 KEYCODE_FUN9 = -20,
961 KEYCODE_FUN10 = -21,
962 KEYCODE_FUN11 = -22,
963 KEYCODE_FUN12 = -23,
964#endif
Denis Vlasenko5f6aaf32008-10-25 23:27:29 +0000965 /* How long the longest ESC sequence we know? */
966 KEYCODE_BUFFER_SIZE = 4
Denis Vlasenko0112ff52008-10-25 23:23:00 +0000967};
Denys Vlasenko071ede12009-05-15 23:23:23 +0200968/* Note: fd may be in blocking or non-blocking mode, both make sense.
969 * For one, less uses non-blocking mode.
970 * Only the first read syscall inside read_key may block indefinitely
971 * (unless fd is in non-blocking mode),
972 * subsequent reads will time out after a few milliseconds.
973 */
Denis Vlasenko0112ff52008-10-25 23:23:00 +0000974int read_key(int fd, smalluint *nbuffered, char *buffer) FAST_FUNC;
975
976
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000977/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000978int create_icmp_socket(void) FAST_FUNC;
979int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000980/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000981/* This structure defines protocol families and their handlers. */
982struct aftype {
983 const char *name;
984 const char *title;
985 int af;
986 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000987 char* FAST_FUNC (*print)(unsigned char *);
988 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
989 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
990 void FAST_FUNC (*herror)(char *text);
991 int FAST_FUNC (*rprint)(int options);
992 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000993 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000994 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000995};
996/* This structure defines hardware protocols and their handlers. */
997struct hwtype {
998 const char *name;
999 const char *title;
1000 int type;
1001 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001002 char* FAST_FUNC (*print)(unsigned char *);
1003 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1004 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001005 int suppress_null_addr;
1006};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001007extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001008int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001009#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001010int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001011#else
1012#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001013#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001014const struct aftype *get_aftype(const char *name) FAST_FUNC;
1015const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1016const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001017
1018
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001019#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001020extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001021/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001022extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001023extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001024#endif
1025
Mike Frysinger9412ec72008-02-07 22:41:33 +00001026#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001027extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1028extern struct mntent *find_mount_point(const char *name, const char *table) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001029#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001030extern void erase_mtab(const char * name) FAST_FUNC;
1031extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1032extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1033extern void bb_warn_ignoring_args(int n) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001034
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001035extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001036
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001037extern char *query_loop(const char *device) FAST_FUNC;
1038extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001039/* If *devname is not NULL, use that name, otherwise try to find free one,
1040 * malloc and return it in *devname.
1041 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001042extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001043
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001044/* Like bb_ask below, but asks on stdin with no timeout. */
1045char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001046//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001047char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001048int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001049
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001050int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001051
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001052/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001053 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001054 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001055enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001056 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1057 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1058// TODO: COLLAPSE and TRIM seem to always go in pair
1059 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1060 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001061 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001062 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001063// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1064 // NORMAL is:
1065 // * remove leading and trailing delimiters and collapse
1066 // multiple delimiters into one
1067 // * warn and continue if less than mintokens delimiters found
1068 // * grab everything into last token
1069 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001070};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001071typedef struct parser_t {
1072 FILE *fp;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001073 char *line;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001074 char *data;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001075 int lineno;
1076} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001077parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001078parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001079int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1080#define config_read(parser, tokens, max, min, str, flags) \
1081 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001082void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001083
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001084/* Concatenate path and filename to new allocated buffer.
1085 * Add "/" only as needed (no duplicate "//" are produced).
1086 * If path is NULL, it is assumed to be "/".
1087 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001088char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1089char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1090const char *bb_basename(const char *name) FAST_FUNC;
Denis Vlasenko7e84e532007-05-08 17:52:17 +00001091/* NB: can violate const-ness (similarly to strchr) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001092char *last_char_is(const char *s, int c) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001093
Denis Vlasenko4921b542007-02-03 02:17:41 +00001094
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001095int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001096
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001097int get_signum(const char *name) FAST_FUNC;
1098const char *get_signame(int number) FAST_FUNC;
1099void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001100
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001101char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001102/* Returns ptr to NUL */
1103char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001104
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001105#define FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001106extern void bb_do_delay(int seconds) FAST_FUNC;
1107extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001108extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001109extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001110#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001111extern void renew_current_security_context(void) FAST_FUNC;
1112extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001113extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001114 char *user, char *role, char *type, char *range) FAST_FUNC;
1115extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1116extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001117#else
1118#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001119#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001120extern void selinux_or_die(void) FAST_FUNC;
1121extern int restricted_shell(const char *shell) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001122
1123/* setup_environment:
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001124 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001125 * TERM=(old value)
1126 * USER=pw->pw_name, LOGNAME=pw->pw_name
1127 * PATH=bb_default_[root_]path
1128 * HOME=pw->pw_dir
1129 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001130 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001131 * if not root (if pw->pw_uid != 0):
1132 * USER=pw->pw_name, LOGNAME=pw->pw_name
1133 * HOME=pw->pw_dir
1134 * SHELL=shell
1135 * else does nothing
1136 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001137extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw) FAST_FUNC;
1138extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001139/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001140#if !ENABLE_USE_BB_CRYPT
1141#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1142#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001143extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1144extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001145/* rnd is additional random input. New one is returned.
1146 * Useful if you call crypt_make_salt many times in a row:
1147 * rnd = crypt_make_salt(buf1, 4, 0);
1148 * rnd = crypt_make_salt(buf2, 4, rnd);
1149 * rnd = crypt_make_salt(buf3, 4, rnd);
1150 * (otherwise we risk having same salt generated)
1151 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001152extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001153
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001154/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001155#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1156#define update_passwd(filename, username, data, member) \
1157 update_passwd(filename, username, data)
1158#endif
1159extern int update_passwd(const char *filename,
1160 const char *username,
1161 const char *data,
1162 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001163
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001164int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1165int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1166int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1167int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1168const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001169
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001170extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1171extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001172
Denis Vlasenko4e12b1a2008-12-23 23:36:47 +00001173char *xmalloc_ttyname(int fd) FAST_FUNC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001174/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001175int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001176
Denis Vlasenko202ac502008-11-05 13:20:58 +00001177int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1178
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001179/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001180int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1181int 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 +00001182#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001183int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1184int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001185#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1186#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1187#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001188int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1189int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001190#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1191#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1192#endif
1193
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001194char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1195void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1196void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001197#ifdef __GLIBC__
1198/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001199unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001200#undef makedev
1201#define makedev(a,b) bb_makedev(a,b)
1202#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001203
1204
Denis Vlasenko38f63192007-01-22 09:03:07 +00001205#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001206/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001207# ifdef CONFIG_FEATURE_EDITING_HISTORY
1208# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1209# else
1210# define MAX_HISTORY 0
1211# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001212typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001213 int flags;
1214 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001215# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001216 int cnt_history;
1217 int cur_history;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001218# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001219 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001220 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001221# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001222 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001223# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001224} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001225enum {
1226 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001227 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1228 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1229 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1230 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001231 WITH_PATH_LOOKUP = 0x20,
1232 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1233};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001234line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denis Vlasenkoc0ea82a2009-03-23 06:33:37 +00001235/* so far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001236/* Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001237 * -1 on read errors or EOF, or on bare Ctrl-D,
1238 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001239 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001240 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001241int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001242#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001243int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001244#define read_line_input(prompt, command, maxsize, state) \
1245 read_line_input(prompt, command, maxsize)
1246#endif
1247
1248
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001249#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001250# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001251enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001252# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001253/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001254enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001255# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001256#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001257typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001258 DIR *dir;
Denis Vlasenko512499c2007-08-26 18:23:13 +00001259 uint8_t shift_pages_to_bytes;
1260 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001261/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001262 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001263 char *argv0;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001264 IF_SELINUX(char *context;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001265 /* Everything below must contain no ptrs to malloc'ed data:
1266 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001267 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001268 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001269 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001270 unsigned pid;
1271 unsigned ppid;
1272 unsigned pgid;
1273 unsigned sid;
1274 unsigned uid;
1275 unsigned gid;
Denis Vlasenko31789a82007-06-19 14:43:17 +00001276 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001277#if ENABLE_FEATURE_TOPMEM
1278 unsigned long mapped_rw;
1279 unsigned long mapped_ro;
1280 unsigned long shared_clean;
1281 unsigned long shared_dirty;
1282 unsigned long private_clean;
1283 unsigned long private_dirty;
1284 unsigned long stack;
1285#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001286 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001287 /* basename of executable in exec(2), read from /proc/N/stat
1288 * (if executable is symlink or script, it is NOT replaced
1289 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001290 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001291 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001292#if ENABLE_FEATURE_TOP_SMP_PROCESS
1293 int last_seen_on_cpu;
1294#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001295} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001296enum {
1297 PSSCAN_PID = 1 << 0,
1298 PSSCAN_PPID = 1 << 1,
1299 PSSCAN_PGID = 1 << 2,
1300 PSSCAN_SID = 1 << 3,
1301 PSSCAN_UIDGID = 1 << 4,
1302 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001303 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001304 PSSCAN_ARGV0 = 1 << 7,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001305 /* PSSCAN_EXE = 1 << 8, - not implemented */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001306 PSSCAN_STATE = 1 << 9,
1307 PSSCAN_VSZ = 1 << 10,
1308 PSSCAN_RSS = 1 << 11,
1309 PSSCAN_STIME = 1 << 12,
1310 PSSCAN_UTIME = 1 << 13,
1311 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001312 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001313 /* NB: used by find_pid_by_name(). Any applet using it
1314 * needs to be mentioned here. */
1315 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1316 || ENABLE_PGREP || ENABLE_PKILL
1317 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001318 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001319 ),
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001320 IF_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001321 PSSCAN_START_TIME = 1 << 18,
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001322 PSSCAN_CPU = 1 << 19,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001323 /* These are all retrieved from proc/NN/stat in one go: */
1324 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001325 /**/ | PSSCAN_COMM | PSSCAN_STATE
1326 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1327 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1328 /**/ | PSSCAN_TTY
1329#if ENABLE_FEATURE_TOP_SMP_PROCESS
1330 /**/ | PSSCAN_CPU
1331#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001332};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001333//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1334void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1335procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001336/* Format cmdline (up to col chars) into char buf[col+1] */
1337/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001338void read_cmdline(char *buf, int col, unsigned pid, const char *comm) FAST_FUNC;
1339pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1340pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001341
1342
1343extern const char bb_uuenc_tbl_base64[];
1344extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001345void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001346
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001347typedef struct sha1_ctx_t {
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001348 uint32_t hash[8]; /* 5, +3 elements for sha256 */
Denis Vlasenko98c87f72009-03-11 21:15:51 +00001349 uint64_t total64;
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001350 uint8_t wbuffer[64]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko8ec8d5e2009-03-15 02:56:00 +00001351 void (*process_block)(struct sha1_ctx_t*) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001352} sha1_ctx_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001353void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1354void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001355void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001356typedef struct sha1_ctx_t sha256_ctx_t;
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001357void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001358#define sha256_hash sha1_hash
1359#define sha256_end sha1_end
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001360typedef struct sha512_ctx_t {
Denis Vlasenkocd2cd312009-03-12 15:40:27 +00001361 uint64_t hash[8];
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001362 uint64_t total64[2];
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001363 uint8_t wbuffer[128]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001364} sha512_ctx_t;
1365void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1366void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001367void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1368#if 1
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001369typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001370 uint32_t A;
1371 uint32_t B;
1372 uint32_t C;
1373 uint32_t D;
1374 uint64_t total;
1375 uint32_t buflen;
1376 char buffer[128];
1377} md5_ctx_t;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001378#else
1379/* libbb/md5prime.c uses a bit different one: */
1380typedef struct md5_ctx_t {
1381 uint32_t state[4]; /* state (ABCD) */
1382 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1383 unsigned char buffer[64]; /* input buffer */
1384} md5_ctx_t;
1385#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001386void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1387void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001388void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1389
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001390
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001391uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1392
1393typedef struct masks_labels_t {
1394 const char *labels;
1395 const int masks[];
1396} masks_labels_t;
1397int print_flags_separated(const int *masks, const char *labels,
1398 int flags, const char *separator) FAST_FUNC;
1399int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001400
1401
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001402extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001403/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001404extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001405extern const char bb_msg_memory_exhausted[];
1406extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001407extern const char bb_msg_read_error[];
1408extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001409extern const char bb_msg_unknown[];
1410extern const char bb_msg_can_not_create_raw_socket[];
1411extern const char bb_msg_perm_denied_are_you_root[];
1412extern const char bb_msg_requires_arg[];
1413extern const char bb_msg_invalid_arg[];
1414extern const char bb_msg_standard_input[];
1415extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001416
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001417extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001418/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001419extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001420
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001421extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001422extern const char bb_path_passwd_file[];
1423extern const char bb_path_shadow_file[];
1424extern const char bb_path_gshadow_file[];
1425extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001426extern const char bb_path_motd_file[];
1427extern const char bb_path_wtmp_file[];
1428extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001429extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001430/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1431 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001432extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1433#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1434#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001435
Denis Vlasenko703e2022007-01-22 14:12:08 +00001436extern const int const_int_0;
1437extern const int const_int_1;
1438
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001439
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001440#ifndef BUFSIZ
1441#define BUFSIZ 4096
1442#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001443/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001444enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1445extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001446/* This struct is deliberately not defined. */
1447/* See docs/keep_data_small.txt */
1448struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001449/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001450 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001451 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001452extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001453/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001454#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001455#define SET_PTR_TO_GLOBALS(x) do { \
1456 (*(struct globals**)&ptr_to_globals) = (x); \
1457 barrier(); \
1458} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001459
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001460/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1461 * use bb_default_login_shell and following defines.
1462 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1463 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001464#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001465extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001466/* "/bin/sh" */
1467#define DEFAULT_SHELL (bb_default_login_shell+1)
1468/* "sh" */
1469#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1470
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001471#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001472# define CURRENT_VC "/dev/vc/0"
1473# define VC_1 "/dev/vc/1"
1474# define VC_2 "/dev/vc/2"
1475# define VC_3 "/dev/vc/3"
1476# define VC_4 "/dev/vc/4"
1477# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001478#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1479/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1480 respective serial ports .. as such, we can't use the common device paths for
1481 these. -- PFM */
1482# define SC_0 "/dev/ttsc/0"
1483# define SC_1 "/dev/ttsc/1"
1484# define SC_FORMAT "/dev/ttsc/%d"
1485#else
1486# define SC_0 "/dev/tts/0"
1487# define SC_1 "/dev/tts/1"
1488# define SC_FORMAT "/dev/tts/%d"
1489#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001490# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001491# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001492# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001493# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001494# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001495#else
1496# define CURRENT_VC "/dev/tty0"
1497# define VC_1 "/dev/tty1"
1498# define VC_2 "/dev/tty2"
1499# define VC_3 "/dev/tty3"
1500# define VC_4 "/dev/tty4"
1501# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001502#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1503# define SC_0 "/dev/ttySC0"
1504# define SC_1 "/dev/ttySC1"
1505# define SC_FORMAT "/dev/ttySC%d"
1506#else
1507# define SC_0 "/dev/ttyS0"
1508# define SC_1 "/dev/ttyS1"
1509# define SC_FORMAT "/dev/ttyS%d"
1510#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001511# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001512# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001513# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001514# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001515# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001516#endif
1517
1518/* The following devices are the same on devfs and non-devfs systems. */
1519#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001520#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001521
Rob Landleyc57ec372006-04-10 17:07:15 +00001522
Rob Landleyb623a542006-05-31 22:09:03 +00001523#ifndef RB_POWER_OFF
1524/* Stop system and switch power off if possible. */
1525#define RB_POWER_OFF 0x4321fedc
1526#endif
1527
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001528/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001529#undef isalnum
1530#undef isalpha
1531#undef isascii
1532#undef isblank
1533#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001534#undef isgraph
1535#undef islower
1536#undef isprint
1537#undef ispunct
1538#undef isspace
1539#undef isupper
1540#undef isxdigit
1541
Denis Vlasenko459903b2006-11-27 14:44:18 +00001542/* This one is more efficient - we save ~400 bytes */
1543#undef isdigit
1544#define isdigit(a) ((unsigned)((a) - '0') <= 9)
1545
Denis Vlasenko6b06cb82008-05-15 21:30:45 +00001546#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denis Vlasenko459903b2006-11-27 14:44:18 +00001547
Denis Vlasenko98636eb2008-05-09 17:59:34 +00001548
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001549POP_SAVED_FUNCTION_VISIBILITY
1550
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001551#endif