blob: 0f8973d9e334c34b42c32850dd2d659ec6789817 [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__
Denys Vlasenko9d57a802009-10-23 14:24:44 +020033# include <netinet/in.h>
34# include <arpa/inet.h>
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +020035#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
Denys Vlasenko9d57a802009-10-23 14:24:44 +020048# define PATH_MAX 256
49#endif
50
51#ifndef BUFSIZ
52# define BUFSIZ 4096
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000053#endif
Rob Landley299a6b42006-05-27 21:42:58 +000054
Mike Frysinger22876c72008-02-07 22:10:07 +000055#ifdef HAVE_MNTENT_H
56#include <mntent.h>
57#endif
58
Mike Frysinger9412ec72008-02-07 22:41:33 +000059#ifdef HAVE_SYS_STATFS_H
60#include <sys/statfs.h>
61#endif
62
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000063#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000064#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000065#include <selinux/context.h>
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +000066#include <selinux/flask.h>
67#include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000068#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000069
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000070#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +020071# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000072#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +020073# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000074#endif
75
Denis Vlasenko98636eb2008-05-09 17:59:34 +000076#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +020077# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000078#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000079
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000080#include <pwd.h>
81#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000082#if ENABLE_FEATURE_SHADOWPASSWDS
Mike Frysinger52a42672009-07-09 01:33:20 -040083# if !ENABLE_USE_BB_SHADOW
84/* If using busybox's shadow implementation, do not include the shadow.h
85 * header as the toolchain may not provide it at all.
86 */
87# include <shadow.h>
88# endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000089#endif
90
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +000091/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +000092
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +000093extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000094#if defined(__GLIBC__) && __GLIBC__ < 2
95int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000096#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000097/* klogctl is in libc's klog.h, but we cheat and not #include that */
98int klogctl(int type, char *b, int len);
99/* This is declared here rather than #including <libgen.h> in order to avoid
100 * confusing the two versions of basename. See the dirname/basename man page
101 * for details. */
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200102#if !defined __FreeBSD__
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000103char *dirname(char *path);
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200104#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000105/* Include our own copy of struct sysinfo to avoid binary compatibility
106 * problems with Linux 2.4, which changed things. Grumble, grumble. */
107struct sysinfo {
108 long uptime; /* Seconds since boot */
109 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
110 unsigned long totalram; /* Total usable main memory size */
111 unsigned long freeram; /* Available memory size */
112 unsigned long sharedram; /* Amount of shared memory */
113 unsigned long bufferram; /* Memory used by buffers */
114 unsigned long totalswap; /* Total swap space size */
115 unsigned long freeswap; /* swap space still available */
116 unsigned short procs; /* Number of current processes */
117 unsigned short pad; /* Padding needed for m68k */
118 unsigned long totalhigh; /* Total high memory size */
119 unsigned long freehigh; /* Available high memory size */
120 unsigned int mem_unit; /* Memory unit size in bytes */
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000121 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000122};
123int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +0000124
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000125
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000126/* Make all declarations hidden (-fvisibility flag only affects definitions) */
127/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000128PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000129
130
131#if ENABLE_USE_BB_PWD_GRP
132# include "pwd_.h"
133# include "grp_.h"
134#endif
135#if ENABLE_FEATURE_SHADOWPASSWDS
136# if ENABLE_USE_BB_SHADOW
137# include "shadow_.h"
138# endif
139#endif
140
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000141/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000142#define MAXINT(T) (T)( \
143 ((T)-1) > 0 \
144 ? (T)-1 \
145 : (T)~((T)1 << (sizeof(T)*8-1)) \
146 )
147
148#define MININT(T) (T)( \
149 ((T)-1) > 0 \
150 ? (T)0 \
151 : ((T)1 << (sizeof(T)*8-1)) \
152 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000153
Denis Vlasenko56254152006-10-07 16:24:46 +0000154/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000155/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000156 * (stat, lseek etc) mapped to "largefile" variants by libc.
157 * Practically it means that open() automatically has O_LARGEFILE added
158 * and all filesize/file_offset parameters and struct members are "large"
159 * (in today's world - signed 64bit). For full support of large files,
160 * we need a few helper #defines (below) and careful use of off_t
161 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000162#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000163/* CONFIG_LFS is on */
164# if ULONG_MAX > 0xffffffff
165/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000166typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000167# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000168/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
169# define BB_STRTOOFF bb_strtoul
170# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000171/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
172# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000173# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000174/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000175typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000176# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000177# define BB_STRTOOFF bb_strtoull
178# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000179# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000180# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000181#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000182/* CONFIG_LFS is off */
183# if UINT_MAX == 0xffffffff
184/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
185 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000186typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000187# define XATOOFF(a) xatoi_u(a)
188# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000189# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000190# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000191# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000192typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000193# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
194# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000195# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000196# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000197# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000198#endif
199/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000200#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000201
Eric Andersenaad1a882001-03-16 22:47:14 +0000202/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000203#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000204#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000205#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000206#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000207#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000208#define SKIP ((int) 2)
209
210/* for mtab.c */
211#define MTAB_GETMOUNTPT '1'
212#define MTAB_GETDEVICE '2'
213
214#define BUF_SIZE 8192
215#define EXPAND_ALLOC 1024
216
Eric Andersenaad1a882001-03-16 22:47:14 +0000217/* Macros for min/max. */
218#ifndef MIN
219#define MIN(a,b) (((a)<(b))?(a):(b))
220#endif
221
222#ifndef MAX
223#define MAX(a,b) (((a)>(b))?(a):(b))
224#endif
225
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000226/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000227#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000228#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000229#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
230#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
231#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000232#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000233#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
234#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
235#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
236#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000237#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
238#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
239#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000240#endif
241#endif
242
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000243#if defined(__GLIBC__)
244/* glibc uses __errno_location() to get a ptr to errno */
245/* We can just memorize it once - no multithreading in busybox :) */
246extern int *const bb_errno;
247#undef errno
248#define errno (*bb_errno)
249#endif
250
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000251unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000252unsigned long long monotonic_us(void) FAST_FUNC;
253unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000254
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000255extern void chomp(char *s) FAST_FUNC;
256extern void trim(char *s) FAST_FUNC;
257extern char *skip_whitespace(const char *) FAST_FUNC;
258extern char *skip_non_whitespace(const char *) FAST_FUNC;
259extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000260
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000261//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000262extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
263extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000264enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
265 FILEUTILS_PRESERVE_STATUS = 1,
266 FILEUTILS_DEREFERENCE = 2,
267 FILEUTILS_RECUR = 4,
268 FILEUTILS_FORCE = 8,
269 FILEUTILS_INTERACTIVE = 0x10,
270 FILEUTILS_MAKE_HARDLINK = 0x20,
271 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000272 FILEUTILS_DEREF_SOFTLINK = 0x80,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000273#if ENABLE_SELINUX
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000274 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
275 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000276#endif
277};
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000278#define FILEUTILS_CP_OPTSTR "pdRfilsL" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000279extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000280/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
281 * the source, not copy (unless "source" is a directory).
282 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
283 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000284extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000285
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000286enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000287 ACTION_RECURSE = (1 << 0),
288 ACTION_FOLLOWLINKS = (1 << 1),
289 ACTION_FOLLOWLINKS_L0 = (1 << 2),
290 ACTION_DEPTHFIRST = (1 << 3),
291 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000292 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200293 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000294};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200295typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000296extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000297 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
298 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
299 void* userData, unsigned depth) FAST_FUNC;
300extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000301enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000302extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000303extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000304extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
305extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000306/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000307extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
308extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
309extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000310/* "short" copy can be detected by return value < size */
311/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000312extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000313extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000314/* xxxx_strip version can modify its parameter:
315 * "/" -> "/"
316 * "abc" -> "abc"
317 * "abc/def" -> "def"
318 * "abc/def/" -> "def" !!
319 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000320extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000321/* "abc/def/" -> "" and it never modifies 'path' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000322extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000323
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000324int ndelay_on(int fd) FAST_FUNC;
325int ndelay_off(int fd) FAST_FUNC;
326int close_on_exec_on(int fd) FAST_FUNC;
327void xdup2(int, int) FAST_FUNC;
328void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000329
330
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000331DIR *xopendir(const char *path) FAST_FUNC;
332DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000333
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100334/* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC; */
335char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
336char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100337/* !RETURNS_MALLOC: it's a realloc-like function */
338char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000339
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100340char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000341
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000342
Denis Vlasenko33196372008-02-23 01:25:38 +0000343enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000344 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000345 * otherwise would kill us, except for those resulting from bugs:
346 * SIGSEGV, SIGILL, SIGFPE.
347 * Other fatal signals not included (TODO?):
348 * SIGBUS Bus error (bad memory access)
349 * SIGPOLL Pollable event. Synonym of SIGIO
350 * SIGPROF Profiling timer expired
351 * SIGSYS Bad argument to routine
352 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000353 *
354 * The only known arch with some of these sigs not fitting
355 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
356 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000357 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000358 BB_FATAL_SIGS = (int)(0
359 + (1LL << SIGHUP)
360 + (1LL << SIGINT)
361 + (1LL << SIGTERM)
362 + (1LL << SIGPIPE) // Write to pipe with no readers
363 + (1LL << SIGQUIT) // Quit from keyboard
364 + (1LL << SIGABRT) // Abort signal from abort(3)
365 + (1LL << SIGALRM) // Timer signal from alarm(2)
366 + (1LL << SIGVTALRM) // Virtual alarm clock
367 + (1LL << SIGXCPU) // CPU time limit exceeded
368 + (1LL << SIGXFSZ) // File size limit exceeded
369 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
370 + (1LL << SIGUSR2)
371 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000372};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000373void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000374/* Unlike signal() and bb_signals, sets handler with sigaction()
375 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000376 * will be blocked; syscalls will not be restarted: */
377void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000378/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000379void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000380/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000381void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
382void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000383void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000384void sig_block(int sig) FAST_FUNC;
385void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000386/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000387int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000388/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000389int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000390/* Standard handler which just records signo */
391extern smallint bb_got_signal;
392void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000393
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000394
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000395void xsetgid(gid_t gid) FAST_FUNC;
396void xsetuid(uid_t uid) FAST_FUNC;
397void xchdir(const char *path) FAST_FUNC;
398void xchroot(const char *path) FAST_FUNC;
399void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000400void bb_unsetenv(const char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000401void xunlink(const char *pathname) FAST_FUNC;
402void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200403int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100404int xopen_nonblocking(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000405int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
406int open_or_warn(const char *pathname, int flags) FAST_FUNC;
407int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
408int open_or_warn_stdin(const char *pathname) FAST_FUNC;
409void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
410int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
411off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
412off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000413
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000414void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000415/* In this form code with pipes is much more readable */
416struct fd_pair { int rd; int wr; };
417#define piped_pair(pair) pipe(&((pair).rd))
418#define xpiped_pair(pair) xpipe(&((pair).rd))
419
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000420/* Useful for having small structure members/global variables */
421typedef int8_t socktype_t;
422typedef int8_t family_t;
423struct BUG_too_small {
424 char BUG_socktype_t_too_small[(0
425 | SOCK_STREAM
426 | SOCK_DGRAM
427 | SOCK_RDM
428 | SOCK_SEQPACKET
429 | SOCK_RAW
430 ) <= 127 ? 1 : -1];
431 char BUG_family_t_too_small[(0
432 | AF_UNSPEC
433 | AF_INET
434 | AF_INET6
435 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000436#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000437 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000438#endif
439#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000440 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000441#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000442 /* | AF_DECnet */
443 /* | AF_IPX */
444 ) <= 127 ? 1 : -1];
445};
446
447
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200448void parse_datestr(const char *date_str, struct tm *tm_time) FAST_FUNC;
Denys Vlasenko7aca89a2009-07-18 03:41:29 +0200449time_t validate_tm_time(const char *date_str, struct tm *tm_time) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200450
451
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000452int xsocket(int domain, int type, int protocol) FAST_FUNC;
453void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
454void xlisten(int s, int backlog) FAST_FUNC;
455void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000456ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000457 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000458/* SO_REUSEADDR allows a server to rebind to an address that is already
459 * "in use" by old connections to e.g. previous server instance which is
460 * killed or crashed. Without it bind will fail until all such connections
461 * time out. Linux does not allow multiple live binds on same ip:port
462 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
463 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000464void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
465int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000466int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000467/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000468unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000469typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000470 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000471 union {
472 struct sockaddr sa;
473 struct sockaddr_in sin;
474#if ENABLE_FEATURE_IPV6
475 struct sockaddr_in6 sin6;
476#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000477 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000478} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000479enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000480 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000481 LSA_SIZEOF_SA = sizeof(
482 union {
483 struct sockaddr sa;
484 struct sockaddr_in sin;
485#if ENABLE_FEATURE_IPV6
486 struct sockaddr_in6 sin6;
487#endif
488 }
489 )
490};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000491/* Create stream socket, and allocate suitable lsa.
492 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000493 * af == AF_UNSPEC will result in trying to create IPv6 socket,
494 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000495 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000496#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000497int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000498#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000499int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000500#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
501#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000502int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000503/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000504 * numeric IP ("N.N.N.N") or numeric IPv6 address,
505 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000506 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000507/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000508int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
509int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000510/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
511 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
512 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
513 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000514int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000515/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000516int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000517/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100518len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000519/* Return malloc'ed len_and_sockaddr with socket address of host:port
520 * Currently will return IPv4 or IPv6 sockaddrs only
521 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000522 * UNIX socket address being returned, IPX sockaddr etc...
523 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100524len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000525/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100526len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
527len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000528/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000529#if !ENABLE_FEATURE_IPV6
530#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
531#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
532#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100533len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
534len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000535#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000536/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000537 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000538 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000539void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000540/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000541int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000542/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100543char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000544/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100545char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000546/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100547char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000548/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100549char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
550char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000551// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000552// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000553struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000554// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000555// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000556
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000557
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000558void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000559ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000560 const struct sockaddr *to,
561 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000562 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000563ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000564 struct sockaddr *from,
565 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000566 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000567
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100568
569char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
570char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000571void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000572char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000573char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000574/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000575 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000576int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100577char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000578/* Prints unprintable chars ch as ^C or M-c to file
579 * (M-c is used only if ch is ORed with PRINTABLE_META),
580 * else it is printed as-is (except for ch = 0x9b) */
581enum { PRINTABLE_META = 0x100 };
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000582void fputc_printable(int ch, FILE *file) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000583// gcc-4.1.1 still isn't good enough at optimizing it
584// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000585//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000586//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000587//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000588//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000589#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000590#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000591#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000592#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000593#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000594
595/* dmalloc will redefine these to it's own implementation. It is safe
596 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100597void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
598void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
599void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000600void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000601/* After xrealloc_vector(v, 4, idx) it's ok to use
602 * at least v[idx] and v[idx+1], for all idx values.
603 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
604 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000605#define xrealloc_vector(vector, shift, idx) \
606 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
607void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
608
Eric Andersenaad1a882001-03-16 22:47:14 +0000609
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000610extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
611extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000612// NB: will return short read on error, not -1,
613// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000614extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
615extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
616extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000617extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
618extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000619// Reads one line a-la fgets (but doesn't save terminating '\n').
620// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000621// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100622extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000623/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100624extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000625/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100626extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000627/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000628extern int open_zipped(const char *fname) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100629extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000630/* Never returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100631extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000632
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000633extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000634// NB: will return short write on error, not -1,
635// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000636extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
637extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000638extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000639extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000640
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200641/* Close fd, but check for failures (some types of write errors) */
642extern void xclose(int fd) FAST_FUNC;
643
Denis Vlasenko1de08302006-10-26 23:32:43 +0000644/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000645extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000646
647extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenko69f4f9a2008-08-09 17:16:40 +0000648extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000649/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100650extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000651/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100652extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000653/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100654extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000655/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100656extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000657/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100658extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000659/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100660/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000661
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000662extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
663extern void die_if_ferror_stdout(void) FAST_FUNC;
Denys Vlasenko8131eea2009-11-02 14:19:51 +0100664extern int fflush_all(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000665extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000666extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
667extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000668/* Prints warning to stderr and returns NULL on failure: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000669extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000670/* "Opens" stdin if filename is special, else just opens file: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000671extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
672extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +0000673extern FILE* fopen_for_read(const char *path) FAST_FUNC;
674extern FILE* xfopen_for_read(const char *path) FAST_FUNC;
675extern FILE* fopen_for_write(const char *path) FAST_FUNC;
676extern FILE* xfopen_for_write(const char *path) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000677
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000678int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
679void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000680
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000681/* Wrapper which restarts poll on EINTR or ENOMEM.
682 * On other errors complains [perror("poll")] and returns.
683 * Warning! May take (much) longer than timeout_ms to return!
684 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000685int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000686
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000687char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000688char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000689
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000690/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000691char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000692
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000693char *utoa(unsigned n) FAST_FUNC;
694char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000695/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000696char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
697char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000698/* Intelligent formatters of bignums */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000699void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
700void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200701/* If block_size == 0, display size without fractional part,
702 * else display (size * block_size) with one decimal digit.
703 * If display_unit == 0, add suffix (K,M,G...),
704 * else divide by display_unit and do not use suffix. */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000705//TODO: provide pointer to buf (avoid statics)?
706const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000707 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000708/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000709char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000710
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200711/* Generate a UUID */
712void generate_uuid(uint8_t *buf) FAST_FUNC;
713
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000714/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000715struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000716 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000717 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000718};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000719#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000720/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000721/* Using xatoi() instead of naive atoi() is not always convenient -
722 * in many places people want *non-negative* values, but store them
723 * in signed int. Therefore we need this one:
724 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000725int xatoi_u(const char *numstr) FAST_FUNC;
Denis Vlasenko13858992006-10-08 12:49:22 +0000726/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000727uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000728
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000729
Eric Andersenaad1a882001-03-16 22:47:14 +0000730/* These parse entries in /etc/passwd and /etc/group. This is desirable
731 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000732 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000733long xuname2uid(const char *name) FAST_FUNC;
734long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000735/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000736unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000737/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000738struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000739 uid_t uid;
740 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000741};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000742/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000743int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000744/* always sets uid and gid, allows numeric; exits on failure */
745void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000746/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000747void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000748struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000749struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000750struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
751struct group* xgetgrgid(gid_t gid) FAST_FUNC;
752char* xuid2uname(uid_t uid) FAST_FUNC;
753char* xgid2group(gid_t gid) FAST_FUNC;
754char* uid2uname(uid_t uid) FAST_FUNC;
755char* gid2group(gid_t gid) FAST_FUNC;
756char* uid2uname_utoa(long uid) FAST_FUNC;
757char* gid2group_utoa(long gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000758/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000759const char* get_cached_username(uid_t uid) FAST_FUNC;
760const char* get_cached_groupname(gid_t gid) FAST_FUNC;
761void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000762/* internally usernames are saved in fixed-sized char[] buffers */
763enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000764#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000765void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000766#else
767#define die_if_bad_username(name) ((void)(name))
768#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000769
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000770int execable_file(const char *name) FAST_FUNC;
771char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
772int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000773
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000774/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
775 * but it may exec busybox and call applet instead of searching PATH.
776 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000777#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000778int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000779#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
780#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000781 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000782 cmd, __VA_ARGS__)
783#else
784#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
785#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
786#endif
787
788/* NOMMU friendy fork+exec */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000789pid_t spawn(char **argv) FAST_FUNC;
790pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000791
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000792pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000793/* Unlike waitpid, waits ONLY for one process.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000794 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000795 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000796 * IOW: rc = wait4pid(spawn(argv));
797 * if (rc < 0) bb_perror_msg("%s", argv[0]);
798 * if (rc > 0) bb_error_msg("exit code: %d", rc);
799 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000800int wait4pid(pid_t pid) FAST_FUNC;
801pid_t wait_any_nohang(int *wstat) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000802/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200803int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000804struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000805 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000806 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000807 int xfunc_error_retval;
808 uint32_t option_mask32;
809 int die_sleep;
810 smallint saved;
811};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000812void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
813void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000814/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000815int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
816int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000817
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000818/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000819 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000820 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000821 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000822 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
823 * rexec's itself on NOMMU with argv passed as command line.
824 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
825 * from the start. (It will detect it and not reexec again second time).
826 * You have to audit carefully that you don't do something twice as a result
827 * (opening files/sockets, parsing config files etc...)!
828 *
829 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
830 * (will do setsid()).
831 *
Denis Vlasenko83518d12009-03-20 22:17:13 +0000832 * fork_or_rexec(argv) = bare-bones "fork" on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000833 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000834 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000835 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000836 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000837 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000838 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
839 * to /dev/null if they are not.
840 */
841enum {
842 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000843 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000844 DAEMON_CLOSE_EXTRA_FDS = 4,
845 DAEMON_ONLY_SANITIZE = 8, /* internal use */
846};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000847#if BB_MMU
Denis Vlasenko83518d12009-03-20 22:17:13 +0000848 pid_t fork_or_rexec(void) FAST_FUNC;
Denis Vlasenko367960b2007-08-18 14:20:21 +0000849 enum { re_execed = 0 };
Denis Vlasenko83518d12009-03-20 22:17:13 +0000850# define fork_or_rexec(argv) fork_or_rexec()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000851# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
852# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000853#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000854 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000855 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000856 extern bool re_execed;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000857 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
858 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
859 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000860# define fork() BUG_fork_is_unavailable_on_nommu()
861# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
862# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000863#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000864void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
865void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000866/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000867int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000868
869
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000870extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000871extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200872#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000873#define No_argument "\0"
874#define Required_argument "\001"
875#define Optional_argument "\002"
876extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000877#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000878extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000879extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000880
881
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000882typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000883 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000884 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000885} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000886void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
887void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
888void *llist_pop(llist_t **elm) FAST_FUNC;
889void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
890void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
891llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +0000892llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000893/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000894 * llist_t *llist_add_to(llist_t *old_head, void *data)
895 * etc does not result in smaller code... */
896
Denis Vlasenko80edead2007-08-02 22:31:05 +0000897/* start_stop_daemon and udhcpc are special - they want
898 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000899#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000900/* True only if we created pidfile which is *file*, not /dev/null etc */
901extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000902void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000903#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000904#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000905enum { wrote_pidfile = 0 };
906#define write_pidfile(path) ((void)0)
907#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000908#endif
909
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000910enum {
911 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000912 LOGMODE_STDIO = (1 << 0),
913 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000914 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
915};
916extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000917extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000918extern int die_sleep;
919extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000920extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000921extern void xfunc_die(void) NORETURN FAST_FUNC;
922extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000923extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
924extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
925extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
926extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
927extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +0000928extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000929extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
930extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000931extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000932extern void bb_perror_nomsg(void) FAST_FUNC;
933extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
934extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000935
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000936/* We need to export XXX_main from libbusybox
937 * only if we build "individual" binaries
938 */
939#if ENABLE_FEATURE_INDIVIDUAL
940#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
941#else
942#define MAIN_EXTERNALLY_VISIBLE
943#endif
944
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000945
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000946/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000947int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000948/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000949int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
950int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
951int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
952int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000953/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000954int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +0000955/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000956int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
957/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000958int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000959int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +0000960
Denis Vlasenko468aea22008-04-01 14:47:57 +0000961#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000962void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +0000963#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000964
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000965
966/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000967int create_icmp_socket(void) FAST_FUNC;
968int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000969/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000970/* This structure defines protocol families and their handlers. */
971struct aftype {
972 const char *name;
973 const char *title;
974 int af;
975 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000976 char* FAST_FUNC (*print)(unsigned char *);
977 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
978 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
979 void FAST_FUNC (*herror)(char *text);
980 int FAST_FUNC (*rprint)(int options);
981 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000982 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000983 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000984};
985/* This structure defines hardware protocols and their handlers. */
986struct hwtype {
987 const char *name;
988 const char *title;
989 int type;
990 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000991 char* FAST_FUNC (*print)(unsigned char *);
992 int FAST_FUNC (*input)(const char *, struct sockaddr *);
993 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000994 int suppress_null_addr;
995};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000996extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000997int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000998#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000999int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001000#else
1001#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001002#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001003const struct aftype *get_aftype(const char *name) FAST_FUNC;
1004const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1005const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001006
1007
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001008#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001009extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001010/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001011extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001012extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001013#endif
1014
Mike Frysinger9412ec72008-02-07 22:41:33 +00001015#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001016extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001017extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001018#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001019extern void erase_mtab(const char * name) FAST_FUNC;
1020extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1021extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1022extern void bb_warn_ignoring_args(int n) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001023
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001024extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001025
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001026extern char *query_loop(const char *device) FAST_FUNC;
1027extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001028/* If *devname is not NULL, use that name, otherwise try to find free one,
1029 * malloc and return it in *devname.
1030 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001031extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001032
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001033/* Like bb_ask below, but asks on stdin with no timeout. */
1034char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001035//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001036char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001037int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001038
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001039int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001040
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001041/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001042 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001043 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001044enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001045 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1046 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1047// TODO: COLLAPSE and TRIM seem to always go in pair
1048 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1049 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001050 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001051 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001052// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1053 // NORMAL is:
1054 // * remove leading and trailing delimiters and collapse
1055 // multiple delimiters into one
1056 // * warn and continue if less than mintokens delimiters found
1057 // * grab everything into last token
1058 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001059};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001060typedef struct parser_t {
1061 FILE *fp;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001062 char *line;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001063 char *data;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001064 int lineno;
1065} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001066parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001067parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001068int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1069#define config_read(parser, tokens, max, min, str, flags) \
1070 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001071void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001072
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001073/* Concatenate path and filename to new allocated buffer.
1074 * Add "/" only as needed (no duplicate "//" are produced).
1075 * If path is NULL, it is assumed to be "/".
1076 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001077char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1078char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1079const char *bb_basename(const char *name) FAST_FUNC;
Denis Vlasenko7e84e532007-05-08 17:52:17 +00001080/* NB: can violate const-ness (similarly to strchr) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001081char *last_char_is(const char *s, int c) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001082
Denis Vlasenko4921b542007-02-03 02:17:41 +00001083
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001084int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001085
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001086int get_signum(const char *name) FAST_FUNC;
1087const char *get_signame(int number) FAST_FUNC;
1088void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001089
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001090char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001091/* Returns ptr to NUL */
1092char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001093
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001094#define FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001095extern void bb_do_delay(int seconds) FAST_FUNC;
1096extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001097extern 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 +00001098extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001099#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001100extern void renew_current_security_context(void) FAST_FUNC;
1101extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001102extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001103 char *user, char *role, char *type, char *range) FAST_FUNC;
1104extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1105extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001106#else
1107#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001108#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001109extern void selinux_or_die(void) FAST_FUNC;
1110extern int restricted_shell(const char *shell) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001111
1112/* setup_environment:
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001113 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001114 * TERM=(old value)
1115 * USER=pw->pw_name, LOGNAME=pw->pw_name
1116 * PATH=bb_default_[root_]path
1117 * HOME=pw->pw_dir
1118 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001119 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001120 * if not root (if pw->pw_uid != 0):
1121 * USER=pw->pw_name, LOGNAME=pw->pw_name
1122 * HOME=pw->pw_dir
1123 * SHELL=shell
1124 * else does nothing
1125 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001126extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw) FAST_FUNC;
1127extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001128/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001129#if !ENABLE_USE_BB_CRYPT
1130#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1131#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001132extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1133extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001134/* rnd is additional random input. New one is returned.
1135 * Useful if you call crypt_make_salt many times in a row:
1136 * rnd = crypt_make_salt(buf1, 4, 0);
1137 * rnd = crypt_make_salt(buf2, 4, rnd);
1138 * rnd = crypt_make_salt(buf3, 4, rnd);
1139 * (otherwise we risk having same salt generated)
1140 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001141extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001142
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001143/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001144#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1145#define update_passwd(filename, username, data, member) \
1146 update_passwd(filename, username, data)
1147#endif
1148extern int update_passwd(const char *filename,
1149 const char *username,
1150 const char *data,
1151 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001152
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001153int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1154int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1155int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1156int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1157const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001158
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001159extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1160extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001161
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001162char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001163/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001164int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001165
Denis Vlasenko202ac502008-11-05 13:20:58 +00001166int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1167
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001168/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001169int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1170int 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 +00001171#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001172int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1173int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001174#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1175#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1176#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001177int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1178int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001179#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1180#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1181#endif
1182
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001183char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1184void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1185void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001186#ifdef __GLIBC__
1187/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001188unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001189#undef makedev
1190#define makedev(a,b) bb_makedev(a,b)
1191#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001192
1193
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001194/* "Keycodes" that report an escape sequence.
1195 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001196 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001197 * Also, -1 is reserved for error indication and we don't use it. */
1198enum {
1199 KEYCODE_UP = -2,
1200 KEYCODE_DOWN = -3,
1201 KEYCODE_RIGHT = -4,
1202 KEYCODE_LEFT = -5,
1203 KEYCODE_HOME = -6,
1204 KEYCODE_END = -7,
1205 KEYCODE_INSERT = -8,
1206 KEYCODE_DELETE = -9,
1207 KEYCODE_PAGEUP = -10,
1208 KEYCODE_PAGEDOWN = -11,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001209
1210 KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1211 KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1212 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1213 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001214#if 0
1215 KEYCODE_FUN1 = -12,
1216 KEYCODE_FUN2 = -13,
1217 KEYCODE_FUN3 = -14,
1218 KEYCODE_FUN4 = -15,
1219 KEYCODE_FUN5 = -16,
1220 KEYCODE_FUN6 = -17,
1221 KEYCODE_FUN7 = -18,
1222 KEYCODE_FUN8 = -19,
1223 KEYCODE_FUN9 = -20,
1224 KEYCODE_FUN10 = -21,
1225 KEYCODE_FUN11 = -22,
1226 KEYCODE_FUN12 = -23,
1227#endif
Denys Vlasenko180f5852009-10-26 00:59:59 +01001228 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001229 /* How long is the longest ESC sequence we know?
1230 * We want it big enough to be able to contain
1231 * cursor position sequence "ESC [ 9999 ; 9999 R"
1232 */
1233 KEYCODE_BUFFER_SIZE = 16
1234};
1235/* Note: fd may be in blocking or non-blocking mode, both make sense.
1236 * For one, less uses non-blocking mode.
1237 * Only the first read syscall inside read_key may block indefinitely
1238 * (unless fd is in non-blocking mode),
1239 * subsequent reads will time out after a few milliseconds.
1240 * Return of -1 means EOF or error (errno == 0 on EOF).
1241 * buffer[0] is used as a counter of buffered chars and must be 0
1242 * on first call.
1243 */
1244int64_t read_key(int fd, char *buffer) FAST_FUNC;
1245
1246
Denis Vlasenko38f63192007-01-22 09:03:07 +00001247#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001248/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001249# ifdef CONFIG_FEATURE_EDITING_HISTORY
1250# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1251# else
1252# define MAX_HISTORY 0
1253# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001254typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001255 int flags;
1256 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001257# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001258 int cnt_history;
1259 int cur_history;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001260# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001261 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001262 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001263# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001264 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001265# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001266} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001267enum {
1268 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001269 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1270 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1271 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1272 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001273 WITH_PATH_LOOKUP = 0x20,
1274 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1275};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001276line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001277/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1278/* maxsize must be >= 2.
1279 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001280 * -1 on read errors or EOF, or on bare Ctrl-D,
1281 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001282 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001283 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001284int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001285#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001286#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001287int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001288#define read_line_input(prompt, command, maxsize, state) \
1289 read_line_input(prompt, command, maxsize)
1290#endif
1291
1292
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001293#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001294# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001295enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001296# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001297/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001298enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001299# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001300#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001301typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001302 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001303 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001304 uint8_t shift_pages_to_bytes;
1305 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001306/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001307 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001308 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001309 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001310 IF_SELINUX(char *context;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001311 /* Everything below must contain no ptrs to malloc'ed data:
1312 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001313 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001314 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001315 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001316 unsigned pid;
1317 unsigned ppid;
1318 unsigned pgid;
1319 unsigned sid;
1320 unsigned uid;
1321 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001322#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1323 unsigned ruid;
1324 unsigned rgid;
1325 int niceness;
1326#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001327 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001328#if ENABLE_FEATURE_TOPMEM
1329 unsigned long mapped_rw;
1330 unsigned long mapped_ro;
1331 unsigned long shared_clean;
1332 unsigned long shared_dirty;
1333 unsigned long private_clean;
1334 unsigned long private_dirty;
1335 unsigned long stack;
1336#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001337 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001338 /* basename of executable in exec(2), read from /proc/N/stat
1339 * (if executable is symlink or script, it is NOT replaced
1340 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001341 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001342 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001343#if ENABLE_FEATURE_TOP_SMP_PROCESS
1344 int last_seen_on_cpu;
1345#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001346} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001347/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001348enum {
1349 PSSCAN_PID = 1 << 0,
1350 PSSCAN_PPID = 1 << 1,
1351 PSSCAN_PGID = 1 << 2,
1352 PSSCAN_SID = 1 << 3,
1353 PSSCAN_UIDGID = 1 << 4,
1354 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001355 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001356 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001357 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001358 PSSCAN_STATE = 1 << 9,
1359 PSSCAN_VSZ = 1 << 10,
1360 PSSCAN_RSS = 1 << 11,
1361 PSSCAN_STIME = 1 << 12,
1362 PSSCAN_UTIME = 1 << 13,
1363 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001364 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001365 /* NB: used by find_pid_by_name(). Any applet using it
1366 * needs to be mentioned here. */
1367 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1368 || ENABLE_PGREP || ENABLE_PKILL
1369 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001370 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001371 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001372 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001373 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001374 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1375 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1376 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001377 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001378 /* These are all retrieved from proc/NN/stat in one go: */
1379 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001380 /**/ | PSSCAN_COMM | PSSCAN_STATE
1381 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1382 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001383 /**/ | PSSCAN_TTY | PSSCAN_NICE
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001384 /**/ | PSSCAN_CPU
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001385};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001386//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1387void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1388procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001389/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001390/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001391void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001392pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1393pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001394
1395
1396extern const char bb_uuenc_tbl_base64[];
1397extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001398void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001399
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001400typedef struct sha1_ctx_t {
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001401 uint32_t hash[8]; /* 5, +3 elements for sha256 */
Denis Vlasenko98c87f72009-03-11 21:15:51 +00001402 uint64_t total64;
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001403 uint8_t wbuffer[64]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko8ec8d5e2009-03-15 02:56:00 +00001404 void (*process_block)(struct sha1_ctx_t*) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001405} sha1_ctx_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001406void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1407void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001408void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001409typedef struct sha1_ctx_t sha256_ctx_t;
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001410void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001411#define sha256_hash sha1_hash
1412#define sha256_end sha1_end
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001413typedef struct sha512_ctx_t {
Denis Vlasenkocd2cd312009-03-12 15:40:27 +00001414 uint64_t hash[8];
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001415 uint64_t total64[2];
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001416 uint8_t wbuffer[128]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001417} sha512_ctx_t;
1418void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1419void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001420void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1421#if 1
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001422typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001423 uint32_t A;
1424 uint32_t B;
1425 uint32_t C;
1426 uint32_t D;
1427 uint64_t total;
1428 uint32_t buflen;
1429 char buffer[128];
1430} md5_ctx_t;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001431#else
1432/* libbb/md5prime.c uses a bit different one: */
1433typedef struct md5_ctx_t {
1434 uint32_t state[4]; /* state (ABCD) */
1435 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1436 unsigned char buffer[64]; /* input buffer */
1437} md5_ctx_t;
1438#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001439void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1440void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001441void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1442
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001443
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001444uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1445
1446typedef struct masks_labels_t {
1447 const char *labels;
1448 const int masks[];
1449} masks_labels_t;
1450int print_flags_separated(const int *masks, const char *labels,
1451 int flags, const char *separator) FAST_FUNC;
1452int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001453
Magnus Dammf5914992009-11-08 16:34:43 +01001454typedef struct bb_progress_t {
1455 off_t lastsize;
1456 unsigned lastupdate_sec;
1457 unsigned start_sec;
1458} bb_progress_t;
1459
1460void bb_progress_init(bb_progress_t *p) FAST_FUNC;
1461void bb_progress_update(bb_progress_t *p, const char *curfile,
1462 off_t beg_range, off_t transferred,
1463 off_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001464
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001465extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001466/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001467extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001468extern const char bb_msg_memory_exhausted[];
1469extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001470extern const char bb_msg_read_error[];
1471extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001472extern const char bb_msg_unknown[];
1473extern const char bb_msg_can_not_create_raw_socket[];
1474extern const char bb_msg_perm_denied_are_you_root[];
1475extern const char bb_msg_requires_arg[];
1476extern const char bb_msg_invalid_arg[];
1477extern const char bb_msg_standard_input[];
1478extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001479
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001480extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001481/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001482extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001483
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001484extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001485extern const char bb_path_passwd_file[];
1486extern const char bb_path_shadow_file[];
1487extern const char bb_path_gshadow_file[];
1488extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001489extern const char bb_path_motd_file[];
1490extern const char bb_path_wtmp_file[];
1491extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001492extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001493/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1494 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001495extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1496#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1497#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001498
Denis Vlasenko703e2022007-01-22 14:12:08 +00001499extern const int const_int_0;
1500extern const int const_int_1;
1501
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001502
Denis Vlasenko85818632007-04-19 14:47:11 +00001503/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001504enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1505extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001506/* This struct is deliberately not defined. */
1507/* See docs/keep_data_small.txt */
1508struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001509/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001510 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001511 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001512extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001513/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001514#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001515#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001516 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001517 barrier(); \
1518} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001519
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001520/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1521 * use bb_default_login_shell and following defines.
1522 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1523 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001524#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001525extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001526/* "/bin/sh" */
1527#define DEFAULT_SHELL (bb_default_login_shell+1)
1528/* "sh" */
1529#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1530
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001531#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001532# define CURRENT_VC "/dev/vc/0"
1533# define VC_1 "/dev/vc/1"
1534# define VC_2 "/dev/vc/2"
1535# define VC_3 "/dev/vc/3"
1536# define VC_4 "/dev/vc/4"
1537# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001538#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1539/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1540 respective serial ports .. as such, we can't use the common device paths for
1541 these. -- PFM */
1542# define SC_0 "/dev/ttsc/0"
1543# define SC_1 "/dev/ttsc/1"
1544# define SC_FORMAT "/dev/ttsc/%d"
1545#else
1546# define SC_0 "/dev/tts/0"
1547# define SC_1 "/dev/tts/1"
1548# define SC_FORMAT "/dev/tts/%d"
1549#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001550# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001551# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001552# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001553# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001554# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001555#else
1556# define CURRENT_VC "/dev/tty0"
1557# define VC_1 "/dev/tty1"
1558# define VC_2 "/dev/tty2"
1559# define VC_3 "/dev/tty3"
1560# define VC_4 "/dev/tty4"
1561# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001562#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1563# define SC_0 "/dev/ttySC0"
1564# define SC_1 "/dev/ttySC1"
1565# define SC_FORMAT "/dev/ttySC%d"
1566#else
1567# define SC_0 "/dev/ttyS0"
1568# define SC_1 "/dev/ttyS1"
1569# define SC_FORMAT "/dev/ttyS%d"
1570#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001571# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001572# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001573# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001574# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001575# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001576#endif
1577
1578/* The following devices are the same on devfs and non-devfs systems. */
1579#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001580#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001581
Rob Landleyc57ec372006-04-10 17:07:15 +00001582
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001583#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1584
Rob Landleyb623a542006-05-31 22:09:03 +00001585
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001586/* We redefine ctype macros. Unicode-correct handling of char types
1587 * can't be done with such byte-oriented operations anyway,
1588 * we don't lose anything.
1589 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001590#undef isalnum
1591#undef isalpha
1592#undef isascii
1593#undef isblank
1594#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001595#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001596#undef isgraph
1597#undef islower
1598#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001599#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001600#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001601#undef isupper
1602#undef isxdigit
1603#undef toupper
1604#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001605
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001606/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001607 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001608#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001609#define isascii(a) ((unsigned char)(a) <= 0x7f)
1610#define isgraph(a) ((unsigned char)(a) > ' ')
1611#define isprint(a) ((unsigned char)(a) >= ' ')
1612#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1613#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001614#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001615#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1616#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001617/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001618 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001619 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001620#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko11c12c42009-10-23 13:57:24 +02001621
1622// Bigger code:
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001623//#define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
Denys Vlasenko11c12c42009-10-23 13:57:24 +02001624#define isalnum(a) bb_ascii_isalnum(a)
1625static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1626{
1627 unsigned char b = a - '0';
1628 if (b <= 9)
1629 return (b <= 9);
1630 b = (a|0x20) - 'a';
1631 return b <= 'z' - 'a';
1632}
1633#define isxdigit(a) bb_ascii_isxdigit(a)
1634static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1635{
1636 unsigned char b = a - '0';
1637 if (b <= 9)
1638 return (b <= 9);
1639 b = (a|0x20) - 'a';
1640 return b <= 'f' - 'a';
1641}
1642
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001643// Unsafe wrt NUL!
1644//#define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1645#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1646
1647#define toupper(a) bb_ascii_toupper(a)
1648static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1649{
1650 unsigned char b = a - 'a';
1651 if (b <= ('z' - 'a'))
1652 a -= 'a' - 'A';
1653 return a;
1654}
1655#define tolower(a) bb_ascii_tolower(a)
1656static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1657{
1658 unsigned char b = a - 'A';
1659 if (b <= ('Z' - 'A'))
1660 a += 'a' - 'A';
1661 return a;
1662}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001663
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001664
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001665POP_SAVED_FUNCTION_VISIBILITY
1666
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001667#endif