blob: c5b685985e91dd504a60a2159631cca0bfe22d57 [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Eric Andersenaad1a882001-03-16 22:47:14 +00006 * Permission has been granted to redistribute this code under the GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Rob Landleyeb84a422006-09-20 21:41:13 +00008 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +000010#ifndef __LIBBUSYBOX_H__
11#define __LIBBUSYBOX_H__ 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
Denis Vlasenkobf295dd2007-04-05 21:57:47 +000020#include <mntent.h>
Rob Landleyb623a542006-05-31 22:09:03 +000021#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000022#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000023#include <signal.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000024#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000025#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000026#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000027#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000028#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000029#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000030#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000031#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000032#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000033#include <sys/stat.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000034#include <sys/statfs.h>
Rob Landley299a6b42006-05-27 21:42:58 +000035#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000036#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000037#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000038#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000039#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000040#include <unistd.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000041#include <utime.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000042/* Try to pull in PATH_MAX */
43#include <limits.h>
44#include <sys/param.h>
45#ifndef PATH_MAX
46#define PATH_MAX 256
47#endif
Rob Landley299a6b42006-05-27 21:42:58 +000048
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000049#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000050#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000051#include <selinux/context.h>
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +000052#include <selinux/flask.h>
53#include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000054#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000055
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000056#if ENABLE_LOCALE_SUPPORT
Rob Landleyd921b2e2006-08-03 15:41:12 +000057#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000058#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000059#define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000060#endif
61
Eric Andersen887ca792002-07-03 23:19:26 +000062#include "pwd_.h"
63#include "grp_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000064/* ifdef it out, because it may include <shadow.h> */
65/* and we may not even _have_ <shadow.h>! */
66#if ENABLE_FEATURE_SHADOWPASSWDS
Eric Andersen27f64e12002-06-23 04:24:25 +000067#include "shadow_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000068#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000069
Denis Vlasenko847fa772008-01-28 22:45:43 +000070/* Some libc's don't declare it, help them */
71extern char **environ;
72
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000073#if defined(__GLIBC__) && __GLIBC__ < 2
74int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000075#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000076/* klogctl is in libc's klog.h, but we cheat and not #include that */
77int klogctl(int type, char *b, int len);
78/* This is declared here rather than #including <libgen.h> in order to avoid
79 * confusing the two versions of basename. See the dirname/basename man page
80 * for details. */
81char *dirname(char *path);
82/* Include our own copy of struct sysinfo to avoid binary compatibility
83 * problems with Linux 2.4, which changed things. Grumble, grumble. */
84struct sysinfo {
85 long uptime; /* Seconds since boot */
86 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
87 unsigned long totalram; /* Total usable main memory size */
88 unsigned long freeram; /* Available memory size */
89 unsigned long sharedram; /* Amount of shared memory */
90 unsigned long bufferram; /* Memory used by buffers */
91 unsigned long totalswap; /* Total swap space size */
92 unsigned long freeswap; /* swap space still available */
93 unsigned short procs; /* Number of current processes */
94 unsigned short pad; /* Padding needed for m68k */
95 unsigned long totalhigh; /* Total high memory size */
96 unsigned long freehigh; /* Available high memory size */
97 unsigned int mem_unit; /* Memory unit size in bytes */
98 char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
99};
100int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +0000101
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000102
103/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000104#define MAXINT(T) (T)( \
105 ((T)-1) > 0 \
106 ? (T)-1 \
107 : (T)~((T)1 << (sizeof(T)*8-1)) \
108 )
109
110#define MININT(T) (T)( \
111 ((T)-1) > 0 \
112 ? (T)0 \
113 : ((T)1 << (sizeof(T)*8-1)) \
114 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000115
Denis Vlasenko56254152006-10-07 16:24:46 +0000116/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000117/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000118 * (stat, lseek etc) mapped to "largefile" variants by libc.
119 * Practically it means that open() automatically has O_LARGEFILE added
120 * and all filesize/file_offset parameters and struct members are "large"
121 * (in today's world - signed 64bit). For full support of large files,
122 * we need a few helper #defines (below) and careful use of off_t
123 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000124#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000125/* CONFIG_LFS is on */
126# if ULONG_MAX > 0xffffffff
127/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000128# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000129/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
130# define BB_STRTOOFF bb_strtoul
131# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000132/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
133# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000134# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000135/* "long" is too short, need "long long" */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000136# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000137# define BB_STRTOOFF bb_strtoull
138# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000139# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000140# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000141#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000142/* CONFIG_LFS is off */
143# if UINT_MAX == 0xffffffff
144/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
145 * gcc will throw warnings on printf("%d", off_t). Crap... */
146# define XATOOFF(a) xatoi_u(a)
147# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000148# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000149# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000150# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000151# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
152# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000153# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000154# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000155# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000156#endif
157/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000158#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000159
Eric Andersenaad1a882001-03-16 22:47:14 +0000160/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000161#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000162#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000163#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000164#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000165#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000166#define SKIP ((int) 2)
167
168/* for mtab.c */
169#define MTAB_GETMOUNTPT '1'
170#define MTAB_GETDEVICE '2'
171
172#define BUF_SIZE 8192
173#define EXPAND_ALLOC 1024
174
Eric Andersenaad1a882001-03-16 22:47:14 +0000175/* Macros for min/max. */
176#ifndef MIN
177#define MIN(a,b) (((a)<(b))?(a):(b))
178#endif
179
180#ifndef MAX
181#define MAX(a,b) (((a)>(b))?(a):(b))
182#endif
183
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000184/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000185#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000186#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000187#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
188#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
189#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000190#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000191#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
192#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
193#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
194#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000195#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
196#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
197#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000198#endif
199#endif
200
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000201#if defined(__GLIBC__)
202/* glibc uses __errno_location() to get a ptr to errno */
203/* We can just memorize it once - no multithreading in busybox :) */
204extern int *const bb_errno;
205#undef errno
206#define errno (*bb_errno)
207#endif
208
Denis Vlasenko459be352007-06-17 19:09:05 +0000209unsigned long long monotonic_us(void);
Denis Vlasenkobd7bb292007-06-17 23:40:26 +0000210unsigned monotonic_sec(void);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000211
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000212extern void chomp(char *s);
213extern void trim(char *s);
214extern char *skip_whitespace(const char *);
Denis Vlasenko0de93752006-12-26 02:51:29 +0000215extern char *skip_non_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000216
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000217//TODO: supply a pointer to char[11] buffer (avoid statics)?
Bernhard Reutner-Fischer835f5752007-01-22 17:48:08 +0000218extern const char *bb_mode_string(mode_t mode);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000219extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000220extern int remove_file(const char *path, int flags);
221extern int copy_file(const char *source, const char *dest, int flags);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000222enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000223 ACTION_RECURSE = (1 << 0),
224 ACTION_FOLLOWLINKS = (1 << 1),
225 ACTION_FOLLOWLINKS_L0 = (1 << 2),
226 ACTION_DEPTHFIRST = (1 << 3),
227 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000228};
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000229extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000230 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
231 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
Denis Vlasenkod166f832007-07-05 00:12:55 +0000232 void* userData, unsigned depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000233extern int device_open(const char *device, int mode);
234extern int get_console_fd(void);
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +0000235extern char *find_block_device(const char *path);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000236/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000237extern off_t bb_copyfd_eof(int fd1, int fd2);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000238extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
239extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
240/* "short" copy can be detected by return value < size */
241/* this helper yells "short read!" if param is not -1 */
242extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000243extern char bb_process_escape_sequence(const char **ptr);
Denis Vlasenko818322b2007-09-24 18:27:04 +0000244/* xxxx_strip version can modify its parameter:
245 * "/" -> "/"
246 * "abc" -> "abc"
247 * "abc/def" -> "def"
248 * "abc/def/" -> "def" !!
249 */
250extern char *bb_get_last_path_component_strip(char *path);
251/* "abc/def/" -> "" and it never modifies 'path' */
252extern char *bb_get_last_path_component_nostrip(const char *path);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000253
254int ndelay_on(int fd);
255int ndelay_off(int fd);
Denis Vlasenko96e1b382007-09-30 23:50:48 +0000256int close_on_exec_on(int fd);
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000257void xdup2(int, int);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000258void xmove_fd(int, int);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000259
260
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000261DIR *xopendir(const char *path);
262DIR *warn_opendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000263
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000264/* UNUSED: char *xmalloc_realpath(const char *path); */
265char *xmalloc_readlink(const char *path);
Denis Vlasenko6ca04442007-02-11 16:19:28 +0000266char *xmalloc_readlink_or_warn(const char *path);
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000267char *xrealloc_getcwd_or_warn(char *cwd);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000268
Paul Fox599bbfb2007-11-08 20:00:36 +0000269char *xmalloc_follow_symlinks(const char *path);
Denis Vlasenko473dae02007-04-11 07:04:23 +0000270
271//TODO: signal(sid, f) is the same? then why?
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000272extern void sig_catch(int,void (*)(int));
273//#define sig_ignore(s) (sig_catch((s), SIG_IGN))
274//#define sig_uncatch(s) (sig_catch((s), SIG_DFL))
275extern void sig_block(int);
276extern void sig_unblock(int);
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000277/* UNUSED: extern void sig_blocknone(void); */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000278extern void sig_pause(void);
279
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000280
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000281void xsetgid(gid_t gid);
282void xsetuid(uid_t uid);
283void xchdir(const char *path);
284void xsetenv(const char *key, const char *value);
285void xunlink(const char *pathname);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000286void xstat(const char *pathname, struct stat *buf);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000287int xopen(const char *pathname, int flags);
288int xopen3(const char *pathname, int flags, int mode);
Denis Vlasenko50f7f442007-04-11 23:20:53 +0000289int open_or_warn(const char *pathname, int flags);
290int open3_or_warn(const char *pathname, int flags, int mode);
Denis Vlasenko5a6aedd2007-05-26 16:44:20 +0000291void xpipe(int filedes[2]);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000292off_t xlseek(int fd, off_t offset, int whence);
293off_t fdlength(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000294
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000295/* Useful for having small structure members/global variables */
296typedef int8_t socktype_t;
297typedef int8_t family_t;
298struct BUG_too_small {
299 char BUG_socktype_t_too_small[(0
300 | SOCK_STREAM
301 | SOCK_DGRAM
302 | SOCK_RDM
303 | SOCK_SEQPACKET
304 | SOCK_RAW
305 ) <= 127 ? 1 : -1];
306 char BUG_family_t_too_small[(0
307 | AF_UNSPEC
308 | AF_INET
309 | AF_INET6
310 | AF_UNIX
311 | AF_PACKET
312 | AF_NETLINK
313 /* | AF_DECnet */
314 /* | AF_IPX */
315 ) <= 127 ? 1 : -1];
316};
317
318
Denis Vlasenko448f0242007-01-22 22:43:05 +0000319int xsocket(int domain, int type, int protocol);
320void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
321void xlisten(int s, int backlog);
322void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000323ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Bernhard Reutner-Fischerb2908892007-04-12 11:34:39 +0000324 socklen_t tolen);
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000325/* SO_REUSEADDR allows a server to rebind to an address that is already
326 * "in use" by old connections to e.g. previous server instance which is
327 * killed or crashed. Without it bind will fail until all such connections
328 * time out. Linux does not allow multiple live binds on same ip:port
329 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
330 * Turn it on before you call bind(). */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000331void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000332int setsockopt_broadcast(int fd);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000333/* NB: returns port in host byte order */
334unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000335typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000336 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000337 union {
338 struct sockaddr sa;
339 struct sockaddr_in sin;
340#if ENABLE_FEATURE_IPV6
341 struct sockaddr_in6 sin6;
342#endif
343 };
344} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000345enum {
346 LSA_SIZEOF_SA = sizeof(
347 union {
348 struct sockaddr sa;
349 struct sockaddr_in sin;
350#if ENABLE_FEATURE_IPV6
351 struct sockaddr_in6 sin6;
352#endif
353 }
354 )
355};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000356/* Create stream socket, and allocate suitable lsa.
357 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000358 * af == AF_UNSPEC will result in trying to create IPv6 socket,
359 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000360 */
361int xsocket_type(len_and_sockaddr **lsap, USE_FEATURE_IPV6(int af,) int sock_type);
Denis Vlasenko5d687242007-01-12 20:59:31 +0000362int xsocket_stream(len_and_sockaddr **lsap);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000363/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000364 * numeric IP ("N.N.N.N") or numeric IPv6 address,
365 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000366 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000367/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000368int create_and_bind_stream_or_die(const char *bindaddr, int port);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000369int create_and_bind_dgram_or_die(const char *bindaddr, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000370/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
371 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
372 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
373 * If there is no suffix, port argument is used */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000374int create_and_connect_stream_or_die(const char *peer, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000375/* Connect to peer identified by lsa */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000376int xconnect_stream(const len_and_sockaddr *lsa);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000377/* Return malloc'ed len_and_sockaddr with socket address of host:port
378 * Currently will return IPv4 or IPv6 sockaddrs only
379 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000380 * UNIX socket address being returned, IPX sockaddr etc...
381 * On error does bb_error_msg and returns NULL */
382len_and_sockaddr* host2sockaddr(const char *host, int port);
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000383/* Version which dies on error */
Denis Vlasenko42823d52007-02-04 02:39:08 +0000384len_and_sockaddr* xhost2sockaddr(const char *host, int port);
Denis Vlasenko9ca26d32007-02-09 17:32:16 +0000385len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000386#if ENABLE_FEATURE_IPV6
387/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000388len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko42823d52007-02-04 02:39:08 +0000389len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenkoa1042e92007-01-26 07:01:10 +0000390#else
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000391/* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
392#define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
Denis Vlasenko42823d52007-02-04 02:39:08 +0000393#define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000394#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000395/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000396 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000397 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000398void set_nport(len_and_sockaddr *lsa, unsigned port);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000399/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000400int get_nport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000401/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000402char* xmalloc_sockaddr2host(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000403/* This one doesn't append :PORTNUM */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000404char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000405/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000406char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
Denis Vlasenko448f0242007-01-22 22:43:05 +0000407/* inet_[ap]ton on steroids */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000408char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
409char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000410// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000411// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenko448f0242007-01-22 22:43:05 +0000412struct hostent *xgethostbyname(const char *name);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000413// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000414// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000415
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000416
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000417void socket_want_pktinfo(int fd);
418ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
419 const struct sockaddr *from, const struct sockaddr *to,
420 socklen_t tolen);
421ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
422 struct sockaddr *from, struct sockaddr *to,
423 socklen_t sa_size);
424
Denis Vlasenko4daad902007-09-27 10:20:47 +0000425char *xstrdup(const char *s);
426char *xstrndup(const char *s, int n);
427char *safe_strncpy(char *dst, const char *src, size_t size);
428/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000429 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenko4daad902007-09-27 10:20:47 +0000430int bb_putchar(int ch);
431char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000432/* Prints unprintable chars ch as ^C or M-c to file
433 * (M-c is used only if ch is ORed with PRINTABLE_META),
434 * else it is printed as-is (except for ch = 0x9b) */
435enum { PRINTABLE_META = 0x100 };
436void fputc_printable(int ch, FILE *file);
Denis Vlasenko9f739442006-12-16 23:49:13 +0000437// gcc-4.1.1 still isn't good enough at optimizing it
438// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000439//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000440//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000441//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000442//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000443#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000444#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000445#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000446#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000447#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000448
449/* dmalloc will redefine these to it's own implementation. It is safe
450 * to have the prototypes here unconditionally. */
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000451extern void *malloc_or_warn(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000452extern void *xmalloc(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000453extern void *xzalloc(size_t size);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000454extern void *xrealloc(void *old, size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000455
Denis Vlasenkoea620772006-10-14 02:23:43 +0000456extern ssize_t safe_read(int fd, void *buf, size_t count);
457extern ssize_t full_read(int fd, void *buf, size_t count);
458extern void xread(int fd, void *buf, size_t count);
459extern unsigned char xread_char(int fd);
Denis Vlasenkod67cef22007-06-13 06:47:47 +0000460// Read one line a-la fgets. Uses one read(), works only on seekable streams
Denis Vlasenkoea620772006-10-14 02:23:43 +0000461extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenkod67cef22007-06-13 06:47:47 +0000462// Read one line a-la fgets. Reads byte-by-byte.
463// Useful when it is important to not read ahead.
464extern char *xmalloc_reads(int fd, char *pfx);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000465extern ssize_t read_close(int fd, void *buf, size_t count);
466extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
467extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000468
469extern ssize_t safe_write(int fd, const void *buf, size_t count);
470extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000471extern void xwrite(int fd, const void *buf, size_t count);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000472
Denis Vlasenko1de08302006-10-26 23:32:43 +0000473/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000474extern void xprint_and_close_file(FILE *file);
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000475/* Reads up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000476extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000477/* Chops off TERMINATING_STRING: from the end: */
478extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string);
479/* Reads up to (and including) "\n" or NUL byte */
480extern char *xmalloc_fgets(FILE *file);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000481/* Chops off '\n' from the end, unlike fgets: */
482extern char *xmalloc_getline(FILE *file);
483extern char *bb_get_chunk_from_file(FILE *file, int *end);
484extern void die_if_ferror(FILE *file, const char *msg);
485extern void die_if_ferror_stdout(void);
486extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000487extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000488extern int fclose_if_not_stdin(FILE *file);
489extern FILE *xfopen(const char *filename, const char *mode);
490/* Prints warning to stderr and returns NULL on failure: */
491extern FILE *fopen_or_warn(const char *filename, const char *mode);
492/* "Opens" stdin if filename is special, else just opens file: */
493extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000494
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000495/* Wrapper which restarts poll on EINTR or ENOMEM.
496 * On other errors complains [perror("poll")] and returns.
497 * Warning! May take (much) longer than timeout_ms to return!
498 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
499int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms);
500
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000501/* Convert each alpha char in str to lower-case */
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000502char* str_tolower(char *str);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000503
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000504char *utoa(unsigned n);
505char *itoa(int n);
Denis Vlasenko10457b92007-03-27 22:01:31 +0000506/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000507char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
508char *itoa_to_buf(int n, char *buf, unsigned buflen);
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000509/* Intelligent formatters of bignums */
510void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale);
511void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale);
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000512//TODO: provide pointer to buf (avoid statics)?
513const char *make_human_readable_str(unsigned long long size,
514 unsigned long block_size, unsigned long display_unit);
515/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
516char *bin2hex(char *buf, const char *cp, int count);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000517
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000518/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000519struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000520 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000521 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000522};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000523#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000524/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000525/* Using xatoi() instead of naive atoi() is not always convenient -
526 * in many places people want *non-negative* values, but store them
527 * in signed int. Therefore we need this one:
528 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
529int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000530/* Useful for reading port numbers */
531uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000532
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000533
Eric Andersenaad1a882001-03-16 22:47:14 +0000534/* These parse entries in /etc/passwd and /etc/group. This is desirable
535 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000536 * increases target size and is often not needed on embedded systems. */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000537long xuname2uid(const char *name);
538long xgroup2gid(const char *name);
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000539/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000540unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000541/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000542struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000543 uid_t uid;
544 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000545};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000546/* always sets uid and gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000547int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
Denis Vlasenkocce38582007-02-26 22:47:42 +0000548/* chown-like handling of "user[:[group]" */
549void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
Denis Vlasenko3734b942007-07-27 11:20:10 +0000550/* bb_getpwuid, bb_getgrgid:
Denis Vlasenko1d10aaf2007-07-27 11:22:34 +0000551 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
552 * as a string to buf, return user/group name or NULL
553 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
554 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
Denis Vlasenko3734b942007-07-27 11:20:10 +0000555*/
556char *bb_getpwuid(char *name, int bufsize, long uid);
557char *bb_getgrgid(char *group, int bufsize, long gid);
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000558/* versions which cache results (useful for ps, ls etc) */
559const char* get_cached_username(uid_t uid);
560const char* get_cached_groupname(gid_t gid);
561void clear_username_cache(void);
562/* internally usernames are saved in fixed-sized char[] buffers */
563enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000564
Eric Andersenaad1a882001-03-16 22:47:14 +0000565
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000566int execable_file(const char *name);
567char *find_execable(const char *filename);
568int exists_execable(const char *filename);
569
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000570/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
571 * but it may exec busybox and call applet instead of searching PATH.
572 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000573#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000574int bb_execvp(const char *file, char *const argv[]);
575#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
576#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000577 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000578 cmd, __VA_ARGS__)
579#else
580#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
581#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
582#endif
583
584/* NOMMU friendy fork+exec */
585pid_t spawn(char **argv);
586pid_t xspawn(char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000587
588/* Unlike waitpid, waits ONLY for one process,
589 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000590 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000591 * IOW: rc = wait4pid(spawn(argv));
592 * if (rc < 0) bb_perror_msg("%s", argv[0]);
593 * if (rc > 0) bb_error_msg("exit code: %d", rc);
594 */
Denis Vlasenkofb0eba72008-01-02 19:55:04 +0000595int safe_waitpid(int pid, int *wstat, int options);
Denis Vlasenko473dae02007-04-11 07:04:23 +0000596int wait4pid(int pid);
Denis Vlasenkofb0eba72008-01-02 19:55:04 +0000597int wait_any_nohang(int *wstat);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000598#define wait_crashed(w) ((w) & 127)
599#define wait_exitcode(w) ((w) >> 8)
600#define wait_stopsig(w) ((w) >> 8)
601#define wait_stopped(w) (((w) & 127) == 127)
602/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
603int spawn_and_wait(char **argv);
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000604struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000605 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000606 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000607 int xfunc_error_retval;
608 uint32_t option_mask32;
609 int die_sleep;
610 smallint saved;
611};
612void save_nofork_data(struct nofork_save_area *save);
613void restore_nofork_data(struct nofork_save_area *save);
614/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000615int run_nofork_applet(int applet_no, char **argv);
616int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000617
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000618/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000619 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000620 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000621 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000622 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
623 * rexec's itself on NOMMU with argv passed as command line.
624 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
625 * from the start. (It will detect it and not reexec again second time).
626 * You have to audit carefully that you don't do something twice as a result
627 * (opening files/sockets, parsing config files etc...)!
628 *
629 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
630 * (will do setsid()).
631 *
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000632 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
633 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
634 * Currently used for openvt. On MMU ignores argv.
635 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000636 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000637 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000638 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
639 * to /dev/null if they are not.
640 */
641enum {
642 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000643 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000644 DAEMON_CLOSE_EXTRA_FDS = 4,
645 DAEMON_ONLY_SANITIZE = 8, /* internal use */
646};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000647#if BB_MMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000648 void forkexit_or_rexec(void);
Denis Vlasenko367960b2007-08-18 14:20:21 +0000649 enum { re_execed = 0 };
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000650# define forkexit_or_rexec(argv) forkexit_or_rexec()
651# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
652# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000653#else
Denis Vlasenko367960b2007-08-18 14:20:21 +0000654 void re_exec(char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000655 void forkexit_or_rexec(char **argv);
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000656 extern bool re_execed;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000657# define fork() BUG_fork_is_unavailable_on_nommu()
658# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
659# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000660#endif
661void bb_daemonize_or_rexec(int flags, char **argv);
662void bb_sanitize_stdio(void);
Denis Vlasenko52816302007-11-06 05:26:51 +0000663/* Clear dangerous stuff, set PATH */
664void sanitize_env_for_suid(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000665
666
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000667extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000668#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000669#define No_argument "\0"
670#define Required_argument "\001"
671#define Optional_argument "\002"
672extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000673#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000674extern uint32_t option_mask32;
Denis Vlasenkod37f2222007-08-19 13:42:08 +0000675extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000676
677
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000678typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000679 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000680 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000681} llist_t;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000682void llist_add_to(llist_t **old_head, void *data);
683void llist_add_to_end(llist_t **list_head, void *data);
684void *llist_pop(llist_t **elm);
685void llist_unlink(llist_t **head, llist_t *elm);
686void llist_free(llist_t *elm, void (*freeit)(void *data));
687llist_t *llist_rev(llist_t *list);
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000688/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000689 * llist_t *llist_add_to(llist_t *old_head, void *data)
690 * etc does not result in smaller code... */
691
Denis Vlasenko80edead2007-08-02 22:31:05 +0000692/* start_stop_daemon and udhcpc are special - they want
693 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000694#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000695/* True only if we created pidfile which is *file*, not /dev/null etc */
696extern smallint wrote_pidfile;
697void write_pidfile(const char *path);
698#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000699#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000700enum { wrote_pidfile = 0 };
701#define write_pidfile(path) ((void)0)
702#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000703#endif
704
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000705enum {
706 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000707 LOGMODE_STDIO = (1 << 0),
708 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000709 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
710};
711extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000712extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000713extern int die_sleep;
714extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000715extern jmp_buf die_jmp;
Denis Vlasenko335b63d2007-04-10 21:38:30 +0000716extern void xfunc_die(void) ATTRIBUTE_NORETURN;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000717extern void bb_show_usage(void) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000718extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
719extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
720extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000721extern void bb_simple_perror_msg(const char *s);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000722extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000723extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000724extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
725extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
726extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
727extern void bb_perror_nomsg(void);
728extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000729extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000730
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000731/* We need to export XXX_main from libbusybox
732 * only if we build "individual" binaries
733 */
734#if ENABLE_FEATURE_INDIVIDUAL
735#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
736#else
737#define MAIN_EXTERNALLY_VISIBLE
738#endif
739
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000740
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000741/* applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000742int bb_cat(char** argv);
Denis Vlasenkofe5e23b2007-11-24 02:23:51 +0000743int echo_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000744int test_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
745int kill_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko703e2022007-01-22 14:12:08 +0000746#if ENABLE_ROUTE
Denis Vlasenko06af2162007-02-03 17:28:39 +0000747void bb_displayroutes(int noresolve, int netstatfmt);
748#endif
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000749int chown_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko06af2162007-02-03 17:28:39 +0000750#if ENABLE_GUNZIP
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000751int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko703e2022007-01-22 14:12:08 +0000752#endif
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000753#if ENABLE_BUNZIP2
754int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
755#endif
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000756int bbunpack(char **argv,
Denis Vlasenkoc86e0522007-03-20 11:30:28 +0000757 char* (*make_new_name)(char *filename),
758 USE_DESKTOP(long long) int (*unpacker)(void)
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000759);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000760
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000761
762/* Networking */
763int create_icmp_socket(void);
764int create_icmp6_socket(void);
765/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000766/* This structure defines protocol families and their handlers. */
767struct aftype {
768 const char *name;
769 const char *title;
770 int af;
771 int alen;
772 char *(*print) (unsigned char *);
773 const char *(*sprint) (struct sockaddr *, int numeric);
774 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
775 void (*herror) (char *text);
776 int (*rprint) (int options);
777 int (*rinput) (int typ, int ext, char **argv);
778
779 /* may modify src */
780 int (*getmask) (char *src, struct sockaddr * mask, char *name);
781};
782/* This structure defines hardware protocols and their handlers. */
783struct hwtype {
784 const char *name;
785 const char *title;
786 int type;
787 int alen;
788 char *(*print) (unsigned char *);
789 int (*input) (const char *, struct sockaddr *);
790 int (*activate) (int fd);
791 int suppress_null_addr;
792};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000793extern smallint interface_opt_a;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000794int display_interfaces(char *ifname);
Denis Vlasenko1cc70222007-03-15 19:46:43 +0000795const struct aftype *get_aftype(const char *name);
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000796const struct hwtype *get_hwtype(const char *name);
797const struct hwtype *get_hwntype(int type);
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000798
799
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000800#ifndef BUILD_INDIVIDUAL
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000801extern int find_applet_by_name(const char *name);
Denis Vlasenko32b633a2007-04-09 03:05:48 +0000802/* Returns only if applet is not found. */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000803extern void run_applet_and_exit(const char *name, char **argv);
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000804extern void run_applet_no_and_exit(int a, char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000805#endif
806
Denis Vlasenkobf295dd2007-04-05 21:57:47 +0000807extern int match_fstype(const struct mntent *mt, const char *fstypes);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000808extern struct mntent *find_mount_point(const char *name, const char *table);
809extern void erase_mtab(const char * name);
810extern unsigned int tty_baud_to_value(speed_t speed);
811extern speed_t tty_value_to_baud(unsigned int value);
812extern void bb_warn_ignoring_args(int n);
813
814extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000815
Rob Landley1d589b22005-11-29 23:47:10 +0000816extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000817extern int del_loop(const char *device);
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +0000818/* If *devname is not NULL, use that name, otherwise try to find free one,
819 * malloc and return it in *devname.
820 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
821extern int set_loop(char **devname, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000822
Eric Andersenaad1a882001-03-16 22:47:14 +0000823
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000824//TODO: pass buf pointer or return allocated buf (avoid statics)?
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000825char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000826int bb_ask_confirmation(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000827
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000828extern int bb_parse_mode(const char* s, mode_t* theMode);
829
Eric Andersene5dfced2001-04-09 22:48:12 +0000830char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000831char *concat_subpath_file(const char *path, const char *filename);
Denis Vlasenkodc757aa2007-06-30 08:04:05 +0000832const char *bb_basename(const char *name);
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000833/* NB: can violate const-ness (similarly to strchr) */
Eric Andersenc911a432001-05-15 17:42:16 +0000834char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000835
Denis Vlasenko4921b542007-02-03 02:17:41 +0000836
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000837USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
838int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000839
Denis Vlasenko14579152006-10-26 01:09:46 +0000840
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000841int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000842
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000843int get_signum(const char *name);
844const char *get_signame(int number);
Denis Vlasenkoa4f4de92007-09-30 16:32:01 +0000845void print_signames(void);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000846
Manuel Novoa III cad53642003-03-19 09:13:01 +0000847char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000848
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000849#define FAIL_DELAY 3
850extern void bb_do_delay(int seconds);
851extern void change_identity(const struct passwd *pw);
852extern const char *change_identity_e2str(const struct passwd *pw);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000853extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000854extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000855#if ENABLE_SELINUX
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000856extern void renew_current_security_context(void);
857extern void set_current_security_context(security_context_t sid);
Denis Vlasenko1203c9b2007-03-11 22:16:02 +0000858extern context_t set_security_context_component(security_context_t cur_context,
859 char *user, char *role, char *type, char *range);
Denis Vlasenko39c651e2007-03-12 18:22:55 +0000860extern void setfscreatecon_or_die(security_context_t scontext);
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +0000861extern void selinux_preserve_fcontext(int fdesc);
862#else
863#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000864#endif
Denis Vlasenkod46d3c22007-02-06 19:28:50 +0000865extern void selinux_or_die(void);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000866extern int restricted_shell(const char *shell);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000867
868/* setup_environment:
869 * if loginshell = 1: cd(pw->pw_dir), clear environment, then set
870 * TERM=(old value)
871 * USER=pw->pw_name, LOGNAME=pw->pw_name
872 * PATH=bb_default_[root_]path
873 * HOME=pw->pw_dir
874 * SHELL=shell
875 * else if changeenv = 1:
876 * if not root (if pw->pw_uid != 0):
877 * USER=pw->pw_name, LOGNAME=pw->pw_name
878 * HOME=pw->pw_dir
879 * SHELL=shell
880 * else does nothing
881 */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000882extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
883extern int correct_password(const struct passwd *pw);
Denis Vlasenko21d10142007-07-20 21:28:41 +0000884/* Returns a ptr to static storage */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000885extern char *pw_encrypt(const char *clear, const char *salt);
886extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenkobfc3d822007-11-04 04:10:17 +0000887
888int index_in_str_array(const char *const string_array[], const char *key);
889int index_in_strings(const char *strings, const char *key);
890int index_in_substr_array(const char *const string_array[], const char *key);
891int index_in_substrings(const char *strings, const char *key);
892const char *nth_string(const char *strings, int n);
893
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000894extern void print_login_issue(const char *issue_file, const char *tty);
895extern void print_login_prompt(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000896
Denis Vlasenko21d10142007-07-20 21:28:41 +0000897/* rnd is additional random input. New one is returned.
898 * Useful if you call crypt_make_salt many times in a row:
899 * rnd = crypt_make_salt(buf1, 4, 0);
900 * rnd = crypt_make_salt(buf2, 4, rnd);
901 * rnd = crypt_make_salt(buf3, 4, rnd);
902 * (otherwise we risk having same salt generated)
903 */
904extern int crypt_make_salt(char *p, int cnt, int rnd);
905
906/* Returns number of lines changed, or -1 on error */
907extern int update_passwd(const char *filename, const char *username,
908 const char *new_pw);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000909
Denis Vlasenkof893da82007-08-09 08:27:24 +0000910/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
911int get_terminal_width_height(int fd, int *width, int *height);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000912
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +0000913int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
914void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
915#if ENABLE_IOCTL_HEX2STR_ERROR
916int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name);
917void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name);
918#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
919#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
920#else
921int bb_ioctl_or_warn(int fd, int request, void *argp);
922void bb_xioctl(int fd, int request, void *argp);
923#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
924#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
925#endif
926
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000927char *is_in_ino_dev_hashtable(const struct stat *statbuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000928void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
929void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +0000930#ifdef __GLIBC__
931/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000932unsigned long long bb_makedev(unsigned int major, unsigned int minor);
Denis Vlasenko0b354702006-11-24 14:54:27 +0000933#undef makedev
934#define makedev(a,b) bb_makedev(a,b)
935#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000936
937
Denis Vlasenko38f63192007-01-22 09:03:07 +0000938#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000939/* It's NOT just ENABLEd or disabled. It's a number: */
Denis Vlasenko38f63192007-01-22 09:03:07 +0000940#ifdef CONFIG_FEATURE_EDITING_HISTORY
941#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000942#else
943#define MAX_HISTORY 0
944#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000945typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000946 int flags;
947 const char *path_lookup;
948#if MAX_HISTORY
949 int cnt_history;
950 int cur_history;
Denis Vlasenko38f63192007-01-22 09:03:07 +0000951 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000952 char *history[MAX_HISTORY + 1];
953#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000954} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000955enum {
956 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +0000957 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
958 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
959 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
960 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000961 WITH_PATH_LOOKUP = 0x20,
962 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
963};
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000964line_input_t *new_line_input_t(int flags);
Denis Vlasenko6a5377a2007-09-25 18:35:28 +0000965/* Returns:
966 * -1 on read errors or EOF, or on bare Ctrl-D.
967 * 0 on ctrl-C,
968 * >0 length of input string, including terminating '\n'
969 * [is this true? stores "" in 'command' if return value is 0 or -1]
970 */
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000971int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
972#else
973int read_line_input(const char* prompt, char* command, int maxsize);
974#define read_line_input(prompt, command, maxsize, state) \
975 read_line_input(prompt, command, maxsize)
976#endif
977
978
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000979#ifndef COMM_LEN
980#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +0000981enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000982#else
983/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +0000984enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000985#endif
986#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +0000987typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000988 DIR *dir;
Denis Vlasenko512499c2007-08-26 18:23:13 +0000989 uint8_t shift_pages_to_bytes;
990 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000991/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +0000992 char *argv0;
Denis Vlasenko0696b8a2007-06-06 07:40:16 +0000993 USE_SELINUX(char *context;)
994 /* Everything below must contain no ptrs to malloc'ed data:
995 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +0000996 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000997 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +0000998 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000999 unsigned pid;
1000 unsigned ppid;
1001 unsigned pgid;
1002 unsigned sid;
1003 unsigned uid;
1004 unsigned gid;
Denis Vlasenko31789a82007-06-19 14:43:17 +00001005 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001006#if ENABLE_FEATURE_TOPMEM
1007 unsigned long mapped_rw;
1008 unsigned long mapped_ro;
1009 unsigned long shared_clean;
1010 unsigned long shared_dirty;
1011 unsigned long private_clean;
1012 unsigned long private_dirty;
1013 unsigned long stack;
1014#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001015 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001016 /* basename of executable in exec(2), read from /proc/N/stat
1017 * (if executable is symlink or script, it is NOT replaced
1018 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001019 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001020 /* user/group? - use passwd/group parsing functions */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001021} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001022enum {
1023 PSSCAN_PID = 1 << 0,
1024 PSSCAN_PPID = 1 << 1,
1025 PSSCAN_PGID = 1 << 2,
1026 PSSCAN_SID = 1 << 3,
1027 PSSCAN_UIDGID = 1 << 4,
1028 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001029 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001030 PSSCAN_ARGV0 = 1 << 7,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001031 /* PSSCAN_EXE = 1 << 8, - not implemented */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001032 PSSCAN_STATE = 1 << 9,
1033 PSSCAN_VSZ = 1 << 10,
1034 PSSCAN_RSS = 1 << 11,
1035 PSSCAN_STIME = 1 << 12,
1036 PSSCAN_UTIME = 1 << 13,
1037 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001038 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko72e1c892007-09-29 22:26:01 +00001039 PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1040 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001041 PSSCAN_START_TIME = 1 << 18,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001042 /* These are all retrieved from proc/NN/stat in one go: */
1043 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1044 | PSSCAN_COMM | PSSCAN_STATE
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001045 | PSSCAN_VSZ | PSSCAN_RSS
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001046 | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001047 | PSSCAN_TTY,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001048};
1049procps_status_t* alloc_procps_scan(int flags);
1050void free_procps_scan(procps_status_t* sp);
1051procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001052/* Format cmdline (up to col chars) into char buf[col+1] */
1053/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1054void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
Denis Vlasenko35fb5122006-11-01 09:16:49 +00001055pid_t *find_pid_by_name(const char* procName);
1056pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001057
1058
1059extern const char bb_uuenc_tbl_base64[];
1060extern const char bb_uuenc_tbl_std[];
Denis Vlasenkoe8240f12007-06-26 15:59:37 +00001061void bb_uuencode(char *store, const void *s, int length, const char *tbl);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001062
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001063typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001064 uint32_t count[2];
1065 uint32_t hash[5];
1066 uint32_t wbuf[16];
1067} sha1_ctx_t;
1068void sha1_begin(sha1_ctx_t *ctx);
1069void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
1070void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
1071
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001072typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001073 uint32_t A;
1074 uint32_t B;
1075 uint32_t C;
1076 uint32_t D;
1077 uint64_t total;
1078 uint32_t buflen;
1079 char buffer[128];
1080} md5_ctx_t;
1081void md5_begin(md5_ctx_t *ctx);
1082void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
1083void *md5_end(void *resbuf, md5_ctx_t *ctx);
1084
Denis Vlasenkoc6758a02007-04-10 21:40:19 +00001085uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001086
1087
Denis Vlasenko49622d72007-03-10 16:58:49 +00001088enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Matt Kraai01441032001-04-24 01:30:02 +00001089 FILEUTILS_PRESERVE_STATUS = 1,
Matt Kraai4c557bf2001-10-05 01:35:10 +00001090 FILEUTILS_DEREFERENCE = 2,
Matt Kraai01441032001-04-24 01:30:02 +00001091 FILEUTILS_RECUR = 4,
1092 FILEUTILS_FORCE = 8,
Denis Vlasenkof24e1f42006-10-21 23:40:20 +00001093 FILEUTILS_INTERACTIVE = 0x10,
1094 FILEUTILS_MAKE_HARDLINK = 0x20,
1095 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenko49622d72007-03-10 16:58:49 +00001096#if ENABLE_SELINUX
1097 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
1098 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
1099#endif
Matt Kraai91b28552001-04-23 18:53:07 +00001100};
1101
Denis Vlasenko49622d72007-03-10 16:58:49 +00001102#define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001103extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001104/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001105extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001106extern const char bb_msg_memory_exhausted[];
1107extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001108extern const char bb_msg_read_error[];
1109extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001110extern const char bb_msg_unknown[];
1111extern const char bb_msg_can_not_create_raw_socket[];
1112extern const char bb_msg_perm_denied_are_you_root[];
1113extern const char bb_msg_requires_arg[];
1114extern const char bb_msg_invalid_arg[];
1115extern const char bb_msg_standard_input[];
1116extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001117
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001118extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001119/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001120extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001121
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001122extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001123extern const char bb_path_passwd_file[];
1124extern const char bb_path_shadow_file[];
1125extern const char bb_path_gshadow_file[];
1126extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001127extern const char bb_path_motd_file[];
1128extern const char bb_path_wtmp_file[];
1129extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001130extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001131/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1132 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001133extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1134#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1135#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001136
Denis Vlasenko703e2022007-01-22 14:12:08 +00001137extern const int const_int_0;
1138extern const int const_int_1;
1139
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001140
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001141#ifndef BUFSIZ
1142#define BUFSIZ 4096
1143#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001144/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001145enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1146extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001147/* This struct is deliberately not defined. */
1148/* See docs/keep_data_small.txt */
1149struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001150/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001151 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001152 * If you want to assign a value, use PTR_TO_GLOBALS = xxx */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001153extern struct globals *const ptr_to_globals;
1154#define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001155
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001156
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001157/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1158 * use bb_default_login_shell and following defines.
1159 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1160 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001161#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001162extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001163/* "/bin/sh" */
1164#define DEFAULT_SHELL (bb_default_login_shell+1)
1165/* "sh" */
1166#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1167
1168
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001169#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001170# define CURRENT_VC "/dev/vc/0"
1171# define VC_1 "/dev/vc/1"
1172# define VC_2 "/dev/vc/2"
1173# define VC_3 "/dev/vc/3"
1174# define VC_4 "/dev/vc/4"
1175# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001176#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1177/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1178 respective serial ports .. as such, we can't use the common device paths for
1179 these. -- PFM */
1180# define SC_0 "/dev/ttsc/0"
1181# define SC_1 "/dev/ttsc/1"
1182# define SC_FORMAT "/dev/ttsc/%d"
1183#else
1184# define SC_0 "/dev/tts/0"
1185# define SC_1 "/dev/tts/1"
1186# define SC_FORMAT "/dev/tts/%d"
1187#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001188# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001189# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001190# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001191# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001192# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001193#else
1194# define CURRENT_VC "/dev/tty0"
1195# define VC_1 "/dev/tty1"
1196# define VC_2 "/dev/tty2"
1197# define VC_3 "/dev/tty3"
1198# define VC_4 "/dev/tty4"
1199# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001200#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1201# define SC_0 "/dev/ttySC0"
1202# define SC_1 "/dev/ttySC1"
1203# define SC_FORMAT "/dev/ttySC%d"
1204#else
1205# define SC_0 "/dev/ttyS0"
1206# define SC_1 "/dev/ttyS1"
1207# define SC_FORMAT "/dev/ttyS%d"
1208#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001209# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001210# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001211# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001212# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001213# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001214#endif
1215
1216/* The following devices are the same on devfs and non-devfs systems. */
1217#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001218#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001219
Rob Landleyc57ec372006-04-10 17:07:15 +00001220
Rob Landleyb623a542006-05-31 22:09:03 +00001221#ifndef RB_POWER_OFF
1222/* Stop system and switch power off if possible. */
1223#define RB_POWER_OFF 0x4321fedc
1224#endif
1225
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001226/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001227#undef isalnum
1228#undef isalpha
1229#undef isascii
1230#undef isblank
1231#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001232#undef isgraph
1233#undef islower
1234#undef isprint
1235#undef ispunct
1236#undef isspace
1237#undef isupper
1238#undef isxdigit
1239
Denis Vlasenko459903b2006-11-27 14:44:18 +00001240/* This one is more efficient - we save ~400 bytes */
1241#undef isdigit
1242#define isdigit(a) ((unsigned)((a) - '0') <= 9)
1243
1244
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001245#ifdef DMALLOC
1246#include <dmalloc.h>
1247#endif
1248
Denis Vlasenko80b8b392007-06-25 10:55:35 +00001249#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
1250
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +00001251#endif /* __LIBBUSYBOX_H__ */