blob: f50ae3604df1385924c8239eb74197262fe3d2c7 [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Eric Andersenaad1a882001-03-16 22:47:14 +00006 * Permission has been granted to redistribute this code under the GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Rob Landleyeb84a422006-09-20 21:41:13 +00008 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +000010#ifndef __LIBBUSYBOX_H__
11#define __LIBBUSYBOX_H__ 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
20#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000021#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000022#include <signal.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000023#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000024#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000025#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000026#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000027#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000028#include <sys/poll.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 Landley299a6b42006-05-27 21:42:58 +000033#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000034#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000035#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000036#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000037#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000038#include <unistd.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000039#include <utime.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000040/* Try to pull in PATH_MAX */
41#include <limits.h>
42#include <sys/param.h>
43#ifndef PATH_MAX
44#define PATH_MAX 256
45#endif
Rob Landley299a6b42006-05-27 21:42:58 +000046
Mike Frysinger22876c72008-02-07 22:10:07 +000047#ifdef HAVE_MNTENT_H
48#include <mntent.h>
49#endif
50
Mike Frysinger9412ec72008-02-07 22:41:33 +000051#ifdef HAVE_SYS_STATFS_H
52#include <sys/statfs.h>
53#endif
54
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000055#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000056#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000057#include <selinux/context.h>
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +000058#include <selinux/flask.h>
59#include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000060#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000061
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000062#if ENABLE_LOCALE_SUPPORT
Rob Landleyd921b2e2006-08-03 15:41:12 +000063#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000064#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000065#define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000066#endif
67
Denis Vlasenko98636eb2008-05-09 17:59:34 +000068#ifdef DMALLOC
69#include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000070#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000071
Denis Vlasenko98636eb2008-05-09 17:59:34 +000072#if !ENABLE_USE_BB_PWD_GRP
73# include <pwd.h>
74# include <grp.h>
75#endif
76#if ENABLE_FEATURE_SHADOWPASSWDS
77# if !ENABLE_USE_BB_SHADOW
78# include <shadow.h>
79# endif
80#endif
81
82/* Some libc's forget to declare these, help them */
Denis Vlasenko847fa772008-01-28 22:45:43 +000083extern char **environ;
84
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000085#if defined(__GLIBC__) && __GLIBC__ < 2
86int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000087#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000088/* klogctl is in libc's klog.h, but we cheat and not #include that */
89int klogctl(int type, char *b, int len);
90/* This is declared here rather than #including <libgen.h> in order to avoid
91 * confusing the two versions of basename. See the dirname/basename man page
92 * for details. */
93char *dirname(char *path);
94/* Include our own copy of struct sysinfo to avoid binary compatibility
95 * problems with Linux 2.4, which changed things. Grumble, grumble. */
96struct sysinfo {
97 long uptime; /* Seconds since boot */
98 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
99 unsigned long totalram; /* Total usable main memory size */
100 unsigned long freeram; /* Available memory size */
101 unsigned long sharedram; /* Amount of shared memory */
102 unsigned long bufferram; /* Memory used by buffers */
103 unsigned long totalswap; /* Total swap space size */
104 unsigned long freeswap; /* swap space still available */
105 unsigned short procs; /* Number of current processes */
106 unsigned short pad; /* Padding needed for m68k */
107 unsigned long totalhigh; /* Total high memory size */
108 unsigned long freehigh; /* Available high memory size */
109 unsigned int mem_unit; /* Memory unit size in bytes */
110 char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
111};
112int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +0000113
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000114
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000115/* Make all declarations hidden (-fvisibility flag only affects definitions) */
116/* (don't include system headers after this until corresponding pop!) */
117#if __GNUC_PREREQ(4,1)
118# pragma GCC visibility push(hidden)
119#endif
120
121
122#if ENABLE_USE_BB_PWD_GRP
123# include "pwd_.h"
124# include "grp_.h"
125#endif
126#if ENABLE_FEATURE_SHADOWPASSWDS
127# if ENABLE_USE_BB_SHADOW
128# include "shadow_.h"
129# endif
130#endif
131
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000132/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000133#define MAXINT(T) (T)( \
134 ((T)-1) > 0 \
135 ? (T)-1 \
136 : (T)~((T)1 << (sizeof(T)*8-1)) \
137 )
138
139#define MININT(T) (T)( \
140 ((T)-1) > 0 \
141 ? (T)0 \
142 : ((T)1 << (sizeof(T)*8-1)) \
143 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000144
Denis Vlasenko56254152006-10-07 16:24:46 +0000145/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000146/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000147 * (stat, lseek etc) mapped to "largefile" variants by libc.
148 * Practically it means that open() automatically has O_LARGEFILE added
149 * and all filesize/file_offset parameters and struct members are "large"
150 * (in today's world - signed 64bit). For full support of large files,
151 * we need a few helper #defines (below) and careful use of off_t
152 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000153#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000154/* CONFIG_LFS is on */
155# if ULONG_MAX > 0xffffffff
156/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000157# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000158/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
159# define BB_STRTOOFF bb_strtoul
160# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000161/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
162# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000163# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000164/* "long" is too short, need "long long" */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000165# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000166# define BB_STRTOOFF bb_strtoull
167# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000168# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000169# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000170#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000171/* CONFIG_LFS is off */
172# if UINT_MAX == 0xffffffff
173/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
174 * gcc will throw warnings on printf("%d", off_t). Crap... */
175# define XATOOFF(a) xatoi_u(a)
176# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000177# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000178# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000179# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000180# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
181# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000182# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000183# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000184# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000185#endif
186/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000187#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000188
Eric Andersenaad1a882001-03-16 22:47:14 +0000189/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000190#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000191#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000192#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000193#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000194#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000195#define SKIP ((int) 2)
196
197/* for mtab.c */
198#define MTAB_GETMOUNTPT '1'
199#define MTAB_GETDEVICE '2'
200
201#define BUF_SIZE 8192
202#define EXPAND_ALLOC 1024
203
Eric Andersenaad1a882001-03-16 22:47:14 +0000204/* Macros for min/max. */
205#ifndef MIN
206#define MIN(a,b) (((a)<(b))?(a):(b))
207#endif
208
209#ifndef MAX
210#define MAX(a,b) (((a)>(b))?(a):(b))
211#endif
212
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000213/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000214#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000215#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000216#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
217#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
218#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000219#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000220#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
221#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
222#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
223#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000224#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
225#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
226#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000227#endif
228#endif
229
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000230#if defined(__GLIBC__)
231/* glibc uses __errno_location() to get a ptr to errno */
232/* We can just memorize it once - no multithreading in busybox :) */
233extern int *const bb_errno;
234#undef errno
235#define errno (*bb_errno)
236#endif
237
Denis Vlasenko459be352007-06-17 19:09:05 +0000238unsigned long long monotonic_us(void);
Denis Vlasenkobd7bb292007-06-17 23:40:26 +0000239unsigned monotonic_sec(void);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000240
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000241extern void chomp(char *s);
242extern void trim(char *s);
243extern char *skip_whitespace(const char *);
Denis Vlasenko0de93752006-12-26 02:51:29 +0000244extern char *skip_non_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000245
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000246//TODO: supply a pointer to char[11] buffer (avoid statics)?
Bernhard Reutner-Fischer835f5752007-01-22 17:48:08 +0000247extern const char *bb_mode_string(mode_t mode);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000248extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000249enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
250 FILEUTILS_PRESERVE_STATUS = 1,
251 FILEUTILS_DEREFERENCE = 2,
252 FILEUTILS_RECUR = 4,
253 FILEUTILS_FORCE = 8,
254 FILEUTILS_INTERACTIVE = 0x10,
255 FILEUTILS_MAKE_HARDLINK = 0x20,
256 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000257 FILEUTILS_DEREF_SOFTLINK = 0x80,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000258#if ENABLE_SELINUX
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000259 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
260 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000261#endif
262};
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000263#define FILEUTILS_CP_OPTSTR "pdRfilsL" USE_SELINUX("c")
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000264extern int remove_file(const char *path, int flags);
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000265/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
266 * the source, not copy (unless "source" is a directory).
267 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
268 * work coreutils-compatibly. */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000269extern int copy_file(const char *source, const char *dest, int flags);
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000270
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000271enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000272 ACTION_RECURSE = (1 << 0),
273 ACTION_FOLLOWLINKS = (1 << 1),
274 ACTION_FOLLOWLINKS_L0 = (1 << 2),
275 ACTION_DEPTHFIRST = (1 << 3),
276 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000277};
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000278extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000279 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
280 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
Denis Vlasenkod166f832007-07-05 00:12:55 +0000281 void* userData, unsigned depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000282extern int device_open(const char *device, int mode);
Denis Vlasenko85c24712008-03-17 09:04:04 +0000283enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000284extern int xgetpty(char *line);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000285extern int get_console_fd(void);
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000286extern void console_make_active(int fd, const int vt_num);
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +0000287extern char *find_block_device(const char *path);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000288/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000289extern off_t bb_copyfd_eof(int fd1, int fd2);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000290extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
291extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
292/* "short" copy can be detected by return value < size */
293/* this helper yells "short read!" if param is not -1 */
294extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000295extern char bb_process_escape_sequence(const char **ptr);
Denis Vlasenko818322b2007-09-24 18:27:04 +0000296/* xxxx_strip version can modify its parameter:
297 * "/" -> "/"
298 * "abc" -> "abc"
299 * "abc/def" -> "def"
300 * "abc/def/" -> "def" !!
301 */
302extern char *bb_get_last_path_component_strip(char *path);
303/* "abc/def/" -> "" and it never modifies 'path' */
304extern char *bb_get_last_path_component_nostrip(const char *path);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000305
306int ndelay_on(int fd);
307int ndelay_off(int fd);
Denis Vlasenko96e1b382007-09-30 23:50:48 +0000308int close_on_exec_on(int fd);
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000309void xdup2(int, int);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000310void xmove_fd(int, int);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000311
312
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000313DIR *xopendir(const char *path);
314DIR *warn_opendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000315
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000316/* UNUSED: char *xmalloc_realpath(const char *path); */
317char *xmalloc_readlink(const char *path);
Denis Vlasenko6ca04442007-02-11 16:19:28 +0000318char *xmalloc_readlink_or_warn(const char *path);
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000319char *xrealloc_getcwd_or_warn(char *cwd);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000320
Paul Fox599bbfb2007-11-08 20:00:36 +0000321char *xmalloc_follow_symlinks(const char *path);
Denis Vlasenko473dae02007-04-11 07:04:23 +0000322
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000323
Denis Vlasenko33196372008-02-23 01:25:38 +0000324enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000325 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000326 * otherwise would kill us, except for those resulting from bugs:
327 * SIGSEGV, SIGILL, SIGFPE.
328 * Other fatal signals not included (TODO?):
329 * SIGBUS Bus error (bad memory access)
330 * SIGPOLL Pollable event. Synonym of SIGIO
331 * SIGPROF Profiling timer expired
332 * SIGSYS Bad argument to routine
333 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000334 *
335 * The only known arch with some of these sigs not fitting
336 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
337 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000338 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000339 BB_FATAL_SIGS = (int)(0
340 + (1LL << SIGHUP)
341 + (1LL << SIGINT)
342 + (1LL << SIGTERM)
343 + (1LL << SIGPIPE) // Write to pipe with no readers
344 + (1LL << SIGQUIT) // Quit from keyboard
345 + (1LL << SIGABRT) // Abort signal from abort(3)
346 + (1LL << SIGALRM) // Timer signal from alarm(2)
347 + (1LL << SIGVTALRM) // Virtual alarm clock
348 + (1LL << SIGXCPU) // CPU time limit exceeded
349 + (1LL << SIGXFSZ) // File size limit exceeded
350 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
351 + (1LL << SIGUSR2)
352 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000353};
Denis Vlasenko25591c32008-02-16 22:58:56 +0000354void bb_signals(int sigs, void (*f)(int));
355/* Unlike signal() and bb_signals, sets handler with sigaction()
356 * and in a way that while signal handler is run, no other signals
357 * will be blocked: */
358void bb_signals_recursive(int sigs, void (*f)(int));
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000359/* syscalls like read() will be interrupted with EINTR: */
360void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int));
361/* syscalls like read() won't be interrupted (though select/poll will be): */
362void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int));
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000363void wait_for_any_sig(void);
Denis Vlasenko400d8bb2008-02-24 13:36:01 +0000364void kill_myself_with_sig(int sig) ATTRIBUTE_NORETURN;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000365void sig_block(int sig);
366void sig_unblock(int sig);
367/* Will do sigaction(signum, act, NULL): */
368int sigaction_set(int sig, const struct sigaction *act);
369/* SIG_BLOCK/SIG_UNBLOCK all signals: */
370int sigprocmask_allsigs(int how);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000371
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000372
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000373void xsetgid(gid_t gid);
374void xsetuid(uid_t uid);
375void xchdir(const char *path);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000376void xchroot(const char *path);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000377void xsetenv(const char *key, const char *value);
378void xunlink(const char *pathname);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000379void xstat(const char *pathname, struct stat *buf);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000380int xopen(const char *pathname, int flags);
381int xopen3(const char *pathname, int flags, int mode);
Denis Vlasenko50f7f442007-04-11 23:20:53 +0000382int open_or_warn(const char *pathname, int flags);
383int open3_or_warn(const char *pathname, int flags, int mode);
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000384int open_or_warn_stdin(const char *pathname);
Denis Vlasenkocb448fe2008-02-17 14:28:53 +0000385void xrename(const char *oldpath, const char *newpath);
386int rename_or_warn(const char *oldpath, const char *newpath);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000387off_t xlseek(int fd, off_t offset, int whence);
388off_t fdlength(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000389
Denis Vlasenko37188322008-02-16 13:20:56 +0000390void xpipe(int filedes[2]);
391/* In this form code with pipes is much more readable */
392struct fd_pair { int rd; int wr; };
393#define piped_pair(pair) pipe(&((pair).rd))
394#define xpiped_pair(pair) xpipe(&((pair).rd))
395
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000396/* Useful for having small structure members/global variables */
397typedef int8_t socktype_t;
398typedef int8_t family_t;
399struct BUG_too_small {
400 char BUG_socktype_t_too_small[(0
401 | SOCK_STREAM
402 | SOCK_DGRAM
403 | SOCK_RDM
404 | SOCK_SEQPACKET
405 | SOCK_RAW
406 ) <= 127 ? 1 : -1];
407 char BUG_family_t_too_small[(0
408 | AF_UNSPEC
409 | AF_INET
410 | AF_INET6
411 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000412#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000413 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000414#endif
415#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000416 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000417#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000418 /* | AF_DECnet */
419 /* | AF_IPX */
420 ) <= 127 ? 1 : -1];
421};
422
423
Denis Vlasenko448f0242007-01-22 22:43:05 +0000424int xsocket(int domain, int type, int protocol);
425void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
426void xlisten(int s, int backlog);
427void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000428ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Bernhard Reutner-Fischerb2908892007-04-12 11:34:39 +0000429 socklen_t tolen);
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000430/* SO_REUSEADDR allows a server to rebind to an address that is already
431 * "in use" by old connections to e.g. previous server instance which is
432 * killed or crashed. Without it bind will fail until all such connections
433 * time out. Linux does not allow multiple live binds on same ip:port
434 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
435 * Turn it on before you call bind(). */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000436void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000437int setsockopt_broadcast(int fd);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000438/* NB: returns port in host byte order */
439unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000440typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000441 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000442 union {
443 struct sockaddr sa;
444 struct sockaddr_in sin;
445#if ENABLE_FEATURE_IPV6
446 struct sockaddr_in6 sin6;
447#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000448 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000449} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000450enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000451 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000452 LSA_SIZEOF_SA = sizeof(
453 union {
454 struct sockaddr sa;
455 struct sockaddr_in sin;
456#if ENABLE_FEATURE_IPV6
457 struct sockaddr_in6 sin6;
458#endif
459 }
460 )
461};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000462/* Create stream socket, and allocate suitable lsa.
463 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000464 * af == AF_UNSPEC will result in trying to create IPv6 socket,
465 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000466 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000467#if ENABLE_FEATURE_IPV6
468int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type);
469#else
470int xsocket_type(len_and_sockaddr **lsap, int sock_type);
471#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
472#endif
Denis Vlasenko5d687242007-01-12 20:59:31 +0000473int xsocket_stream(len_and_sockaddr **lsap);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000474/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000475 * numeric IP ("N.N.N.N") or numeric IPv6 address,
476 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000477 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000478/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000479int create_and_bind_stream_or_die(const char *bindaddr, int port);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000480int create_and_bind_dgram_or_die(const char *bindaddr, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000481/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
482 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
483 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
484 * If there is no suffix, port argument is used */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000485int create_and_connect_stream_or_die(const char *peer, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000486/* Connect to peer identified by lsa */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000487int xconnect_stream(const len_and_sockaddr *lsa);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000488/* Return malloc'ed len_and_sockaddr with socket address of host:port
489 * Currently will return IPv4 or IPv6 sockaddrs only
490 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000491 * UNIX socket address being returned, IPX sockaddr etc...
492 * On error does bb_error_msg and returns NULL */
493len_and_sockaddr* host2sockaddr(const char *host, int port);
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000494/* Version which dies on error */
Denis Vlasenko42823d52007-02-04 02:39:08 +0000495len_and_sockaddr* xhost2sockaddr(const char *host, int port);
Denis Vlasenko9ca26d32007-02-09 17:32:16 +0000496len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000497/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000498#if !ENABLE_FEATURE_IPV6
499#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
500#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
501#else
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000502len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko42823d52007-02-04 02:39:08 +0000503len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000504#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000505/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000506 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000507 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000508void set_nport(len_and_sockaddr *lsa, unsigned port);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000509/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000510int get_nport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000511/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000512char* xmalloc_sockaddr2host(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000513/* This one doesn't append :PORTNUM */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000514char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000515/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000516char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
Denis Vlasenko448f0242007-01-22 22:43:05 +0000517/* inet_[ap]ton on steroids */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000518char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
519char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000520// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000521// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenko448f0242007-01-22 22:43:05 +0000522struct hostent *xgethostbyname(const char *name);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000523// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000524// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000525
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000526
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000527void socket_want_pktinfo(int fd);
528ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000529 const struct sockaddr *to,
530 const struct sockaddr *from,
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000531 socklen_t tolen);
532ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000533 struct sockaddr *from,
534 struct sockaddr *to,
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000535 socklen_t sa_size);
536
Denis Vlasenko4daad902007-09-27 10:20:47 +0000537char *xstrdup(const char *s);
538char *xstrndup(const char *s, int n);
539char *safe_strncpy(char *dst, const char *src, size_t size);
540/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000541 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenko4daad902007-09-27 10:20:47 +0000542int bb_putchar(int ch);
543char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000544/* Prints unprintable chars ch as ^C or M-c to file
545 * (M-c is used only if ch is ORed with PRINTABLE_META),
546 * else it is printed as-is (except for ch = 0x9b) */
547enum { PRINTABLE_META = 0x100 };
548void fputc_printable(int ch, FILE *file);
Denis Vlasenko9f739442006-12-16 23:49:13 +0000549// gcc-4.1.1 still isn't good enough at optimizing it
550// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000551//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000552//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000553//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000554//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000555#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000556#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000557#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000558#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000559#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000560
561/* dmalloc will redefine these to it's own implementation. It is safe
562 * to have the prototypes here unconditionally. */
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000563extern void *malloc_or_warn(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000564extern void *xmalloc(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000565extern void *xzalloc(size_t size);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000566extern void *xrealloc(void *old, size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000567
Denis Vlasenkoea620772006-10-14 02:23:43 +0000568extern ssize_t safe_read(int fd, void *buf, size_t count);
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000569extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000570// NB: will return short read on error, not -1,
571// if some data was read before error occurred
Denis Vlasenkoea620772006-10-14 02:23:43 +0000572extern ssize_t full_read(int fd, void *buf, size_t count);
573extern void xread(int fd, void *buf, size_t count);
574extern unsigned char xread_char(int fd);
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000575// Reads one line a-la fgets (but doesn't save terminating '\n').
576// Uses single full_read() call, works only on seekable streams.
Denis Vlasenkoea620772006-10-14 02:23:43 +0000577extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000578// Reads one line a-la fgets (but doesn't save terminating '\n').
579// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000580// Bytes are appended to pfx (which must be malloced, or NULL).
Denis Vlasenko0b6c6a92008-03-24 00:04:42 +0000581extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p);
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000582extern ssize_t read_close(int fd, void *buf, size_t maxsz);
583extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000584/* Returns NULL if file can't be opened */
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000585extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000586/* Never returns NULL */
587extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000588
589extern ssize_t safe_write(int fd, const void *buf, size_t count);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000590// NB: will return short write on error, not -1,
591// if some data was written before error occurred
Denis Vlasenkoea620772006-10-14 02:23:43 +0000592extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000593extern void xwrite(int fd, const void *buf, size_t count);
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000594extern void xopen_xwrite_close(const char* file, const char *str);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000595
Denis Vlasenko1de08302006-10-26 23:32:43 +0000596/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000597extern void xprint_and_close_file(FILE *file);
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000598/* Reads up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000599extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000600/* Chops off TERMINATING_STRING from the end: */
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000601extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000602/* Reads up to (and including) "\n" or NUL byte: */
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000603extern char *xmalloc_fgets(FILE *file);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000604/* Chops off '\n' from the end, unlike fgets: */
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000605extern char *xmalloc_fgetline(FILE *file);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000606extern char *bb_get_chunk_from_file(FILE *file, int *end);
607extern void die_if_ferror(FILE *file, const char *msg);
608extern void die_if_ferror_stdout(void);
609extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000610extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000611extern int fclose_if_not_stdin(FILE *file);
612extern FILE *xfopen(const char *filename, const char *mode);
613/* Prints warning to stderr and returns NULL on failure: */
614extern FILE *fopen_or_warn(const char *filename, const char *mode);
615/* "Opens" stdin if filename is special, else just opens file: */
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000616extern FILE *xfopen_stdin(const char *filename);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000617extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000618
Denis Vlasenkofb290382008-03-02 12:51:26 +0000619int bb_pstrcmp(const void *a, const void *b);
620void qsort_string_vector(char **sv, unsigned count);
621
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000622/* Wrapper which restarts poll on EINTR or ENOMEM.
623 * On other errors complains [perror("poll")] and returns.
624 * Warning! May take (much) longer than timeout_ms to return!
625 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
626int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms);
627
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000628char *safe_gethostname(void);
629
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000630/* Convert each alpha char in str to lower-case */
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000631char* str_tolower(char *str);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000632
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000633char *utoa(unsigned n);
634char *itoa(int n);
Denis Vlasenko10457b92007-03-27 22:01:31 +0000635/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000636char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
637char *itoa_to_buf(int n, char *buf, unsigned buflen);
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000638/* Intelligent formatters of bignums */
639void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale);
640void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale);
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000641//TODO: provide pointer to buf (avoid statics)?
642const char *make_human_readable_str(unsigned long long size,
643 unsigned long block_size, unsigned long display_unit);
644/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
645char *bin2hex(char *buf, const char *cp, int count);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000646
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000647/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000648struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000649 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000650 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000651};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000652#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000653/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000654/* Using xatoi() instead of naive atoi() is not always convenient -
655 * in many places people want *non-negative* values, but store them
656 * in signed int. Therefore we need this one:
657 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
658int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000659/* Useful for reading port numbers */
660uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000661
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000662
Eric Andersenaad1a882001-03-16 22:47:14 +0000663/* These parse entries in /etc/passwd and /etc/group. This is desirable
664 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000665 * increases target size and is often not needed on embedded systems. */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000666long xuname2uid(const char *name);
667long xgroup2gid(const char *name);
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000668/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000669unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000670/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000671struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000672 uid_t uid;
673 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000674};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000675/* always sets uid and gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000676int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
Denis Vlasenkocce38582007-02-26 22:47:42 +0000677/* chown-like handling of "user[:[group]" */
678void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
Denis Vlasenko3734b942007-07-27 11:20:10 +0000679/* bb_getpwuid, bb_getgrgid:
Denis Vlasenko1d10aaf2007-07-27 11:22:34 +0000680 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
681 * as a string to buf, return user/group name or NULL
682 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
683 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
Denis Vlasenko3734b942007-07-27 11:20:10 +0000684*/
685char *bb_getpwuid(char *name, int bufsize, long uid);
686char *bb_getgrgid(char *group, int bufsize, long gid);
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000687/* versions which cache results (useful for ps, ls etc) */
688const char* get_cached_username(uid_t uid);
689const char* get_cached_groupname(gid_t gid);
690void clear_username_cache(void);
691/* internally usernames are saved in fixed-sized char[] buffers */
692enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000693#if ENABLE_FEATURE_CHECK_NAMES
694void die_if_bad_username(const char* name);
695#else
696#define die_if_bad_username(name) ((void)(name))
697#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000698
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000699int execable_file(const char *name);
700char *find_execable(const char *filename);
701int exists_execable(const char *filename);
702
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000703/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
704 * but it may exec busybox and call applet instead of searching PATH.
705 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000706#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000707int bb_execvp(const char *file, char *const argv[]);
708#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
709#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000710 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000711 cmd, __VA_ARGS__)
712#else
713#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
714#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
715#endif
716
717/* NOMMU friendy fork+exec */
718pid_t spawn(char **argv);
719pid_t xspawn(char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000720
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000721int safe_waitpid(int pid, int *wstat, int options);
722/* Unlike waitpid, waits ONLY for one process.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000723 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000724 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000725 * IOW: rc = wait4pid(spawn(argv));
726 * if (rc < 0) bb_perror_msg("%s", argv[0]);
727 * if (rc > 0) bb_error_msg("exit code: %d", rc);
728 */
Denis Vlasenko473dae02007-04-11 07:04:23 +0000729int wait4pid(int pid);
Denis Vlasenkofb0eba72008-01-02 19:55:04 +0000730int wait_any_nohang(int *wstat);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000731#define wait_crashed(w) ((w) & 127)
732#define wait_exitcode(w) ((w) >> 8)
733#define wait_stopsig(w) ((w) >> 8)
734#define wait_stopped(w) (((w) & 127) == 127)
735/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
736int spawn_and_wait(char **argv);
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000737struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000738 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000739 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000740 int xfunc_error_retval;
741 uint32_t option_mask32;
742 int die_sleep;
743 smallint saved;
744};
745void save_nofork_data(struct nofork_save_area *save);
746void restore_nofork_data(struct nofork_save_area *save);
747/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000748int run_nofork_applet(int applet_no, char **argv);
749int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000750
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000751/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000752 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000753 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000754 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000755 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
756 * rexec's itself on NOMMU with argv passed as command line.
757 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
758 * from the start. (It will detect it and not reexec again second time).
759 * You have to audit carefully that you don't do something twice as a result
760 * (opening files/sockets, parsing config files etc...)!
761 *
762 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
763 * (will do setsid()).
764 *
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000765 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
766 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenkob44c7902008-03-17 09:29:43 +0000767 * Currently used for openvt and setsid. On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000768 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000769 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000770 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000771 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
772 * to /dev/null if they are not.
773 */
774enum {
775 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000776 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000777 DAEMON_CLOSE_EXTRA_FDS = 4,
778 DAEMON_ONLY_SANITIZE = 8, /* internal use */
779};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000780#if BB_MMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000781 void forkexit_or_rexec(void);
Denis Vlasenko367960b2007-08-18 14:20:21 +0000782 enum { re_execed = 0 };
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000783# define forkexit_or_rexec(argv) forkexit_or_rexec()
784# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
785# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000786#else
Denis Vlasenko367960b2007-08-18 14:20:21 +0000787 void re_exec(char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkoc52248e2008-03-20 14:04:30 +0000788 void forkexit_or_rexec(char **argv);
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000789 extern bool re_execed;
Denis Vlasenko05743d72008-02-10 12:10:08 +0000790 int BUG_fork_is_unavailable_on_nommu(void);
791 int BUG_daemon_is_unavailable_on_nommu(void);
792 void BUG_bb_daemonize_is_unavailable_on_nommu(void);
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000793# define fork() BUG_fork_is_unavailable_on_nommu()
794# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
795# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000796#endif
797void bb_daemonize_or_rexec(int flags, char **argv);
798void bb_sanitize_stdio(void);
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000799/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
800int sanitize_env_if_suid(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000801
802
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000803extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000804extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000805#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000806#define No_argument "\0"
807#define Required_argument "\001"
808#define Optional_argument "\002"
809extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000810#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000811extern uint32_t option_mask32;
Denis Vlasenkod37f2222007-08-19 13:42:08 +0000812extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000813
814
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000815typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000816 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000817 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000818} llist_t;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000819void llist_add_to(llist_t **old_head, void *data);
820void llist_add_to_end(llist_t **list_head, void *data);
821void *llist_pop(llist_t **elm);
822void llist_unlink(llist_t **head, llist_t *elm);
823void llist_free(llist_t *elm, void (*freeit)(void *data));
824llist_t *llist_rev(llist_t *list);
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000825/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000826 * llist_t *llist_add_to(llist_t *old_head, void *data)
827 * etc does not result in smaller code... */
828
Denis Vlasenko80edead2007-08-02 22:31:05 +0000829/* start_stop_daemon and udhcpc are special - they want
830 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000831#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000832/* True only if we created pidfile which is *file*, not /dev/null etc */
833extern smallint wrote_pidfile;
834void write_pidfile(const char *path);
835#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000836#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000837enum { wrote_pidfile = 0 };
838#define write_pidfile(path) ((void)0)
839#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000840#endif
841
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000842enum {
843 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000844 LOGMODE_STDIO = (1 << 0),
845 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000846 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
847};
848extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000849extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000850extern int die_sleep;
851extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000852extern jmp_buf die_jmp;
Denis Vlasenko335b63d2007-04-10 21:38:30 +0000853extern void xfunc_die(void) ATTRIBUTE_NORETURN;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000854extern void bb_show_usage(void) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000855extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
856extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
857extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000858extern void bb_simple_perror_msg(const char *s);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000859extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000860extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000861extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
862extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
863extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
864extern void bb_perror_nomsg(void);
865extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000866extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000867
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000868/* We need to export XXX_main from libbusybox
869 * only if we build "individual" binaries
870 */
871#if ENABLE_FEATURE_INDIVIDUAL
872#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
873#else
874#define MAIN_EXTERNALLY_VISIBLE
875#endif
876
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000877
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000878/* applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000879int bb_cat(char** argv);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000880/* If shell needs them, these three "exist" even if not enabled as applets */
881int echo_main(int argc, char** argv) USE_ECHO(MAIN_EXTERNALLY_VISIBLE);
882int test_main(int argc, char **argv) USE_TEST(MAIN_EXTERNALLY_VISIBLE);
883int kill_main(int argc, char **argv) USE_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000884int chown_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000885int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000886int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000887int bbunpack(char **argv,
Denis Vlasenkoc86e0522007-03-20 11:30:28 +0000888 char* (*make_new_name)(char *filename),
889 USE_DESKTOP(long long) int (*unpacker)(void)
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000890);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000891#if ENABLE_ROUTE
892void bb_displayroutes(int noresolve, int netstatfmt);
893#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000894
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000895
896/* Networking */
897int create_icmp_socket(void);
898int create_icmp6_socket(void);
899/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000900/* This structure defines protocol families and their handlers. */
901struct aftype {
902 const char *name;
903 const char *title;
904 int af;
905 int alen;
906 char *(*print) (unsigned char *);
907 const char *(*sprint) (struct sockaddr *, int numeric);
908 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
909 void (*herror) (char *text);
910 int (*rprint) (int options);
911 int (*rinput) (int typ, int ext, char **argv);
912
913 /* may modify src */
914 int (*getmask) (char *src, struct sockaddr * mask, char *name);
915};
916/* This structure defines hardware protocols and their handlers. */
917struct hwtype {
918 const char *name;
919 const char *title;
920 int type;
921 int alen;
922 char *(*print) (unsigned char *);
923 int (*input) (const char *, struct sockaddr *);
924 int (*activate) (int fd);
925 int suppress_null_addr;
926};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000927extern smallint interface_opt_a;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000928int display_interfaces(char *ifname);
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000929#if ENABLE_FEATURE_HWIB
930int in_ib(const char *bufp, struct sockaddr *sap);
931#endif
Denis Vlasenko1cc70222007-03-15 19:46:43 +0000932const struct aftype *get_aftype(const char *name);
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000933const struct hwtype *get_hwtype(const char *name);
934const struct hwtype *get_hwntype(int type);
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000935
936
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000937#ifndef BUILD_INDIVIDUAL
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000938extern int find_applet_by_name(const char *name);
Denis Vlasenko32b633a2007-04-09 03:05:48 +0000939/* Returns only if applet is not found. */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000940extern void run_applet_and_exit(const char *name, char **argv);
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000941extern void run_applet_no_and_exit(int a, char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000942#endif
943
Mike Frysinger9412ec72008-02-07 22:41:33 +0000944#ifdef HAVE_MNTENT_H
Denis Vlasenkobf295dd2007-04-05 21:57:47 +0000945extern int match_fstype(const struct mntent *mt, const char *fstypes);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000946extern struct mntent *find_mount_point(const char *name, const char *table);
Mike Frysinger9412ec72008-02-07 22:41:33 +0000947#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000948extern void erase_mtab(const char * name);
949extern unsigned int tty_baud_to_value(speed_t speed);
950extern speed_t tty_value_to_baud(unsigned int value);
951extern void bb_warn_ignoring_args(int n);
952
953extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000954
Rob Landley1d589b22005-11-29 23:47:10 +0000955extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000956extern int del_loop(const char *device);
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +0000957/* If *devname is not NULL, use that name, otherwise try to find free one,
958 * malloc and return it in *devname.
959 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
960extern int set_loop(char **devname, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000961
Eric Andersenaad1a882001-03-16 22:47:14 +0000962
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000963//TODO: pass buf pointer or return allocated buf (avoid statics)?
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000964char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000965int bb_ask_confirmation(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000966
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000967extern int bb_parse_mode(const char* s, mode_t* theMode);
968
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +0000969/* Concatenate path and filename to new allocated buffer.
970 * Add "/" only as needed (no duplicate "//" are produced).
971 * If path is NULL, it is assumed to be "/".
972 * filename should not be NULL. */
Eric Andersene5dfced2001-04-09 22:48:12 +0000973char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000974char *concat_subpath_file(const char *path, const char *filename);
Denis Vlasenkodc757aa2007-06-30 08:04:05 +0000975const char *bb_basename(const char *name);
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000976/* NB: can violate const-ness (similarly to strchr) */
Eric Andersenc911a432001-05-15 17:42:16 +0000977char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000978
Denis Vlasenko4921b542007-02-03 02:17:41 +0000979
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000980USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
981int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000982
Denis Vlasenko14579152006-10-26 01:09:46 +0000983
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000984int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000985
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000986int get_signum(const char *name);
987const char *get_signame(int number);
Denis Vlasenkoa4f4de92007-09-30 16:32:01 +0000988void print_signames(void);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000989
Manuel Novoa III cad53642003-03-19 09:13:01 +0000990char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000991
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000992#define FAIL_DELAY 3
993extern void bb_do_delay(int seconds);
994extern void change_identity(const struct passwd *pw);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000995extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000996extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000997#if ENABLE_SELINUX
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000998extern void renew_current_security_context(void);
999extern void set_current_security_context(security_context_t sid);
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001000extern context_t set_security_context_component(security_context_t cur_context,
1001 char *user, char *role, char *type, char *range);
Denis Vlasenko39c651e2007-03-12 18:22:55 +00001002extern void setfscreatecon_or_die(security_context_t scontext);
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001003extern void selinux_preserve_fcontext(int fdesc);
1004#else
1005#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001006#endif
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001007extern void selinux_or_die(void);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001008extern int restricted_shell(const char *shell);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001009
1010/* setup_environment:
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001011 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001012 * TERM=(old value)
1013 * USER=pw->pw_name, LOGNAME=pw->pw_name
1014 * PATH=bb_default_[root_]path
1015 * HOME=pw->pw_dir
1016 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001017 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001018 * if not root (if pw->pw_uid != 0):
1019 * USER=pw->pw_name, LOGNAME=pw->pw_name
1020 * HOME=pw->pw_dir
1021 * SHELL=shell
1022 * else does nothing
1023 */
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001024extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001025extern int correct_password(const struct passwd *pw);
Denis Vlasenko21d10142007-07-20 21:28:41 +00001026/* Returns a ptr to static storage */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001027extern char *pw_encrypt(const char *clear, const char *salt);
1028extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001029
1030int index_in_str_array(const char *const string_array[], const char *key);
1031int index_in_strings(const char *strings, const char *key);
1032int index_in_substr_array(const char *const string_array[], const char *key);
1033int index_in_substrings(const char *strings, const char *key);
1034const char *nth_string(const char *strings, int n);
1035
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001036extern void print_login_issue(const char *issue_file, const char *tty);
1037extern void print_login_prompt(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001038
Denis Vlasenko21d10142007-07-20 21:28:41 +00001039/* rnd is additional random input. New one is returned.
1040 * Useful if you call crypt_make_salt many times in a row:
1041 * rnd = crypt_make_salt(buf1, 4, 0);
1042 * rnd = crypt_make_salt(buf2, 4, rnd);
1043 * rnd = crypt_make_salt(buf3, 4, rnd);
1044 * (otherwise we risk having same salt generated)
1045 */
1046extern int crypt_make_salt(char *p, int cnt, int rnd);
1047
1048/* Returns number of lines changed, or -1 on error */
1049extern int update_passwd(const char *filename, const char *username,
1050 const char *new_pw);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001051
Denis Vlasenkof893da82007-08-09 08:27:24 +00001052/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenko55995022008-05-18 22:28:26 +00001053int get_terminal_width_height(int fd, unsigned *width, unsigned *height);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001054
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001055/* NB: "unsigned request" is crucial! "int request" will break some arches! */
1056int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
1057int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001058#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001059int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name);
1060int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name);
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001061#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1062#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1063#else
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001064int bb_ioctl_or_warn(int fd, unsigned request, void *argp);
1065int bb_xioctl(int fd, unsigned request, void *argp);
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001066#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1067#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1068#endif
1069
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001070char *is_in_ino_dev_hashtable(const struct stat *statbuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001071void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
1072void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +00001073#ifdef __GLIBC__
1074/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001075unsigned long long bb_makedev(unsigned int major, unsigned int minor);
Denis Vlasenko0b354702006-11-24 14:54:27 +00001076#undef makedev
1077#define makedev(a,b) bb_makedev(a,b)
1078#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001079
1080
Denis Vlasenko38f63192007-01-22 09:03:07 +00001081#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001082/* It's NOT just ENABLEd or disabled. It's a number: */
Denis Vlasenko38f63192007-01-22 09:03:07 +00001083#ifdef CONFIG_FEATURE_EDITING_HISTORY
1084#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001085#else
1086#define MAX_HISTORY 0
1087#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001088typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001089 int flags;
1090 const char *path_lookup;
1091#if MAX_HISTORY
1092 int cnt_history;
1093 int cur_history;
Denis Vlasenko38f63192007-01-22 09:03:07 +00001094 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001095 char *history[MAX_HISTORY + 1];
1096#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001097} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001098enum {
1099 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001100 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1101 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1102 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1103 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001104 WITH_PATH_LOOKUP = 0x20,
1105 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1106};
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001107line_input_t *new_line_input_t(int flags);
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001108/* Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001109 * -1 on read errors or EOF, or on bare Ctrl-D,
1110 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001111 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001112 */
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001113int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
1114#else
1115int read_line_input(const char* prompt, char* command, int maxsize);
1116#define read_line_input(prompt, command, maxsize, state) \
1117 read_line_input(prompt, command, maxsize)
1118#endif
1119
1120
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001121#ifndef COMM_LEN
1122#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001123enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001124#else
1125/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001126enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001127#endif
1128#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001129typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001130 DIR *dir;
Denis Vlasenko512499c2007-08-26 18:23:13 +00001131 uint8_t shift_pages_to_bytes;
1132 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001133/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001134 char *argv0;
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001135 USE_SELINUX(char *context;)
1136 /* Everything below must contain no ptrs to malloc'ed data:
1137 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001138 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001139 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001140 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001141 unsigned pid;
1142 unsigned ppid;
1143 unsigned pgid;
1144 unsigned sid;
1145 unsigned uid;
1146 unsigned gid;
Denis Vlasenko31789a82007-06-19 14:43:17 +00001147 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001148#if ENABLE_FEATURE_TOPMEM
1149 unsigned long mapped_rw;
1150 unsigned long mapped_ro;
1151 unsigned long shared_clean;
1152 unsigned long shared_dirty;
1153 unsigned long private_clean;
1154 unsigned long private_dirty;
1155 unsigned long stack;
1156#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001157 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001158 /* basename of executable in exec(2), read from /proc/N/stat
1159 * (if executable is symlink or script, it is NOT replaced
1160 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001161 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001162 /* user/group? - use passwd/group parsing functions */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001163} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001164enum {
1165 PSSCAN_PID = 1 << 0,
1166 PSSCAN_PPID = 1 << 1,
1167 PSSCAN_PGID = 1 << 2,
1168 PSSCAN_SID = 1 << 3,
1169 PSSCAN_UIDGID = 1 << 4,
1170 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001171 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001172 PSSCAN_ARGV0 = 1 << 7,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001173 /* PSSCAN_EXE = 1 << 8, - not implemented */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001174 PSSCAN_STATE = 1 << 9,
1175 PSSCAN_VSZ = 1 << 10,
1176 PSSCAN_RSS = 1 << 11,
1177 PSSCAN_STIME = 1 << 12,
1178 PSSCAN_UTIME = 1 << 13,
1179 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001180 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko72e1c892007-09-29 22:26:01 +00001181 PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1182 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001183 PSSCAN_START_TIME = 1 << 18,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001184 /* These are all retrieved from proc/NN/stat in one go: */
1185 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1186 | PSSCAN_COMM | PSSCAN_STATE
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001187 | PSSCAN_VSZ | PSSCAN_RSS
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001188 | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001189 | PSSCAN_TTY,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001190};
Denis Vlasenko68404f12008-03-17 09:00:54 +00001191//procps_status_t* alloc_procps_scan(void);
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001192void free_procps_scan(procps_status_t* sp);
1193procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001194/* Format cmdline (up to col chars) into char buf[col+1] */
1195/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1196void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
Denis Vlasenko35fb5122006-11-01 09:16:49 +00001197pid_t *find_pid_by_name(const char* procName);
1198pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001199
1200
1201extern const char bb_uuenc_tbl_base64[];
1202extern const char bb_uuenc_tbl_std[];
Denis Vlasenkoe8240f12007-06-26 15:59:37 +00001203void bb_uuencode(char *store, const void *s, int length, const char *tbl);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001204
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001205typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001206 uint32_t count[2];
1207 uint32_t hash[5];
1208 uint32_t wbuf[16];
1209} sha1_ctx_t;
1210void sha1_begin(sha1_ctx_t *ctx);
1211void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
1212void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
1213
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001214typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001215 uint32_t A;
1216 uint32_t B;
1217 uint32_t C;
1218 uint32_t D;
1219 uint64_t total;
1220 uint32_t buflen;
1221 char buffer[128];
1222} md5_ctx_t;
1223void md5_begin(md5_ctx_t *ctx);
1224void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
1225void *md5_end(void *resbuf, md5_ctx_t *ctx);
1226
Denis Vlasenkoc6758a02007-04-10 21:40:19 +00001227uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001228
1229
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001230extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001231/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001232extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001233extern const char bb_msg_memory_exhausted[];
1234extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001235extern const char bb_msg_read_error[];
1236extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001237extern const char bb_msg_unknown[];
1238extern const char bb_msg_can_not_create_raw_socket[];
1239extern const char bb_msg_perm_denied_are_you_root[];
1240extern const char bb_msg_requires_arg[];
1241extern const char bb_msg_invalid_arg[];
1242extern const char bb_msg_standard_input[];
1243extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001244
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001245extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001246/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001247extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001248
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001249extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001250extern const char bb_path_passwd_file[];
1251extern const char bb_path_shadow_file[];
1252extern const char bb_path_gshadow_file[];
1253extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001254extern const char bb_path_motd_file[];
1255extern const char bb_path_wtmp_file[];
1256extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001257extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001258/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1259 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001260extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1261#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1262#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001263
Denis Vlasenko703e2022007-01-22 14:12:08 +00001264extern const int const_int_0;
1265extern const int const_int_1;
1266
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001267
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001268#ifndef BUFSIZ
1269#define BUFSIZ 4096
1270#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001271/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001272enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1273extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001274/* This struct is deliberately not defined. */
1275/* See docs/keep_data_small.txt */
1276struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001277/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001278 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001279 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001280extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001281/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1282#define barrier() asm volatile("":::"memory")
1283#define SET_PTR_TO_GLOBALS(x) do { \
1284 (*(struct globals**)&ptr_to_globals) = (x); \
1285 barrier(); \
1286} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001287
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001288/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1289 * use bb_default_login_shell and following defines.
1290 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1291 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001292#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001293extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001294/* "/bin/sh" */
1295#define DEFAULT_SHELL (bb_default_login_shell+1)
1296/* "sh" */
1297#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1298
1299
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001300#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001301# define CURRENT_VC "/dev/vc/0"
1302# define VC_1 "/dev/vc/1"
1303# define VC_2 "/dev/vc/2"
1304# define VC_3 "/dev/vc/3"
1305# define VC_4 "/dev/vc/4"
1306# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001307#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1308/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1309 respective serial ports .. as such, we can't use the common device paths for
1310 these. -- PFM */
1311# define SC_0 "/dev/ttsc/0"
1312# define SC_1 "/dev/ttsc/1"
1313# define SC_FORMAT "/dev/ttsc/%d"
1314#else
1315# define SC_0 "/dev/tts/0"
1316# define SC_1 "/dev/tts/1"
1317# define SC_FORMAT "/dev/tts/%d"
1318#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001319# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001320# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001321# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001322# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001323# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001324#else
1325# define CURRENT_VC "/dev/tty0"
1326# define VC_1 "/dev/tty1"
1327# define VC_2 "/dev/tty2"
1328# define VC_3 "/dev/tty3"
1329# define VC_4 "/dev/tty4"
1330# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001331#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1332# define SC_0 "/dev/ttySC0"
1333# define SC_1 "/dev/ttySC1"
1334# define SC_FORMAT "/dev/ttySC%d"
1335#else
1336# define SC_0 "/dev/ttyS0"
1337# define SC_1 "/dev/ttyS1"
1338# define SC_FORMAT "/dev/ttyS%d"
1339#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001340# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001341# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001342# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001343# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001344# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001345#endif
1346
1347/* The following devices are the same on devfs and non-devfs systems. */
1348#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001349#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001350
Rob Landleyc57ec372006-04-10 17:07:15 +00001351
Rob Landleyb623a542006-05-31 22:09:03 +00001352#ifndef RB_POWER_OFF
1353/* Stop system and switch power off if possible. */
1354#define RB_POWER_OFF 0x4321fedc
1355#endif
1356
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001357/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001358#undef isalnum
1359#undef isalpha
1360#undef isascii
1361#undef isblank
1362#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001363#undef isgraph
1364#undef islower
1365#undef isprint
1366#undef ispunct
1367#undef isspace
1368#undef isupper
1369#undef isxdigit
1370
Denis Vlasenko459903b2006-11-27 14:44:18 +00001371/* This one is more efficient - we save ~400 bytes */
1372#undef isdigit
1373#define isdigit(a) ((unsigned)((a) - '0') <= 9)
1374
Denis Vlasenko6b06cb82008-05-15 21:30:45 +00001375#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denis Vlasenko459903b2006-11-27 14:44:18 +00001376
Denis Vlasenko98636eb2008-05-09 17:59:34 +00001377
1378#if __GNUC_PREREQ(4,1)
1379# pragma GCC visibility pop
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001380#endif
1381
Denis Vlasenko80b8b392007-06-25 10:55:35 +00001382
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +00001383#endif /* __LIBBUSYBOX_H__ */