blob: 5d7248104150192affd40b6e266871f9976a9b78 [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.
Rob Landleyeb84a422006-09-20 21:41:13 +00007 *
8 * 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>
Eric Andersen9e480452003-07-03 10:07:04 +000044#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000045
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000046#if ENABLE_LOCALE_SUPPORT
Rob Landleyd921b2e2006-08-03 15:41:12 +000047#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000048#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000049#define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000050#endif
51
Eric Andersen887ca792002-07-03 23:19:26 +000052#include "pwd_.h"
53#include "grp_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000054/* ifdef it out, because it may include <shadow.h> */
55/* and we may not even _have_ <shadow.h>! */
56#if ENABLE_FEATURE_SHADOWPASSWDS
Eric Andersen27f64e12002-06-23 04:24:25 +000057#include "shadow_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000058#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000059
Rob Landley362dc2b2006-06-05 17:35:24 +000060/* Try to pull in PATH_MAX */
61#include <limits.h>
62#include <sys/param.h>
63#ifndef PATH_MAX
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000064#define PATH_MAX 256
Rob Landley362dc2b2006-06-05 17:35:24 +000065#endif
66
Denis Vlasenko92297942006-11-21 11:58:14 +000067/* Tested to work correctly (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +000068#define MAXINT(T) (T)( \
69 ((T)-1) > 0 \
70 ? (T)-1 \
71 : (T)~((T)1 << (sizeof(T)*8-1)) \
72 )
73
74#define MININT(T) (T)( \
75 ((T)-1) > 0 \
76 ? (T)0 \
77 : ((T)1 << (sizeof(T)*8-1)) \
78 )
Denis Vlasenko7039a662006-10-08 17:54:47 +000079
Denis Vlasenko56254152006-10-07 16:24:46 +000080/* Large file support */
Denis Vlasenko7039a662006-10-08 17:54:47 +000081/* Note that CONFIG_LFS forces bbox to be built with all common ops
82 * (stat, lseek etc) mapped to "largefile" variants by libc.
83 * Practically it means that open() automatically has O_LARGEFILE added
84 * and all filesize/file_offset parameters and struct members are "large"
85 * (in today's world - signed 64bit). For full support of large files,
86 * we need a few helper #defines (below) and careful use of off_t
87 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +000088#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +000089/* CONFIG_LFS is on */
90# if ULONG_MAX > 0xffffffff
91/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +000092# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +000093/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
94# define BB_STRTOOFF bb_strtoul
95# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +000096/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
97# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +000098# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +000099/* "long" is too short, need "long long" */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000100# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000101# define BB_STRTOOFF bb_strtoull
102# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000103# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000104# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000105#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000106/* CONFIG_LFS is off */
107# if UINT_MAX == 0xffffffff
108/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
109 * gcc will throw warnings on printf("%d", off_t). Crap... */
110# define XATOOFF(a) xatoi_u(a)
111# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000112# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000113# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000114# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000115# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
116# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000117# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000118# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000119# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000120#endif
121/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000122#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000123
Eric Andersenaad1a882001-03-16 22:47:14 +0000124/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000125#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000126#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000127#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000128#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000129#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000130#define SKIP ((int) 2)
131
132/* for mtab.c */
133#define MTAB_GETMOUNTPT '1'
134#define MTAB_GETDEVICE '2'
135
136#define BUF_SIZE 8192
137#define EXPAND_ALLOC 1024
138
Eric Andersenaad1a882001-03-16 22:47:14 +0000139/* Macros for min/max. */
140#ifndef MIN
141#define MIN(a,b) (((a)<(b))?(a):(b))
142#endif
143
144#ifndef MAX
145#define MAX(a,b) (((a)>(b))?(a):(b))
146#endif
147
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000148/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000149#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000150#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
151#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
152#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
153#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000154#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000155#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
156#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
157#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
158#else
159#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
160#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
161#define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
162#endif
163#endif
164
165
Denis Vlasenko83e5d6f2006-12-18 21:49:06 +0000166#if defined(__GLIBC__) && __GLIBC__ < 2
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000167int vdprintf(int d, const char *format, va_list ap);
168#endif
169// This is declared here rather than #including <libgen.h> in order to avoid
170// confusing the two versions of basename. See the dirname/basename man page
171// for details.
172char *dirname(char *path);
173/* Include our own copy of struct sysinfo to avoid binary compatibility
174 * problems with Linux 2.4, which changed things. Grumble, grumble. */
175struct sysinfo {
176 long uptime; /* Seconds since boot */
177 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
178 unsigned long totalram; /* Total usable main memory size */
179 unsigned long freeram; /* Available memory size */
180 unsigned long sharedram; /* Amount of shared memory */
181 unsigned long bufferram; /* Memory used by buffers */
182 unsigned long totalswap; /* Total swap space size */
183 unsigned long freeswap; /* swap space still available */
184 unsigned short procs; /* Number of current processes */
185 unsigned short pad; /* Padding needed for m68k */
186 unsigned long totalhigh; /* Total high memory size */
187 unsigned long freehigh; /* Available high memory size */
188 unsigned int mem_unit; /* Memory unit size in bytes */
189 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000190};
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000191extern int sysinfo(struct sysinfo* info);
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000192
Manuel Novoa III cad53642003-03-19 09:13:01 +0000193
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000194extern void chomp(char *s);
195extern void trim(char *s);
196extern char *skip_whitespace(const char *);
Denis Vlasenko0de93752006-12-26 02:51:29 +0000197extern char *skip_non_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000198
Manuel Novoa III cad53642003-03-19 09:13:01 +0000199extern const char *bb_mode_string(int mode);
200extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000201extern int remove_file(const char *path, int flags);
202extern int copy_file(const char *source, const char *dest, int flags);
203extern int recursive_action(const char *fileName, int recurse,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000204 int followLinks, int depthFirst,
205 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
206 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
207 void* userData, int depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000208extern int device_open(const char *device, int mode);
209extern int get_console_fd(void);
210extern char *find_block_device(char *path);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000211/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000212extern off_t bb_copyfd_eof(int fd1, int fd2);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000213extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
214extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
215/* "short" copy can be detected by return value < size */
216/* this helper yells "short read!" if param is not -1 */
217extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000218extern char bb_process_escape_sequence(const char **ptr);
219extern char *bb_get_last_path_component(char *path);
Denis Vlasenko75f8d082006-11-22 15:54:52 +0000220extern int ndelay_on(int fd);
Denis Vlasenkoa5b3e762006-12-24 07:15:50 +0000221extern int ndelay_off(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000222
223
Rob Landleyd921b2e2006-08-03 15:41:12 +0000224extern DIR *xopendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000225extern DIR *warn_opendir(const char *path);
226
227char *xgetcwd(char *cwd);
228char *xreadlink(const char *path);
229extern void xstat(char *filename, struct stat *buf);
230extern pid_t spawn(char **argv);
231extern pid_t xspawn(char **argv);
232extern int wait4pid(int pid);
233extern void xsetgid(gid_t gid);
234extern void xsetuid(uid_t uid);
235extern void xdaemon(int nochdir, int noclose);
236extern void xchdir(const char *path);
237extern void xsetenv(const char *key, const char *value);
238extern int xopen(const char *pathname, int flags);
239extern int xopen3(const char *pathname, int flags, int mode);
240extern off_t xlseek(int fd, off_t offset, int whence);
241extern off_t fdlength(int fd);
242
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000243
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000244extern int xsocket(int domain, int type, int protocol);
245extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
246extern void xlisten(int s, int backlog);
247extern void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
248extern int xconnect_tcp_v4(struct sockaddr_in *s_addr);
249extern struct hostent *xgethostbyname(const char *name);
250extern struct hostent *xgethostbyname2(const char *name, int af);
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000251extern int xsocket_stream_ip4or6(sa_family_t *fp);
252typedef union {
253 struct sockaddr sa;
254 struct sockaddr_in sin;
255#if ENABLE_FEATURE_IPV6
256 struct sockaddr_in6 sin6;
257#endif
258} sockaddr_inet;
259extern int dotted2sockaddr(const char *dotted, struct sockaddr* sp, int socklen);
260extern int create_and_bind_socket_ip4or6(const char *hostaddr, int port);
Denis Vlasenko48237b02006-11-22 23:22:06 +0000261extern int setsockopt_reuseaddr(int fd);
262extern int setsockopt_broadcast(int fd);
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000263
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000264
265extern char *xstrdup(const char *s);
266extern char *xstrndup(const char *s, int n);
267extern char *safe_strncpy(char *dst, const char *src, size_t size);
268extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko9f739442006-12-16 23:49:13 +0000269// gcc-4.1.1 still isn't good enough at optimizing it
270// (+200 bytes compared to macro)
271//static ATTRIBUTE_ALWAYS_INLINE
272//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
273//static ATTRIBUTE_ALWAYS_INLINE
274//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
275#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
276#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000277#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
278#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000279
280/* dmalloc will redefine these to it's own implementation. It is safe
281 * to have the prototypes here unconditionally. */
282extern void *xmalloc(size_t size);
283extern void *xrealloc(void *old, size_t size);
284extern void *xzalloc(size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000285
Denis Vlasenkoea620772006-10-14 02:23:43 +0000286extern ssize_t safe_read(int fd, void *buf, size_t count);
287extern ssize_t full_read(int fd, void *buf, size_t count);
288extern void xread(int fd, void *buf, size_t count);
289extern unsigned char xread_char(int fd);
290extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000291extern ssize_t read_close(int fd, void *buf, size_t count);
292extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
293extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000294
295extern ssize_t safe_write(int fd, const void *buf, size_t count);
296extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000297extern void xwrite(int fd, const void *buf, size_t count);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000298
Denis Vlasenko1de08302006-10-26 23:32:43 +0000299/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000300extern void xprint_and_close_file(FILE *file);
301extern char *xmalloc_fgets(FILE *file);
Denis Vlasenko1de08302006-10-26 23:32:43 +0000302/* Read up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000303extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
304/* Chops off '\n' from the end, unlike fgets: */
305extern char *xmalloc_getline(FILE *file);
306extern char *bb_get_chunk_from_file(FILE *file, int *end);
307extern void die_if_ferror(FILE *file, const char *msg);
308extern void die_if_ferror_stdout(void);
309extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000310extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000311extern int fclose_if_not_stdin(FILE *file);
312extern FILE *xfopen(const char *filename, const char *mode);
313/* Prints warning to stderr and returns NULL on failure: */
314extern FILE *fopen_or_warn(const char *filename, const char *mode);
315/* "Opens" stdin if filename is special, else just opens file: */
316extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000317
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000318
Denis Vlasenkoaae03112006-11-05 00:44:39 +0000319extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000320extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
321extern char *utoa(unsigned n);
322extern void itoa_to_buf(int n, char *buf, unsigned buflen);
323extern char *itoa(int n);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000324
Eric Andersenaad1a882001-03-16 22:47:14 +0000325struct suffix_mult {
Eric Andersene5dfced2001-04-09 22:48:12 +0000326 const char *suffix;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000327 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000328};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000329#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000330/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000331/* Using xatoi() instead of naive atoi() is not always convenient -
332 * in many places people want *non-negative* values, but store them
333 * in signed int. Therefore we need this one:
334 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
335int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000336/* Useful for reading port numbers */
337uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000338
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000339
Eric Andersenaad1a882001-03-16 22:47:14 +0000340/* These parse entries in /etc/passwd and /etc/group. This is desirable
341 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000342 * increases target size and is often not needed on embedded systems. */
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000343extern long xuname2uid(const char *name);
344extern long xgroup2gid(const char *name);
345/* wrapper: allows string to contain numeric uid or gid */
346extern unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
347/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000348struct bb_uidgid_t {
349 uid_t uid;
350 gid_t gid;
351};
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000352extern int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
353/* what is this? */
354/*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
355extern char *bb_getpwuid(char *name, long uid, int bufsize);
356extern char *bb_getgrgid(char *group, long gid, int bufsize);
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000357
Eric Andersenaad1a882001-03-16 22:47:14 +0000358
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000359enum { BB_GETOPT_ERROR = 0x80000000 };
360extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000361#if ENABLE_GETOPT_LONG
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000362extern const struct option *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000363#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000364extern uint32_t option_mask32;
365extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
366
367
368typedef struct llist_s {
369 char *data;
370 struct llist_s *link;
371} llist_t;
372extern void llist_add_to(llist_t **old_head, void *data);
373extern void llist_add_to_end(llist_t **list_head, void *data);
374extern void *llist_pop(llist_t **elm);
375extern void llist_free(llist_t *elm, void (*freeit)(void *data));
376extern llist_t* rev_llist(llist_t *list);
377
378enum {
379 LOGMODE_NONE = 0,
380 LOGMODE_STDIO = 1<<0,
381 LOGMODE_SYSLOG = 1<<1,
382 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
383};
384extern const char *msg_eol;
385extern int logmode;
386extern int die_sleep;
387extern int xfunc_error_retval;
388extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
389extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
390extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
391extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
392extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
393extern void bb_vherror_msg(const char *s, va_list p);
394extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
395extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
396extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
397extern void bb_perror_nomsg(void);
398extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000399/* These are used internally -- you shouldn't need to use them */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000400extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
401extern void bb_vperror_msg(const char *s, va_list p);
402extern void bb_vinfo_msg(const char *s, va_list p);
403
404
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000405/* applets which are useful from another applets */
406extern int bb_cat(char** argv);
407extern int bb_echo(char** argv);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000408extern int bb_test(int argc, char** argv);
409
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000410
411/* Networking */
412int create_icmp_socket(void);
413int create_icmp6_socket(void);
414/* interface.c */
415extern int interface_opt_a;
416int display_interfaces(char *ifname);
417
418
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000419#ifndef BUILD_INDIVIDUAL
420extern struct BB_applet *find_applet_by_name(const char *name);
421extern void run_applet_by_name(const char *name, int argc, char **argv);
422#endif
423
424extern struct mntent *find_mount_point(const char *name, const char *table);
425extern void erase_mtab(const char * name);
426extern unsigned int tty_baud_to_value(speed_t speed);
427extern speed_t tty_value_to_baud(unsigned int value);
428extern void bb_warn_ignoring_args(int n);
429
430extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000431
Rob Landley1d589b22005-11-29 23:47:10 +0000432extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000433extern int del_loop(const char *device);
Denis Vlasenko13858992006-10-08 12:49:22 +0000434extern int set_loop(char **device, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000435
Eric Andersenaad1a882001-03-16 22:47:14 +0000436
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000437const char *make_human_readable_str(unsigned long long size,
Eric Andersen97e24262003-08-22 23:08:37 +0000438 unsigned long block_size, unsigned long display_unit);
Eric Andersenaad1a882001-03-16 22:47:14 +0000439
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000440char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000441int bb_ask_confirmation(void);
Eric Andersene76c3b02001-04-05 03:14:39 +0000442int klogctl(int type, char * b, int len);
Eric Andersenaad1a882001-03-16 22:47:14 +0000443
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000444extern int bb_parse_mode(const char* s, mode_t* theMode);
445
Eric Andersene5dfced2001-04-09 22:48:12 +0000446char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000447char *concat_subpath_file(const char *path, const char *filename);
Eric Andersenc911a432001-05-15 17:42:16 +0000448char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000449
Denis Vlasenkof6f43df2006-10-11 22:16:56 +0000450int execable_file(const char *name);
451char *find_execable(const char *filename);
452int exists_execable(const char *filename);
453
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000454USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
455int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000456
Denis Vlasenko14579152006-10-26 01:09:46 +0000457
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000458unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
459void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
Glenn L McGrath78b0e372001-06-26 02:06:08 +0000460
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000461int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000462
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000463int get_signum(const char *name);
464const char *get_signame(int number);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000465
Manuel Novoa III cad53642003-03-19 09:13:01 +0000466char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000467
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000468#define FAIL_DELAY 3
469extern void bb_do_delay(int seconds);
470extern void change_identity(const struct passwd *pw);
471extern const char *change_identity_e2str(const struct passwd *pw);
472extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000473#if ENABLE_SELINUX
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000474extern void renew_current_security_context(void);
475extern void set_current_security_context(security_context_t sid);
476#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000477extern int restricted_shell(const char *shell);
478extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
479extern int correct_password(const struct passwd *pw);
480extern char *pw_encrypt(const char *clear, const char *salt);
481extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenko5af906e2006-11-05 18:05:09 +0000482extern int index_in_str_array(const char * const string_array[], const char *key);
483extern int index_in_substr_array(const char * const string_array[], const char *key);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000484extern void print_login_issue(const char *issue_file, const char *tty);
485extern void print_login_prompt(void);
486#ifdef BB_NOMMU
487extern void vfork_daemon(int nochdir, int noclose);
488extern void vfork_daemon_rexec(int nochdir, int noclose,
489 int argc, char **argv, char *foreground_opt);
490#endif
491extern int get_terminal_width_height(int fd, int *width, int *height);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000492
493int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
494void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
495void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +0000496#ifdef __GLIBC__
497/* At least glibc has horrendously large inline for this, so wrap it */
498extern unsigned long long bb_makedev(unsigned int major, unsigned int minor);
499#undef makedev
500#define makedev(a,b) bb_makedev(a,b)
501#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000502
503
504#ifndef COMM_LEN
505#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +0000506enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000507#else
508/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +0000509enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000510#endif
511#endif
512typedef struct {
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000513 DIR *dir;
514/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000515 char *cmd;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000516 unsigned long rss;
517 unsigned long stime, utime;
518 unsigned pid;
519 unsigned ppid;
520 unsigned pgid;
521 unsigned sid;
522 unsigned uid;
523 unsigned gid;
524 /* basename of executable file in call to exec(2), size from */
525 /* sizeof(task_struct.comm) in /usr/include/linux/sched.h */
526 char state[4];
527 char comm[COMM_LEN];
528// user/group? - use passwd/group parsing functions
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000529} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000530enum {
531 PSSCAN_PID = 1 << 0,
532 PSSCAN_PPID = 1 << 1,
533 PSSCAN_PGID = 1 << 2,
534 PSSCAN_SID = 1 << 3,
535 PSSCAN_UIDGID = 1 << 4,
536 PSSCAN_COMM = 1 << 5,
537 PSSCAN_CMD = 1 << 6,
538 PSSCAN_STATE = 1 << 7,
539 PSSCAN_RSS = 1 << 8,
540 PSSCAN_STIME = 1 << 9,
541 PSSCAN_UTIME = 1 << 10,
542 /* These are all retrieved from proc/NN/stat in one go: */
543 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
544 | PSSCAN_COMM | PSSCAN_STATE
545 | PSSCAN_RSS | PSSCAN_STIME | PSSCAN_UTIME,
546};
547procps_status_t* alloc_procps_scan(int flags);
548void free_procps_scan(procps_status_t* sp);
549procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko35fb5122006-11-01 09:16:49 +0000550pid_t *find_pid_by_name(const char* procName);
551pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000552void clear_username_cache(void);
553const char* get_cached_username(uid_t uid);
Denis Vlasenkoc50f3702006-11-24 14:57:31 +0000554const char* get_cached_groupname(gid_t gid);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000555
556
557extern const char bb_uuenc_tbl_base64[];
558extern const char bb_uuenc_tbl_std[];
559void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
560
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000561typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000562 uint32_t count[2];
563 uint32_t hash[5];
564 uint32_t wbuf[16];
565} sha1_ctx_t;
566void sha1_begin(sha1_ctx_t *ctx);
567void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
568void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
569
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000570typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000571 uint32_t A;
572 uint32_t B;
573 uint32_t C;
574 uint32_t D;
575 uint64_t total;
576 uint32_t buflen;
577 char buffer[128];
578} md5_ctx_t;
579void md5_begin(md5_ctx_t *ctx);
580void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
581void *md5_end(void *resbuf, md5_ctx_t *ctx);
582
583uint32_t *crc32_filltable(int endian);
584
585
Manuel Novoa III cad53642003-03-19 09:13:01 +0000586enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
Matt Kraai01441032001-04-24 01:30:02 +0000587 FILEUTILS_PRESERVE_STATUS = 1,
Matt Kraai4c557bf2001-10-05 01:35:10 +0000588 FILEUTILS_DEREFERENCE = 2,
Matt Kraai01441032001-04-24 01:30:02 +0000589 FILEUTILS_RECUR = 4,
590 FILEUTILS_FORCE = 8,
Denis Vlasenkof24e1f42006-10-21 23:40:20 +0000591 FILEUTILS_INTERACTIVE = 0x10,
592 FILEUTILS_MAKE_HARDLINK = 0x20,
593 FILEUTILS_MAKE_SOFTLINK = 0x40,
Matt Kraai91b28552001-04-23 18:53:07 +0000594};
Denis Vlasenkof24e1f42006-10-21 23:40:20 +0000595#define FILEUTILS_CP_OPTSTR "pdRfils"
Matt Kraai91b28552001-04-23 18:53:07 +0000596
Denis Vlasenko8f8f2682006-10-03 21:00:43 +0000597extern const char *applet_name;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000598extern const char BB_BANNER[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000599
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000600extern const char bb_msg_full_version[];
601extern const char bb_msg_memory_exhausted[];
602extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000603extern const char bb_msg_read_error[];
604extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000605extern const char bb_msg_unknown[];
606extern const char bb_msg_can_not_create_raw_socket[];
607extern const char bb_msg_perm_denied_are_you_root[];
608extern const char bb_msg_requires_arg[];
609extern const char bb_msg_invalid_arg[];
610extern const char bb_msg_standard_input[];
611extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000612
Denis Vlasenko7ca39212006-11-21 20:34:21 +0000613extern const char bb_str_default[];
614
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000615extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000616extern const char bb_path_nologin_file[];
617extern const char bb_path_passwd_file[];
618extern const char bb_path_shadow_file[];
619extern const char bb_path_gshadow_file[];
620extern const char bb_path_group_file[];
621extern const char bb_path_securetty_file[];
622extern const char bb_path_motd_file[];
623extern const char bb_path_wtmp_file[];
624extern const char bb_dev_null[];
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +0000625
626#ifndef BUFSIZ
627#define BUFSIZ 4096
628#endif
629extern char bb_common_bufsiz1[BUFSIZ+1];
630
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000631/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
632 * use bb_default_login_shell and following defines.
633 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
634 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000635#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000636extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000637/* "/bin/sh" */
638#define DEFAULT_SHELL (bb_default_login_shell+1)
639/* "sh" */
640#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
641
642
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000643#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +0000644# define CURRENT_VC "/dev/vc/0"
645# define VC_1 "/dev/vc/1"
646# define VC_2 "/dev/vc/2"
647# define VC_3 "/dev/vc/3"
648# define VC_4 "/dev/vc/4"
649# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000650#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
651/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
652 respective serial ports .. as such, we can't use the common device paths for
653 these. -- PFM */
654# define SC_0 "/dev/ttsc/0"
655# define SC_1 "/dev/ttsc/1"
656# define SC_FORMAT "/dev/ttsc/%d"
657#else
658# define SC_0 "/dev/tts/0"
659# define SC_1 "/dev/tts/1"
660# define SC_FORMAT "/dev/tts/%d"
661#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000662# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000663# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000664# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +0000665# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000666#else
667# define CURRENT_VC "/dev/tty0"
668# define VC_1 "/dev/tty1"
669# define VC_2 "/dev/tty2"
670# define VC_3 "/dev/tty3"
671# define VC_4 "/dev/tty4"
672# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000673#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
674# define SC_0 "/dev/ttySC0"
675# define SC_1 "/dev/ttySC1"
676# define SC_FORMAT "/dev/ttySC%d"
677#else
678# define SC_0 "/dev/ttyS0"
679# define SC_1 "/dev/ttyS1"
680# define SC_FORMAT "/dev/ttyS%d"
681#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000682# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000683# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000684# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +0000685# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000686#endif
687
688/* The following devices are the same on devfs and non-devfs systems. */
689#define CURRENT_TTY "/dev/tty"
690#define CONSOLE_DEV "/dev/console"
691
Rob Landleyc57ec372006-04-10 17:07:15 +0000692
Rob Landleyb623a542006-05-31 22:09:03 +0000693#ifndef RB_POWER_OFF
694/* Stop system and switch power off if possible. */
695#define RB_POWER_OFF 0x4321fedc
696#endif
697
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000698/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +0000699#undef isalnum
700#undef isalpha
701#undef isascii
702#undef isblank
703#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +0000704#undef isgraph
705#undef islower
706#undef isprint
707#undef ispunct
708#undef isspace
709#undef isupper
710#undef isxdigit
711
Denis Vlasenko459903b2006-11-27 14:44:18 +0000712/* This one is more efficient - we save ~400 bytes */
713#undef isdigit
714#define isdigit(a) ((unsigned)((a) - '0') <= 9)
715
716
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000717#ifdef DMALLOC
718#include <dmalloc.h>
719#endif
720
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +0000721#endif /* __LIBBUSYBOX_H__ */