blob: ad0d59d04cc442bff7b71aa6ffb9dc85aa142a23 [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Eric Andersenaad1a882001-03-16 22:47:14 +00006 * Permission has been granted to redistribute this code under the GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Rob Landleyeb84a422006-09-20 21:41:13 +00008 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000010#ifndef LIBBB_H
11#define LIBBB_H 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
20#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000021#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000022#include <signal.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000023#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000024#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000025#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000026#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000027#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000028#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000029#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000030#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000031#include <sys/socket.h>
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +020032#if defined __FreeBSD__
33#include <netinet/in.h>
34#include <arpa/inet.h>
35#endif
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000036#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000037#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000038#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000039#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000040#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000041#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000042#include <unistd.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000043#include <utime.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000044/* Try to pull in PATH_MAX */
45#include <limits.h>
46#include <sys/param.h>
47#ifndef PATH_MAX
48#define PATH_MAX 256
49#endif
Rob Landley299a6b42006-05-27 21:42:58 +000050
Mike Frysinger22876c72008-02-07 22:10:07 +000051#ifdef HAVE_MNTENT_H
52#include <mntent.h>
53#endif
54
Mike Frysinger9412ec72008-02-07 22:41:33 +000055#ifdef HAVE_SYS_STATFS_H
56#include <sys/statfs.h>
57#endif
58
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000059#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000060#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000061#include <selinux/context.h>
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +000062#include <selinux/flask.h>
63#include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000064#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000065
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000066#if ENABLE_LOCALE_SUPPORT
Rob Landleyd921b2e2006-08-03 15:41:12 +000067#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000068#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000069#define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000070#endif
71
Denis Vlasenko98636eb2008-05-09 17:59:34 +000072#ifdef DMALLOC
73#include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000074#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000075
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000076#include <pwd.h>
77#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000078#if ENABLE_FEATURE_SHADOWPASSWDS
Mike Frysinger52a42672009-07-09 01:33:20 -040079# if !ENABLE_USE_BB_SHADOW
80/* If using busybox's shadow implementation, do not include the shadow.h
81 * header as the toolchain may not provide it at all.
82 */
83# include <shadow.h>
84# endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000085#endif
86
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +000087/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +000088
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +000089extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000090#if defined(__GLIBC__) && __GLIBC__ < 2
91int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000092#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000093/* klogctl is in libc's klog.h, but we cheat and not #include that */
94int klogctl(int type, char *b, int len);
95/* This is declared here rather than #including <libgen.h> in order to avoid
96 * confusing the two versions of basename. See the dirname/basename man page
97 * for details. */
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +020098#if !defined __FreeBSD__
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000099char *dirname(char *path);
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200100#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000101/* Include our own copy of struct sysinfo to avoid binary compatibility
102 * problems with Linux 2.4, which changed things. Grumble, grumble. */
103struct sysinfo {
104 long uptime; /* Seconds since boot */
105 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
106 unsigned long totalram; /* Total usable main memory size */
107 unsigned long freeram; /* Available memory size */
108 unsigned long sharedram; /* Amount of shared memory */
109 unsigned long bufferram; /* Memory used by buffers */
110 unsigned long totalswap; /* Total swap space size */
111 unsigned long freeswap; /* swap space still available */
112 unsigned short procs; /* Number of current processes */
113 unsigned short pad; /* Padding needed for m68k */
114 unsigned long totalhigh; /* Total high memory size */
115 unsigned long freehigh; /* Available high memory size */
116 unsigned int mem_unit; /* Memory unit size in bytes */
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000117 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000118};
119int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +0000120
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000121
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000122/* Make all declarations hidden (-fvisibility flag only affects definitions) */
123/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000124PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000125
126
127#if ENABLE_USE_BB_PWD_GRP
128# include "pwd_.h"
129# include "grp_.h"
130#endif
131#if ENABLE_FEATURE_SHADOWPASSWDS
132# if ENABLE_USE_BB_SHADOW
133# include "shadow_.h"
134# endif
135#endif
136
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000137/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000138#define MAXINT(T) (T)( \
139 ((T)-1) > 0 \
140 ? (T)-1 \
141 : (T)~((T)1 << (sizeof(T)*8-1)) \
142 )
143
144#define MININT(T) (T)( \
145 ((T)-1) > 0 \
146 ? (T)0 \
147 : ((T)1 << (sizeof(T)*8-1)) \
148 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000149
Denis Vlasenko56254152006-10-07 16:24:46 +0000150/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000151/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000152 * (stat, lseek etc) mapped to "largefile" variants by libc.
153 * Practically it means that open() automatically has O_LARGEFILE added
154 * and all filesize/file_offset parameters and struct members are "large"
155 * (in today's world - signed 64bit). For full support of large files,
156 * we need a few helper #defines (below) and careful use of off_t
157 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000158#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000159/* CONFIG_LFS is on */
160# if ULONG_MAX > 0xffffffff
161/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000162typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000163# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000164/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
165# define BB_STRTOOFF bb_strtoul
166# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000167/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
168# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000169# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000170/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000171typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000172# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000173# define BB_STRTOOFF bb_strtoull
174# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000175# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000176# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000177#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000178/* CONFIG_LFS is off */
179# if UINT_MAX == 0xffffffff
180/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
181 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000182typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000183# define XATOOFF(a) xatoi_u(a)
184# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000185# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000186# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000187# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000188typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000189# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
190# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000191# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000192# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000193# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000194#endif
195/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000196#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000197
Eric Andersenaad1a882001-03-16 22:47:14 +0000198/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000199#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000200#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000201#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000202#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000203#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000204#define SKIP ((int) 2)
205
206/* for mtab.c */
207#define MTAB_GETMOUNTPT '1'
208#define MTAB_GETDEVICE '2'
209
210#define BUF_SIZE 8192
211#define EXPAND_ALLOC 1024
212
Eric Andersenaad1a882001-03-16 22:47:14 +0000213/* Macros for min/max. */
214#ifndef MIN
215#define MIN(a,b) (((a)<(b))?(a):(b))
216#endif
217
218#ifndef MAX
219#define MAX(a,b) (((a)>(b))?(a):(b))
220#endif
221
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000222/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000223#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000224#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000225#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
226#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
227#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000228#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000229#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
230#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
231#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
232#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000233#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
234#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
235#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000236#endif
237#endif
238
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000239#if defined(__GLIBC__)
240/* glibc uses __errno_location() to get a ptr to errno */
241/* We can just memorize it once - no multithreading in busybox :) */
242extern int *const bb_errno;
243#undef errno
244#define errno (*bb_errno)
245#endif
246
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000247unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000248unsigned long long monotonic_us(void) FAST_FUNC;
249unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000250
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000251extern void chomp(char *s) FAST_FUNC;
252extern void trim(char *s) FAST_FUNC;
253extern char *skip_whitespace(const char *) FAST_FUNC;
254extern char *skip_non_whitespace(const char *) FAST_FUNC;
255extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000256
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000257//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000258extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
259extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000260enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
261 FILEUTILS_PRESERVE_STATUS = 1,
262 FILEUTILS_DEREFERENCE = 2,
263 FILEUTILS_RECUR = 4,
264 FILEUTILS_FORCE = 8,
265 FILEUTILS_INTERACTIVE = 0x10,
266 FILEUTILS_MAKE_HARDLINK = 0x20,
267 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000268 FILEUTILS_DEREF_SOFTLINK = 0x80,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000269#if ENABLE_SELINUX
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000270 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
271 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000272#endif
273};
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000274#define FILEUTILS_CP_OPTSTR "pdRfilsL" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000275extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000276/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
277 * the source, not copy (unless "source" is a directory).
278 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
279 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000280extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000281
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000282enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000283 ACTION_RECURSE = (1 << 0),
284 ACTION_FOLLOWLINKS = (1 << 1),
285 ACTION_FOLLOWLINKS_L0 = (1 << 2),
286 ACTION_DEPTHFIRST = (1 << 3),
287 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000288 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200289 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000290};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200291typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000292extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000293 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
294 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
295 void* userData, unsigned depth) FAST_FUNC;
296extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000297enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000298extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000299extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000300extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
301extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000302/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000303extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
304extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
305extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000306/* "short" copy can be detected by return value < size */
307/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000308extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000309extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000310/* xxxx_strip version can modify its parameter:
311 * "/" -> "/"
312 * "abc" -> "abc"
313 * "abc/def" -> "def"
314 * "abc/def/" -> "def" !!
315 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000316extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000317/* "abc/def/" -> "" and it never modifies 'path' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000318extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000319
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000320int ndelay_on(int fd) FAST_FUNC;
321int ndelay_off(int fd) FAST_FUNC;
322int close_on_exec_on(int fd) FAST_FUNC;
323void xdup2(int, int) FAST_FUNC;
324void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000325
326
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000327DIR *xopendir(const char *path) FAST_FUNC;
328DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000329
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000330/* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC; */
331char *xmalloc_readlink(const char *path) FAST_FUNC;
332char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC;
333char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000334
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000335char *xmalloc_follow_symlinks(const char *path) FAST_FUNC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000336
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000337
Denis Vlasenko33196372008-02-23 01:25:38 +0000338enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000339 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000340 * otherwise would kill us, except for those resulting from bugs:
341 * SIGSEGV, SIGILL, SIGFPE.
342 * Other fatal signals not included (TODO?):
343 * SIGBUS Bus error (bad memory access)
344 * SIGPOLL Pollable event. Synonym of SIGIO
345 * SIGPROF Profiling timer expired
346 * SIGSYS Bad argument to routine
347 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000348 *
349 * The only known arch with some of these sigs not fitting
350 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
351 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000352 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000353 BB_FATAL_SIGS = (int)(0
354 + (1LL << SIGHUP)
355 + (1LL << SIGINT)
356 + (1LL << SIGTERM)
357 + (1LL << SIGPIPE) // Write to pipe with no readers
358 + (1LL << SIGQUIT) // Quit from keyboard
359 + (1LL << SIGABRT) // Abort signal from abort(3)
360 + (1LL << SIGALRM) // Timer signal from alarm(2)
361 + (1LL << SIGVTALRM) // Virtual alarm clock
362 + (1LL << SIGXCPU) // CPU time limit exceeded
363 + (1LL << SIGXFSZ) // File size limit exceeded
364 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
365 + (1LL << SIGUSR2)
366 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000367};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000368void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000369/* Unlike signal() and bb_signals, sets handler with sigaction()
370 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000371 * will be blocked; syscalls will not be restarted: */
372void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000373/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000374void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000375/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000376void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
377void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000378void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000379void sig_block(int sig) FAST_FUNC;
380void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000381/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000382int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000383/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000384int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000385/* Standard handler which just records signo */
386extern smallint bb_got_signal;
387void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000388
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000389
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000390void xsetgid(gid_t gid) FAST_FUNC;
391void xsetuid(uid_t uid) FAST_FUNC;
392void xchdir(const char *path) FAST_FUNC;
393void xchroot(const char *path) FAST_FUNC;
394void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000395void bb_unsetenv(const char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000396void xunlink(const char *pathname) FAST_FUNC;
397void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200398int xopen(const char *pathname, int flags) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000399int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
400int open_or_warn(const char *pathname, int flags) FAST_FUNC;
401int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
402int open_or_warn_stdin(const char *pathname) FAST_FUNC;
403void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
404int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
405off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
406off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000407
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000408void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000409/* In this form code with pipes is much more readable */
410struct fd_pair { int rd; int wr; };
411#define piped_pair(pair) pipe(&((pair).rd))
412#define xpiped_pair(pair) xpipe(&((pair).rd))
413
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000414/* Useful for having small structure members/global variables */
415typedef int8_t socktype_t;
416typedef int8_t family_t;
417struct BUG_too_small {
418 char BUG_socktype_t_too_small[(0
419 | SOCK_STREAM
420 | SOCK_DGRAM
421 | SOCK_RDM
422 | SOCK_SEQPACKET
423 | SOCK_RAW
424 ) <= 127 ? 1 : -1];
425 char BUG_family_t_too_small[(0
426 | AF_UNSPEC
427 | AF_INET
428 | AF_INET6
429 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000430#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000431 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000432#endif
433#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000434 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000435#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000436 /* | AF_DECnet */
437 /* | AF_IPX */
438 ) <= 127 ? 1 : -1];
439};
440
441
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200442void parse_datestr(const char *date_str, struct tm *tm_time) FAST_FUNC;
Denys Vlasenko7aca89a2009-07-18 03:41:29 +0200443time_t validate_tm_time(const char *date_str, struct tm *tm_time) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200444
445
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000446int xsocket(int domain, int type, int protocol) FAST_FUNC;
447void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
448void xlisten(int s, int backlog) FAST_FUNC;
449void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000450ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000451 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000452/* SO_REUSEADDR allows a server to rebind to an address that is already
453 * "in use" by old connections to e.g. previous server instance which is
454 * killed or crashed. Without it bind will fail until all such connections
455 * time out. Linux does not allow multiple live binds on same ip:port
456 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
457 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000458void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
459int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000460int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000461/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000462unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000463typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000464 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000465 union {
466 struct sockaddr sa;
467 struct sockaddr_in sin;
468#if ENABLE_FEATURE_IPV6
469 struct sockaddr_in6 sin6;
470#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000471 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000472} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000473enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000474 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000475 LSA_SIZEOF_SA = sizeof(
476 union {
477 struct sockaddr sa;
478 struct sockaddr_in sin;
479#if ENABLE_FEATURE_IPV6
480 struct sockaddr_in6 sin6;
481#endif
482 }
483 )
484};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000485/* Create stream socket, and allocate suitable lsa.
486 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000487 * af == AF_UNSPEC will result in trying to create IPv6 socket,
488 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000489 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000490#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000491int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000492#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000493int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000494#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
495#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000496int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000497/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000498 * numeric IP ("N.N.N.N") or numeric IPv6 address,
499 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000500 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000501/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000502int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
503int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000504/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
505 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
506 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
507 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000508int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000509/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000510int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000511/* Get local address of bound or accepted socket */
512len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000513/* Return malloc'ed len_and_sockaddr with socket address of host:port
514 * Currently will return IPv4 or IPv6 sockaddrs only
515 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000516 * UNIX socket address being returned, IPX sockaddr etc...
517 * On error does bb_error_msg and returns NULL */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000518len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000519/* Version which dies on error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000520len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC;
521len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000522/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000523#if !ENABLE_FEATURE_IPV6
524#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
525#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
526#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000527len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
528len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000529#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000530/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000531 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000532 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000533void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000534/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000535int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000536/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000537char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000538/* This one doesn't append :PORTNUM */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000539char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000540/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000541char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000542/* inet_[ap]ton on steroids */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000543char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC;
544char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000545// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000546// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000547struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000548// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000549// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000550
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000551
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000552void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000553ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000554 const struct sockaddr *to,
555 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000556 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000557ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000558 struct sockaddr *from,
559 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000560 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000561
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000562char *xstrdup(const char *s) FAST_FUNC;
563char *xstrndup(const char *s, int n) FAST_FUNC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000564void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000565char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000566char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000567/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000568 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000569int bb_putchar(int ch) FAST_FUNC;
570char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000571/* Prints unprintable chars ch as ^C or M-c to file
572 * (M-c is used only if ch is ORed with PRINTABLE_META),
573 * else it is printed as-is (except for ch = 0x9b) */
574enum { PRINTABLE_META = 0x100 };
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000575void fputc_printable(int ch, FILE *file) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000576// gcc-4.1.1 still isn't good enough at optimizing it
577// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000578//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000579//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000580//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000581//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000582#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000583#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000584#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000585#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000586#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000587
588/* dmalloc will redefine these to it's own implementation. It is safe
589 * to have the prototypes here unconditionally. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000590void *malloc_or_warn(size_t size) FAST_FUNC;
591void *xmalloc(size_t size) FAST_FUNC;
592void *xzalloc(size_t size) FAST_FUNC;
593void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000594/* After xrealloc_vector(v, 4, idx) it's ok to use
595 * at least v[idx] and v[idx+1], for all idx values.
596 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
597 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000598#define xrealloc_vector(vector, shift, idx) \
599 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
600void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
601
Eric Andersenaad1a882001-03-16 22:47:14 +0000602
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000603extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
604extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000605// NB: will return short read on error, not -1,
606// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000607extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
608extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
609extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000610extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
611extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000612// Reads one line a-la fgets (but doesn't save terminating '\n').
613// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000614// Bytes are appended to pfx (which must be malloced, or NULL).
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000615extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000616/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denis Vlasenkob6052722008-07-10 17:43:01 +0000617extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000618/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000619extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000620/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000621extern int open_zipped(const char *fname) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000622extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000623/* Never returns NULL */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000624extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000625
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000626extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000627// NB: will return short write on error, not -1,
628// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000629extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
630extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000631extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000632extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000633
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200634/* Close fd, but check for failures (some types of write errors) */
635extern void xclose(int fd) FAST_FUNC;
636
Denis Vlasenko1de08302006-10-26 23:32:43 +0000637/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000638extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000639
640extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenko69f4f9a2008-08-09 17:16:40 +0000641extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000642/* Reads up to (and including) TERMINATING_STRING: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000643extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000644/* Same, with limited max size, and returns the length (excluding NUL): */
645extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000646/* Chops off TERMINATING_STRING from the end: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000647extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000648/* Reads up to (and including) "\n" or NUL byte: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000649extern char *xmalloc_fgets(FILE *file) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000650/* Chops off '\n' from the end, unlike fgets: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000651extern char *xmalloc_fgetline(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000652/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denis Vlasenko5e476ba2008-07-15 21:29:44 +0000653/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000654
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000655extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
656extern void die_if_ferror_stdout(void) FAST_FUNC;
657extern void xfflush_stdout(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000658extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000659extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
660extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000661/* Prints warning to stderr and returns NULL on failure: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000662extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000663/* "Opens" stdin if filename is special, else just opens file: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000664extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
665extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000666extern FILE* fopen_for_read(const char *path) FAST_FUNC;
667extern FILE* xfopen_for_read(const char *path) FAST_FUNC;
668extern FILE* fopen_for_write(const char *path) FAST_FUNC;
669extern FILE* xfopen_for_write(const char *path) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000670
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000671int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
672void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000673
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000674/* Wrapper which restarts poll on EINTR or ENOMEM.
675 * On other errors complains [perror("poll")] and returns.
676 * Warning! May take (much) longer than timeout_ms to return!
677 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000678int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000679
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000680char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000681char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000682
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000683/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000684char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000685
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000686char *utoa(unsigned n) FAST_FUNC;
687char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000688/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000689char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
690char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000691/* Intelligent formatters of bignums */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000692void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
693void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200694/* If block_size == 0, display size without fractional part,
695 * else display (size * block_size) with one decimal digit.
696 * If display_unit == 0, add suffix (K,M,G...),
697 * else divide by display_unit and do not use suffix. */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000698//TODO: provide pointer to buf (avoid statics)?
699const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000700 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000701/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000702char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000703
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200704/* Generate a UUID */
705void generate_uuid(uint8_t *buf) FAST_FUNC;
706
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000707/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000708struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000709 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000710 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000711};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000712#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000713/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000714/* Using xatoi() instead of naive atoi() is not always convenient -
715 * in many places people want *non-negative* values, but store them
716 * in signed int. Therefore we need this one:
717 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000718int xatoi_u(const char *numstr) FAST_FUNC;
Denis Vlasenko13858992006-10-08 12:49:22 +0000719/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000720uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000721
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000722
Eric Andersenaad1a882001-03-16 22:47:14 +0000723/* These parse entries in /etc/passwd and /etc/group. This is desirable
724 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000725 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000726long xuname2uid(const char *name) FAST_FUNC;
727long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000728/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000729unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000730/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000731struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000732 uid_t uid;
733 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000734};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000735/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000736int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000737/* always sets uid and gid, allows numeric; exits on failure */
738void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000739/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000740void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000741struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000742struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000743struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
744struct group* xgetgrgid(gid_t gid) FAST_FUNC;
745char* xuid2uname(uid_t uid) FAST_FUNC;
746char* xgid2group(gid_t gid) FAST_FUNC;
747char* uid2uname(uid_t uid) FAST_FUNC;
748char* gid2group(gid_t gid) FAST_FUNC;
749char* uid2uname_utoa(long uid) FAST_FUNC;
750char* gid2group_utoa(long gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000751/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000752const char* get_cached_username(uid_t uid) FAST_FUNC;
753const char* get_cached_groupname(gid_t gid) FAST_FUNC;
754void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000755/* internally usernames are saved in fixed-sized char[] buffers */
756enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000757#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000758void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000759#else
760#define die_if_bad_username(name) ((void)(name))
761#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000762
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000763int execable_file(const char *name) FAST_FUNC;
764char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
765int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000766
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000767/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
768 * but it may exec busybox and call applet instead of searching PATH.
769 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000770#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000771int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000772#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
773#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000774 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000775 cmd, __VA_ARGS__)
776#else
777#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
778#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
779#endif
780
781/* NOMMU friendy fork+exec */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000782pid_t spawn(char **argv) FAST_FUNC;
783pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000784
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000785pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000786/* Unlike waitpid, waits ONLY for one process.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000787 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000788 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000789 * IOW: rc = wait4pid(spawn(argv));
790 * if (rc < 0) bb_perror_msg("%s", argv[0]);
791 * if (rc > 0) bb_error_msg("exit code: %d", rc);
792 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000793int wait4pid(pid_t pid) FAST_FUNC;
794pid_t wait_any_nohang(int *wstat) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000795/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200796int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000797struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000798 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000799 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000800 int xfunc_error_retval;
801 uint32_t option_mask32;
802 int die_sleep;
803 smallint saved;
804};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000805void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
806void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000807/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000808int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
809int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000810
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000811/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000812 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000813 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000814 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000815 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
816 * rexec's itself on NOMMU with argv passed as command line.
817 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
818 * from the start. (It will detect it and not reexec again second time).
819 * You have to audit carefully that you don't do something twice as a result
820 * (opening files/sockets, parsing config files etc...)!
821 *
822 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
823 * (will do setsid()).
824 *
Denis Vlasenko83518d12009-03-20 22:17:13 +0000825 * fork_or_rexec(argv) = bare-bones "fork" on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000826 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000827 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000828 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000829 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000830 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000831 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
832 * to /dev/null if they are not.
833 */
834enum {
835 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000836 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000837 DAEMON_CLOSE_EXTRA_FDS = 4,
838 DAEMON_ONLY_SANITIZE = 8, /* internal use */
839};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000840#if BB_MMU
Denis Vlasenko83518d12009-03-20 22:17:13 +0000841 pid_t fork_or_rexec(void) FAST_FUNC;
Denis Vlasenko367960b2007-08-18 14:20:21 +0000842 enum { re_execed = 0 };
Denis Vlasenko83518d12009-03-20 22:17:13 +0000843# define fork_or_rexec(argv) fork_or_rexec()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000844# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
845# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000846#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000847 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000848 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000849 extern bool re_execed;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000850 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
851 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
852 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000853# define fork() BUG_fork_is_unavailable_on_nommu()
854# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
855# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000856#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000857void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
858void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000859/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000860int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000861
862
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000863extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000864extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200865#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000866#define No_argument "\0"
867#define Required_argument "\001"
868#define Optional_argument "\002"
869extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000870#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000871extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000872extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000873
874
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000875typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000876 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000877 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000878} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000879void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
880void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
881void *llist_pop(llist_t **elm) FAST_FUNC;
882void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
883void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
884llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +0000885llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000886/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000887 * llist_t *llist_add_to(llist_t *old_head, void *data)
888 * etc does not result in smaller code... */
889
Denis Vlasenko80edead2007-08-02 22:31:05 +0000890/* start_stop_daemon and udhcpc are special - they want
891 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000892#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000893/* True only if we created pidfile which is *file*, not /dev/null etc */
894extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000895void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000896#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000897#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000898enum { wrote_pidfile = 0 };
899#define write_pidfile(path) ((void)0)
900#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000901#endif
902
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000903enum {
904 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000905 LOGMODE_STDIO = (1 << 0),
906 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000907 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
908};
909extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000910extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000911extern int die_sleep;
912extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000913extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000914extern void xfunc_die(void) NORETURN FAST_FUNC;
915extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000916extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
917extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
918extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
919extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
920extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +0000921extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000922extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
923extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000924extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000925extern void bb_perror_nomsg(void) FAST_FUNC;
926extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
927extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000928
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000929/* We need to export XXX_main from libbusybox
930 * only if we build "individual" binaries
931 */
932#if ENABLE_FEATURE_INDIVIDUAL
933#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
934#else
935#define MAIN_EXTERNALLY_VISIBLE
936#endif
937
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000938
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000939/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000940int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000941/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000942int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
943int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
944int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
945int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000946/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000947int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +0000948/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000949int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
950/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000951int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000952int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +0000953
Denis Vlasenko468aea22008-04-01 14:47:57 +0000954#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000955void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +0000956#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000957
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000958
959/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000960int create_icmp_socket(void) FAST_FUNC;
961int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000962/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000963/* This structure defines protocol families and their handlers. */
964struct aftype {
965 const char *name;
966 const char *title;
967 int af;
968 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000969 char* FAST_FUNC (*print)(unsigned char *);
970 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
971 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
972 void FAST_FUNC (*herror)(char *text);
973 int FAST_FUNC (*rprint)(int options);
974 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000975 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000976 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000977};
978/* This structure defines hardware protocols and their handlers. */
979struct hwtype {
980 const char *name;
981 const char *title;
982 int type;
983 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000984 char* FAST_FUNC (*print)(unsigned char *);
985 int FAST_FUNC (*input)(const char *, struct sockaddr *);
986 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000987 int suppress_null_addr;
988};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000989extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000990int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000991#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000992int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +0000993#else
994#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000995#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000996const struct aftype *get_aftype(const char *name) FAST_FUNC;
997const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
998const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000999
1000
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001001#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001002extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001003/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001004extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001005extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001006#endif
1007
Mike Frysinger9412ec72008-02-07 22:41:33 +00001008#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001009extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001010extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001011#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001012extern void erase_mtab(const char * name) FAST_FUNC;
1013extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1014extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1015extern void bb_warn_ignoring_args(int n) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001016
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001017extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001018
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001019extern char *query_loop(const char *device) FAST_FUNC;
1020extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001021/* If *devname is not NULL, use that name, otherwise try to find free one,
1022 * malloc and return it in *devname.
1023 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001024extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001025
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001026/* Like bb_ask below, but asks on stdin with no timeout. */
1027char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001028//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001029char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001030int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001031
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001032int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001033
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001034/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001035 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001036 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001037enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001038 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1039 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1040// TODO: COLLAPSE and TRIM seem to always go in pair
1041 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1042 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001043 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001044 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001045// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1046 // NORMAL is:
1047 // * remove leading and trailing delimiters and collapse
1048 // multiple delimiters into one
1049 // * warn and continue if less than mintokens delimiters found
1050 // * grab everything into last token
1051 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001052};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001053typedef struct parser_t {
1054 FILE *fp;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001055 char *line;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001056 char *data;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001057 int lineno;
1058} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001059parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001060parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001061int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1062#define config_read(parser, tokens, max, min, str, flags) \
1063 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001064void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001065
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001066/* Concatenate path and filename to new allocated buffer.
1067 * Add "/" only as needed (no duplicate "//" are produced).
1068 * If path is NULL, it is assumed to be "/".
1069 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001070char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1071char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1072const char *bb_basename(const char *name) FAST_FUNC;
Denis Vlasenko7e84e532007-05-08 17:52:17 +00001073/* NB: can violate const-ness (similarly to strchr) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001074char *last_char_is(const char *s, int c) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001075
Denis Vlasenko4921b542007-02-03 02:17:41 +00001076
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001077int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001078
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001079int get_signum(const char *name) FAST_FUNC;
1080const char *get_signame(int number) FAST_FUNC;
1081void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001082
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001083char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001084/* Returns ptr to NUL */
1085char *bb_simplify_abs_path_inplace(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 Vlasenko829bbd32009-04-14 00:51:05 +00001135
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001136/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001137#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1138#define update_passwd(filename, username, data, member) \
1139 update_passwd(filename, username, data)
1140#endif
1141extern int update_passwd(const char *filename,
1142 const char *username,
1143 const char *data,
1144 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001145
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001146int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1147int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1148int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1149int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1150const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001151
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001152extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1153extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001154
Denis Vlasenko4e12b1a2008-12-23 23:36:47 +00001155char *xmalloc_ttyname(int fd) FAST_FUNC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001156/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001157int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001158
Denis Vlasenko202ac502008-11-05 13:20:58 +00001159int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1160
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001161/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001162int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1163int 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 +00001164#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001165int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1166int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001167#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1168#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1169#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001170int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1171int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001172#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1173#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1174#endif
1175
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001176char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1177void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1178void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001179#ifdef __GLIBC__
1180/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001181unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001182#undef makedev
1183#define makedev(a,b) bb_makedev(a,b)
1184#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001185
1186
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001187/* "Keycodes" that report an escape sequence.
1188 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001189 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001190 * Also, -1 is reserved for error indication and we don't use it. */
1191enum {
1192 KEYCODE_UP = -2,
1193 KEYCODE_DOWN = -3,
1194 KEYCODE_RIGHT = -4,
1195 KEYCODE_LEFT = -5,
1196 KEYCODE_HOME = -6,
1197 KEYCODE_END = -7,
1198 KEYCODE_INSERT = -8,
1199 KEYCODE_DELETE = -9,
1200 KEYCODE_PAGEUP = -10,
1201 KEYCODE_PAGEDOWN = -11,
1202#if 0
1203 KEYCODE_FUN1 = -12,
1204 KEYCODE_FUN2 = -13,
1205 KEYCODE_FUN3 = -14,
1206 KEYCODE_FUN4 = -15,
1207 KEYCODE_FUN5 = -16,
1208 KEYCODE_FUN6 = -17,
1209 KEYCODE_FUN7 = -18,
1210 KEYCODE_FUN8 = -19,
1211 KEYCODE_FUN9 = -20,
1212 KEYCODE_FUN10 = -21,
1213 KEYCODE_FUN11 = -22,
1214 KEYCODE_FUN12 = -23,
1215#endif
1216 KEYCODE_CURSOR_POS = -0x100,
1217 /* How long is the longest ESC sequence we know?
1218 * We want it big enough to be able to contain
1219 * cursor position sequence "ESC [ 9999 ; 9999 R"
1220 */
1221 KEYCODE_BUFFER_SIZE = 16
1222};
1223/* Note: fd may be in blocking or non-blocking mode, both make sense.
1224 * For one, less uses non-blocking mode.
1225 * Only the first read syscall inside read_key may block indefinitely
1226 * (unless fd is in non-blocking mode),
1227 * subsequent reads will time out after a few milliseconds.
1228 * Return of -1 means EOF or error (errno == 0 on EOF).
1229 * buffer[0] is used as a counter of buffered chars and must be 0
1230 * on first call.
1231 */
1232int64_t read_key(int fd, char *buffer) FAST_FUNC;
1233
1234
Denis Vlasenko38f63192007-01-22 09:03:07 +00001235#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001236/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001237# ifdef CONFIG_FEATURE_EDITING_HISTORY
1238# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1239# else
1240# define MAX_HISTORY 0
1241# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001242typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001243 int flags;
1244 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001245# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001246 int cnt_history;
1247 int cur_history;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001248# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001249 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001250 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001251# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001252 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001253# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001254} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001255enum {
1256 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001257 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1258 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1259 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1260 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001261 WITH_PATH_LOOKUP = 0x20,
1262 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1263};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001264line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001265/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1266/* maxsize must be >= 2.
1267 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001268 * -1 on read errors or EOF, or on bare Ctrl-D,
1269 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001270 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001271 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001272int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001273#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001274#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001275int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001276#define read_line_input(prompt, command, maxsize, state) \
1277 read_line_input(prompt, command, maxsize)
1278#endif
1279
1280
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001281#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001282# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001283enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001284# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001285/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001286enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001287# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001288#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001289typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001290 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001291 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001292 uint8_t shift_pages_to_bytes;
1293 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001294/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001295 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001296 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001297 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001298 IF_SELINUX(char *context;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001299 /* Everything below must contain no ptrs to malloc'ed data:
1300 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001301 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001302 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001303 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001304 unsigned pid;
1305 unsigned ppid;
1306 unsigned pgid;
1307 unsigned sid;
1308 unsigned uid;
1309 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001310#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1311 unsigned ruid;
1312 unsigned rgid;
1313 int niceness;
1314#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001315 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001316#if ENABLE_FEATURE_TOPMEM
1317 unsigned long mapped_rw;
1318 unsigned long mapped_ro;
1319 unsigned long shared_clean;
1320 unsigned long shared_dirty;
1321 unsigned long private_clean;
1322 unsigned long private_dirty;
1323 unsigned long stack;
1324#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001325 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001326 /* basename of executable in exec(2), read from /proc/N/stat
1327 * (if executable is symlink or script, it is NOT replaced
1328 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001329 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001330 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001331#if ENABLE_FEATURE_TOP_SMP_PROCESS
1332 int last_seen_on_cpu;
1333#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001334} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001335/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001336enum {
1337 PSSCAN_PID = 1 << 0,
1338 PSSCAN_PPID = 1 << 1,
1339 PSSCAN_PGID = 1 << 2,
1340 PSSCAN_SID = 1 << 3,
1341 PSSCAN_UIDGID = 1 << 4,
1342 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001343 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001344 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001345 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001346 PSSCAN_STATE = 1 << 9,
1347 PSSCAN_VSZ = 1 << 10,
1348 PSSCAN_RSS = 1 << 11,
1349 PSSCAN_STIME = 1 << 12,
1350 PSSCAN_UTIME = 1 << 13,
1351 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001352 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001353 /* NB: used by find_pid_by_name(). Any applet using it
1354 * needs to be mentioned here. */
1355 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1356 || ENABLE_PGREP || ENABLE_PKILL
1357 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001358 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001359 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001360 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001361 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001362 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1363 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1364 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001365 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001366 /* These are all retrieved from proc/NN/stat in one go: */
1367 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001368 /**/ | PSSCAN_COMM | PSSCAN_STATE
1369 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1370 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001371 /**/ | PSSCAN_TTY | PSSCAN_NICE
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001372 /**/ | PSSCAN_CPU
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001373};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001374//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1375void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1376procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001377/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001378/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001379void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001380pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1381pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001382
1383
1384extern const char bb_uuenc_tbl_base64[];
1385extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001386void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001387
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001388typedef struct sha1_ctx_t {
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001389 uint32_t hash[8]; /* 5, +3 elements for sha256 */
Denis Vlasenko98c87f72009-03-11 21:15:51 +00001390 uint64_t total64;
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001391 uint8_t wbuffer[64]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko8ec8d5e2009-03-15 02:56:00 +00001392 void (*process_block)(struct sha1_ctx_t*) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001393} sha1_ctx_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001394void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1395void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001396void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001397typedef struct sha1_ctx_t sha256_ctx_t;
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001398void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001399#define sha256_hash sha1_hash
1400#define sha256_end sha1_end
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001401typedef struct sha512_ctx_t {
Denis Vlasenkocd2cd312009-03-12 15:40:27 +00001402 uint64_t hash[8];
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001403 uint64_t total64[2];
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001404 uint8_t wbuffer[128]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001405} sha512_ctx_t;
1406void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1407void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001408void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1409#if 1
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001410typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001411 uint32_t A;
1412 uint32_t B;
1413 uint32_t C;
1414 uint32_t D;
1415 uint64_t total;
1416 uint32_t buflen;
1417 char buffer[128];
1418} md5_ctx_t;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001419#else
1420/* libbb/md5prime.c uses a bit different one: */
1421typedef struct md5_ctx_t {
1422 uint32_t state[4]; /* state (ABCD) */
1423 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1424 unsigned char buffer[64]; /* input buffer */
1425} md5_ctx_t;
1426#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001427void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1428void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001429void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1430
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001431
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001432uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1433
1434typedef struct masks_labels_t {
1435 const char *labels;
1436 const int masks[];
1437} masks_labels_t;
1438int print_flags_separated(const int *masks, const char *labels,
1439 int flags, const char *separator) FAST_FUNC;
1440int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001441
1442
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001443extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001444/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001445extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001446extern const char bb_msg_memory_exhausted[];
1447extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001448extern const char bb_msg_read_error[];
1449extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001450extern const char bb_msg_unknown[];
1451extern const char bb_msg_can_not_create_raw_socket[];
1452extern const char bb_msg_perm_denied_are_you_root[];
1453extern const char bb_msg_requires_arg[];
1454extern const char bb_msg_invalid_arg[];
1455extern const char bb_msg_standard_input[];
1456extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001457
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001458extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001459/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001460extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001461
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001462extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001463extern const char bb_path_passwd_file[];
1464extern const char bb_path_shadow_file[];
1465extern const char bb_path_gshadow_file[];
1466extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001467extern const char bb_path_motd_file[];
1468extern const char bb_path_wtmp_file[];
1469extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001470extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001471/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1472 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001473extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1474#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1475#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001476
Denis Vlasenko703e2022007-01-22 14:12:08 +00001477extern const int const_int_0;
1478extern const int const_int_1;
1479
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001480
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001481#ifndef BUFSIZ
1482#define BUFSIZ 4096
1483#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001484/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001485enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1486extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001487/* This struct is deliberately not defined. */
1488/* See docs/keep_data_small.txt */
1489struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001490/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001491 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001492 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001493extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001494/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001495#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001496#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001497 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001498 barrier(); \
1499} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001500
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001501/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1502 * use bb_default_login_shell and following defines.
1503 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1504 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001505#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001506extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001507/* "/bin/sh" */
1508#define DEFAULT_SHELL (bb_default_login_shell+1)
1509/* "sh" */
1510#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1511
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001512#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001513# define CURRENT_VC "/dev/vc/0"
1514# define VC_1 "/dev/vc/1"
1515# define VC_2 "/dev/vc/2"
1516# define VC_3 "/dev/vc/3"
1517# define VC_4 "/dev/vc/4"
1518# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001519#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1520/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1521 respective serial ports .. as such, we can't use the common device paths for
1522 these. -- PFM */
1523# define SC_0 "/dev/ttsc/0"
1524# define SC_1 "/dev/ttsc/1"
1525# define SC_FORMAT "/dev/ttsc/%d"
1526#else
1527# define SC_0 "/dev/tts/0"
1528# define SC_1 "/dev/tts/1"
1529# define SC_FORMAT "/dev/tts/%d"
1530#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001531# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001532# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001533# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001534# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001535# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001536#else
1537# define CURRENT_VC "/dev/tty0"
1538# define VC_1 "/dev/tty1"
1539# define VC_2 "/dev/tty2"
1540# define VC_3 "/dev/tty3"
1541# define VC_4 "/dev/tty4"
1542# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001543#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1544# define SC_0 "/dev/ttySC0"
1545# define SC_1 "/dev/ttySC1"
1546# define SC_FORMAT "/dev/ttySC%d"
1547#else
1548# define SC_0 "/dev/ttyS0"
1549# define SC_1 "/dev/ttyS1"
1550# define SC_FORMAT "/dev/ttyS%d"
1551#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001552# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001553# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001554# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001555# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001556# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001557#endif
1558
1559/* The following devices are the same on devfs and non-devfs systems. */
1560#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001561#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001562
Rob Landleyc57ec372006-04-10 17:07:15 +00001563
Rob Landleyb623a542006-05-31 22:09:03 +00001564#ifndef RB_POWER_OFF
1565/* Stop system and switch power off if possible. */
1566#define RB_POWER_OFF 0x4321fedc
1567#endif
1568
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001569/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001570#undef isalnum
1571#undef isalpha
1572#undef isascii
1573#undef isblank
1574#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001575#undef isgraph
1576#undef islower
1577#undef isprint
1578#undef ispunct
Rob Landley4ae905a2006-07-06 17:22:54 +00001579#undef isupper
1580#undef isxdigit
1581
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001582/* This one is more efficient - we save ~500 bytes.
1583 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denis Vlasenko459903b2006-11-27 14:44:18 +00001584#undef isdigit
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001585#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denis Vlasenko459903b2006-11-27 14:44:18 +00001586
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001587/* This one is more efficient too! ~200 bytes */
1588/* In POSIX/C locale (the only locale we care about: do we REALLY want
1589 * to allow Unicode whitespace in, say, .conf files? nuts!)
1590 * isspace is only these chars: "\t\n\v\f\r" and space.
1591 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
1592 * Use that.
1593 */
1594#undef isspace
1595#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
1596
Denis Vlasenko6b06cb82008-05-15 21:30:45 +00001597#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denis Vlasenko459903b2006-11-27 14:44:18 +00001598
Denis Vlasenko98636eb2008-05-09 17:59:34 +00001599
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001600POP_SAVED_FUNCTION_VISIBILITY
1601
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001602#endif