blob: 401fce4cf5b5e1dc67e8f999ee5419d8fde5265a [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>
Rob Landleyd921b2e2006-08-03 15:41:12 +000020#include <malloc.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>
Rob Landley5d9c42a2006-06-24 17:55:02 +000027#include <string.h>
28#include <strings.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000029#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000030#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000031#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000032#include <sys/stat.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000033#include <sys/statfs.h>
Rob Landley299a6b42006-05-27 21:42:58 +000034#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000035#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000036#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000037#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000038#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000039#include <unistd.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000040#include <utime.h>
Rob Landley299a6b42006-05-27 21:42:58 +000041
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000042#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000043#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000044#include <selinux/context.h>
Eric Andersen9e480452003-07-03 10:07:04 +000045#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000046
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000047#if ENABLE_LOCALE_SUPPORT
Rob Landleyd921b2e2006-08-03 15:41:12 +000048#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000049#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000050#define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000051#endif
52
Eric Andersen887ca792002-07-03 23:19:26 +000053#include "pwd_.h"
54#include "grp_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000055/* ifdef it out, because it may include <shadow.h> */
56/* and we may not even _have_ <shadow.h>! */
57#if ENABLE_FEATURE_SHADOWPASSWDS
Eric Andersen27f64e12002-06-23 04:24:25 +000058#include "shadow_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000059#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000060
Rob Landley362dc2b2006-06-05 17:35:24 +000061/* Try to pull in PATH_MAX */
62#include <limits.h>
63#include <sys/param.h>
64#ifndef PATH_MAX
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000065#define PATH_MAX 256
Rob Landley362dc2b2006-06-05 17:35:24 +000066#endif
67
Denis Vlasenko92297942006-11-21 11:58:14 +000068/* Tested to work correctly (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +000069#define MAXINT(T) (T)( \
70 ((T)-1) > 0 \
71 ? (T)-1 \
72 : (T)~((T)1 << (sizeof(T)*8-1)) \
73 )
74
75#define MININT(T) (T)( \
76 ((T)-1) > 0 \
77 ? (T)0 \
78 : ((T)1 << (sizeof(T)*8-1)) \
79 )
Denis Vlasenko7039a662006-10-08 17:54:47 +000080
Denis Vlasenko56254152006-10-07 16:24:46 +000081/* Large file support */
Denis Vlasenko7039a662006-10-08 17:54:47 +000082/* Note that CONFIG_LFS forces bbox to be built with all common ops
83 * (stat, lseek etc) mapped to "largefile" variants by libc.
84 * Practically it means that open() automatically has O_LARGEFILE added
85 * and all filesize/file_offset parameters and struct members are "large"
86 * (in today's world - signed 64bit). For full support of large files,
87 * we need a few helper #defines (below) and careful use of off_t
88 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +000089#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +000090/* CONFIG_LFS is on */
91# if ULONG_MAX > 0xffffffff
92/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +000093# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +000094/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
95# define BB_STRTOOFF bb_strtoul
96# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +000097/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
98# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +000099# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000100/* "long" is too short, need "long long" */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000101# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000102# define BB_STRTOOFF bb_strtoull
103# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000104# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000105# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000106#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000107/* CONFIG_LFS is off */
108# if UINT_MAX == 0xffffffff
109/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
110 * gcc will throw warnings on printf("%d", off_t). Crap... */
111# define XATOOFF(a) xatoi_u(a)
112# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000113# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000114# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000115# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000116# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
117# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000118# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000119# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000120# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000121#endif
122/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000123#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000124
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000125/* This structure defines protocol families and their handlers. */
126struct aftype {
Denis Vlasenko322661d2007-01-29 23:43:52 +0000127 const char *name;
128 const char *title;
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000129 int af;
130 int alen;
131 char *(*print) (unsigned char *);
132 char *(*sprint) (struct sockaddr *, int numeric);
133 int (*input) (int type, char *bufp, struct sockaddr *);
134 void (*herror) (char *text);
135 int (*rprint) (int options);
136 int (*rinput) (int typ, int ext, char **argv);
137
138 /* may modify src */
139 int (*getmask) (char *src, struct sockaddr * mask, char *name);
140
141 int fd;
142 char *flag_file;
143};
144
145/* This structure defines hardware protocols and their handlers. */
146struct hwtype {
Denis Vlasenko322661d2007-01-29 23:43:52 +0000147 const char *name;
148 const char *title;
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000149 int type;
150 int alen;
151 char *(*print) (unsigned char *);
152 int (*input) (char *, struct sockaddr *);
153 int (*activate) (int fd);
154 int suppress_null_addr;
155};
156
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
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000183#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
184#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
192#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)
195#endif
196#endif
197
198
Denis Vlasenko83e5d6f2006-12-18 21:49:06 +0000199#if defined(__GLIBC__) && __GLIBC__ < 2
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000200int vdprintf(int d, const char *format, va_list ap);
201#endif
202// This is declared here rather than #including <libgen.h> in order to avoid
203// confusing the two versions of basename. See the dirname/basename man page
204// for details.
205char *dirname(char *path);
206/* Include our own copy of struct sysinfo to avoid binary compatibility
207 * problems with Linux 2.4, which changed things. Grumble, grumble. */
208struct sysinfo {
209 long uptime; /* Seconds since boot */
210 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
211 unsigned long totalram; /* Total usable main memory size */
212 unsigned long freeram; /* Available memory size */
213 unsigned long sharedram; /* Amount of shared memory */
214 unsigned long bufferram; /* Memory used by buffers */
215 unsigned long totalswap; /* Total swap space size */
216 unsigned long freeswap; /* swap space still available */
217 unsigned short procs; /* Number of current processes */
218 unsigned short pad; /* Padding needed for m68k */
219 unsigned long totalhigh; /* Total high memory size */
220 unsigned long freehigh; /* Available high memory size */
221 unsigned int mem_unit; /* Memory unit size in bytes */
222 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000223};
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000224extern int sysinfo(struct sysinfo* info);
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000225
Manuel Novoa III cad53642003-03-19 09:13:01 +0000226
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000227extern void chomp(char *s);
228extern void trim(char *s);
229extern char *skip_whitespace(const char *);
Denis Vlasenko0de93752006-12-26 02:51:29 +0000230extern char *skip_non_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000231
Bernhard Reutner-Fischer835f5752007-01-22 17:48:08 +0000232extern const char *bb_mode_string(mode_t mode);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000233extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000234extern int remove_file(const char *path, int flags);
235extern int copy_file(const char *source, const char *dest, int flags);
236extern int recursive_action(const char *fileName, int recurse,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000237 int followLinks, int depthFirst,
238 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
239 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
240 void* userData, int depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000241extern int device_open(const char *device, int mode);
242extern int get_console_fd(void);
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +0000243extern char *find_block_device(const char *path);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000244/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000245extern off_t bb_copyfd_eof(int fd1, int fd2);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000246extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
247extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
248/* "short" copy can be detected by return value < size */
249/* this helper yells "short read!" if param is not -1 */
250extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000251extern char bb_process_escape_sequence(const char **ptr);
Denis Vlasenkob6aae0f2007-01-29 22:51:25 +0000252/* TODO: sometimes modifies its parameter, which
253 * makes it rather inconvenient at times: */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000254extern char *bb_get_last_path_component(char *path);
Denis Vlasenko75f8d082006-11-22 15:54:52 +0000255extern int ndelay_on(int fd);
Denis Vlasenkoa5b3e762006-12-24 07:15:50 +0000256extern int ndelay_off(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000257
258
Rob Landleyd921b2e2006-08-03 15:41:12 +0000259extern DIR *xopendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000260extern DIR *warn_opendir(const char *path);
261
Denis Vlasenko6ca04442007-02-11 16:19:28 +0000262char *xrealloc_getcwd_or_warn(char *cwd);
263char *xmalloc_readlink_or_warn(const char *path);
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +0000264char *xmalloc_realpath(const char *path);
Denis Vlasenko434ad542007-01-27 13:45:17 +0000265extern void xstat(const char *filename, struct stat *buf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000266extern pid_t spawn(char **argv);
267extern pid_t xspawn(char **argv);
268extern int wait4pid(int pid);
269extern void xsetgid(gid_t gid);
270extern void xsetuid(uid_t uid);
271extern void xdaemon(int nochdir, int noclose);
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000272/* More clever/thorough xdaemon */
Denis Vlasenko9af7c9d2007-01-19 21:19:35 +0000273extern void bb_sanitize_stdio_maybe_daemonize(int daemonize);
274extern void bb_sanitize_stdio(void);
Denis Vlasenkoc84520d2007-02-17 14:12:10 +0000275/* NB: be careful: dont open syslog/network sockets before bb_daemonize */
Denis Vlasenko9af7c9d2007-01-19 21:19:35 +0000276extern void bb_daemonize(void);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000277extern void xchdir(const char *path);
278extern void xsetenv(const char *key, const char *value);
279extern int xopen(const char *pathname, int flags);
280extern int xopen3(const char *pathname, int flags, int mode);
281extern off_t xlseek(int fd, off_t offset, int whence);
282extern off_t fdlength(int fd);
283
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000284
Denis Vlasenko448f0242007-01-22 22:43:05 +0000285int xsocket(int domain, int type, int protocol);
286void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
287void xlisten(int s, int backlog);
288void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
289int setsockopt_reuseaddr(int fd);
290int setsockopt_broadcast(int fd);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000291/* NB: returns port in host byte order */
292unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000293typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000294 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000295 union {
296 struct sockaddr sa;
297 struct sockaddr_in sin;
298#if ENABLE_FEATURE_IPV6
299 struct sockaddr_in6 sin6;
300#endif
301 };
302} len_and_sockaddr;
Denis Vlasenko5d687242007-01-12 20:59:31 +0000303/* Create stream socket, and allocated suitable lsa
304 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6)) */
305int xsocket_stream(len_and_sockaddr **lsap);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000306/* Create server TCP socket bound to bindaddr:port. bindaddr can be NULL,
307 * numeric IP ("N.N.N.N") or numeric IPv6 address,
308 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
309 * If there is no suffix, port argument is used */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000310int create_and_bind_stream_or_die(const char *bindaddr, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000311/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
312 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
313 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
314 * If there is no suffix, port argument is used */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000315int create_and_connect_stream_or_die(const char *peer, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000316/* Connect to peer identified by lsa */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000317int xconnect_stream(const len_and_sockaddr *lsa);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000318/* Return malloc'ed len_and_sockaddr with socket address of host:port
319 * Currently will return IPv4 or IPv6 sockaddrs only
320 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000321 * UNIX socket address being returned, IPX sockaddr etc...
322 * On error does bb_error_msg and returns NULL */
323len_and_sockaddr* host2sockaddr(const char *host, int port);
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000324/* Version which dies on error */
Denis Vlasenko42823d52007-02-04 02:39:08 +0000325len_and_sockaddr* xhost2sockaddr(const char *host, int port);
Denis Vlasenko9ca26d32007-02-09 17:32:16 +0000326len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000327#if ENABLE_FEATURE_IPV6
328/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000329len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko42823d52007-02-04 02:39:08 +0000330len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenkoa1042e92007-01-26 07:01:10 +0000331#else
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000332/* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
333#define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
Denis Vlasenko42823d52007-02-04 02:39:08 +0000334#define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000335#endif
Denis Vlasenko5d687242007-01-12 20:59:31 +0000336/* Assign sin[6]_port member if the socket is of corresponding type,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000337 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000338 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000339void set_nport(len_and_sockaddr *lsa, unsigned port);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000340/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000341int get_nport(const len_and_sockaddr *lsa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000342/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000343char* xmalloc_sockaddr2host(const struct sockaddr *sa, socklen_t salen);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000344/* This one doesn't append :PORTNUM */
345char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa, socklen_t salen);
346/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000347char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa, socklen_t salen);
348/* inet_[ap]ton on steroids */
349char* xmalloc_sockaddr2dotted(const struct sockaddr *sa, socklen_t salen);
350char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa, socklen_t salen);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000351// "old" (ipv4 only) API
Denis Vlasenko10944522007-02-04 02:40:27 +0000352// users: traceroute.c hostname.c
Denis Vlasenko448f0242007-01-22 22:43:05 +0000353struct hostent *xgethostbyname(const char *name);
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000354// Also inetd.c and inetd.c are using gethostbyname(),
355// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000356
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000357
358extern char *xstrdup(const char *s);
359extern char *xstrndup(const char *s, int n);
360extern char *safe_strncpy(char *dst, const char *src, size_t size);
361extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko9f739442006-12-16 23:49:13 +0000362// gcc-4.1.1 still isn't good enough at optimizing it
363// (+200 bytes compared to macro)
364//static ATTRIBUTE_ALWAYS_INLINE
365//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
366//static ATTRIBUTE_ALWAYS_INLINE
367//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
368#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
369#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000370#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
371#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000372
373/* dmalloc will redefine these to it's own implementation. It is safe
374 * to have the prototypes here unconditionally. */
375extern void *xmalloc(size_t size);
376extern void *xrealloc(void *old, size_t size);
377extern void *xzalloc(size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000378
Denis Vlasenkoea620772006-10-14 02:23:43 +0000379extern ssize_t safe_read(int fd, void *buf, size_t count);
380extern ssize_t full_read(int fd, void *buf, size_t count);
381extern void xread(int fd, void *buf, size_t count);
382extern unsigned char xread_char(int fd);
383extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000384extern ssize_t read_close(int fd, void *buf, size_t count);
385extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
386extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000387
388extern ssize_t safe_write(int fd, const void *buf, size_t count);
389extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000390extern void xwrite(int fd, const void *buf, size_t count);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000391
Denis Vlasenko1de08302006-10-26 23:32:43 +0000392/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000393extern void xprint_and_close_file(FILE *file);
394extern char *xmalloc_fgets(FILE *file);
Denis Vlasenko1de08302006-10-26 23:32:43 +0000395/* Read up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000396extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
397/* Chops off '\n' from the end, unlike fgets: */
398extern char *xmalloc_getline(FILE *file);
399extern char *bb_get_chunk_from_file(FILE *file, int *end);
400extern void die_if_ferror(FILE *file, const char *msg);
401extern void die_if_ferror_stdout(void);
402extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000403extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000404extern int fclose_if_not_stdin(FILE *file);
405extern FILE *xfopen(const char *filename, const char *mode);
406/* Prints warning to stderr and returns NULL on failure: */
407extern FILE *fopen_or_warn(const char *filename, const char *mode);
408/* "Opens" stdin if filename is special, else just opens file: */
409extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000410
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000411
Rob Landleyc9c1a412006-07-12 19:17:55 +0000412extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
413extern char *utoa(unsigned n);
414extern void itoa_to_buf(int n, char *buf, unsigned buflen);
415extern char *itoa(int n);
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +0000416extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
417/* Put a string of hex bytes (ala "1b"), return advanced pointer */
418extern char *bin2hex(char *buf, const char *cp, int count);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000419
Eric Andersenaad1a882001-03-16 22:47:14 +0000420struct suffix_mult {
Eric Andersene5dfced2001-04-09 22:48:12 +0000421 const char *suffix;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000422 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000423};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000424#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000425/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000426/* Using xatoi() instead of naive atoi() is not always convenient -
427 * in many places people want *non-negative* values, but store them
428 * in signed int. Therefore we need this one:
429 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
430int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000431/* Useful for reading port numbers */
432uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000433
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000434
Eric Andersenaad1a882001-03-16 22:47:14 +0000435/* These parse entries in /etc/passwd and /etc/group. This is desirable
436 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000437 * increases target size and is often not needed on embedded systems. */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000438long xuname2uid(const char *name);
439long xgroup2gid(const char *name);
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000440/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000441unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000442/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000443struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000444 uid_t uid;
445 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000446};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000447/* always sets uid and gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000448int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
Denis Vlasenkocce38582007-02-26 22:47:42 +0000449/* chown-like handling of "user[:[group]" */
450void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000451/* what is this? */
452/*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000453char *bb_getpwuid(char *name, long uid, int bufsize);
454char *bb_getgrgid(char *group, long gid, int bufsize);
455/* versions which cache results (useful for ps, ls etc) */
456const char* get_cached_username(uid_t uid);
457const char* get_cached_groupname(gid_t gid);
458void clear_username_cache(void);
459/* internally usernames are saved in fixed-sized char[] buffers */
460enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000461
Eric Andersenaad1a882001-03-16 22:47:14 +0000462
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000463enum { BB_GETOPT_ERROR = 0x80000000 };
464extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000465#if ENABLE_GETOPT_LONG
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000466extern const struct option *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000467#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000468extern uint32_t option_mask32;
469extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
470
471
472typedef struct llist_s {
473 char *data;
474 struct llist_s *link;
475} llist_t;
476extern void llist_add_to(llist_t **old_head, void *data);
477extern void llist_add_to_end(llist_t **list_head, void *data);
478extern void *llist_pop(llist_t **elm);
Denis Vlasenkoc115fdb2007-03-06 22:53:10 +0000479extern void llist_unlink(llist_t **head, llist_t *elm);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000480extern void llist_free(llist_t *elm, void (*freeit)(void *data));
Denis Vlasenko54cf5112007-02-17 18:11:45 +0000481extern llist_t* llist_rev(llist_t *list);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000482
483enum {
484 LOGMODE_NONE = 0,
485 LOGMODE_STDIO = 1<<0,
486 LOGMODE_SYSLOG = 1<<1,
487 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
488};
489extern const char *msg_eol;
490extern int logmode;
491extern int die_sleep;
492extern int xfunc_error_retval;
Denis Vlasenko9b1381f2007-01-03 02:56:00 +0000493extern void sleep_and_die(void) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000494extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
495extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
496extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
497extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
498extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
499extern void bb_vherror_msg(const char *s, va_list p);
500extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
501extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
502extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
503extern void bb_perror_nomsg(void);
504extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000505/* These are used internally -- you shouldn't need to use them */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000506extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
507extern void bb_vperror_msg(const char *s, va_list p);
508extern void bb_vinfo_msg(const char *s, va_list p);
509
510
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000511/* applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000512int bb_cat(char** argv);
513int bb_echo(char** argv);
514int bb_test(int argc, char** argv);
Denis Vlasenko703e2022007-01-22 14:12:08 +0000515#if ENABLE_ROUTE
Denis Vlasenko06af2162007-02-03 17:28:39 +0000516void bb_displayroutes(int noresolve, int netstatfmt);
517#endif
Denis Vlasenko02f0c4c2007-03-09 10:08:53 +0000518int chown_main(int argc, char **argv);
Denis Vlasenko06af2162007-02-03 17:28:39 +0000519#if ENABLE_GUNZIP
520int gunzip_main(int argc, char **argv);
Denis Vlasenko703e2022007-01-22 14:12:08 +0000521#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000522
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000523
524/* Networking */
525int create_icmp_socket(void);
526int create_icmp6_socket(void);
527/* interface.c */
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000528struct aftype;
529struct hwtype;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000530extern int interface_opt_a;
531int display_interfaces(char *ifname);
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000532struct aftype *get_aftype(const char *name);
533const struct hwtype *get_hwtype(const char *name);
534const struct hwtype *get_hwntype(int type);
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000535
536
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000537#ifndef BUILD_INDIVIDUAL
538extern struct BB_applet *find_applet_by_name(const char *name);
539extern void run_applet_by_name(const char *name, int argc, char **argv);
540#endif
541
542extern struct mntent *find_mount_point(const char *name, const char *table);
543extern void erase_mtab(const char * name);
544extern unsigned int tty_baud_to_value(speed_t speed);
545extern speed_t tty_value_to_baud(unsigned int value);
546extern void bb_warn_ignoring_args(int n);
547
548extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000549
Rob Landley1d589b22005-11-29 23:47:10 +0000550extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000551extern int del_loop(const char *device);
Denis Vlasenko13858992006-10-08 12:49:22 +0000552extern int set_loop(char **device, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000553
Eric Andersenaad1a882001-03-16 22:47:14 +0000554
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000555const char *make_human_readable_str(unsigned long long size,
Eric Andersen97e24262003-08-22 23:08:37 +0000556 unsigned long block_size, unsigned long display_unit);
Eric Andersenaad1a882001-03-16 22:47:14 +0000557
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000558char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000559int bb_ask_confirmation(void);
Eric Andersene76c3b02001-04-05 03:14:39 +0000560int klogctl(int type, char * b, int len);
Eric Andersenaad1a882001-03-16 22:47:14 +0000561
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000562extern int bb_parse_mode(const char* s, mode_t* theMode);
563
Eric Andersene5dfced2001-04-09 22:48:12 +0000564char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000565char *concat_subpath_file(const char *path, const char *filename);
Eric Andersenc911a432001-05-15 17:42:16 +0000566char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000567
Denis Vlasenkof6f43df2006-10-11 22:16:56 +0000568int execable_file(const char *name);
569char *find_execable(const char *filename);
570int exists_execable(const char *filename);
571
Denis Vlasenko710694f2007-02-07 20:27:03 +0000572#if ENABLE_FEATURE_EXEC_PREFER_APPLETS
Denis Vlasenko1d76f432007-02-06 01:20:12 +0000573int bb_execvp(const char *file, char *const argv[]);
574#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
Denis Vlasenko4921b542007-02-03 02:17:41 +0000575#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1d76f432007-02-06 01:20:12 +0000576 execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
577 cmd, __VA_ARGS__)
Denis Vlasenko4921b542007-02-03 02:17:41 +0000578#else
Denis Vlasenko1d76f432007-02-06 01:20:12 +0000579#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000580#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
Denis Vlasenko4921b542007-02-03 02:17:41 +0000581#endif
582
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000583USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
584int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000585
Denis Vlasenko14579152006-10-26 01:09:46 +0000586
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000587int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000588
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000589int get_signum(const char *name);
590const char *get_signame(int number);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000591
Manuel Novoa III cad53642003-03-19 09:13:01 +0000592char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000593
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000594#define FAIL_DELAY 3
595extern void bb_do_delay(int seconds);
596extern void change_identity(const struct passwd *pw);
597extern const char *change_identity_e2str(const struct passwd *pw);
598extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000599#if ENABLE_SELINUX
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000600extern void renew_current_security_context(void);
601extern void set_current_security_context(security_context_t sid);
Denis Vlasenko1203c9b2007-03-11 22:16:02 +0000602extern context_t set_security_context_component(security_context_t cur_context,
603 char *user, char *role, char *type, char *range);
Denis Vlasenko39c651e2007-03-12 18:22:55 +0000604extern void setfscreatecon_or_die(security_context_t scontext);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000605#endif
Denis Vlasenkod46d3c22007-02-06 19:28:50 +0000606extern void selinux_or_die(void);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000607extern int restricted_shell(const char *shell);
608extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
609extern int correct_password(const struct passwd *pw);
610extern char *pw_encrypt(const char *clear, const char *salt);
611extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenko5af906e2006-11-05 18:05:09 +0000612extern int index_in_str_array(const char * const string_array[], const char *key);
613extern int index_in_substr_array(const char * const string_array[], const char *key);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000614extern void print_login_issue(const char *issue_file, const char *tty);
615extern void print_login_prompt(void);
616#ifdef BB_NOMMU
617extern void vfork_daemon(int nochdir, int noclose);
618extern void vfork_daemon_rexec(int nochdir, int noclose,
619 int argc, char **argv, char *foreground_opt);
620#endif
Bernhard Reutner-Fischeraf457602007-01-20 21:33:50 +0000621extern int get_terminal_width_height(const int fd, int *width, int *height);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000622
623int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
624void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
625void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +0000626#ifdef __GLIBC__
627/* At least glibc has horrendously large inline for this, so wrap it */
628extern unsigned long long bb_makedev(unsigned int major, unsigned int minor);
629#undef makedev
630#define makedev(a,b) bb_makedev(a,b)
631#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000632
633
Denis Vlasenko38f63192007-01-22 09:03:07 +0000634#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000635/* It's NOT just ENABLEd or disabled. It's a number: */
Denis Vlasenko38f63192007-01-22 09:03:07 +0000636#ifdef CONFIG_FEATURE_EDITING_HISTORY
637#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000638#else
639#define MAX_HISTORY 0
640#endif
641struct line_input_t {
642 int flags;
643 const char *path_lookup;
644#if MAX_HISTORY
645 int cnt_history;
646 int cur_history;
Denis Vlasenko38f63192007-01-22 09:03:07 +0000647 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000648 char *history[MAX_HISTORY + 1];
649#endif
650};
651enum {
652 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +0000653 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
654 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
655 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
656 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +0000657 WITH_PATH_LOOKUP = 0x20,
658 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
659};
660typedef struct line_input_t line_input_t;
661line_input_t *new_line_input_t(int flags);
662int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
663#else
664int read_line_input(const char* prompt, char* command, int maxsize);
665#define read_line_input(prompt, command, maxsize, state) \
666 read_line_input(prompt, command, maxsize)
667#endif
668
669
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000670#ifndef COMM_LEN
671#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +0000672enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000673#else
674/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +0000675enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000676#endif
677#endif
678typedef struct {
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000679 DIR *dir;
680/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000681 char *cmd;
Mike Frysinger0aa6ba52007-02-08 08:21:58 +0000682 unsigned long vsz;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000683 unsigned long stime, utime;
684 unsigned pid;
685 unsigned ppid;
686 unsigned pgid;
687 unsigned sid;
688 unsigned uid;
689 unsigned gid;
690 /* basename of executable file in call to exec(2), size from */
691 /* sizeof(task_struct.comm) in /usr/include/linux/sched.h */
692 char state[4];
693 char comm[COMM_LEN];
694// user/group? - use passwd/group parsing functions
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000695} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000696enum {
697 PSSCAN_PID = 1 << 0,
698 PSSCAN_PPID = 1 << 1,
699 PSSCAN_PGID = 1 << 2,
700 PSSCAN_SID = 1 << 3,
701 PSSCAN_UIDGID = 1 << 4,
702 PSSCAN_COMM = 1 << 5,
703 PSSCAN_CMD = 1 << 6,
704 PSSCAN_STATE = 1 << 7,
Mike Frysinger0aa6ba52007-02-08 08:21:58 +0000705 PSSCAN_VSZ = 1 << 8,
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000706 PSSCAN_STIME = 1 << 9,
707 PSSCAN_UTIME = 1 << 10,
708 /* These are all retrieved from proc/NN/stat in one go: */
709 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
710 | PSSCAN_COMM | PSSCAN_STATE
Mike Frysinger0aa6ba52007-02-08 08:21:58 +0000711 | PSSCAN_VSZ | PSSCAN_STIME | PSSCAN_UTIME,
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000712};
713procps_status_t* alloc_procps_scan(int flags);
714void free_procps_scan(procps_status_t* sp);
715procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko35fb5122006-11-01 09:16:49 +0000716pid_t *find_pid_by_name(const char* procName);
717pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000718
719
720extern const char bb_uuenc_tbl_base64[];
721extern const char bb_uuenc_tbl_std[];
722void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
723
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000724typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000725 uint32_t count[2];
726 uint32_t hash[5];
727 uint32_t wbuf[16];
728} sha1_ctx_t;
729void sha1_begin(sha1_ctx_t *ctx);
730void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
731void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
732
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000733typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000734 uint32_t A;
735 uint32_t B;
736 uint32_t C;
737 uint32_t D;
738 uint64_t total;
739 uint32_t buflen;
740 char buffer[128];
741} md5_ctx_t;
742void md5_begin(md5_ctx_t *ctx);
743void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
744void *md5_end(void *resbuf, md5_ctx_t *ctx);
745
746uint32_t *crc32_filltable(int endian);
747
748
Denis Vlasenko49622d72007-03-10 16:58:49 +0000749enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Matt Kraai01441032001-04-24 01:30:02 +0000750 FILEUTILS_PRESERVE_STATUS = 1,
Matt Kraai4c557bf2001-10-05 01:35:10 +0000751 FILEUTILS_DEREFERENCE = 2,
Matt Kraai01441032001-04-24 01:30:02 +0000752 FILEUTILS_RECUR = 4,
753 FILEUTILS_FORCE = 8,
Denis Vlasenkof24e1f42006-10-21 23:40:20 +0000754 FILEUTILS_INTERACTIVE = 0x10,
755 FILEUTILS_MAKE_HARDLINK = 0x20,
756 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenko49622d72007-03-10 16:58:49 +0000757#if ENABLE_SELINUX
758 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
759 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
760#endif
Matt Kraai91b28552001-04-23 18:53:07 +0000761};
762
Denis Vlasenko49622d72007-03-10 16:58:49 +0000763#define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
Denis Vlasenko8f8f2682006-10-03 21:00:43 +0000764extern const char *applet_name;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000765extern const char BB_BANNER[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000766
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000767extern const char bb_msg_full_version[];
768extern const char bb_msg_memory_exhausted[];
769extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000770extern const char bb_msg_read_error[];
771extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000772extern const char bb_msg_unknown[];
773extern const char bb_msg_can_not_create_raw_socket[];
774extern const char bb_msg_perm_denied_are_you_root[];
775extern const char bb_msg_requires_arg[];
776extern const char bb_msg_invalid_arg[];
777extern const char bb_msg_standard_input[];
778extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000779
Denis Vlasenko7ca39212006-11-21 20:34:21 +0000780extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +0000781/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +0000782extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +0000783
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000784extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000785extern const char bb_path_nologin_file[];
786extern const char bb_path_passwd_file[];
787extern const char bb_path_shadow_file[];
788extern const char bb_path_gshadow_file[];
789extern const char bb_path_group_file[];
790extern const char bb_path_securetty_file[];
791extern const char bb_path_motd_file[];
792extern const char bb_path_wtmp_file[];
793extern const char bb_dev_null[];
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +0000794
Denis Vlasenko703e2022007-01-22 14:12:08 +0000795extern const int const_int_0;
796extern const int const_int_1;
797
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +0000798#ifndef BUFSIZ
799#define BUFSIZ 4096
800#endif
801extern char bb_common_bufsiz1[BUFSIZ+1];
802
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000803/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
804 * use bb_default_login_shell and following defines.
805 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
806 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000807#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000808extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000809/* "/bin/sh" */
810#define DEFAULT_SHELL (bb_default_login_shell+1)
811/* "sh" */
812#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
813
814
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000815#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +0000816# define CURRENT_VC "/dev/vc/0"
817# define VC_1 "/dev/vc/1"
818# define VC_2 "/dev/vc/2"
819# define VC_3 "/dev/vc/3"
820# define VC_4 "/dev/vc/4"
821# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000822#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
823/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
824 respective serial ports .. as such, we can't use the common device paths for
825 these. -- PFM */
826# define SC_0 "/dev/ttsc/0"
827# define SC_1 "/dev/ttsc/1"
828# define SC_FORMAT "/dev/ttsc/%d"
829#else
830# define SC_0 "/dev/tts/0"
831# define SC_1 "/dev/tts/1"
832# define SC_FORMAT "/dev/tts/%d"
833#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000834# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000835# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000836# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +0000837# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000838#else
839# define CURRENT_VC "/dev/tty0"
840# define VC_1 "/dev/tty1"
841# define VC_2 "/dev/tty2"
842# define VC_3 "/dev/tty3"
843# define VC_4 "/dev/tty4"
844# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000845#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
846# define SC_0 "/dev/ttySC0"
847# define SC_1 "/dev/ttySC1"
848# define SC_FORMAT "/dev/ttySC%d"
849#else
850# define SC_0 "/dev/ttyS0"
851# define SC_1 "/dev/ttyS1"
852# define SC_FORMAT "/dev/ttyS%d"
853#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000854# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000855# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000856# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +0000857# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000858#endif
859
860/* The following devices are the same on devfs and non-devfs systems. */
861#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +0000862#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +0000863
Rob Landleyc57ec372006-04-10 17:07:15 +0000864
Rob Landleyb623a542006-05-31 22:09:03 +0000865#ifndef RB_POWER_OFF
866/* Stop system and switch power off if possible. */
867#define RB_POWER_OFF 0x4321fedc
868#endif
869
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000870/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +0000871#undef isalnum
872#undef isalpha
873#undef isascii
874#undef isblank
875#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +0000876#undef isgraph
877#undef islower
878#undef isprint
879#undef ispunct
880#undef isspace
881#undef isupper
882#undef isxdigit
883
Denis Vlasenko459903b2006-11-27 14:44:18 +0000884/* This one is more efficient - we save ~400 bytes */
885#undef isdigit
886#define isdigit(a) ((unsigned)((a) - '0') <= 9)
887
888
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000889#ifdef DMALLOC
890#include <dmalloc.h>
891#endif
892
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +0000893#endif /* __LIBBUSYBOX_H__ */