blob: eefc13261409040040060eb8b8e0c65386851db2 [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 */
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +000010#ifndef __LIBBUSYBOX_H__
11#define __LIBBUSYBOX_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!) */
113#if __GNUC_PREREQ(4,1)
114# pragma GCC visibility push(hidden)
115#endif
116
117
118#if ENABLE_USE_BB_PWD_GRP
119# include "pwd_.h"
120# include "grp_.h"
121#endif
122#if ENABLE_FEATURE_SHADOWPASSWDS
123# if ENABLE_USE_BB_SHADOW
124# include "shadow_.h"
125# endif
126#endif
127
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000128/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000129#define MAXINT(T) (T)( \
130 ((T)-1) > 0 \
131 ? (T)-1 \
132 : (T)~((T)1 << (sizeof(T)*8-1)) \
133 )
134
135#define MININT(T) (T)( \
136 ((T)-1) > 0 \
137 ? (T)0 \
138 : ((T)1 << (sizeof(T)*8-1)) \
139 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000140
Denis Vlasenko56254152006-10-07 16:24:46 +0000141/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000142/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000143 * (stat, lseek etc) mapped to "largefile" variants by libc.
144 * Practically it means that open() automatically has O_LARGEFILE added
145 * and all filesize/file_offset parameters and struct members are "large"
146 * (in today's world - signed 64bit). For full support of large files,
147 * we need a few helper #defines (below) and careful use of off_t
148 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000149#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000150/* CONFIG_LFS is on */
151# if ULONG_MAX > 0xffffffff
152/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000153# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000154/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
155# define BB_STRTOOFF bb_strtoul
156# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000157/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
158# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000159# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000160/* "long" is too short, need "long long" */
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... */
171# define XATOOFF(a) xatoi_u(a)
172# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000173# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000174# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000175# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000176# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
177# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000178# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000179# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000180# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000181#endif
182/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000183#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000184
Eric Andersenaad1a882001-03-16 22:47:14 +0000185/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000186#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000187#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000188#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000189#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000190#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000191#define SKIP ((int) 2)
192
193/* for mtab.c */
194#define MTAB_GETMOUNTPT '1'
195#define MTAB_GETDEVICE '2'
196
197#define BUF_SIZE 8192
198#define EXPAND_ALLOC 1024
199
Eric Andersenaad1a882001-03-16 22:47:14 +0000200/* Macros for min/max. */
201#ifndef MIN
202#define MIN(a,b) (((a)<(b))?(a):(b))
203#endif
204
205#ifndef MAX
206#define MAX(a,b) (((a)>(b))?(a):(b))
207#endif
208
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000209/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000210#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000211#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000212#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
213#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
214#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000215#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000216#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
217#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
218#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
219#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000220#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
221#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
222#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000223#endif
224#endif
225
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000226#if defined(__GLIBC__)
227/* glibc uses __errno_location() to get a ptr to errno */
228/* We can just memorize it once - no multithreading in busybox :) */
229extern int *const bb_errno;
230#undef errno
231#define errno (*bb_errno)
232#endif
233
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000234unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000235unsigned long long monotonic_us(void) FAST_FUNC;
236unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000237
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000238extern void chomp(char *s) FAST_FUNC;
239extern void trim(char *s) FAST_FUNC;
240extern char *skip_whitespace(const char *) FAST_FUNC;
241extern char *skip_non_whitespace(const char *) FAST_FUNC;
242extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000243
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000244//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000245extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
246extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000247enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
248 FILEUTILS_PRESERVE_STATUS = 1,
249 FILEUTILS_DEREFERENCE = 2,
250 FILEUTILS_RECUR = 4,
251 FILEUTILS_FORCE = 8,
252 FILEUTILS_INTERACTIVE = 0x10,
253 FILEUTILS_MAKE_HARDLINK = 0x20,
254 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000255 FILEUTILS_DEREF_SOFTLINK = 0x80,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000256#if ENABLE_SELINUX
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000257 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
258 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000259#endif
260};
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000261#define FILEUTILS_CP_OPTSTR "pdRfilsL" USE_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000262extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000263/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
264 * the source, not copy (unless "source" is a directory).
265 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
266 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000267extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000268
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000269enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000270 ACTION_RECURSE = (1 << 0),
271 ACTION_FOLLOWLINKS = (1 << 1),
272 ACTION_FOLLOWLINKS_L0 = (1 << 2),
273 ACTION_DEPTHFIRST = (1 << 3),
274 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000275 ACTION_QUIET = (1 << 5),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000276};
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000277extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000278 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
279 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
280 void* userData, unsigned depth) FAST_FUNC;
281extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000282enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000283extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000284extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000285extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
286extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000287/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000288extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
289extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
290extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000291/* "short" copy can be detected by return value < size */
292/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000293extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000294extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000295/* xxxx_strip version can modify its parameter:
296 * "/" -> "/"
297 * "abc" -> "abc"
298 * "abc/def" -> "def"
299 * "abc/def/" -> "def" !!
300 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000301extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000302/* "abc/def/" -> "" and it never modifies 'path' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000303extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000304
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000305int ndelay_on(int fd) FAST_FUNC;
306int ndelay_off(int fd) FAST_FUNC;
307int close_on_exec_on(int fd) FAST_FUNC;
308void xdup2(int, int) FAST_FUNC;
309void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000310
311
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000312DIR *xopendir(const char *path) FAST_FUNC;
313DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000314
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000315/* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC; */
316char *xmalloc_readlink(const char *path) FAST_FUNC;
317char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC;
318char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000319
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000320char *xmalloc_follow_symlinks(const char *path) FAST_FUNC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000321
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000322
Denis Vlasenko33196372008-02-23 01:25:38 +0000323enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000324 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000325 * otherwise would kill us, except for those resulting from bugs:
326 * SIGSEGV, SIGILL, SIGFPE.
327 * Other fatal signals not included (TODO?):
328 * SIGBUS Bus error (bad memory access)
329 * SIGPOLL Pollable event. Synonym of SIGIO
330 * SIGPROF Profiling timer expired
331 * SIGSYS Bad argument to routine
332 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000333 *
334 * The only known arch with some of these sigs not fitting
335 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
336 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000337 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000338 BB_FATAL_SIGS = (int)(0
339 + (1LL << SIGHUP)
340 + (1LL << SIGINT)
341 + (1LL << SIGTERM)
342 + (1LL << SIGPIPE) // Write to pipe with no readers
343 + (1LL << SIGQUIT) // Quit from keyboard
344 + (1LL << SIGABRT) // Abort signal from abort(3)
345 + (1LL << SIGALRM) // Timer signal from alarm(2)
346 + (1LL << SIGVTALRM) // Virtual alarm clock
347 + (1LL << SIGXCPU) // CPU time limit exceeded
348 + (1LL << SIGXFSZ) // File size limit exceeded
349 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
350 + (1LL << SIGUSR2)
351 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000352};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000353void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000354/* Unlike signal() and bb_signals, sets handler with sigaction()
355 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000356 * will be blocked; syscalls will not be restarted: */
357void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000358/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000359void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000360/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000361void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
362void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000363void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000364void sig_block(int sig) FAST_FUNC;
365void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000366/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000367int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000368/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000369int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000370/* Standard handler which just records signo */
371extern smallint bb_got_signal;
372void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000373
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000374
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000375void xsetgid(gid_t gid) FAST_FUNC;
376void xsetuid(uid_t uid) FAST_FUNC;
377void xchdir(const char *path) FAST_FUNC;
378void xchroot(const char *path) FAST_FUNC;
379void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000380void bb_unsetenv(const char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000381void xunlink(const char *pathname) FAST_FUNC;
382void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
383int xopen(const char *pathname, int flags) FAST_FUNC FAST_FUNC;
384int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
385int open_or_warn(const char *pathname, int flags) FAST_FUNC;
386int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
387int open_or_warn_stdin(const char *pathname) FAST_FUNC;
388void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
389int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
390off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
391off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000392
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000393void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000394/* In this form code with pipes is much more readable */
395struct fd_pair { int rd; int wr; };
396#define piped_pair(pair) pipe(&((pair).rd))
397#define xpiped_pair(pair) xpipe(&((pair).rd))
398
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000399/* Useful for having small structure members/global variables */
400typedef int8_t socktype_t;
401typedef int8_t family_t;
402struct BUG_too_small {
403 char BUG_socktype_t_too_small[(0
404 | SOCK_STREAM
405 | SOCK_DGRAM
406 | SOCK_RDM
407 | SOCK_SEQPACKET
408 | SOCK_RAW
409 ) <= 127 ? 1 : -1];
410 char BUG_family_t_too_small[(0
411 | AF_UNSPEC
412 | AF_INET
413 | AF_INET6
414 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000415#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000416 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000417#endif
418#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000419 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000420#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000421 /* | AF_DECnet */
422 /* | AF_IPX */
423 ) <= 127 ? 1 : -1];
424};
425
426
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000427int xsocket(int domain, int type, int protocol) FAST_FUNC;
428void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
429void xlisten(int s, int backlog) FAST_FUNC;
430void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000431ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000432 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000433/* SO_REUSEADDR allows a server to rebind to an address that is already
434 * "in use" by old connections to e.g. previous server instance which is
435 * killed or crashed. Without it bind will fail until all such connections
436 * time out. Linux does not allow multiple live binds on same ip:port
437 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
438 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000439void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
440int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000441int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000442/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000443unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000444typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000445 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000446 union {
447 struct sockaddr sa;
448 struct sockaddr_in sin;
449#if ENABLE_FEATURE_IPV6
450 struct sockaddr_in6 sin6;
451#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000452 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000453} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000454enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000455 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000456 LSA_SIZEOF_SA = sizeof(
457 union {
458 struct sockaddr sa;
459 struct sockaddr_in sin;
460#if ENABLE_FEATURE_IPV6
461 struct sockaddr_in6 sin6;
462#endif
463 }
464 )
465};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000466/* Create stream socket, and allocate suitable lsa.
467 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000468 * af == AF_UNSPEC will result in trying to create IPv6 socket,
469 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000470 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000471#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000472int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000473#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000474int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000475#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
476#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000477int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000478/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000479 * numeric IP ("N.N.N.N") or numeric IPv6 address,
480 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000481 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000482/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000483int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
484int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000485/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
486 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
487 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
488 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000489int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000490/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000491int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000492/* Return malloc'ed len_and_sockaddr with socket address of host:port
493 * Currently will return IPv4 or IPv6 sockaddrs only
494 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000495 * UNIX socket address being returned, IPX sockaddr etc...
496 * On error does bb_error_msg and returns NULL */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000497len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000498/* Version which dies on error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000499len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC;
500len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000501/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000502#if !ENABLE_FEATURE_IPV6
503#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
504#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
505#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000506len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
507len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000508#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000509/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000510 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000511 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000512void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000513/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000514int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000515/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000516char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000517/* This one doesn't append :PORTNUM */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000518char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000519/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000520char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000521/* inet_[ap]ton on steroids */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000522char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC;
523char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000524// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000525// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000526struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000527// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000528// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000529
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000530
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000531void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000532ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000533 const struct sockaddr *to,
534 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000535 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000536ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000537 struct sockaddr *from,
538 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000539 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000540
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000541char *xstrdup(const char *s) FAST_FUNC;
542char *xstrndup(const char *s, int n) FAST_FUNC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000543void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000544char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000545char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000546/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000547 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000548int bb_putchar(int ch) FAST_FUNC;
549char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000550/* Prints unprintable chars ch as ^C or M-c to file
551 * (M-c is used only if ch is ORed with PRINTABLE_META),
552 * else it is printed as-is (except for ch = 0x9b) */
553enum { PRINTABLE_META = 0x100 };
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000554void fputc_printable(int ch, FILE *file) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000555// gcc-4.1.1 still isn't good enough at optimizing it
556// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000557//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000558//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000559//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000560//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000561#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000562#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000563#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000564#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000565#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000566
567/* dmalloc will redefine these to it's own implementation. It is safe
568 * to have the prototypes here unconditionally. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000569void *malloc_or_warn(size_t size) FAST_FUNC;
570void *xmalloc(size_t size) FAST_FUNC;
571void *xzalloc(size_t size) FAST_FUNC;
572void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000573/* After xrealloc_vector(v, 4, idx) it's ok to use
574 * at least v[idx] and v[idx+1], for all idx values.
575 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
576 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000577#define xrealloc_vector(vector, shift, idx) \
578 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
579void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
580
Eric Andersenaad1a882001-03-16 22:47:14 +0000581
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000582extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
583extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000584// NB: will return short read on error, not -1,
585// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000586extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
587extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
588extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000589extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
590extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000591// Reads one line a-la fgets (but doesn't save terminating '\n').
592// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000593// Bytes are appended to pfx (which must be malloced, or NULL).
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000594extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000595/* Reads block up to *maxsz_p (default: MAX_INT(ssize_t)) */
596extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000597/* Returns NULL if file can't be opened */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000598extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000599/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000600extern int open_zipped(const char *fname) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000601extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000602/* Never returns NULL */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000603extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000604
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000605extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000606// NB: will return short write on error, not -1,
607// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000608extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
609extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
610extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000611
Denis Vlasenko1de08302006-10-26 23:32:43 +0000612/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000613extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000614
615extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenko69f4f9a2008-08-09 17:16:40 +0000616extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000617/* Reads up to (and including) TERMINATING_STRING: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000618extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000619/* Chops off TERMINATING_STRING from the end: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000620extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000621/* Reads up to (and including) "\n" or NUL byte: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000622extern char *xmalloc_fgets(FILE *file) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000623/* Chops off '\n' from the end, unlike fgets: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000624extern char *xmalloc_fgetline(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000625/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denis Vlasenko5e476ba2008-07-15 21:29:44 +0000626/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000627
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000628extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
629extern void die_if_ferror_stdout(void) FAST_FUNC;
630extern void xfflush_stdout(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000631extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000632extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
633extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000634/* Prints warning to stderr and returns NULL on failure: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000635extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000636/* "Opens" stdin if filename is special, else just opens file: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000637extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
638extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000639extern FILE* fopen_for_read(const char *path) FAST_FUNC;
640extern FILE* xfopen_for_read(const char *path) FAST_FUNC;
641extern FILE* fopen_for_write(const char *path) FAST_FUNC;
642extern FILE* xfopen_for_write(const char *path) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000643
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000644int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
645void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000646
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000647/* Wrapper which restarts poll on EINTR or ENOMEM.
648 * On other errors complains [perror("poll")] and returns.
649 * Warning! May take (much) longer than timeout_ms to return!
650 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000651int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000652
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000653char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000654char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000655
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000656/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000657char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000658
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000659char *utoa(unsigned n) FAST_FUNC;
660char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000661/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000662char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
663char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000664/* Intelligent formatters of bignums */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000665void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
666void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000667//TODO: provide pointer to buf (avoid statics)?
668const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000669 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000670/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000671char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000672
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000673/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000674struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000675 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000676 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000677};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000678#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000679/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000680/* Using xatoi() instead of naive atoi() is not always convenient -
681 * in many places people want *non-negative* values, but store them
682 * in signed int. Therefore we need this one:
683 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000684int xatoi_u(const char *numstr) FAST_FUNC;
Denis Vlasenko13858992006-10-08 12:49:22 +0000685/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000686uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000687
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000688
Eric Andersenaad1a882001-03-16 22:47:14 +0000689/* These parse entries in /etc/passwd and /etc/group. This is desirable
690 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000691 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000692long xuname2uid(const char *name) FAST_FUNC;
693long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000694/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000695unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000696/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000697struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000698 uid_t uid;
699 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000700};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000701/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000702int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000703/* always sets uid and gid, allows numeric; exits on failure */
704void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000705/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000706void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000707struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000708struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000709struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
710struct group* xgetgrgid(gid_t gid) FAST_FUNC;
711char* xuid2uname(uid_t uid) FAST_FUNC;
712char* xgid2group(gid_t gid) FAST_FUNC;
713char* uid2uname(uid_t uid) FAST_FUNC;
714char* gid2group(gid_t gid) FAST_FUNC;
715char* uid2uname_utoa(long uid) FAST_FUNC;
716char* gid2group_utoa(long gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000717/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000718const char* get_cached_username(uid_t uid) FAST_FUNC;
719const char* get_cached_groupname(gid_t gid) FAST_FUNC;
720void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000721/* internally usernames are saved in fixed-sized char[] buffers */
722enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000723#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000724void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000725#else
726#define die_if_bad_username(name) ((void)(name))
727#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000728
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000729int execable_file(const char *name) FAST_FUNC;
730char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
731int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000732
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000733/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
734 * but it may exec busybox and call applet instead of searching PATH.
735 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000736#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000737int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000738#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
739#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000740 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000741 cmd, __VA_ARGS__)
742#else
743#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
744#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
745#endif
746
747/* NOMMU friendy fork+exec */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000748pid_t spawn(char **argv) FAST_FUNC;
749pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000750
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000751pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000752/* Unlike waitpid, waits ONLY for one process.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000753 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000754 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000755 * IOW: rc = wait4pid(spawn(argv));
756 * if (rc < 0) bb_perror_msg("%s", argv[0]);
757 * if (rc > 0) bb_error_msg("exit code: %d", rc);
758 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000759int wait4pid(pid_t pid) FAST_FUNC;
760pid_t wait_any_nohang(int *wstat) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000761#define wait_crashed(w) ((w) & 127)
762#define wait_exitcode(w) ((w) >> 8)
763#define wait_stopsig(w) ((w) >> 8)
764#define wait_stopped(w) (((w) & 127) == 127)
765/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000766pid_t spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000767struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000768 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000769 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000770 int xfunc_error_retval;
771 uint32_t option_mask32;
772 int die_sleep;
773 smallint saved;
774};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000775void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
776void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000777/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000778int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
779int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000780
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000781/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000782 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000783 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000784 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000785 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
786 * rexec's itself on NOMMU with argv passed as command line.
787 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
788 * from the start. (It will detect it and not reexec again second time).
789 * You have to audit carefully that you don't do something twice as a result
790 * (opening files/sockets, parsing config files etc...)!
791 *
792 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
793 * (will do setsid()).
794 *
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000795 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
796 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenkof10bc392008-11-06 23:28:42 +0000797 * Currently used for setsid only. On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000798 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000799 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000800 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000801 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
802 * to /dev/null if they are not.
803 */
804enum {
805 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000806 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000807 DAEMON_CLOSE_EXTRA_FDS = 4,
808 DAEMON_ONLY_SANITIZE = 8, /* internal use */
809};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000810#if BB_MMU
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000811 void forkexit_or_rexec(void) FAST_FUNC;
Denis Vlasenko367960b2007-08-18 14:20:21 +0000812 enum { re_execed = 0 };
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000813# define forkexit_or_rexec(argv) forkexit_or_rexec()
814# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
815# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000816#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000817 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000818 void forkexit_or_rexec(char **argv) FAST_FUNC;
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000819 extern bool re_execed;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000820 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
821 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
822 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000823# define fork() BUG_fork_is_unavailable_on_nommu()
824# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
825# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000826#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000827void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
828void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000829/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000830int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000831
832
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000833extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000834extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000835#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000836#define No_argument "\0"
837#define Required_argument "\001"
838#define Optional_argument "\002"
839extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000840#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000841extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000842extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000843
844
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000845typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000846 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000847 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000848} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000849void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
850void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
851void *llist_pop(llist_t **elm) FAST_FUNC;
852void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
853void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
854llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000855/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000856 * llist_t *llist_add_to(llist_t *old_head, void *data)
857 * etc does not result in smaller code... */
858
Denis Vlasenko80edead2007-08-02 22:31:05 +0000859/* start_stop_daemon and udhcpc are special - they want
860 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000861#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000862/* True only if we created pidfile which is *file*, not /dev/null etc */
863extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000864void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000865#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000866#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000867enum { wrote_pidfile = 0 };
868#define write_pidfile(path) ((void)0)
869#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000870#endif
871
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000872enum {
873 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000874 LOGMODE_STDIO = (1 << 0),
875 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000876 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
877};
878extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000879extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000880extern int die_sleep;
881extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000882extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000883extern void xfunc_die(void) NORETURN FAST_FUNC;
884extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000885extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
886extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
887extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
888extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
889extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
890extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn)) FAST_FUNC;
891extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
892extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000893extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000894extern void bb_perror_nomsg(void) FAST_FUNC;
895extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
896extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000897
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000898/* We need to export XXX_main from libbusybox
899 * only if we build "individual" binaries
900 */
901#if ENABLE_FEATURE_INDIVIDUAL
902#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
903#else
904#define MAIN_EXTERNALLY_VISIBLE
905#endif
906
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000907
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000908/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000909int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000910/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko468aea22008-04-01 14:47:57 +0000911int echo_main(int argc, char** argv) USE_ECHO(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000912int printf_main(int argc, char **argv) USE_PRINTF(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000913int test_main(int argc, char **argv) USE_TEST(MAIN_EXTERNALLY_VISIBLE);
914int kill_main(int argc, char **argv) USE_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000915/* Similar, but used by chgrp, not shell */
916int chown_main(int argc, char **argv) USE_CHOWN(MAIN_EXTERNALLY_VISIBLE);
917/* Don't need USE_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000918int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000919int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +0000920
Denis Vlasenko468aea22008-04-01 14:47:57 +0000921#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000922void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +0000923#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000924
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000925
Denis Vlasenko0112ff52008-10-25 23:23:00 +0000926/* "Keycodes" that report an escape sequence.
927 * We use something which fits into signed char,
928 * yet doesn't represent any valid Unicode characher.
929 * Also, -1 is reserved for error indication and we don't use it. */
930enum {
Denis Vlasenkoa9acbe62008-11-24 13:25:20 +0000931 KEYCODE_UP = -2,
Denis Vlasenko0112ff52008-10-25 23:23:00 +0000932 KEYCODE_DOWN = -3,
933 KEYCODE_RIGHT = -4,
934 KEYCODE_LEFT = -5,
935 KEYCODE_HOME = -6,
936 KEYCODE_END = -7,
937 KEYCODE_INSERT = -8,
938 KEYCODE_DELETE = -9,
939 KEYCODE_PAGEUP = -10,
940 KEYCODE_PAGEDOWN = -11,
941#if 0
942 KEYCODE_FUN1 = -12,
943 KEYCODE_FUN2 = -13,
944 KEYCODE_FUN3 = -14,
945 KEYCODE_FUN4 = -15,
946 KEYCODE_FUN5 = -16,
947 KEYCODE_FUN6 = -17,
948 KEYCODE_FUN7 = -18,
949 KEYCODE_FUN8 = -19,
950 KEYCODE_FUN9 = -20,
951 KEYCODE_FUN10 = -21,
952 KEYCODE_FUN11 = -22,
953 KEYCODE_FUN12 = -23,
954#endif
Denis Vlasenko5f6aaf32008-10-25 23:27:29 +0000955 /* How long the longest ESC sequence we know? */
956 KEYCODE_BUFFER_SIZE = 4
Denis Vlasenko0112ff52008-10-25 23:23:00 +0000957};
958int read_key(int fd, smalluint *nbuffered, char *buffer) FAST_FUNC;
959
960
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000961/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000962int create_icmp_socket(void) FAST_FUNC;
963int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000964/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000965/* This structure defines protocol families and their handlers. */
966struct aftype {
967 const char *name;
968 const char *title;
969 int af;
970 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000971 char* FAST_FUNC (*print)(unsigned char *);
972 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
973 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
974 void FAST_FUNC (*herror)(char *text);
975 int FAST_FUNC (*rprint)(int options);
976 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000977 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000978 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000979};
980/* This structure defines hardware protocols and their handlers. */
981struct hwtype {
982 const char *name;
983 const char *title;
984 int type;
985 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000986 char* FAST_FUNC (*print)(unsigned char *);
987 int FAST_FUNC (*input)(const char *, struct sockaddr *);
988 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000989 int suppress_null_addr;
990};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000991extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000992int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000993#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000994int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +0000995#else
996#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000997#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000998const struct aftype *get_aftype(const char *name) FAST_FUNC;
999const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1000const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001001
1002
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001003#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001004extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001005/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001006extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001007extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001008#endif
1009
Mike Frysinger9412ec72008-02-07 22:41:33 +00001010#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001011extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
1012extern struct mntent *find_mount_point(const char *name, const char *table) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001013#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001014extern void erase_mtab(const char * name) FAST_FUNC;
1015extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1016extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1017extern void bb_warn_ignoring_args(int n) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001018
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001019extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001020
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001021extern char *query_loop(const char *device) FAST_FUNC;
1022extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001023/* If *devname is not NULL, use that name, otherwise try to find free one,
1024 * malloc and return it in *devname.
1025 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001026extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001027
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001028/* Like bb_ask below, but asks on stdin with no timeout. */
1029char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001030//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001031char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001032int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001033
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001034int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001035
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001036/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001037 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001038 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001039enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001040 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1041 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1042// TODO: COLLAPSE and TRIM seem to always go in pair
1043 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1044 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001045 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001046 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001047// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1048 // NORMAL is:
1049 // * remove leading and trailing delimiters and collapse
1050 // multiple delimiters into one
1051 // * warn and continue if less than mintokens delimiters found
1052 // * grab everything into last token
1053 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001054};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001055typedef struct parser_t {
1056 FILE *fp;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001057 char *line;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001058 char *data;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001059 int lineno;
1060} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001061parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001062parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001063int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1064#define config_read(parser, tokens, max, min, str, flags) \
1065 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001066void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001067
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001068/* Concatenate path and filename to new allocated buffer.
1069 * Add "/" only as needed (no duplicate "//" are produced).
1070 * If path is NULL, it is assumed to be "/".
1071 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001072char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1073char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1074const char *bb_basename(const char *name) FAST_FUNC;
Denis Vlasenko7e84e532007-05-08 17:52:17 +00001075/* NB: can violate const-ness (similarly to strchr) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001076char *last_char_is(const char *s, int c) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001077
Denis Vlasenko4921b542007-02-03 02:17:41 +00001078
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001079int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001080
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001081int get_signum(const char *name) FAST_FUNC;
1082const char *get_signame(int number) FAST_FUNC;
1083void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001084
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001085char *bb_simplify_path(const char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001086
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001087#define FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001088extern void bb_do_delay(int seconds) FAST_FUNC;
1089extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001090extern 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 +00001091extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001092#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001093extern void renew_current_security_context(void) FAST_FUNC;
1094extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001095extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001096 char *user, char *role, char *type, char *range) FAST_FUNC;
1097extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1098extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001099#else
1100#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001101#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001102extern void selinux_or_die(void) FAST_FUNC;
1103extern int restricted_shell(const char *shell) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001104
1105/* setup_environment:
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001106 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001107 * TERM=(old value)
1108 * USER=pw->pw_name, LOGNAME=pw->pw_name
1109 * PATH=bb_default_[root_]path
1110 * HOME=pw->pw_dir
1111 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001112 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001113 * if not root (if pw->pw_uid != 0):
1114 * USER=pw->pw_name, LOGNAME=pw->pw_name
1115 * HOME=pw->pw_dir
1116 * SHELL=shell
1117 * else does nothing
1118 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001119extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw) FAST_FUNC;
1120extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001121/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001122#if !ENABLE_USE_BB_CRYPT
1123#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1124#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001125extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1126extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001127/* rnd is additional random input. New one is returned.
1128 * Useful if you call crypt_make_salt many times in a row:
1129 * rnd = crypt_make_salt(buf1, 4, 0);
1130 * rnd = crypt_make_salt(buf2, 4, rnd);
1131 * rnd = crypt_make_salt(buf3, 4, rnd);
1132 * (otherwise we risk having same salt generated)
1133 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001134extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001135/* Returns number of lines changed, or -1 on error */
1136extern int update_passwd(const char *filename, const char *username,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001137 const char *new_pw) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001138
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001139int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1140int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1141int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1142int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1143const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001144
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001145extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1146extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001147
Denis Vlasenko4e12b1a2008-12-23 23:36:47 +00001148char *xmalloc_ttyname(int fd) FAST_FUNC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001149/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001150int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001151
Denis Vlasenko202ac502008-11-05 13:20:58 +00001152int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1153
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001154/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001155int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1156int 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 +00001157#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001158int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1159int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001160#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1161#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1162#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001163int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1164int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001165#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1166#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1167#endif
1168
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001169char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1170void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1171void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001172#ifdef __GLIBC__
1173/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001174unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001175#undef makedev
1176#define makedev(a,b) bb_makedev(a,b)
1177#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001178
1179
Denis Vlasenko38f63192007-01-22 09:03:07 +00001180#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001181/* It's NOT just ENABLEd or disabled. It's a number: */
Denis Vlasenko38f63192007-01-22 09:03:07 +00001182#ifdef CONFIG_FEATURE_EDITING_HISTORY
1183#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001184#else
1185#define MAX_HISTORY 0
1186#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001187typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001188 int flags;
1189 const char *path_lookup;
1190#if MAX_HISTORY
1191 int cnt_history;
1192 int cur_history;
Denis Vlasenko38f63192007-01-22 09:03:07 +00001193 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001194 char *history[MAX_HISTORY + 1];
1195#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001196} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001197enum {
1198 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001199 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1200 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1201 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1202 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001203 WITH_PATH_LOOKUP = 0x20,
1204 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1205};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001206line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001207/* Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001208 * -1 on read errors or EOF, or on bare Ctrl-D,
1209 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001210 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001211 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001212int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001213#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001214int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001215#define read_line_input(prompt, command, maxsize, state) \
1216 read_line_input(prompt, command, maxsize)
1217#endif
1218
1219
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001220#ifndef COMM_LEN
1221#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001222enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001223#else
1224/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001225enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001226#endif
1227#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001228typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001229 DIR *dir;
Denis Vlasenko512499c2007-08-26 18:23:13 +00001230 uint8_t shift_pages_to_bytes;
1231 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001232/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001233 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001234 char *argv0;
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001235 USE_SELINUX(char *context;)
1236 /* Everything below must contain no ptrs to malloc'ed data:
1237 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001238 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001239 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001240 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001241 unsigned pid;
1242 unsigned ppid;
1243 unsigned pgid;
1244 unsigned sid;
1245 unsigned uid;
1246 unsigned gid;
Denis Vlasenko31789a82007-06-19 14:43:17 +00001247 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001248#if ENABLE_FEATURE_TOPMEM
1249 unsigned long mapped_rw;
1250 unsigned long mapped_ro;
1251 unsigned long shared_clean;
1252 unsigned long shared_dirty;
1253 unsigned long private_clean;
1254 unsigned long private_dirty;
1255 unsigned long stack;
1256#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001257 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001258 /* basename of executable in exec(2), read from /proc/N/stat
1259 * (if executable is symlink or script, it is NOT replaced
1260 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001261 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001262 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001263#if ENABLE_FEATURE_TOP_SMP_PROCESS
1264 int last_seen_on_cpu;
1265#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001266} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001267enum {
1268 PSSCAN_PID = 1 << 0,
1269 PSSCAN_PPID = 1 << 1,
1270 PSSCAN_PGID = 1 << 2,
1271 PSSCAN_SID = 1 << 3,
1272 PSSCAN_UIDGID = 1 << 4,
1273 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001274 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001275 PSSCAN_ARGV0 = 1 << 7,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001276 /* PSSCAN_EXE = 1 << 8, - not implemented */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001277 PSSCAN_STATE = 1 << 9,
1278 PSSCAN_VSZ = 1 << 10,
1279 PSSCAN_RSS = 1 << 11,
1280 PSSCAN_STIME = 1 << 12,
1281 PSSCAN_UTIME = 1 << 13,
1282 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001283 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001284 /* NB: used by find_pid_by_name(). Any applet using it
1285 * needs to be mentioned here. */
1286 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1287 || ENABLE_PGREP || ENABLE_PKILL
1288 || ENABLE_PIDOF
1289 || ENABLE_SESTATUS
1290 ),
Denis Vlasenko72e1c892007-09-29 22:26:01 +00001291 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001292 PSSCAN_START_TIME = 1 << 18,
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001293 PSSCAN_CPU = 1 << 19,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001294 /* These are all retrieved from proc/NN/stat in one go: */
1295 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001296 /**/ | PSSCAN_COMM | PSSCAN_STATE
1297 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1298 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1299 /**/ | PSSCAN_TTY
1300#if ENABLE_FEATURE_TOP_SMP_PROCESS
1301 /**/ | PSSCAN_CPU
1302#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001303};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001304//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1305void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1306procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001307/* Format cmdline (up to col chars) into char buf[col+1] */
1308/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001309void read_cmdline(char *buf, int col, unsigned pid, const char *comm) FAST_FUNC;
1310pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1311pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001312
1313
1314extern const char bb_uuenc_tbl_base64[];
1315extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001316void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001317
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001318typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001319 uint32_t count[2];
1320 uint32_t hash[5];
1321 uint32_t wbuf[16];
1322} sha1_ctx_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001323void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1324void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001325void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001326typedef struct sha256_ctx_t {
1327 uint32_t H[8];
1328 uint32_t total[2]; /* rename to "count"? */
1329 uint32_t buflen;
1330 char buffer[128]; /* NB: always correctly aligned for uint32_t */
1331} sha256_ctx_t;
1332void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1333void sha256_hash(const void *buffer, size_t len, sha256_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001334void sha256_end(void *resbuf, sha256_ctx_t *ctx) FAST_FUNC;
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001335typedef struct sha512_ctx_t {
1336 uint64_t H[8];
1337 uint64_t total[2];
1338 uint64_t buflen;
1339 char buffer[256]; /* NB: always correctly aligned for uint64_t */
1340} sha512_ctx_t;
1341void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1342void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001343void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1344#if 1
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001345typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001346 uint32_t A;
1347 uint32_t B;
1348 uint32_t C;
1349 uint32_t D;
1350 uint64_t total;
1351 uint32_t buflen;
1352 char buffer[128];
1353} md5_ctx_t;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001354#else
1355/* libbb/md5prime.c uses a bit different one: */
1356typedef struct md5_ctx_t {
1357 uint32_t state[4]; /* state (ABCD) */
1358 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1359 unsigned char buffer[64]; /* input buffer */
1360} md5_ctx_t;
1361#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001362void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1363void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001364void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1365
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001366
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001367uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1368
1369typedef struct masks_labels_t {
1370 const char *labels;
1371 const int masks[];
1372} masks_labels_t;
1373int print_flags_separated(const int *masks, const char *labels,
1374 int flags, const char *separator) FAST_FUNC;
1375int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001376
1377
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001378extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001379/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001380extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001381extern const char bb_msg_memory_exhausted[];
1382extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001383extern const char bb_msg_read_error[];
1384extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001385extern const char bb_msg_unknown[];
1386extern const char bb_msg_can_not_create_raw_socket[];
1387extern const char bb_msg_perm_denied_are_you_root[];
1388extern const char bb_msg_requires_arg[];
1389extern const char bb_msg_invalid_arg[];
1390extern const char bb_msg_standard_input[];
1391extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001392
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001393extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001394/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001395extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001396
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001397extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001398extern const char bb_path_passwd_file[];
1399extern const char bb_path_shadow_file[];
1400extern const char bb_path_gshadow_file[];
1401extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001402extern const char bb_path_motd_file[];
1403extern const char bb_path_wtmp_file[];
1404extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001405extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001406/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1407 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001408extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1409#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1410#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001411
Denis Vlasenko703e2022007-01-22 14:12:08 +00001412extern const int const_int_0;
1413extern const int const_int_1;
1414
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001415
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001416#ifndef BUFSIZ
1417#define BUFSIZ 4096
1418#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001419/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001420enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1421extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001422/* This struct is deliberately not defined. */
1423/* See docs/keep_data_small.txt */
1424struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001425/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001426 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001427 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001428extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001429/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001430#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001431#define SET_PTR_TO_GLOBALS(x) do { \
1432 (*(struct globals**)&ptr_to_globals) = (x); \
1433 barrier(); \
1434} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001435
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001436/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1437 * use bb_default_login_shell and following defines.
1438 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1439 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001440#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001441extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001442/* "/bin/sh" */
1443#define DEFAULT_SHELL (bb_default_login_shell+1)
1444/* "sh" */
1445#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1446
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001447#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001448# define CURRENT_VC "/dev/vc/0"
1449# define VC_1 "/dev/vc/1"
1450# define VC_2 "/dev/vc/2"
1451# define VC_3 "/dev/vc/3"
1452# define VC_4 "/dev/vc/4"
1453# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001454#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1455/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1456 respective serial ports .. as such, we can't use the common device paths for
1457 these. -- PFM */
1458# define SC_0 "/dev/ttsc/0"
1459# define SC_1 "/dev/ttsc/1"
1460# define SC_FORMAT "/dev/ttsc/%d"
1461#else
1462# define SC_0 "/dev/tts/0"
1463# define SC_1 "/dev/tts/1"
1464# define SC_FORMAT "/dev/tts/%d"
1465#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001466# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001467# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001468# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001469# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001470# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001471#else
1472# define CURRENT_VC "/dev/tty0"
1473# define VC_1 "/dev/tty1"
1474# define VC_2 "/dev/tty2"
1475# define VC_3 "/dev/tty3"
1476# define VC_4 "/dev/tty4"
1477# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001478#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1479# define SC_0 "/dev/ttySC0"
1480# define SC_1 "/dev/ttySC1"
1481# define SC_FORMAT "/dev/ttySC%d"
1482#else
1483# define SC_0 "/dev/ttyS0"
1484# define SC_1 "/dev/ttyS1"
1485# define SC_FORMAT "/dev/ttyS%d"
1486#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001487# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001488# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001489# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001490# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001491# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001492#endif
1493
1494/* The following devices are the same on devfs and non-devfs systems. */
1495#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001496#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001497
Rob Landleyc57ec372006-04-10 17:07:15 +00001498
Rob Landleyb623a542006-05-31 22:09:03 +00001499#ifndef RB_POWER_OFF
1500/* Stop system and switch power off if possible. */
1501#define RB_POWER_OFF 0x4321fedc
1502#endif
1503
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001504/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001505#undef isalnum
1506#undef isalpha
1507#undef isascii
1508#undef isblank
1509#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001510#undef isgraph
1511#undef islower
1512#undef isprint
1513#undef ispunct
1514#undef isspace
1515#undef isupper
1516#undef isxdigit
1517
Denis Vlasenko459903b2006-11-27 14:44:18 +00001518/* This one is more efficient - we save ~400 bytes */
1519#undef isdigit
1520#define isdigit(a) ((unsigned)((a) - '0') <= 9)
1521
Denis Vlasenko6b06cb82008-05-15 21:30:45 +00001522#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denis Vlasenko459903b2006-11-27 14:44:18 +00001523
Denis Vlasenko98636eb2008-05-09 17:59:34 +00001524
1525#if __GNUC_PREREQ(4,1)
1526# pragma GCC visibility pop
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001527#endif
1528
Denis Vlasenko80b8b392007-06-25 10:55:35 +00001529
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +00001530#endif /* __LIBBUSYBOX_H__ */