blob: f574f9b5fb465f081556db226aa77ea68aaa2401 [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 */
88# define STRTOOFF strtol
89# define SAFE_STRTOOFF safe_strtol
Denis Vlasenkocba9ef52006-10-10 21:00:47 +000090# define XSTRTOUOFF xstrtoul
Denis Vlasenko5c759602006-10-28 12:37:16 +000091# define OFF_FMT "ld"
Denis Vlasenko7039a662006-10-08 17:54:47 +000092# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +000093/* "long" is too short, need "long long" */
Denis Vlasenko7039a662006-10-08 17:54:47 +000094# define STRTOOFF strtoll
95# define SAFE_STRTOOFF safe_strtoll
Denis Vlasenkocba9ef52006-10-10 21:00:47 +000096# define XSTRTOUOFF xstrtoull
Denis Vlasenko5c759602006-10-28 12:37:16 +000097# define OFF_FMT "lld"
Denis Vlasenko7039a662006-10-08 17:54:47 +000098# endif
Denis Vlasenko56254152006-10-07 16:24:46 +000099#else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000100# if 0 /* #if UINT_MAX == 0xffffffff */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000101/* Doesn't work. off_t is a long. gcc will throw warnings on printf("%d", off_t)
102 * even if long==int on this arch. Crap... */
103# define STRTOOFF strtol
104# define SAFE_STRTOOFF safe_strtoi
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000105# define XSTRTOUOFF xstrtou
Denis Vlasenko5c759602006-10-28 12:37:16 +0000106# define OFF_FMT "d"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000107# else
108# define STRTOOFF strtol
109# define SAFE_STRTOOFF safe_strtol
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000110# define XSTRTOUOFF xstrtoul
Denis Vlasenko5c759602006-10-28 12:37:16 +0000111# define OFF_FMT "ld"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000112# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000113#endif
114/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000115#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000116
Eric Andersenaad1a882001-03-16 22:47:14 +0000117/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000118#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000119#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000120#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000121#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000122#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000123#define SKIP ((int) 2)
124
125/* for mtab.c */
126#define MTAB_GETMOUNTPT '1'
127#define MTAB_GETDEVICE '2'
128
129#define BUF_SIZE 8192
130#define EXPAND_ALLOC 1024
131
Eric Andersenaad1a882001-03-16 22:47:14 +0000132/* Macros for min/max. */
133#ifndef MIN
134#define MIN(a,b) (((a)<(b))?(a):(b))
135#endif
136
137#ifndef MAX
138#define MAX(a,b) (((a)>(b))?(a):(b))
139#endif
140
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000141/* buffer allocation schemes */
142#ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
143#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
144#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
145#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
146#else
147#ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
148#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
149#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
150#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
151#else
152#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
153#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
154#define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
155#endif
156#endif
157
158
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000159#if (__GLIBC__ < 2)
160int vdprintf(int d, const char *format, va_list ap);
161#endif
162// This is declared here rather than #including <libgen.h> in order to avoid
163// confusing the two versions of basename. See the dirname/basename man page
164// for details.
165char *dirname(char *path);
166/* Include our own copy of struct sysinfo to avoid binary compatibility
167 * problems with Linux 2.4, which changed things. Grumble, grumble. */
168struct sysinfo {
169 long uptime; /* Seconds since boot */
170 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
171 unsigned long totalram; /* Total usable main memory size */
172 unsigned long freeram; /* Available memory size */
173 unsigned long sharedram; /* Amount of shared memory */
174 unsigned long bufferram; /* Memory used by buffers */
175 unsigned long totalswap; /* Total swap space size */
176 unsigned long freeswap; /* swap space still available */
177 unsigned short procs; /* Number of current processes */
178 unsigned short pad; /* Padding needed for m68k */
179 unsigned long totalhigh; /* Total high memory size */
180 unsigned long freehigh; /* Available high memory size */
181 unsigned int mem_unit; /* Memory unit size in bytes */
182 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000183};
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000184extern int sysinfo(struct sysinfo* info);
Denis Vlasenko3538b9a2006-09-06 18:36:50 +0000185
Manuel Novoa III cad53642003-03-19 09:13:01 +0000186
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000187extern void chomp(char *s);
188extern void trim(char *s);
189extern char *skip_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000190
Manuel Novoa III cad53642003-03-19 09:13:01 +0000191extern const char *bb_mode_string(int mode);
192extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000193extern int remove_file(const char *path, int flags);
194extern int copy_file(const char *source, const char *dest, int flags);
195extern int recursive_action(const char *fileName, int recurse,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000196 int followLinks, int depthFirst,
197 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
198 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
199 void* userData, int depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000200extern int device_open(const char *device, int mode);
201extern int get_console_fd(void);
202extern char *find_block_device(char *path);
203extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
204extern off_t bb_copyfd_eof(int fd1, int fd2);
205extern char bb_process_escape_sequence(const char **ptr);
206extern char *bb_get_last_path_component(char *path);
207
208
Rob Landleyd921b2e2006-08-03 15:41:12 +0000209extern DIR *xopendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000210extern DIR *warn_opendir(const char *path);
211
212char *xgetcwd(char *cwd);
213char *xreadlink(const char *path);
214extern void xstat(char *filename, struct stat *buf);
215extern pid_t spawn(char **argv);
216extern pid_t xspawn(char **argv);
217extern int wait4pid(int pid);
218extern void xsetgid(gid_t gid);
219extern void xsetuid(uid_t uid);
220extern void xdaemon(int nochdir, int noclose);
221extern void xchdir(const char *path);
222extern void xsetenv(const char *key, const char *value);
223extern int xopen(const char *pathname, int flags);
224extern int xopen3(const char *pathname, int flags, int mode);
225extern off_t xlseek(int fd, off_t offset, int whence);
226extern off_t fdlength(int fd);
227
228extern int xsocket(int domain, int type, int protocol);
229extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
230extern void xlisten(int s, int backlog);
231extern void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
232extern int xconnect_tcp_v4(struct sockaddr_in *s_addr);
233extern struct hostent *xgethostbyname(const char *name);
234extern struct hostent *xgethostbyname2(const char *name, int af);
235
236extern char *xstrdup(const char *s);
237extern char *xstrndup(const char *s, int n);
238extern char *safe_strncpy(char *dst, const char *src, size_t size);
239extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
240
241/* dmalloc will redefine these to it's own implementation. It is safe
242 * to have the prototypes here unconditionally. */
243extern void *xmalloc(size_t size);
244extern void *xrealloc(void *old, size_t size);
245extern void *xzalloc(size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000246
Denis Vlasenkoea620772006-10-14 02:23:43 +0000247extern ssize_t safe_read(int fd, void *buf, size_t count);
248extern ssize_t full_read(int fd, void *buf, size_t count);
249extern void xread(int fd, void *buf, size_t count);
250extern unsigned char xread_char(int fd);
251extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000252extern ssize_t read_close(int fd, void *buf, size_t count);
253extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
254extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000255
256extern ssize_t safe_write(int fd, const void *buf, size_t count);
257extern ssize_t full_write(int fd, const void *buf, size_t count);
258extern void xwrite(int fd, void *buf, size_t count);
259
Denis Vlasenko1de08302006-10-26 23:32:43 +0000260/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000261extern void xprint_and_close_file(FILE *file);
262extern char *xmalloc_fgets(FILE *file);
Denis Vlasenko1de08302006-10-26 23:32:43 +0000263/* Read up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000264extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
265/* Chops off '\n' from the end, unlike fgets: */
266extern char *xmalloc_getline(FILE *file);
267extern char *bb_get_chunk_from_file(FILE *file, int *end);
268extern void die_if_ferror(FILE *file, const char *msg);
269extern void die_if_ferror_stdout(void);
270extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000271extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000272extern int fclose_if_not_stdin(FILE *file);
273extern FILE *xfopen(const char *filename, const char *mode);
274/* Prints warning to stderr and returns NULL on failure: */
275extern FILE *fopen_or_warn(const char *filename, const char *mode);
276/* "Opens" stdin if filename is special, else just opens file: */
277extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000278
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000279
Denis Vlasenkoaae03112006-11-05 00:44:39 +0000280extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000281extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
282extern char *utoa(unsigned n);
283extern void itoa_to_buf(int n, char *buf, unsigned buflen);
284extern char *itoa(int n);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000285
Denis Vlasenko13858992006-10-08 12:49:22 +0000286// FIXME: the prototype doesn't match libc strtoXX -> confusion
287// FIXME: alot of unchecked strtoXXX are still in tree
288// FIXME: atoi_or_else(str, N)?
289extern int safe_strtoi(const char *arg, int* value);
290extern int safe_strtou(const char *arg, unsigned* value);
291extern int safe_strtod(const char *arg, double* value);
292extern int safe_strtol(const char *arg, long* value);
293extern int safe_strtoll(const char *arg, long long* value);
294extern int safe_strtoul(const char *arg, unsigned long* value);
295extern int safe_strtoull(const char *arg, unsigned long long* value);
296extern int safe_strtou32(const char *arg, uint32_t* value);
Eric Andersenaad1a882001-03-16 22:47:14 +0000297
298struct suffix_mult {
Eric Andersene5dfced2001-04-09 22:48:12 +0000299 const char *suffix;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000300 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000301};
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000302unsigned long long xstrtoull(const char *numstr, int base);
303unsigned long long xatoull(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000304unsigned long xstrtoul_range_sfx(const char *numstr, int base,
Denis Vlasenkocf944462006-10-03 19:02:20 +0000305 unsigned long lower,
306 unsigned long upper,
307 const struct suffix_mult *suffixes);
Denis Vlasenko13858992006-10-08 12:49:22 +0000308unsigned long xstrtoul_range(const char *numstr, int base,
Denis Vlasenkocf944462006-10-03 19:02:20 +0000309 unsigned long lower,
310 unsigned long upper);
Denis Vlasenko1114de72006-10-10 23:26:05 +0000311unsigned long xstrtoul_sfx(const char *numstr, int base,
312 const struct suffix_mult *suffixes);
Denis Vlasenko13858992006-10-08 12:49:22 +0000313unsigned long xstrtoul(const char *numstr, int base);
314unsigned long xatoul_range_sfx(const char *numstr,
315 unsigned long lower,
316 unsigned long upper,
317 const struct suffix_mult *suffixes);
318unsigned long xatoul_sfx(const char *numstr,
319 const struct suffix_mult *suffixes);
320unsigned long xatoul_range(const char *numstr,
Denis Vlasenkocf944462006-10-03 19:02:20 +0000321 unsigned long lower,
322 unsigned long upper);
Denis Vlasenko13858992006-10-08 12:49:22 +0000323unsigned long xatoul(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000324long xstrtol_range_sfx(const char *numstr, int base,
Denis Vlasenkocf944462006-10-03 19:02:20 +0000325 long lower,
326 long upper,
327 const struct suffix_mult *suffixes);
Denis Vlasenko13858992006-10-08 12:49:22 +0000328long xstrtol_range(const char *numstr, int base, long lower, long upper);
329long xatol_range_sfx(const char *numstr,
330 long lower,
331 long upper,
Eric Andersenaad1a882001-03-16 22:47:14 +0000332 const struct suffix_mult *suffixes);
Denis Vlasenko13858992006-10-08 12:49:22 +0000333long xatol_range(const char *numstr, long lower, long upper);
334long xatol_sfx(const char *numstr, const struct suffix_mult *suffixes);
335long xatol(const char *numstr);
336/* Specialized: */
Denis Vlasenko83ea6432006-11-16 02:27:24 +0000337unsigned xatou_range(const char *numstr, unsigned lower, unsigned upper);
338unsigned xatou_sfx(const char *numstr, const struct suffix_mult *suffixes);
Denis Vlasenko13858992006-10-08 12:49:22 +0000339unsigned xatou(const char *numstr);
Denis Vlasenkoca3c9812006-10-08 23:36:17 +0000340int xatoi_range(const char *numstr, int lower, int upper);
Denis Vlasenko13858992006-10-08 12:49:22 +0000341int xatoi(const char *numstr);
342/* Using xatoi() instead of naive atoi() is not always convenient -
343 * in many places people want *non-negative* values, but store them
344 * in signed int. Therefore we need this one:
345 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
346int xatoi_u(const char *numstr);
347uint32_t xatou32(const char *numstr);
348/* Useful for reading port numbers */
349uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000350
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000351
Eric Andersenaad1a882001-03-16 22:47:14 +0000352/* These parse entries in /etc/passwd and /etc/group. This is desirable
353 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000354 * increases target size and is often not needed on embedded systems. */
355extern long bb_xgetpwnam(const char *name);
356extern long bb_xgetgrnam(const char *name);
Denis Vlasenkocf944462006-10-03 19:02:20 +0000357extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
358extern char *bb_getpwuid(char *name, long uid, int bufsize);
359extern char *bb_getgrgid(char *group, long gid, int bufsize);
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000360/* from chpst */
361struct bb_uidgid_t {
362 uid_t uid;
363 gid_t gid;
364};
365extern unsigned uidgid_get(struct bb_uidgid_t*, const char* /*, unsigned*/);
366
Eric Andersenaad1a882001-03-16 22:47:14 +0000367
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000368enum { BB_GETOPT_ERROR = 0x80000000 };
369extern const char *opt_complementary;
370extern const struct option *applet_long_options;
371extern uint32_t option_mask32;
372extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
373
374
375typedef struct llist_s {
376 char *data;
377 struct llist_s *link;
378} llist_t;
379extern void llist_add_to(llist_t **old_head, void *data);
380extern void llist_add_to_end(llist_t **list_head, void *data);
381extern void *llist_pop(llist_t **elm);
382extern void llist_free(llist_t *elm, void (*freeit)(void *data));
383extern llist_t* rev_llist(llist_t *list);
384
385enum {
386 LOGMODE_NONE = 0,
387 LOGMODE_STDIO = 1<<0,
388 LOGMODE_SYSLOG = 1<<1,
389 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
390};
391extern const char *msg_eol;
392extern int logmode;
393extern int die_sleep;
394extern int xfunc_error_retval;
395extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
396extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
397extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
398extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
399extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
400extern void bb_vherror_msg(const char *s, va_list p);
401extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
402extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
403extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
404extern void bb_perror_nomsg(void);
405extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
406/* These two are used internally -- you shouldn't need to use them */
407extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
408extern void bb_vperror_msg(const char *s, va_list p);
409extern void bb_vinfo_msg(const char *s, va_list p);
410
411
412extern int bb_echo(int argc, char** argv);
413extern int bb_test(int argc, char** argv);
414
415#ifndef BUILD_INDIVIDUAL
416extern struct BB_applet *find_applet_by_name(const char *name);
417extern void run_applet_by_name(const char *name, int argc, char **argv);
418#endif
419
420extern struct mntent *find_mount_point(const char *name, const char *table);
421extern void erase_mtab(const char * name);
422extern unsigned int tty_baud_to_value(speed_t speed);
423extern speed_t tty_value_to_baud(unsigned int value);
424extern void bb_warn_ignoring_args(int n);
425
426extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000427
Rob Landley1d589b22005-11-29 23:47:10 +0000428extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000429extern int del_loop(const char *device);
Denis Vlasenko13858992006-10-08 12:49:22 +0000430extern int set_loop(char **device, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000431
Eric Andersenaad1a882001-03-16 22:47:14 +0000432
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000433const char *make_human_readable_str(unsigned long long size,
Eric Andersen97e24262003-08-22 23:08:37 +0000434 unsigned long block_size, unsigned long display_unit);
Eric Andersenaad1a882001-03-16 22:47:14 +0000435
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000436char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000437int bb_ask_confirmation(void);
Eric Andersene76c3b02001-04-05 03:14:39 +0000438int klogctl(int type, char * b, int len);
Eric Andersenaad1a882001-03-16 22:47:14 +0000439
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000440extern int bb_parse_mode(const char* s, mode_t* theMode);
441
Eric Andersene5dfced2001-04-09 22:48:12 +0000442char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000443char *concat_subpath_file(const char *path, const char *filename);
Eric Andersenc911a432001-05-15 17:42:16 +0000444char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000445
Denis Vlasenkof6f43df2006-10-11 22:16:56 +0000446int execable_file(const char *name);
447char *find_execable(const char *filename);
448int exists_execable(const char *filename);
449
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000450USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
451int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000452
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000453int create_icmp_socket(void);
454int create_icmp6_socket(void);
Denis Vlasenko14579152006-10-26 01:09:46 +0000455
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000456unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
457void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
Glenn L McGrath78b0e372001-06-26 02:06:08 +0000458
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000459int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000460
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000461int get_signum(const char *name);
462const char *get_signame(int number);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000463
Manuel Novoa III cad53642003-03-19 09:13:01 +0000464char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000465
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000466#define FAIL_DELAY 3
467extern void bb_do_delay(int seconds);
468extern void change_identity(const struct passwd *pw);
469extern const char *change_identity_e2str(const struct passwd *pw);
470extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
471#ifdef CONFIG_SELINUX
472extern void renew_current_security_context(void);
473extern void set_current_security_context(security_context_t sid);
474#endif
475extern int run_parts(char **args, const unsigned char test_mode, char **env);
476extern int restricted_shell(const char *shell);
477extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
478extern int correct_password(const struct passwd *pw);
479extern char *pw_encrypt(const char *clear, const char *salt);
480extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenko5af906e2006-11-05 18:05:09 +0000481extern int index_in_str_array(const char * const string_array[], const char *key);
482extern int index_in_substr_array(const char * const string_array[], const char *key);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000483extern void print_login_issue(const char *issue_file, const char *tty);
484extern void print_login_prompt(void);
485#ifdef BB_NOMMU
486extern void vfork_daemon(int nochdir, int noclose);
487extern void vfork_daemon_rexec(int nochdir, int noclose,
488 int argc, char **argv, char *foreground_opt);
489#endif
490extern int get_terminal_width_height(int fd, int *width, int *height);
491extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
492
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);
496
497
498#ifndef COMM_LEN
499#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +0000500enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000501#else
502/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +0000503enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000504#endif
505#endif
506typedef struct {
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000507 DIR *dir;
508/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000509 char *cmd;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000510 unsigned long rss;
511 unsigned long stime, utime;
512 unsigned pid;
513 unsigned ppid;
514 unsigned pgid;
515 unsigned sid;
516 unsigned uid;
517 unsigned gid;
518 /* basename of executable file in call to exec(2), size from */
519 /* sizeof(task_struct.comm) in /usr/include/linux/sched.h */
520 char state[4];
521 char comm[COMM_LEN];
522// user/group? - use passwd/group parsing functions
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000523} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000524enum {
525 PSSCAN_PID = 1 << 0,
526 PSSCAN_PPID = 1 << 1,
527 PSSCAN_PGID = 1 << 2,
528 PSSCAN_SID = 1 << 3,
529 PSSCAN_UIDGID = 1 << 4,
530 PSSCAN_COMM = 1 << 5,
531 PSSCAN_CMD = 1 << 6,
532 PSSCAN_STATE = 1 << 7,
533 PSSCAN_RSS = 1 << 8,
534 PSSCAN_STIME = 1 << 9,
535 PSSCAN_UTIME = 1 << 10,
536 /* These are all retrieved from proc/NN/stat in one go: */
537 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
538 | PSSCAN_COMM | PSSCAN_STATE
539 | PSSCAN_RSS | PSSCAN_STIME | PSSCAN_UTIME,
540};
541procps_status_t* alloc_procps_scan(int flags);
542void free_procps_scan(procps_status_t* sp);
543procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko35fb5122006-11-01 09:16:49 +0000544pid_t *find_pid_by_name(const char* procName);
545pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenko459e4d62006-11-05 00:43:51 +0000546void clear_username_cache(void);
547const char* get_cached_username(uid_t uid);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000548
549
550extern const char bb_uuenc_tbl_base64[];
551extern const char bb_uuenc_tbl_std[];
552void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
553
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000554typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000555 uint32_t count[2];
556 uint32_t hash[5];
557 uint32_t wbuf[16];
558} sha1_ctx_t;
559void sha1_begin(sha1_ctx_t *ctx);
560void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
561void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
562
Denis Vlasenkodd539f72006-11-01 20:20:37 +0000563typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000564 uint32_t A;
565 uint32_t B;
566 uint32_t C;
567 uint32_t D;
568 uint64_t total;
569 uint32_t buflen;
570 char buffer[128];
571} md5_ctx_t;
572void md5_begin(md5_ctx_t *ctx);
573void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
574void *md5_end(void *resbuf, md5_ctx_t *ctx);
575
576uint32_t *crc32_filltable(int endian);
577
578
Manuel Novoa III cad53642003-03-19 09:13:01 +0000579enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
Matt Kraai01441032001-04-24 01:30:02 +0000580 FILEUTILS_PRESERVE_STATUS = 1,
Matt Kraai4c557bf2001-10-05 01:35:10 +0000581 FILEUTILS_DEREFERENCE = 2,
Matt Kraai01441032001-04-24 01:30:02 +0000582 FILEUTILS_RECUR = 4,
583 FILEUTILS_FORCE = 8,
Denis Vlasenkof24e1f42006-10-21 23:40:20 +0000584 FILEUTILS_INTERACTIVE = 0x10,
585 FILEUTILS_MAKE_HARDLINK = 0x20,
586 FILEUTILS_MAKE_SOFTLINK = 0x40,
Matt Kraai91b28552001-04-23 18:53:07 +0000587};
Denis Vlasenkof24e1f42006-10-21 23:40:20 +0000588#define FILEUTILS_CP_OPTSTR "pdRfils"
Matt Kraai91b28552001-04-23 18:53:07 +0000589
Denis Vlasenko8f8f2682006-10-03 21:00:43 +0000590extern const char *applet_name;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000591extern const char BB_BANNER[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000592
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000593extern const char bb_msg_full_version[];
594extern const char bb_msg_memory_exhausted[];
595extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000596extern const char bb_msg_read_error[];
597extern const char bb_msg_write_error[];
598extern const char bb_msg_name_longer_than_foo[];
599extern const char bb_msg_unknown[];
600extern const char bb_msg_can_not_create_raw_socket[];
601extern const char bb_msg_perm_denied_are_you_root[];
602extern const char bb_msg_requires_arg[];
603extern const char bb_msg_invalid_arg[];
604extern const char bb_msg_standard_input[];
605extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +0000606
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000607extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000608extern const char bb_path_nologin_file[];
609extern const char bb_path_passwd_file[];
610extern const char bb_path_shadow_file[];
611extern const char bb_path_gshadow_file[];
612extern const char bb_path_group_file[];
613extern const char bb_path_securetty_file[];
614extern const char bb_path_motd_file[];
615extern const char bb_path_wtmp_file[];
616extern const char bb_dev_null[];
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +0000617
618#ifndef BUFSIZ
619#define BUFSIZ 4096
620#endif
621extern char bb_common_bufsiz1[BUFSIZ+1];
622
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000623/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
624 * use bb_default_login_shell and following defines.
625 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
626 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000627#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +0000628extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +0000629/* "/bin/sh" */
630#define DEFAULT_SHELL (bb_default_login_shell+1)
631/* "sh" */
632#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
633
634
Eric Andersenbdfd0d72001-10-24 05:00:29 +0000635#ifdef CONFIG_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +0000636# define CURRENT_VC "/dev/vc/0"
637# define VC_1 "/dev/vc/1"
638# define VC_2 "/dev/vc/2"
639# define VC_3 "/dev/vc/3"
640# define VC_4 "/dev/vc/4"
641# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000642#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
643/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
644 respective serial ports .. as such, we can't use the common device paths for
645 these. -- PFM */
646# define SC_0 "/dev/ttsc/0"
647# define SC_1 "/dev/ttsc/1"
648# define SC_FORMAT "/dev/ttsc/%d"
649#else
650# define SC_0 "/dev/tts/0"
651# define SC_1 "/dev/tts/1"
652# define SC_FORMAT "/dev/tts/%d"
653#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000654# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000655# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000656# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +0000657# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000658#else
659# define CURRENT_VC "/dev/tty0"
660# define VC_1 "/dev/tty1"
661# define VC_2 "/dev/tty2"
662# define VC_3 "/dev/tty3"
663# define VC_4 "/dev/tty4"
664# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +0000665#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
666# define SC_0 "/dev/ttySC0"
667# define SC_1 "/dev/ttySC1"
668# define SC_FORMAT "/dev/ttySC%d"
669#else
670# define SC_0 "/dev/ttyS0"
671# define SC_1 "/dev/ttyS1"
672# define SC_FORMAT "/dev/ttyS%d"
673#endif
Matt Kraai439e3df2001-07-23 14:52:08 +0000674# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +0000675# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0b193a72006-09-29 21:47:11 +0000676# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +0000677# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +0000678#endif
679
680/* The following devices are the same on devfs and non-devfs systems. */
681#define CURRENT_TTY "/dev/tty"
682#define CONSOLE_DEV "/dev/console"
683
Rob Landleyc57ec372006-04-10 17:07:15 +0000684
Rob Landleyb623a542006-05-31 22:09:03 +0000685#ifndef RB_POWER_OFF
686/* Stop system and switch power off if possible. */
687#define RB_POWER_OFF 0x4321fedc
688#endif
689
Rob Landley4ae905a2006-07-06 17:22:54 +0000690// Make sure we call functions instead of macros.
691#undef isalnum
692#undef isalpha
693#undef isascii
694#undef isblank
695#undef iscntrl
696#undef isdigit
697#undef isgraph
698#undef islower
699#undef isprint
700#undef ispunct
701#undef isspace
702#undef isupper
703#undef isxdigit
704
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +0000705#ifdef DMALLOC
706#include <dmalloc.h>
707#endif
708
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +0000709#endif /* __LIBBUSYBOX_H__ */