blob: ef5086d6ceb7f9e958d6b75dc6b0a7229eecd081 [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
Eric Andersen9e480452003-07-03 10:07:04 +000042#ifdef CONFIG_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
Rob Landleyd921b2e2006-08-03 15:41:12 +000046#ifdef CONFIG_LOCALE_SUPPORT
47#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000048#else
49#define setlocale(x,y)
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"
Eric Andersen27f64e12002-06-23 04:24:25 +000054#include "shadow_.h"
Eric Andersen27f64e12002-06-23 04:24:25 +000055
Rob Landley362dc2b2006-06-05 17:35:24 +000056/* Try to pull in PATH_MAX */
57#include <limits.h>
58#include <sys/param.h>
59#ifndef PATH_MAX
60#define PATH_MAX 256
61#endif
62
Denis Vlasenko92297942006-11-21 11:58:14 +000063/* Tested to work correctly (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +000064#define MAXINT(T) (T)( \
65 ((T)-1) > 0 \
66 ? (T)-1 \
67 : (T)~((T)1 << (sizeof(T)*8-1)) \
68 )
69
70#define MININT(T) (T)( \
71 ((T)-1) > 0 \
72 ? (T)0 \
73 : ((T)1 << (sizeof(T)*8-1)) \
74 )
Denis Vlasenko7039a662006-10-08 17:54:47 +000075
Denis Vlasenko56254152006-10-07 16:24:46 +000076/* Large file support */
Denis Vlasenko7039a662006-10-08 17:54:47 +000077/* Note that CONFIG_LFS forces bbox to be built with all common ops
78 * (stat, lseek etc) mapped to "largefile" variants by libc.
79 * Practically it means that open() automatically has O_LARGEFILE added
80 * and all filesize/file_offset parameters and struct members are "large"
81 * (in today's world - signed 64bit). For full support of large files,
82 * we need a few helper #defines (below) and careful use of off_t
83 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +000084#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +000085/* CONFIG_LFS is on */
86# if ULONG_MAX > 0xffffffff
87/* "long" is long enough on this system */
Denis Vlasenkod686a042006-11-27 14:43:21 +000088# define XSTRTOOFF xstrtoul
89/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
90# define BB_STRTOOFF bb_strtoul
91# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +000092/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
93# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +000094# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +000095/* "long" is too short, need "long long" */
Denis Vlasenkod686a042006-11-27 14:43:21 +000096# define XSTRTOOFF xstrtoull
97# define BB_STRTOOFF bb_strtoull
98# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +000099# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000100# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000101#else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000102# if 0 /* #if UINT_MAX == 0xffffffff */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000103/* Doesn't work. off_t is a long. gcc will throw warnings on printf("%d", off_t)
104 * even if long==int on this arch. Crap... */
Denis Vlasenkod686a042006-11-27 14:43:21 +0000105# define XSTRTOOFF xstrtou
106# define BB_STRTOOFF bb_strtoi
Denis Vlasenko7039a662006-10-08 17:54:47 +0000107# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000108# define OFF_FMT ""
Denis Vlasenko7039a662006-10-08 17:54:47 +0000109# else
Denis Vlasenkod686a042006-11-27 14:43:21 +0000110# define XSTRTOOFF xstrtoul
111# define BB_STRTOOFF bb_strtol
Denis Vlasenko7039a662006-10-08 17:54:47 +0000112# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000113# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000114# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000115#endif
116/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000117#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000118
Eric Andersenaad1a882001-03-16 22:47:14 +0000119/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000120#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000121#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000122#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000123#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000124#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000125#define SKIP ((int) 2)
126
127/* for mtab.c */
128#define MTAB_GETMOUNTPT '1'
129#define MTAB_GETDEVICE '2'
130
131#define BUF_SIZE 8192
132#define EXPAND_ALLOC 1024
133
Eric Andersenaad1a882001-03-16 22:47:14 +0000134/* Macros for min/max. */
135#ifndef MIN
136#define MIN(a,b) (((a)<(b))?(a):(b))
137#endif
138
139#ifndef MAX
140#define MAX(a,b) (((a)>(b))?(a):(b))
141#endif
142
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000143/* buffer allocation schemes */
144#ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
145#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
146#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
147#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
148#else
149#ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
150#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
151#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
152#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
153#else
154#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
155#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
156#define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
157#endif
158#endif
159
160
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000161#if (__GLIBC__ < 2)
162int vdprintf(int d, const char *format, va_list ap);
163#endif
164// This is declared here rather than #including <libgen.h> in order to avoid
165// confusing the two versions of basename. See the dirname/basename man page
166// for details.
167char *dirname(char *path);
168/* Include our own copy of struct sysinfo to avoid binary compatibility
169 * problems with Linux 2.4, which changed things. Grumble, grumble. */
170struct sysinfo {
171 long uptime; /* Seconds since boot */
172 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
173 unsigned long totalram; /* Total usable main memory size */
174 unsigned long freeram; /* Available memory size */
175 unsigned long sharedram; /* Amount of shared memory */
176 unsigned long bufferram; /* Memory used by buffers */
177 unsigned long totalswap; /* Total swap space size */
178 unsigned long freeswap; /* swap space still available */
179 unsigned short procs; /* Number of current processes */
180 unsigned short pad; /* Padding needed for m68k */
181 unsigned long totalhigh; /* Total high memory size */
182 unsigned long freehigh; /* Available high memory size */
183 unsigned int mem_unit; /* Memory unit size in bytes */
184 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000185};
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000186extern int sysinfo(struct sysinfo* info);
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000187
Manuel Novoa III cad53642003-03-19 09:13:01 +0000188
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000189extern void chomp(char *s);
190extern void trim(char *s);
191extern char *skip_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000192
Manuel Novoa III cad53642003-03-19 09:13:01 +0000193extern const char *bb_mode_string(int mode);
194extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000195extern int remove_file(const char *path, int flags);
196extern int copy_file(const char *source, const char *dest, int flags);
197extern int recursive_action(const char *fileName, int recurse,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000198 int followLinks, int depthFirst,
199 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
200 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
201 void* userData, int depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000202extern int device_open(const char *device, int mode);
203extern int get_console_fd(void);
204extern char *find_block_device(char *path);
205extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
206extern off_t bb_copyfd_eof(int fd1, int fd2);
207extern char bb_process_escape_sequence(const char **ptr);
208extern char *bb_get_last_path_component(char *path);
Denis Vlasenko75f8d082006-11-22 15:54:52 +0000209extern int ndelay_on(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000210
211
Rob Landleyd921b2e2006-08-03 15:41:12 +0000212extern DIR *xopendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000213extern DIR *warn_opendir(const char *path);
214
215char *xgetcwd(char *cwd);
216char *xreadlink(const char *path);
217extern void xstat(char *filename, struct stat *buf);
218extern pid_t spawn(char **argv);
219extern pid_t xspawn(char **argv);
220extern int wait4pid(int pid);
221extern void xsetgid(gid_t gid);
222extern void xsetuid(uid_t uid);
223extern void xdaemon(int nochdir, int noclose);
224extern void xchdir(const char *path);
225extern void xsetenv(const char *key, const char *value);
226extern int xopen(const char *pathname, int flags);
227extern int xopen3(const char *pathname, int flags, int mode);
228extern off_t xlseek(int fd, off_t offset, int whence);
229extern off_t fdlength(int fd);
230
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000231
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000232extern int xsocket(int domain, int type, int protocol);
233extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
234extern void xlisten(int s, int backlog);
235extern void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
236extern int xconnect_tcp_v4(struct sockaddr_in *s_addr);
237extern struct hostent *xgethostbyname(const char *name);
238extern struct hostent *xgethostbyname2(const char *name, int af);
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000239extern int xsocket_stream_ip4or6(sa_family_t *fp);
240typedef union {
241 struct sockaddr sa;
242 struct sockaddr_in sin;
243#if ENABLE_FEATURE_IPV6
244 struct sockaddr_in6 sin6;
245#endif
246} sockaddr_inet;
247extern int dotted2sockaddr(const char *dotted, struct sockaddr* sp, int socklen);
248extern int create_and_bind_socket_ip4or6(const char *hostaddr, int port);
Denis Vlasenko48237b02006-11-22 23:22:06 +0000249extern int setsockopt_reuseaddr(int fd);
250extern int setsockopt_broadcast(int fd);
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000251
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000252
253extern char *xstrdup(const char *s);
254extern char *xstrndup(const char *s, int n);
255extern char *safe_strncpy(char *dst, const char *src, size_t size);
256extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
257
258/* dmalloc will redefine these to it's own implementation. It is safe
259 * to have the prototypes here unconditionally. */
260extern void *xmalloc(size_t size);
261extern void *xrealloc(void *old, size_t size);
262extern void *xzalloc(size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000263
Denis Vlasenkoea620772006-10-14 02:23:43 +0000264extern ssize_t safe_read(int fd, void *buf, size_t count);
265extern ssize_t full_read(int fd, void *buf, size_t count);
266extern void xread(int fd, void *buf, size_t count);
267extern unsigned char xread_char(int fd);
268extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000269extern ssize_t read_close(int fd, void *buf, size_t count);
270extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
271extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000272
273extern ssize_t safe_write(int fd, const void *buf, size_t count);
274extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000275extern void xwrite(int fd, const void *buf, size_t count);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000276
Denis Vlasenko1de08302006-10-26 23:32:43 +0000277/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000278extern void xprint_and_close_file(FILE *file);
279extern char *xmalloc_fgets(FILE *file);
Denis Vlasenko1de08302006-10-26 23:32:43 +0000280/* Read up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000281extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
282/* Chops off '\n' from the end, unlike fgets: */
283extern char *xmalloc_getline(FILE *file);
284extern char *bb_get_chunk_from_file(FILE *file, int *end);
285extern void die_if_ferror(FILE *file, const char *msg);
286extern void die_if_ferror_stdout(void);
287extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000288extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000289extern int fclose_if_not_stdin(FILE *file);
290extern FILE *xfopen(const char *filename, const char *mode);
291/* Prints warning to stderr and returns NULL on failure: */
292extern FILE *fopen_or_warn(const char *filename, const char *mode);
293/* "Opens" stdin if filename is special, else just opens file: */
294extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000295
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000296
Denis Vlasenkoaae03112006-11-05 00:44:39 +0000297extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000298extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
299extern char *utoa(unsigned n);
300extern void itoa_to_buf(int n, char *buf, unsigned buflen);
301extern char *itoa(int n);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000302
Eric Andersenaad1a882001-03-16 22:47:14 +0000303struct suffix_mult {
Eric Andersene5dfced2001-04-09 22:48:12 +0000304 const char *suffix;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000305 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000306};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000307#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000308/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000309/* Using xatoi() instead of naive atoi() is not always convenient -
310 * in many places people want *non-negative* values, but store them
311 * in signed int. Therefore we need this one:
312 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
313int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000314/* Useful for reading port numbers */
315uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000316
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000317
Eric Andersenaad1a882001-03-16 22:47:14 +0000318/* These parse entries in /etc/passwd and /etc/group. This is desirable
319 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000320 * increases target size and is often not needed on embedded systems. */
321extern long bb_xgetpwnam(const char *name);
322extern long bb_xgetgrnam(const char *name);
Denis Vlasenkobecd8c52006-12-01 21:34:20 +0000323/*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
Denis Vlasenkocf944462006-10-03 19:02:20 +0000324extern char *bb_getpwuid(char *name, long uid, int bufsize);
325extern char *bb_getgrgid(char *group, long gid, int bufsize);
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000326/* from chpst */
327struct bb_uidgid_t {
328 uid_t uid;
329 gid_t gid;
330};
331extern unsigned uidgid_get(struct bb_uidgid_t*, const char* /*, unsigned*/);
332
Eric Andersenaad1a882001-03-16 22:47:14 +0000333
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000334enum { BB_GETOPT_ERROR = 0x80000000 };
335extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000336#if ENABLE_GETOPT_LONG
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000337extern const struct option *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000338#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000339extern uint32_t option_mask32;
340extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
341
342
343typedef struct llist_s {
344 char *data;
345 struct llist_s *link;
346} llist_t;
347extern void llist_add_to(llist_t **old_head, void *data);
348extern void llist_add_to_end(llist_t **list_head, void *data);
349extern void *llist_pop(llist_t **elm);
350extern void llist_free(llist_t *elm, void (*freeit)(void *data));
351extern llist_t* rev_llist(llist_t *list);
352
353enum {
354 LOGMODE_NONE = 0,
355 LOGMODE_STDIO = 1<<0,
356 LOGMODE_SYSLOG = 1<<1,
357 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
358};
359extern const char *msg_eol;
360extern int logmode;
361extern int die_sleep;
362extern int xfunc_error_retval;
363extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
364extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
365extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
366extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
367extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
368extern void bb_vherror_msg(const char *s, va_list p);
369extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
370extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
371extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
372extern void bb_perror_nomsg(void);
373extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000374/* These are used internally -- you shouldn't need to use them */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000375extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
376extern void bb_vperror_msg(const char *s, va_list p);
377extern void bb_vinfo_msg(const char *s, va_list p);
378
379
380extern int bb_echo(int argc, char** argv);
381extern int bb_test(int argc, char** argv);
382
383#ifndef BUILD_INDIVIDUAL
384extern struct BB_applet *find_applet_by_name(const char *name);
385extern void run_applet_by_name(const char *name, int argc, char **argv);
386#endif
387
388extern struct mntent *find_mount_point(const char *name, const char *table);
389extern void erase_mtab(const char * name);
390extern unsigned int tty_baud_to_value(speed_t speed);
391extern speed_t tty_value_to_baud(unsigned int value);
392extern void bb_warn_ignoring_args(int n);
393
394extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000395
Rob Landley1d589b22005-11-29 23:47:10 +0000396extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000397extern int del_loop(const char *device);
Denis Vlasenko13858992006-10-08 12:49:22 +0000398extern int set_loop(char **device, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000399
Eric Andersenaad1a882001-03-16 22:47:14 +0000400
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000401const char *make_human_readable_str(unsigned long long size,
Eric Andersen97e24262003-08-22 23:08:37 +0000402 unsigned long block_size, unsigned long display_unit);
Eric Andersenaad1a882001-03-16 22:47:14 +0000403
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000404char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000405int bb_ask_confirmation(void);
Eric Andersene76c3b02001-04-05 03:14:39 +0000406int klogctl(int type, char * b, int len);
Eric Andersenaad1a882001-03-16 22:47:14 +0000407
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000408extern int bb_parse_mode(const char* s, mode_t* theMode);
409
Eric Andersene5dfced2001-04-09 22:48:12 +0000410char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000411char *concat_subpath_file(const char *path, const char *filename);
Eric Andersenc911a432001-05-15 17:42:16 +0000412char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000413
Denis Vlasenkof6f43df2006-10-11 22:16:56 +0000414int execable_file(const char *name);
415char *find_execable(const char *filename);
416int exists_execable(const char *filename);
417
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000418USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
419int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000420
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000421int create_icmp_socket(void);
422int create_icmp6_socket(void);
Denis Vlasenko14579152006-10-26 01:09:46 +0000423
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000424unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
425void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
Glenn L McGrath78b0e372001-06-26 02:06:08 +0000426
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000427int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000428
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000429int get_signum(const char *name);
430const char *get_signame(int number);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000431
Manuel Novoa III cad53642003-03-19 09:13:01 +0000432char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000433
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000434#define FAIL_DELAY 3
435extern void bb_do_delay(int seconds);
436extern void change_identity(const struct passwd *pw);
437extern const char *change_identity_e2str(const struct passwd *pw);
438extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
439#ifdef CONFIG_SELINUX
440extern void renew_current_security_context(void);
441extern void set_current_security_context(security_context_t sid);
442#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000443extern int restricted_shell(const char *shell);
444extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
445extern int correct_password(const struct passwd *pw);
446extern char *pw_encrypt(const char *clear, const char *salt);
447extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenko5af906e2006-11-05 18:05:09 +0000448extern int index_in_str_array(const char * const string_array[], const char *key);
449extern int index_in_substr_array(const char * const string_array[], const char *key);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000450extern void print_login_issue(const char *issue_file, const char *tty);
451extern void print_login_prompt(void);
452#ifdef BB_NOMMU
453extern void vfork_daemon(int nochdir, int noclose);
454extern void vfork_daemon_rexec(int nochdir, int noclose,
455 int argc, char **argv, char *foreground_opt);
456#endif
457extern int get_terminal_width_height(int fd, int *width, int *height);
458extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
459
460int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
461void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
462void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +0000463#ifdef __GLIBC__
464/* At least glibc has horrendously large inline for this, so wrap it */
465extern unsigned long long bb_makedev(unsigned int major, unsigned int minor);
466#undef makedev
467#define makedev(a,b) bb_makedev(a,b)
468#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000469
470
471#ifndef COMM_LEN
472#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +0000473enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000474#else
475/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +0000476enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000477#endif
478#endif
479typedef struct {
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000480 DIR *dir;
481/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000482 char *cmd;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000483 unsigned long rss;
484 unsigned long stime, utime;
485 unsigned pid;
486 unsigned ppid;
487 unsigned pgid;
488 unsigned sid;
489 unsigned uid;
490 unsigned gid;
491 /* basename of executable file in call to exec(2), size from */
492 /* sizeof(task_struct.comm) in /usr/include/linux/sched.h */
493 char state[4];
494 char comm[COMM_LEN];
495// user/group? - use passwd/group parsing functions
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000496} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000497enum {
498 PSSCAN_PID = 1 << 0,
499 PSSCAN_PPID = 1 << 1,
500 PSSCAN_PGID = 1 << 2,
501 PSSCAN_SID = 1 << 3,
502 PSSCAN_UIDGID = 1 << 4,
503 PSSCAN_COMM = 1 << 5,
504 PSSCAN_CMD = 1 << 6,
505 PSSCAN_STATE = 1 << 7,
506 PSSCAN_RSS = 1 << 8,
507 PSSCAN_STIME = 1 << 9,
508 PSSCAN_UTIME = 1 << 10,
509 /* These are all retrieved from proc/NN/stat in one go: */
510 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
511 | PSSCAN_COMM | PSSCAN_STATE
512 | PSSCAN_RSS | PSSCAN_STIME | PSSCAN_UTIME,
513};
514procps_status_t* alloc_procps_scan(int flags);
515void free_procps_scan(procps_status_t* sp);
516procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko35fb5122006-11-01 09:16:49 +0000517pid_t *find_pid_by_name(const char* procName);
518pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000519void clear_username_cache(void);
520const char* get_cached_username(uid_t uid);
Denis Vlasenkoc50f3702006-11-24 14:57:31 +0000521const char* get_cached_groupname(gid_t gid);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000522
523
524extern const char bb_uuenc_tbl_base64[];
525extern const char bb_uuenc_tbl_std[];
526void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
527
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000528typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000529 uint32_t count[2];
530 uint32_t hash[5];
531 uint32_t wbuf[16];
532} sha1_ctx_t;
533void sha1_begin(sha1_ctx_t *ctx);
534void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
535void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
536
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000537typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000538 uint32_t A;
539 uint32_t B;
540 uint32_t C;
541 uint32_t D;
542 uint64_t total;
543 uint32_t buflen;
544 char buffer[128];
545} md5_ctx_t;
546void md5_begin(md5_ctx_t *ctx);
547void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
548void *md5_end(void *resbuf, md5_ctx_t *ctx);
549
550uint32_t *crc32_filltable(int endian);
551
552
Manuel Novoa III cad53642003-03-19 09:13:01 +0000553enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
Matt Kraai01441032001-04-24 01:30:02 +0000554 FILEUTILS_PRESERVE_STATUS = 1,
Matt Kraai4c557bf2001-10-05 01:35:10 +0000555 FILEUTILS_DEREFERENCE = 2,
Matt Kraai01441032001-04-24 01:30:02 +0000556 FILEUTILS_RECUR = 4,
557 FILEUTILS_FORCE = 8,
Denis Vlasenkof24e1f42006-10-21 23:40:20 +0000558 FILEUTILS_INTERACTIVE = 0x10,
559 FILEUTILS_MAKE_HARDLINK = 0x20,
560 FILEUTILS_MAKE_SOFTLINK = 0x40,
Matt Kraai91b28552001-04-23 18:53:07 +0000561};
Denis Vlasenkof24e1f42006-10-21 23:40:20 +0000562#define FILEUTILS_CP_OPTSTR "pdRfils"
Matt Kraai91b28552001-04-23 18:53:07 +0000563
Denis Vlasenko8f8f2682006-10-03 21:00:43 +0000564extern const char *applet_name;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000565extern const char BB_BANNER[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000566
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000567extern const char bb_msg_full_version[];
568extern const char bb_msg_memory_exhausted[];
569extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000570extern const char bb_msg_read_error[];
571extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000572extern const char bb_msg_unknown[];
573extern const char bb_msg_can_not_create_raw_socket[];
574extern const char bb_msg_perm_denied_are_you_root[];
575extern const char bb_msg_requires_arg[];
576extern const char bb_msg_invalid_arg[];
577extern const char bb_msg_standard_input[];
578extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000579
Denis Vlasenko7ca39212006-11-21 20:34:21 +0000580extern const char bb_str_default[];
581
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000582extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000583extern const char bb_path_nologin_file[];
584extern const char bb_path_passwd_file[];
585extern const char bb_path_shadow_file[];
586extern const char bb_path_gshadow_file[];
587extern const char bb_path_group_file[];
588extern const char bb_path_securetty_file[];
589extern const char bb_path_motd_file[];
590extern const char bb_path_wtmp_file[];
591extern const char bb_dev_null[];
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +0000592
593#ifndef BUFSIZ
594#define BUFSIZ 4096
595#endif
596extern char bb_common_bufsiz1[BUFSIZ+1];
597
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000598/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
599 * use bb_default_login_shell and following defines.
600 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
601 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000602#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000603extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000604/* "/bin/sh" */
605#define DEFAULT_SHELL (bb_default_login_shell+1)
606/* "sh" */
607#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
608
609
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000610#ifdef CONFIG_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +0000611# define CURRENT_VC "/dev/vc/0"
612# define VC_1 "/dev/vc/1"
613# define VC_2 "/dev/vc/2"
614# define VC_3 "/dev/vc/3"
615# define VC_4 "/dev/vc/4"
616# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000617#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
618/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
619 respective serial ports .. as such, we can't use the common device paths for
620 these. -- PFM */
621# define SC_0 "/dev/ttsc/0"
622# define SC_1 "/dev/ttsc/1"
623# define SC_FORMAT "/dev/ttsc/%d"
624#else
625# define SC_0 "/dev/tts/0"
626# define SC_1 "/dev/tts/1"
627# define SC_FORMAT "/dev/tts/%d"
628#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000629# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000630# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000631# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +0000632# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000633#else
634# define CURRENT_VC "/dev/tty0"
635# define VC_1 "/dev/tty1"
636# define VC_2 "/dev/tty2"
637# define VC_3 "/dev/tty3"
638# define VC_4 "/dev/tty4"
639# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000640#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
641# define SC_0 "/dev/ttySC0"
642# define SC_1 "/dev/ttySC1"
643# define SC_FORMAT "/dev/ttySC%d"
644#else
645# define SC_0 "/dev/ttyS0"
646# define SC_1 "/dev/ttyS1"
647# define SC_FORMAT "/dev/ttyS%d"
648#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000649# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000650# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000651# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +0000652# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000653#endif
654
655/* The following devices are the same on devfs and non-devfs systems. */
656#define CURRENT_TTY "/dev/tty"
657#define CONSOLE_DEV "/dev/console"
658
Rob Landleyc57ec372006-04-10 17:07:15 +0000659
Rob Landleyb623a542006-05-31 22:09:03 +0000660#ifndef RB_POWER_OFF
661/* Stop system and switch power off if possible. */
662#define RB_POWER_OFF 0x4321fedc
663#endif
664
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000665/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +0000666#undef isalnum
667#undef isalpha
668#undef isascii
669#undef isblank
670#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +0000671#undef isgraph
672#undef islower
673#undef isprint
674#undef ispunct
675#undef isspace
676#undef isupper
677#undef isxdigit
678
Denis Vlasenko459903b2006-11-27 14:44:18 +0000679/* This one is more efficient - we save ~400 bytes */
680#undef isdigit
681#define isdigit(a) ((unsigned)((a) - '0') <= 9)
682
683
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000684#ifdef DMALLOC
685#include <dmalloc.h>
686#endif
687
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +0000688#endif /* __LIBBUSYBOX_H__ */