blob: 3bec432334c83c25fc0ee55cc1c7ece0eedd2104 [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 Vlasenko7e3a5f52007-11-16 20:18:54 +000070#if defined(__GLIBC__) && __GLIBC__ < 2
71int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000072#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000073/* klogctl is in libc's klog.h, but we cheat and not #include that */
74int klogctl(int type, char *b, int len);
75/* This is declared here rather than #including <libgen.h> in order to avoid
76 * confusing the two versions of basename. See the dirname/basename man page
77 * for details. */
78char *dirname(char *path);
79/* Include our own copy of struct sysinfo to avoid binary compatibility
80 * problems with Linux 2.4, which changed things. Grumble, grumble. */
81struct sysinfo {
82 long uptime; /* Seconds since boot */
83 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
84 unsigned long totalram; /* Total usable main memory size */
85 unsigned long freeram; /* Available memory size */
86 unsigned long sharedram; /* Amount of shared memory */
87 unsigned long bufferram; /* Memory used by buffers */
88 unsigned long totalswap; /* Total swap space size */
89 unsigned long freeswap; /* swap space still available */
90 unsigned short procs; /* Number of current processes */
91 unsigned short pad; /* Padding needed for m68k */
92 unsigned long totalhigh; /* Total high memory size */
93 unsigned long freehigh; /* Available high memory size */
94 unsigned int mem_unit; /* Memory unit size in bytes */
95 char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
96};
97int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +000098
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000099
100/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000101#define MAXINT(T) (T)( \
102 ((T)-1) > 0 \
103 ? (T)-1 \
104 : (T)~((T)1 << (sizeof(T)*8-1)) \
105 )
106
107#define MININT(T) (T)( \
108 ((T)-1) > 0 \
109 ? (T)0 \
110 : ((T)1 << (sizeof(T)*8-1)) \
111 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000112
Denis Vlasenko56254152006-10-07 16:24:46 +0000113/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000114/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000115 * (stat, lseek etc) mapped to "largefile" variants by libc.
116 * Practically it means that open() automatically has O_LARGEFILE added
117 * and all filesize/file_offset parameters and struct members are "large"
118 * (in today's world - signed 64bit). For full support of large files,
119 * we need a few helper #defines (below) and careful use of off_t
120 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000121#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000122/* CONFIG_LFS is on */
123# if ULONG_MAX > 0xffffffff
124/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000125# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000126/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
127# define BB_STRTOOFF bb_strtoul
128# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000129/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
130# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000131# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000132/* "long" is too short, need "long long" */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000133# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000134# define BB_STRTOOFF bb_strtoull
135# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000136# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000137# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000138#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000139/* CONFIG_LFS is off */
140# if UINT_MAX == 0xffffffff
141/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
142 * gcc will throw warnings on printf("%d", off_t). Crap... */
143# define XATOOFF(a) xatoi_u(a)
144# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000145# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000146# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000147# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000148# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
149# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000150# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000151# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000152# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000153#endif
154/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000155#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000156
Eric Andersenaad1a882001-03-16 22:47:14 +0000157/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000158#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000159#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000160#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000161#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000162#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000163#define SKIP ((int) 2)
164
165/* for mtab.c */
166#define MTAB_GETMOUNTPT '1'
167#define MTAB_GETDEVICE '2'
168
169#define BUF_SIZE 8192
170#define EXPAND_ALLOC 1024
171
Eric Andersenaad1a882001-03-16 22:47:14 +0000172/* Macros for min/max. */
173#ifndef MIN
174#define MIN(a,b) (((a)<(b))?(a):(b))
175#endif
176
177#ifndef MAX
178#define MAX(a,b) (((a)>(b))?(a):(b))
179#endif
180
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000181/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000182#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000183#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000184#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
185#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
186#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000187#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000188#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
189#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
190#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
191#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000192#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
193#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
194#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000195#endif
196#endif
197
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000198#if defined(__GLIBC__)
199/* glibc uses __errno_location() to get a ptr to errno */
200/* We can just memorize it once - no multithreading in busybox :) */
201extern int *const bb_errno;
202#undef errno
203#define errno (*bb_errno)
204#endif
205
Denis Vlasenko459be352007-06-17 19:09:05 +0000206unsigned long long monotonic_us(void);
Denis Vlasenkobd7bb292007-06-17 23:40:26 +0000207unsigned monotonic_sec(void);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000208
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000209extern void chomp(char *s);
210extern void trim(char *s);
211extern char *skip_whitespace(const char *);
Denis Vlasenko0de93752006-12-26 02:51:29 +0000212extern char *skip_non_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000213
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000214//TODO: supply a pointer to char[11] buffer (avoid statics)?
Bernhard Reutner-Fischer835f5752007-01-22 17:48:08 +0000215extern const char *bb_mode_string(mode_t mode);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000216extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000217extern int remove_file(const char *path, int flags);
218extern int copy_file(const char *source, const char *dest, int flags);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000219enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000220 ACTION_RECURSE = (1 << 0),
221 ACTION_FOLLOWLINKS = (1 << 1),
222 ACTION_FOLLOWLINKS_L0 = (1 << 2),
223 ACTION_DEPTHFIRST = (1 << 3),
224 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000225};
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000226extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000227 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
228 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
Denis Vlasenkod166f832007-07-05 00:12:55 +0000229 void* userData, unsigned depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000230extern int device_open(const char *device, int mode);
231extern int get_console_fd(void);
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +0000232extern char *find_block_device(const char *path);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000233/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000234extern off_t bb_copyfd_eof(int fd1, int fd2);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000235extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
236extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
237/* "short" copy can be detected by return value < size */
238/* this helper yells "short read!" if param is not -1 */
239extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000240extern char bb_process_escape_sequence(const char **ptr);
Denis Vlasenko818322b2007-09-24 18:27:04 +0000241/* xxxx_strip version can modify its parameter:
242 * "/" -> "/"
243 * "abc" -> "abc"
244 * "abc/def" -> "def"
245 * "abc/def/" -> "def" !!
246 */
247extern char *bb_get_last_path_component_strip(char *path);
248/* "abc/def/" -> "" and it never modifies 'path' */
249extern char *bb_get_last_path_component_nostrip(const char *path);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000250
251int ndelay_on(int fd);
252int ndelay_off(int fd);
Denis Vlasenko96e1b382007-09-30 23:50:48 +0000253int close_on_exec_on(int fd);
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000254void xdup2(int, int);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000255void xmove_fd(int, int);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000256
257
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000258DIR *xopendir(const char *path);
259DIR *warn_opendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000260
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000261/* UNUSED: char *xmalloc_realpath(const char *path); */
262char *xmalloc_readlink(const char *path);
Denis Vlasenko6ca04442007-02-11 16:19:28 +0000263char *xmalloc_readlink_or_warn(const char *path);
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000264char *xrealloc_getcwd_or_warn(char *cwd);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000265
Paul Fox599bbfb2007-11-08 20:00:36 +0000266char *xmalloc_follow_symlinks(const char *path);
Denis Vlasenko473dae02007-04-11 07:04:23 +0000267
268//TODO: signal(sid, f) is the same? then why?
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000269extern void sig_catch(int,void (*)(int));
270//#define sig_ignore(s) (sig_catch((s), SIG_IGN))
271//#define sig_uncatch(s) (sig_catch((s), SIG_DFL))
272extern void sig_block(int);
273extern void sig_unblock(int);
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000274/* UNUSED: extern void sig_blocknone(void); */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000275extern void sig_pause(void);
276
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000277
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000278void xsetgid(gid_t gid);
279void xsetuid(uid_t uid);
280void xchdir(const char *path);
281void xsetenv(const char *key, const char *value);
282void xunlink(const char *pathname);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000283void xstat(const char *pathname, struct stat *buf);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000284int xopen(const char *pathname, int flags);
285int xopen3(const char *pathname, int flags, int mode);
Denis Vlasenko50f7f442007-04-11 23:20:53 +0000286int open_or_warn(const char *pathname, int flags);
287int open3_or_warn(const char *pathname, int flags, int mode);
Denis Vlasenko5a6aedd2007-05-26 16:44:20 +0000288void xpipe(int filedes[2]);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000289off_t xlseek(int fd, off_t offset, int whence);
290off_t fdlength(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000291
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000292/* Useful for having small structure members/global variables */
293typedef int8_t socktype_t;
294typedef int8_t family_t;
295struct BUG_too_small {
296 char BUG_socktype_t_too_small[(0
297 | SOCK_STREAM
298 | SOCK_DGRAM
299 | SOCK_RDM
300 | SOCK_SEQPACKET
301 | SOCK_RAW
302 ) <= 127 ? 1 : -1];
303 char BUG_family_t_too_small[(0
304 | AF_UNSPEC
305 | AF_INET
306 | AF_INET6
307 | AF_UNIX
308 | AF_PACKET
309 | AF_NETLINK
310 /* | AF_DECnet */
311 /* | AF_IPX */
312 ) <= 127 ? 1 : -1];
313};
314
315
Denis Vlasenko448f0242007-01-22 22:43:05 +0000316int xsocket(int domain, int type, int protocol);
317void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
318void xlisten(int s, int backlog);
319void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000320ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Bernhard Reutner-Fischerb2908892007-04-12 11:34:39 +0000321 socklen_t tolen);
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000322/* SO_REUSEADDR allows a server to rebind to an address that is already
323 * "in use" by old connections to e.g. previous server instance which is
324 * killed or crashed. Without it bind will fail until all such connections
325 * time out. Linux does not allow multiple live binds on same ip:port
326 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
327 * Turn it on before you call bind(). */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000328void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000329int setsockopt_broadcast(int fd);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000330/* NB: returns port in host byte order */
331unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000332typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000333 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000334 union {
335 struct sockaddr sa;
336 struct sockaddr_in sin;
337#if ENABLE_FEATURE_IPV6
338 struct sockaddr_in6 sin6;
339#endif
340 };
341} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000342enum {
343 LSA_SIZEOF_SA = sizeof(
344 union {
345 struct sockaddr sa;
346 struct sockaddr_in sin;
347#if ENABLE_FEATURE_IPV6
348 struct sockaddr_in6 sin6;
349#endif
350 }
351 )
352};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000353/* Create stream socket, and allocate suitable lsa.
354 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000355 * af == AF_UNSPEC will result in trying to create IPv6 socket,
356 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000357 */
358int xsocket_type(len_and_sockaddr **lsap, USE_FEATURE_IPV6(int af,) int sock_type);
Denis Vlasenko5d687242007-01-12 20:59:31 +0000359int xsocket_stream(len_and_sockaddr **lsap);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000360/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000361 * numeric IP ("N.N.N.N") or numeric IPv6 address,
362 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000363 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000364/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000365int create_and_bind_stream_or_die(const char *bindaddr, int port);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000366int create_and_bind_dgram_or_die(const char *bindaddr, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000367/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
368 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
369 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
370 * If there is no suffix, port argument is used */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000371int create_and_connect_stream_or_die(const char *peer, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000372/* Connect to peer identified by lsa */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000373int xconnect_stream(const len_and_sockaddr *lsa);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000374/* Return malloc'ed len_and_sockaddr with socket address of host:port
375 * Currently will return IPv4 or IPv6 sockaddrs only
376 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000377 * UNIX socket address being returned, IPX sockaddr etc...
378 * On error does bb_error_msg and returns NULL */
379len_and_sockaddr* host2sockaddr(const char *host, int port);
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000380/* Version which dies on error */
Denis Vlasenko42823d52007-02-04 02:39:08 +0000381len_and_sockaddr* xhost2sockaddr(const char *host, int port);
Denis Vlasenko9ca26d32007-02-09 17:32:16 +0000382len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000383#if ENABLE_FEATURE_IPV6
384/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000385len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko42823d52007-02-04 02:39:08 +0000386len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenkoa1042e92007-01-26 07:01:10 +0000387#else
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000388/* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
389#define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
Denis Vlasenko42823d52007-02-04 02:39:08 +0000390#define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000391#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000392/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000393 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000394 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000395void set_nport(len_and_sockaddr *lsa, unsigned port);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000396/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000397int get_nport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000398/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000399char* xmalloc_sockaddr2host(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000400/* This one doesn't append :PORTNUM */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000401char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000402/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000403char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
Denis Vlasenko448f0242007-01-22 22:43:05 +0000404/* inet_[ap]ton on steroids */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000405char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
406char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000407// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000408// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenko448f0242007-01-22 22:43:05 +0000409struct hostent *xgethostbyname(const char *name);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000410// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000411// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000412
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000413
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000414void socket_want_pktinfo(int fd);
415ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
416 const struct sockaddr *from, const struct sockaddr *to,
417 socklen_t tolen);
418ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
419 struct sockaddr *from, struct sockaddr *to,
420 socklen_t sa_size);
421
Denis Vlasenko4daad902007-09-27 10:20:47 +0000422char *xstrdup(const char *s);
423char *xstrndup(const char *s, int n);
424char *safe_strncpy(char *dst, const char *src, size_t size);
425/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000426 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenko4daad902007-09-27 10:20:47 +0000427int bb_putchar(int ch);
428char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko9f739442006-12-16 23:49:13 +0000429// gcc-4.1.1 still isn't good enough at optimizing it
430// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000431//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000432//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000433//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000434//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000435#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000436#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000437#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000438#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000439#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000440
441/* dmalloc will redefine these to it's own implementation. It is safe
442 * to have the prototypes here unconditionally. */
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000443extern void *malloc_or_warn(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000444extern void *xmalloc(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000445extern void *xzalloc(size_t size);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000446extern void *xrealloc(void *old, size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000447
Denis Vlasenkoea620772006-10-14 02:23:43 +0000448extern ssize_t safe_read(int fd, void *buf, size_t count);
449extern ssize_t full_read(int fd, void *buf, size_t count);
450extern void xread(int fd, void *buf, size_t count);
451extern unsigned char xread_char(int fd);
Denis Vlasenkod67cef22007-06-13 06:47:47 +0000452// Read one line a-la fgets. Uses one read(), works only on seekable streams
Denis Vlasenkoea620772006-10-14 02:23:43 +0000453extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenkod67cef22007-06-13 06:47:47 +0000454// Read one line a-la fgets. Reads byte-by-byte.
455// Useful when it is important to not read ahead.
456extern char *xmalloc_reads(int fd, char *pfx);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000457extern ssize_t read_close(int fd, void *buf, size_t count);
458extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
459extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000460
461extern ssize_t safe_write(int fd, const void *buf, size_t count);
462extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000463extern void xwrite(int fd, const void *buf, size_t count);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000464
Denis Vlasenko1de08302006-10-26 23:32:43 +0000465/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000466extern void xprint_and_close_file(FILE *file);
467extern char *xmalloc_fgets(FILE *file);
Denis Vlasenko1de08302006-10-26 23:32:43 +0000468/* Read up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000469extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
470/* Chops off '\n' from the end, unlike fgets: */
471extern char *xmalloc_getline(FILE *file);
472extern char *bb_get_chunk_from_file(FILE *file, int *end);
473extern void die_if_ferror(FILE *file, const char *msg);
474extern void die_if_ferror_stdout(void);
475extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000476extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000477extern int fclose_if_not_stdin(FILE *file);
478extern FILE *xfopen(const char *filename, const char *mode);
479/* Prints warning to stderr and returns NULL on failure: */
480extern FILE *fopen_or_warn(const char *filename, const char *mode);
481/* "Opens" stdin if filename is special, else just opens file: */
482extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000483
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000484/* Wrapper which restarts poll on EINTR or ENOMEM.
485 * On other errors complains [perror("poll")] and returns.
486 * Warning! May take (much) longer than timeout_ms to return!
487 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
488int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms);
489
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000490/* Convert each alpha char in str to lower-case */
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000491char* str_tolower(char *str);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000492
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000493char *utoa(unsigned n);
494char *itoa(int n);
Denis Vlasenko10457b92007-03-27 22:01:31 +0000495/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000496char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
497char *itoa_to_buf(int n, char *buf, unsigned buflen);
498void smart_ulltoa5(unsigned long long ul, char buf[5]);
499//TODO: provide pointer to buf (avoid statics)?
500const char *make_human_readable_str(unsigned long long size,
501 unsigned long block_size, unsigned long display_unit);
502/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
503char *bin2hex(char *buf, const char *cp, int count);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000504
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000505/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000506struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000507 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000508 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000509};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000510#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000511/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000512/* Using xatoi() instead of naive atoi() is not always convenient -
513 * in many places people want *non-negative* values, but store them
514 * in signed int. Therefore we need this one:
515 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
516int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000517/* Useful for reading port numbers */
518uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000519
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000520
Eric Andersenaad1a882001-03-16 22:47:14 +0000521/* These parse entries in /etc/passwd and /etc/group. This is desirable
522 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000523 * increases target size and is often not needed on embedded systems. */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000524long xuname2uid(const char *name);
525long xgroup2gid(const char *name);
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000526/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000527unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000528/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000529struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000530 uid_t uid;
531 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000532};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000533/* always sets uid and gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000534int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
Denis Vlasenkocce38582007-02-26 22:47:42 +0000535/* chown-like handling of "user[:[group]" */
536void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
Denis Vlasenko3734b942007-07-27 11:20:10 +0000537/* bb_getpwuid, bb_getgrgid:
Denis Vlasenko1d10aaf2007-07-27 11:22:34 +0000538 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
539 * as a string to buf, return user/group name or NULL
540 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
541 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
Denis Vlasenko3734b942007-07-27 11:20:10 +0000542*/
543char *bb_getpwuid(char *name, int bufsize, long uid);
544char *bb_getgrgid(char *group, int bufsize, long gid);
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000545/* versions which cache results (useful for ps, ls etc) */
546const char* get_cached_username(uid_t uid);
547const char* get_cached_groupname(gid_t gid);
548void clear_username_cache(void);
549/* internally usernames are saved in fixed-sized char[] buffers */
550enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000551
Eric Andersenaad1a882001-03-16 22:47:14 +0000552
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000553struct bb_applet;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000554int execable_file(const char *name);
555char *find_execable(const char *filename);
556int exists_execable(const char *filename);
557
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000558/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
559 * but it may exec busybox and call applet instead of searching PATH.
560 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000561#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000562int bb_execvp(const char *file, char *const argv[]);
563#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
564#define BB_EXECLP(prog,cmd,...) \
565 execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
566 cmd, __VA_ARGS__)
567#else
568#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
569#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
570#endif
571
572/* NOMMU friendy fork+exec */
573pid_t spawn(char **argv);
574pid_t xspawn(char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000575
576/* Unlike waitpid, waits ONLY for one process,
577 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000578 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000579 * IOW: rc = wait4pid(spawn(argv));
580 * if (rc < 0) bb_perror_msg("%s", argv[0]);
581 * if (rc > 0) bb_error_msg("exit code: %d", rc);
582 */
Denis Vlasenko473dae02007-04-11 07:04:23 +0000583int wait4pid(int pid);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000584int wait_pid(int *wstat, int pid);
585int wait_nohang(int *wstat);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000586#define wait_crashed(w) ((w) & 127)
587#define wait_exitcode(w) ((w) >> 8)
588#define wait_stopsig(w) ((w) >> 8)
589#define wait_stopped(w) (((w) & 127) == 127)
590/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
591int spawn_and_wait(char **argv);
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000592struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000593 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000594 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000595 int xfunc_error_retval;
596 uint32_t option_mask32;
597 int die_sleep;
598 smallint saved;
599};
600void save_nofork_data(struct nofork_save_area *save);
601void restore_nofork_data(struct nofork_save_area *save);
602/* Does NOT check that applet is NOFORK, just blindly runs it */
603int run_nofork_applet(const struct bb_applet *a, char **argv);
604int run_nofork_applet_prime(struct nofork_save_area *old, const struct bb_applet *a, char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000605
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000606/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000607 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000608 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000609 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000610 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
611 * rexec's itself on NOMMU with argv passed as command line.
612 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
613 * from the start. (It will detect it and not reexec again second time).
614 * You have to audit carefully that you don't do something twice as a result
615 * (opening files/sockets, parsing config files etc...)!
616 *
617 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
618 * (will do setsid()).
619 *
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000620 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
621 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
622 * Currently used for openvt. On MMU ignores argv.
623 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000624 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000625 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000626 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
627 * to /dev/null if they are not.
628 */
629enum {
630 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000631 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000632 DAEMON_CLOSE_EXTRA_FDS = 4,
633 DAEMON_ONLY_SANITIZE = 8, /* internal use */
634};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000635#if BB_MMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000636 void forkexit_or_rexec(void);
Denis Vlasenko367960b2007-08-18 14:20:21 +0000637 enum { re_execed = 0 };
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000638# define forkexit_or_rexec(argv) forkexit_or_rexec()
639# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
640# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000641#else
Denis Vlasenko367960b2007-08-18 14:20:21 +0000642 void re_exec(char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000643 void forkexit_or_rexec(char **argv);
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000644 extern bool re_execed;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000645# define fork() BUG_fork_is_unavailable_on_nommu()
646# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
647# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000648#endif
649void bb_daemonize_or_rexec(int flags, char **argv);
650void bb_sanitize_stdio(void);
Denis Vlasenko52816302007-11-06 05:26:51 +0000651/* Clear dangerous stuff, set PATH */
652void sanitize_env_for_suid(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000653
654
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000655extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000656#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000657#define No_argument "\0"
658#define Required_argument "\001"
659#define Optional_argument "\002"
660extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000661#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000662extern uint32_t option_mask32;
Denis Vlasenkod37f2222007-08-19 13:42:08 +0000663extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000664
665
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000666typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000667 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000668 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000669} llist_t;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000670void llist_add_to(llist_t **old_head, void *data);
671void llist_add_to_end(llist_t **list_head, void *data);
672void *llist_pop(llist_t **elm);
673void llist_unlink(llist_t **head, llist_t *elm);
674void llist_free(llist_t *elm, void (*freeit)(void *data));
675llist_t *llist_rev(llist_t *list);
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000676/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000677 * llist_t *llist_add_to(llist_t *old_head, void *data)
678 * etc does not result in smaller code... */
679
Denis Vlasenko80edead2007-08-02 22:31:05 +0000680/* start_stop_daemon and udhcpc are special - they want
681 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000682#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000683/* True only if we created pidfile which is *file*, not /dev/null etc */
684extern smallint wrote_pidfile;
685void write_pidfile(const char *path);
686#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000687#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000688enum { wrote_pidfile = 0 };
689#define write_pidfile(path) ((void)0)
690#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000691#endif
692
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000693enum {
694 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000695 LOGMODE_STDIO = (1 << 0),
696 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000697 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
698};
699extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000700extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000701extern int die_sleep;
702extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000703extern jmp_buf die_jmp;
Denis Vlasenko335b63d2007-04-10 21:38:30 +0000704extern void xfunc_die(void) ATTRIBUTE_NORETURN;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000705extern void bb_show_usage(void) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000706extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
707extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
708extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000709extern void bb_simple_perror_msg(const char *s);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000710extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000711extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000712extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
713extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
714extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
715extern void bb_perror_nomsg(void);
716extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000717extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000718
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000719/* We need to export XXX_main from libbusybox
720 * only if we build "individual" binaries
721 */
722#if ENABLE_FEATURE_INDIVIDUAL
723#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
724#else
725#define MAIN_EXTERNALLY_VISIBLE
726#endif
727
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000728
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000729/* applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000730int bb_cat(char** argv);
731int bb_echo(char** argv);
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000732int test_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
733int kill_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko703e2022007-01-22 14:12:08 +0000734#if ENABLE_ROUTE
Denis Vlasenko06af2162007-02-03 17:28:39 +0000735void bb_displayroutes(int noresolve, int netstatfmt);
736#endif
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000737int chown_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko06af2162007-02-03 17:28:39 +0000738#if ENABLE_GUNZIP
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000739int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko703e2022007-01-22 14:12:08 +0000740#endif
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000741#if ENABLE_BUNZIP2
742int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
743#endif
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000744int bbunpack(char **argv,
Denis Vlasenkoc86e0522007-03-20 11:30:28 +0000745 char* (*make_new_name)(char *filename),
746 USE_DESKTOP(long long) int (*unpacker)(void)
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000747);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000748
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000749
750/* Networking */
751int create_icmp_socket(void);
752int create_icmp6_socket(void);
753/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000754/* This structure defines protocol families and their handlers. */
755struct aftype {
756 const char *name;
757 const char *title;
758 int af;
759 int alen;
760 char *(*print) (unsigned char *);
761 const char *(*sprint) (struct sockaddr *, int numeric);
762 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
763 void (*herror) (char *text);
764 int (*rprint) (int options);
765 int (*rinput) (int typ, int ext, char **argv);
766
767 /* may modify src */
768 int (*getmask) (char *src, struct sockaddr * mask, char *name);
769};
770/* This structure defines hardware protocols and their handlers. */
771struct hwtype {
772 const char *name;
773 const char *title;
774 int type;
775 int alen;
776 char *(*print) (unsigned char *);
777 int (*input) (const char *, struct sockaddr *);
778 int (*activate) (int fd);
779 int suppress_null_addr;
780};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000781extern smallint interface_opt_a;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000782int display_interfaces(char *ifname);
Denis Vlasenko1cc70222007-03-15 19:46:43 +0000783const struct aftype *get_aftype(const char *name);
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000784const struct hwtype *get_hwtype(const char *name);
785const struct hwtype *get_hwntype(int type);
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000786
787
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000788#ifndef BUILD_INDIVIDUAL
Denis Vlasenko335b63d2007-04-10 21:38:30 +0000789extern const struct bb_applet *find_applet_by_name(const char *name);
Denis Vlasenko32b633a2007-04-09 03:05:48 +0000790/* Returns only if applet is not found. */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000791extern void run_applet_and_exit(const char *name, char **argv);
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000792extern void run_appletstruct_and_exit(const struct bb_applet *a, char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000793#endif
794
Denis Vlasenkobf295dd2007-04-05 21:57:47 +0000795extern int match_fstype(const struct mntent *mt, const char *fstypes);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000796extern struct mntent *find_mount_point(const char *name, const char *table);
797extern void erase_mtab(const char * name);
798extern unsigned int tty_baud_to_value(speed_t speed);
799extern speed_t tty_value_to_baud(unsigned int value);
800extern void bb_warn_ignoring_args(int n);
801
802extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000803
Rob Landley1d589b22005-11-29 23:47:10 +0000804extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000805extern int del_loop(const char *device);
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +0000806/* If *devname is not NULL, use that name, otherwise try to find free one,
807 * malloc and return it in *devname.
808 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
809extern int set_loop(char **devname, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000810
Eric Andersenaad1a882001-03-16 22:47:14 +0000811
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000812//TODO: pass buf pointer or return allocated buf (avoid statics)?
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000813char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000814int bb_ask_confirmation(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000815
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000816extern int bb_parse_mode(const char* s, mode_t* theMode);
817
Eric Andersene5dfced2001-04-09 22:48:12 +0000818char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000819char *concat_subpath_file(const char *path, const char *filename);
Denis Vlasenkodc757aa2007-06-30 08:04:05 +0000820const char *bb_basename(const char *name);
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000821/* NB: can violate const-ness (similarly to strchr) */
Eric Andersenc911a432001-05-15 17:42:16 +0000822char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000823
Denis Vlasenko4921b542007-02-03 02:17:41 +0000824
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000825USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
826int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000827
Denis Vlasenko14579152006-10-26 01:09:46 +0000828
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000829int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000830
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000831int get_signum(const char *name);
832const char *get_signame(int number);
Denis Vlasenkoa4f4de92007-09-30 16:32:01 +0000833void print_signames(void);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000834
Manuel Novoa III cad53642003-03-19 09:13:01 +0000835char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000836
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000837#define FAIL_DELAY 3
838extern void bb_do_delay(int seconds);
839extern void change_identity(const struct passwd *pw);
840extern const char *change_identity_e2str(const struct passwd *pw);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000841extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000842extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000843#if ENABLE_SELINUX
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000844extern void renew_current_security_context(void);
845extern void set_current_security_context(security_context_t sid);
Denis Vlasenko1203c9b2007-03-11 22:16:02 +0000846extern context_t set_security_context_component(security_context_t cur_context,
847 char *user, char *role, char *type, char *range);
Denis Vlasenko39c651e2007-03-12 18:22:55 +0000848extern void setfscreatecon_or_die(security_context_t scontext);
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +0000849extern void selinux_preserve_fcontext(int fdesc);
850#else
851#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000852#endif
Denis Vlasenkod46d3c22007-02-06 19:28:50 +0000853extern void selinux_or_die(void);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000854extern int restricted_shell(const char *shell);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000855
856/* setup_environment:
857 * if loginshell = 1: cd(pw->pw_dir), clear environment, then set
858 * TERM=(old value)
859 * USER=pw->pw_name, LOGNAME=pw->pw_name
860 * PATH=bb_default_[root_]path
861 * HOME=pw->pw_dir
862 * SHELL=shell
863 * else if changeenv = 1:
864 * if not root (if pw->pw_uid != 0):
865 * USER=pw->pw_name, LOGNAME=pw->pw_name
866 * HOME=pw->pw_dir
867 * SHELL=shell
868 * else does nothing
869 */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000870extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
871extern int correct_password(const struct passwd *pw);
Denis Vlasenko21d10142007-07-20 21:28:41 +0000872/* Returns a ptr to static storage */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000873extern char *pw_encrypt(const char *clear, const char *salt);
874extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenkobfc3d822007-11-04 04:10:17 +0000875
876int index_in_str_array(const char *const string_array[], const char *key);
877int index_in_strings(const char *strings, const char *key);
878int index_in_substr_array(const char *const string_array[], const char *key);
879int index_in_substrings(const char *strings, const char *key);
880const char *nth_string(const char *strings, int n);
881
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000882extern void print_login_issue(const char *issue_file, const char *tty);
883extern void print_login_prompt(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000884
Denis Vlasenko21d10142007-07-20 21:28:41 +0000885/* rnd is additional random input. New one is returned.
886 * Useful if you call crypt_make_salt many times in a row:
887 * rnd = crypt_make_salt(buf1, 4, 0);
888 * rnd = crypt_make_salt(buf2, 4, rnd);
889 * rnd = crypt_make_salt(buf3, 4, rnd);
890 * (otherwise we risk having same salt generated)
891 */
892extern int crypt_make_salt(char *p, int cnt, int rnd);
893
894/* Returns number of lines changed, or -1 on error */
895extern int update_passwd(const char *filename, const char *username,
896 const char *new_pw);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000897
Denis Vlasenkof893da82007-08-09 08:27:24 +0000898/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
899int get_terminal_width_height(int fd, int *width, int *height);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000900
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +0000901int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
902void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
903#if ENABLE_IOCTL_HEX2STR_ERROR
904int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name);
905void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name);
906#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
907#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
908#else
909int bb_ioctl_or_warn(int fd, int request, void *argp);
910void bb_xioctl(int fd, int request, void *argp);
911#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
912#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
913#endif
914
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000915char *is_in_ino_dev_hashtable(const struct stat *statbuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000916void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
917void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +0000918#ifdef __GLIBC__
919/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000920unsigned long long bb_makedev(unsigned int major, unsigned int minor);
Denis Vlasenko0b354702006-11-24 14:54:27 +0000921#undef makedev
922#define makedev(a,b) bb_makedev(a,b)
923#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000924
925
Denis Vlasenko38f63192007-01-22 09:03:07 +0000926#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000927/* It's NOT just ENABLEd or disabled. It's a number: */
Denis Vlasenko38f63192007-01-22 09:03:07 +0000928#ifdef CONFIG_FEATURE_EDITING_HISTORY
929#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000930#else
931#define MAX_HISTORY 0
932#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000933typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000934 int flags;
935 const char *path_lookup;
936#if MAX_HISTORY
937 int cnt_history;
938 int cur_history;
Denis Vlasenko38f63192007-01-22 09:03:07 +0000939 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000940 char *history[MAX_HISTORY + 1];
941#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000942} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000943enum {
944 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +0000945 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
946 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
947 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
948 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000949 WITH_PATH_LOOKUP = 0x20,
950 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
951};
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000952line_input_t *new_line_input_t(int flags);
Denis Vlasenko6a5377a2007-09-25 18:35:28 +0000953/* Returns:
954 * -1 on read errors or EOF, or on bare Ctrl-D.
955 * 0 on ctrl-C,
956 * >0 length of input string, including terminating '\n'
957 * [is this true? stores "" in 'command' if return value is 0 or -1]
958 */
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000959int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
960#else
961int read_line_input(const char* prompt, char* command, int maxsize);
962#define read_line_input(prompt, command, maxsize, state) \
963 read_line_input(prompt, command, maxsize)
964#endif
965
966
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000967#ifndef COMM_LEN
968#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +0000969enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000970#else
971/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +0000972enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000973#endif
974#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +0000975typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000976 DIR *dir;
Denis Vlasenko512499c2007-08-26 18:23:13 +0000977 uint8_t shift_pages_to_bytes;
978 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000979/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +0000980 char *argv0;
Denis Vlasenko0696b8a2007-06-06 07:40:16 +0000981 USE_SELINUX(char *context;)
982 /* Everything below must contain no ptrs to malloc'ed data:
983 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +0000984 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000985 unsigned long stime, utime;
986 unsigned pid;
987 unsigned ppid;
988 unsigned pgid;
989 unsigned sid;
990 unsigned uid;
991 unsigned gid;
Denis Vlasenko31789a82007-06-19 14:43:17 +0000992 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +0000993#if ENABLE_FEATURE_TOPMEM
994 unsigned long mapped_rw;
995 unsigned long mapped_ro;
996 unsigned long shared_clean;
997 unsigned long shared_dirty;
998 unsigned long private_clean;
999 unsigned long private_dirty;
1000 unsigned long stack;
1001#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001002 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001003 /* basename of executable in exec(2), read from /proc/N/stat
1004 * (if executable is symlink or script, it is NOT replaced
1005 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001006 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001007 /* user/group? - use passwd/group parsing functions */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001008} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001009enum {
1010 PSSCAN_PID = 1 << 0,
1011 PSSCAN_PPID = 1 << 1,
1012 PSSCAN_PGID = 1 << 2,
1013 PSSCAN_SID = 1 << 3,
1014 PSSCAN_UIDGID = 1 << 4,
1015 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001016 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001017 PSSCAN_ARGV0 = 1 << 7,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001018 /* PSSCAN_EXE = 1 << 8, - not implemented */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001019 PSSCAN_STATE = 1 << 9,
1020 PSSCAN_VSZ = 1 << 10,
1021 PSSCAN_RSS = 1 << 11,
1022 PSSCAN_STIME = 1 << 12,
1023 PSSCAN_UTIME = 1 << 13,
1024 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001025 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko72e1c892007-09-29 22:26:01 +00001026 PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1027 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001028 /* These are all retrieved from proc/NN/stat in one go: */
1029 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1030 | PSSCAN_COMM | PSSCAN_STATE
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001031 | PSSCAN_VSZ | PSSCAN_RSS
1032 | PSSCAN_STIME | PSSCAN_UTIME
1033 | PSSCAN_TTY,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001034};
1035procps_status_t* alloc_procps_scan(int flags);
1036void free_procps_scan(procps_status_t* sp);
1037procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001038/* Format cmdline (up to col chars) into char buf[col+1] */
1039/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1040void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
Denis Vlasenko35fb5122006-11-01 09:16:49 +00001041pid_t *find_pid_by_name(const char* procName);
1042pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001043
1044
1045extern const char bb_uuenc_tbl_base64[];
1046extern const char bb_uuenc_tbl_std[];
Denis Vlasenkoe8240f12007-06-26 15:59:37 +00001047void bb_uuencode(char *store, const void *s, int length, const char *tbl);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001048
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001049typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001050 uint32_t count[2];
1051 uint32_t hash[5];
1052 uint32_t wbuf[16];
1053} sha1_ctx_t;
1054void sha1_begin(sha1_ctx_t *ctx);
1055void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
1056void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
1057
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001058typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001059 uint32_t A;
1060 uint32_t B;
1061 uint32_t C;
1062 uint32_t D;
1063 uint64_t total;
1064 uint32_t buflen;
1065 char buffer[128];
1066} md5_ctx_t;
1067void md5_begin(md5_ctx_t *ctx);
1068void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
1069void *md5_end(void *resbuf, md5_ctx_t *ctx);
1070
Denis Vlasenkoc6758a02007-04-10 21:40:19 +00001071uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001072
1073
Denis Vlasenko49622d72007-03-10 16:58:49 +00001074enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Matt Kraai01441032001-04-24 01:30:02 +00001075 FILEUTILS_PRESERVE_STATUS = 1,
Matt Kraai4c557bf2001-10-05 01:35:10 +00001076 FILEUTILS_DEREFERENCE = 2,
Matt Kraai01441032001-04-24 01:30:02 +00001077 FILEUTILS_RECUR = 4,
1078 FILEUTILS_FORCE = 8,
Denis Vlasenkof24e1f42006-10-21 23:40:20 +00001079 FILEUTILS_INTERACTIVE = 0x10,
1080 FILEUTILS_MAKE_HARDLINK = 0x20,
1081 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenko49622d72007-03-10 16:58:49 +00001082#if ENABLE_SELINUX
1083 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
1084 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
1085#endif
Matt Kraai91b28552001-04-23 18:53:07 +00001086};
1087
Denis Vlasenko49622d72007-03-10 16:58:49 +00001088#define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001089extern const char *applet_name;
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001090/* "BusyBox vN.N.N (timestamp or extra_vestion)" */
1091extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001092extern const char bb_msg_memory_exhausted[];
1093extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001094extern const char bb_msg_read_error[];
1095extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001096extern const char bb_msg_unknown[];
1097extern const char bb_msg_can_not_create_raw_socket[];
1098extern const char bb_msg_perm_denied_are_you_root[];
1099extern const char bb_msg_requires_arg[];
1100extern const char bb_msg_invalid_arg[];
1101extern const char bb_msg_standard_input[];
1102extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001103
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001104extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001105/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001106extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001107
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001108extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001109extern const char bb_path_passwd_file[];
1110extern const char bb_path_shadow_file[];
1111extern const char bb_path_gshadow_file[];
1112extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001113extern const char bb_path_motd_file[];
1114extern const char bb_path_wtmp_file[];
1115extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001116extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001117/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1118 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001119extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1120#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1121#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001122
Denis Vlasenko703e2022007-01-22 14:12:08 +00001123extern const int const_int_0;
1124extern const int const_int_1;
1125
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001126
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001127#ifndef BUFSIZ
1128#define BUFSIZ 4096
1129#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001130/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001131enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1132extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001133/* This struct is deliberately not defined. */
1134/* See docs/keep_data_small.txt */
1135struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001136/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001137 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001138 * If you want to assign a value, use PTR_TO_GLOBALS = xxx */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001139extern struct globals *const ptr_to_globals;
1140#define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001141
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001142
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001143/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1144 * use bb_default_login_shell and following defines.
1145 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1146 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001147#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001148extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001149/* "/bin/sh" */
1150#define DEFAULT_SHELL (bb_default_login_shell+1)
1151/* "sh" */
1152#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1153
1154
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001155#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001156# define CURRENT_VC "/dev/vc/0"
1157# define VC_1 "/dev/vc/1"
1158# define VC_2 "/dev/vc/2"
1159# define VC_3 "/dev/vc/3"
1160# define VC_4 "/dev/vc/4"
1161# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001162#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1163/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1164 respective serial ports .. as such, we can't use the common device paths for
1165 these. -- PFM */
1166# define SC_0 "/dev/ttsc/0"
1167# define SC_1 "/dev/ttsc/1"
1168# define SC_FORMAT "/dev/ttsc/%d"
1169#else
1170# define SC_0 "/dev/tts/0"
1171# define SC_1 "/dev/tts/1"
1172# define SC_FORMAT "/dev/tts/%d"
1173#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001174# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001175# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001176# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001177# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001178# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001179#else
1180# define CURRENT_VC "/dev/tty0"
1181# define VC_1 "/dev/tty1"
1182# define VC_2 "/dev/tty2"
1183# define VC_3 "/dev/tty3"
1184# define VC_4 "/dev/tty4"
1185# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001186#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1187# define SC_0 "/dev/ttySC0"
1188# define SC_1 "/dev/ttySC1"
1189# define SC_FORMAT "/dev/ttySC%d"
1190#else
1191# define SC_0 "/dev/ttyS0"
1192# define SC_1 "/dev/ttyS1"
1193# define SC_FORMAT "/dev/ttyS%d"
1194#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001195# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001196# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001197# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001198# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001199# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001200#endif
1201
1202/* The following devices are the same on devfs and non-devfs systems. */
1203#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001204#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001205
Rob Landleyc57ec372006-04-10 17:07:15 +00001206
Rob Landleyb623a542006-05-31 22:09:03 +00001207#ifndef RB_POWER_OFF
1208/* Stop system and switch power off if possible. */
1209#define RB_POWER_OFF 0x4321fedc
1210#endif
1211
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001212/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001213#undef isalnum
1214#undef isalpha
1215#undef isascii
1216#undef isblank
1217#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001218#undef isgraph
1219#undef islower
1220#undef isprint
1221#undef ispunct
1222#undef isspace
1223#undef isupper
1224#undef isxdigit
1225
Denis Vlasenko459903b2006-11-27 14:44:18 +00001226/* This one is more efficient - we save ~400 bytes */
1227#undef isdigit
1228#define isdigit(a) ((unsigned)((a) - '0') <= 9)
1229
1230
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001231#ifdef DMALLOC
1232#include <dmalloc.h>
1233#endif
1234
Denis Vlasenko80b8b392007-06-25 10:55:35 +00001235#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
1236
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +00001237#endif /* __LIBBUSYBOX_H__ */