blob: 492a561a922b6bfeb1576452872b777f13b1625e [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
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +000082/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +000083extern char **environ;
84
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +000085/* Set the group set for the current user to GROUPS (N of them). */
86int setgroups(size_t n, const gid_t *groups);
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000087#if defined(__GLIBC__) && __GLIBC__ < 2
88int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000089#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000090/* klogctl is in libc's klog.h, but we cheat and not #include that */
91int klogctl(int type, char *b, int len);
92/* This is declared here rather than #including <libgen.h> in order to avoid
93 * confusing the two versions of basename. See the dirname/basename man page
94 * for details. */
95char *dirname(char *path);
96/* Include our own copy of struct sysinfo to avoid binary compatibility
97 * problems with Linux 2.4, which changed things. Grumble, grumble. */
98struct sysinfo {
99 long uptime; /* Seconds since boot */
100 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
101 unsigned long totalram; /* Total usable main memory size */
102 unsigned long freeram; /* Available memory size */
103 unsigned long sharedram; /* Amount of shared memory */
104 unsigned long bufferram; /* Memory used by buffers */
105 unsigned long totalswap; /* Total swap space size */
106 unsigned long freeswap; /* swap space still available */
107 unsigned short procs; /* Number of current processes */
108 unsigned short pad; /* Padding needed for m68k */
109 unsigned long totalhigh; /* Total high memory size */
110 unsigned long freehigh; /* Available high memory size */
111 unsigned int mem_unit; /* Memory unit size in bytes */
112 char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
113};
114int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +0000115
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000116
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000117/* Make all declarations hidden (-fvisibility flag only affects definitions) */
118/* (don't include system headers after this until corresponding pop!) */
119#if __GNUC_PREREQ(4,1)
120# pragma GCC visibility push(hidden)
121#endif
122
123
124#if ENABLE_USE_BB_PWD_GRP
125# include "pwd_.h"
126# include "grp_.h"
127#endif
128#if ENABLE_FEATURE_SHADOWPASSWDS
129# if ENABLE_USE_BB_SHADOW
130# include "shadow_.h"
131# endif
132#endif
133
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000134/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000135#define MAXINT(T) (T)( \
136 ((T)-1) > 0 \
137 ? (T)-1 \
138 : (T)~((T)1 << (sizeof(T)*8-1)) \
139 )
140
141#define MININT(T) (T)( \
142 ((T)-1) > 0 \
143 ? (T)0 \
144 : ((T)1 << (sizeof(T)*8-1)) \
145 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000146
Denis Vlasenko56254152006-10-07 16:24:46 +0000147/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000148/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000149 * (stat, lseek etc) mapped to "largefile" variants by libc.
150 * Practically it means that open() automatically has O_LARGEFILE added
151 * and all filesize/file_offset parameters and struct members are "large"
152 * (in today's world - signed 64bit). For full support of large files,
153 * we need a few helper #defines (below) and careful use of off_t
154 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000155#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000156/* CONFIG_LFS is on */
157# if ULONG_MAX > 0xffffffff
158/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000159# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000160/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
161# define BB_STRTOOFF bb_strtoul
162# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000163/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
164# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000165# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000166/* "long" is too short, need "long long" */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000167# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000168# define BB_STRTOOFF bb_strtoull
169# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000170# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000171# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000172#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000173/* CONFIG_LFS is off */
174# if UINT_MAX == 0xffffffff
175/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
176 * gcc will throw warnings on printf("%d", off_t). Crap... */
177# define XATOOFF(a) xatoi_u(a)
178# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000179# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000180# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000181# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000182# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
183# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000184# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000185# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000186# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000187#endif
188/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000189#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000190
Eric Andersenaad1a882001-03-16 22:47:14 +0000191/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000192#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000193#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000194#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000195#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000196#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000197#define SKIP ((int) 2)
198
199/* for mtab.c */
200#define MTAB_GETMOUNTPT '1'
201#define MTAB_GETDEVICE '2'
202
203#define BUF_SIZE 8192
204#define EXPAND_ALLOC 1024
205
Eric Andersenaad1a882001-03-16 22:47:14 +0000206/* Macros for min/max. */
207#ifndef MIN
208#define MIN(a,b) (((a)<(b))?(a):(b))
209#endif
210
211#ifndef MAX
212#define MAX(a,b) (((a)>(b))?(a):(b))
213#endif
214
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000215/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000216#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000217#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000218#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
219#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
220#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000221#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000222#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
223#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
224#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
225#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000226#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
227#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
228#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000229#endif
230#endif
231
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000232#if defined(__GLIBC__)
233/* glibc uses __errno_location() to get a ptr to errno */
234/* We can just memorize it once - no multithreading in busybox :) */
235extern int *const bb_errno;
236#undef errno
237#define errno (*bb_errno)
238#endif
239
Denis Vlasenko459be352007-06-17 19:09:05 +0000240unsigned long long monotonic_us(void);
Denis Vlasenkobd7bb292007-06-17 23:40:26 +0000241unsigned monotonic_sec(void);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000242
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000243extern void chomp(char *s);
244extern void trim(char *s);
245extern char *skip_whitespace(const char *);
Denis Vlasenko0de93752006-12-26 02:51:29 +0000246extern char *skip_non_whitespace(const char *);
Bernhard Reutner-Fischer17282292008-05-28 14:19:27 +0000247extern char *strrstr(const char *haystack, const char *needle);
Paul Fox0b621582005-08-09 19:38:05 +0000248
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000249//TODO: supply a pointer to char[11] buffer (avoid statics)?
Bernhard Reutner-Fischer835f5752007-01-22 17:48:08 +0000250extern const char *bb_mode_string(mode_t mode);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000251extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000252enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
253 FILEUTILS_PRESERVE_STATUS = 1,
254 FILEUTILS_DEREFERENCE = 2,
255 FILEUTILS_RECUR = 4,
256 FILEUTILS_FORCE = 8,
257 FILEUTILS_INTERACTIVE = 0x10,
258 FILEUTILS_MAKE_HARDLINK = 0x20,
259 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000260 FILEUTILS_DEREF_SOFTLINK = 0x80,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000261#if ENABLE_SELINUX
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000262 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
263 FILEUTILS_SET_SECURITY_CONTEXT = 0x200
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000264#endif
265};
Denis Vlasenkoc0431ed2008-04-27 22:06:24 +0000266#define FILEUTILS_CP_OPTSTR "pdRfilsL" USE_SELINUX("c")
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000267extern int remove_file(const char *path, int flags);
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000268/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
269 * the source, not copy (unless "source" is a directory).
270 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
271 * work coreutils-compatibly. */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000272extern int copy_file(const char *source, const char *dest, int flags);
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000273
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000274enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000275 ACTION_RECURSE = (1 << 0),
276 ACTION_FOLLOWLINKS = (1 << 1),
277 ACTION_FOLLOWLINKS_L0 = (1 << 2),
278 ACTION_DEPTHFIRST = (1 << 3),
279 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000280};
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000281extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000282 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
283 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
Denis Vlasenkod166f832007-07-05 00:12:55 +0000284 void* userData, unsigned depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000285extern int device_open(const char *device, int mode);
Denis Vlasenko85c24712008-03-17 09:04:04 +0000286enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000287extern int xgetpty(char *line);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000288extern int get_console_fd(void);
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000289extern void console_make_active(int fd, const int vt_num);
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +0000290extern char *find_block_device(const char *path);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000291/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000292extern off_t bb_copyfd_eof(int fd1, int fd2);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000293extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
294extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
295/* "short" copy can be detected by return value < size */
296/* this helper yells "short read!" if param is not -1 */
297extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000298extern char bb_process_escape_sequence(const char **ptr);
Denis Vlasenko818322b2007-09-24 18:27:04 +0000299/* xxxx_strip version can modify its parameter:
300 * "/" -> "/"
301 * "abc" -> "abc"
302 * "abc/def" -> "def"
303 * "abc/def/" -> "def" !!
304 */
305extern char *bb_get_last_path_component_strip(char *path);
306/* "abc/def/" -> "" and it never modifies 'path' */
307extern char *bb_get_last_path_component_nostrip(const char *path);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000308
309int ndelay_on(int fd);
310int ndelay_off(int fd);
Denis Vlasenko96e1b382007-09-30 23:50:48 +0000311int close_on_exec_on(int fd);
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000312void xdup2(int, int);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000313void xmove_fd(int, int);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000314
315
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000316DIR *xopendir(const char *path);
317DIR *warn_opendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000318
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000319/* UNUSED: char *xmalloc_realpath(const char *path); */
320char *xmalloc_readlink(const char *path);
Denis Vlasenko6ca04442007-02-11 16:19:28 +0000321char *xmalloc_readlink_or_warn(const char *path);
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000322char *xrealloc_getcwd_or_warn(char *cwd);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000323
Paul Fox599bbfb2007-11-08 20:00:36 +0000324char *xmalloc_follow_symlinks(const char *path);
Denis Vlasenko473dae02007-04-11 07:04:23 +0000325
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000326
Denis Vlasenko33196372008-02-23 01:25:38 +0000327enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000328 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000329 * otherwise would kill us, except for those resulting from bugs:
330 * SIGSEGV, SIGILL, SIGFPE.
331 * Other fatal signals not included (TODO?):
332 * SIGBUS Bus error (bad memory access)
333 * SIGPOLL Pollable event. Synonym of SIGIO
334 * SIGPROF Profiling timer expired
335 * SIGSYS Bad argument to routine
336 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000337 *
338 * The only known arch with some of these sigs not fitting
339 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
340 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000341 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000342 BB_FATAL_SIGS = (int)(0
343 + (1LL << SIGHUP)
344 + (1LL << SIGINT)
345 + (1LL << SIGTERM)
346 + (1LL << SIGPIPE) // Write to pipe with no readers
347 + (1LL << SIGQUIT) // Quit from keyboard
348 + (1LL << SIGABRT) // Abort signal from abort(3)
349 + (1LL << SIGALRM) // Timer signal from alarm(2)
350 + (1LL << SIGVTALRM) // Virtual alarm clock
351 + (1LL << SIGXCPU) // CPU time limit exceeded
352 + (1LL << SIGXFSZ) // File size limit exceeded
353 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
354 + (1LL << SIGUSR2)
355 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000356};
Denis Vlasenko25591c32008-02-16 22:58:56 +0000357void bb_signals(int sigs, void (*f)(int));
358/* Unlike signal() and bb_signals, sets handler with sigaction()
359 * and in a way that while signal handler is run, no other signals
360 * will be blocked: */
361void bb_signals_recursive(int sigs, void (*f)(int));
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000362/* syscalls like read() will be interrupted with EINTR: */
363void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int));
364/* syscalls like read() won't be interrupted (though select/poll will be): */
365void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int));
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000366void wait_for_any_sig(void);
Denis Vlasenko400d8bb2008-02-24 13:36:01 +0000367void kill_myself_with_sig(int sig) ATTRIBUTE_NORETURN;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000368void sig_block(int sig);
369void sig_unblock(int sig);
370/* Will do sigaction(signum, act, NULL): */
371int sigaction_set(int sig, const struct sigaction *act);
372/* SIG_BLOCK/SIG_UNBLOCK all signals: */
373int sigprocmask_allsigs(int how);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000374
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000375
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000376void xsetgid(gid_t gid);
377void xsetuid(uid_t uid);
378void xchdir(const char *path);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000379void xchroot(const char *path);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000380void xsetenv(const char *key, const char *value);
381void xunlink(const char *pathname);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000382void xstat(const char *pathname, struct stat *buf);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000383int xopen(const char *pathname, int flags);
384int xopen3(const char *pathname, int flags, int mode);
Denis Vlasenko50f7f442007-04-11 23:20:53 +0000385int open_or_warn(const char *pathname, int flags);
386int open3_or_warn(const char *pathname, int flags, int mode);
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000387int open_or_warn_stdin(const char *pathname);
Denis Vlasenkocb448fe2008-02-17 14:28:53 +0000388void xrename(const char *oldpath, const char *newpath);
389int rename_or_warn(const char *oldpath, const char *newpath);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000390off_t xlseek(int fd, off_t offset, int whence);
391off_t fdlength(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000392
Denis Vlasenko37188322008-02-16 13:20:56 +0000393void xpipe(int filedes[2]);
394/* In this form code with pipes is much more readable */
395struct fd_pair { int rd; int wr; };
396#define piped_pair(pair) pipe(&((pair).rd))
397#define xpiped_pair(pair) xpipe(&((pair).rd))
398
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000399/* Useful for having small structure members/global variables */
400typedef int8_t socktype_t;
401typedef int8_t family_t;
402struct BUG_too_small {
403 char BUG_socktype_t_too_small[(0
404 | SOCK_STREAM
405 | SOCK_DGRAM
406 | SOCK_RDM
407 | SOCK_SEQPACKET
408 | SOCK_RAW
409 ) <= 127 ? 1 : -1];
410 char BUG_family_t_too_small[(0
411 | AF_UNSPEC
412 | AF_INET
413 | AF_INET6
414 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000415#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000416 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000417#endif
418#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000419 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000420#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000421 /* | AF_DECnet */
422 /* | AF_IPX */
423 ) <= 127 ? 1 : -1];
424};
425
426
Denis Vlasenko448f0242007-01-22 22:43:05 +0000427int xsocket(int domain, int type, int protocol);
428void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
429void xlisten(int s, int backlog);
430void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000431ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Bernhard Reutner-Fischerb2908892007-04-12 11:34:39 +0000432 socklen_t tolen);
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000433/* SO_REUSEADDR allows a server to rebind to an address that is already
434 * "in use" by old connections to e.g. previous server instance which is
435 * killed or crashed. Without it bind will fail until all such connections
436 * time out. Linux does not allow multiple live binds on same ip:port
437 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
438 * Turn it on before you call bind(). */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000439void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000440int setsockopt_broadcast(int fd);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000441/* NB: returns port in host byte order */
442unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000443typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000444 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000445 union {
446 struct sockaddr sa;
447 struct sockaddr_in sin;
448#if ENABLE_FEATURE_IPV6
449 struct sockaddr_in6 sin6;
450#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000451 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000452} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000453enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000454 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000455 LSA_SIZEOF_SA = sizeof(
456 union {
457 struct sockaddr sa;
458 struct sockaddr_in sin;
459#if ENABLE_FEATURE_IPV6
460 struct sockaddr_in6 sin6;
461#endif
462 }
463 )
464};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000465/* Create stream socket, and allocate suitable lsa.
466 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000467 * af == AF_UNSPEC will result in trying to create IPv6 socket,
468 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000469 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000470#if ENABLE_FEATURE_IPV6
471int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type);
472#else
473int xsocket_type(len_and_sockaddr **lsap, int sock_type);
474#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
475#endif
Denis Vlasenko5d687242007-01-12 20:59:31 +0000476int xsocket_stream(len_and_sockaddr **lsap);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000477/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000478 * numeric IP ("N.N.N.N") or numeric IPv6 address,
479 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000480 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000481/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000482int create_and_bind_stream_or_die(const char *bindaddr, int port);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000483int create_and_bind_dgram_or_die(const char *bindaddr, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000484/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
485 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
486 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
487 * If there is no suffix, port argument is used */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000488int create_and_connect_stream_or_die(const char *peer, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000489/* Connect to peer identified by lsa */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000490int xconnect_stream(const len_and_sockaddr *lsa);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000491/* Return malloc'ed len_and_sockaddr with socket address of host:port
492 * Currently will return IPv4 or IPv6 sockaddrs only
493 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000494 * UNIX socket address being returned, IPX sockaddr etc...
495 * On error does bb_error_msg and returns NULL */
496len_and_sockaddr* host2sockaddr(const char *host, int port);
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000497/* Version which dies on error */
Denis Vlasenko42823d52007-02-04 02:39:08 +0000498len_and_sockaddr* xhost2sockaddr(const char *host, int port);
Denis Vlasenko9ca26d32007-02-09 17:32:16 +0000499len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000500/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000501#if !ENABLE_FEATURE_IPV6
502#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
503#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
504#else
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000505len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko42823d52007-02-04 02:39:08 +0000506len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000507#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000508/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000509 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000510 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000511void set_nport(len_and_sockaddr *lsa, unsigned port);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000512/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000513int get_nport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000514/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000515char* xmalloc_sockaddr2host(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000516/* This one doesn't append :PORTNUM */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000517char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000518/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000519char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
Denis Vlasenko448f0242007-01-22 22:43:05 +0000520/* inet_[ap]ton on steroids */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000521char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
522char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000523// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000524// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenko448f0242007-01-22 22:43:05 +0000525struct hostent *xgethostbyname(const char *name);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000526// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000527// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000528
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000529
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000530void socket_want_pktinfo(int fd);
531ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000532 const struct sockaddr *to,
533 const struct sockaddr *from,
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000534 socklen_t tolen);
535ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000536 struct sockaddr *from,
537 struct sockaddr *to,
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000538 socklen_t sa_size);
539
Denis Vlasenko4daad902007-09-27 10:20:47 +0000540char *xstrdup(const char *s);
541char *xstrndup(const char *s, int n);
542char *safe_strncpy(char *dst, const char *src, size_t size);
543/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000544 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenko4daad902007-09-27 10:20:47 +0000545int bb_putchar(int ch);
546char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000547/* Prints unprintable chars ch as ^C or M-c to file
548 * (M-c is used only if ch is ORed with PRINTABLE_META),
549 * else it is printed as-is (except for ch = 0x9b) */
550enum { PRINTABLE_META = 0x100 };
551void fputc_printable(int ch, FILE *file);
Denis Vlasenko9f739442006-12-16 23:49:13 +0000552// gcc-4.1.1 still isn't good enough at optimizing it
553// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000554//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000555//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000556//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000557//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000558#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000559#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000560#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000561#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000562#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000563
564/* dmalloc will redefine these to it's own implementation. It is safe
565 * to have the prototypes here unconditionally. */
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000566extern void *malloc_or_warn(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000567extern void *xmalloc(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000568extern void *xzalloc(size_t size);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000569extern void *xrealloc(void *old, size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000570
Denis Vlasenkoea620772006-10-14 02:23:43 +0000571extern ssize_t safe_read(int fd, void *buf, size_t count);
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000572extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000573// NB: will return short read on error, not -1,
574// if some data was read before error occurred
Denis Vlasenkoea620772006-10-14 02:23:43 +0000575extern ssize_t full_read(int fd, void *buf, size_t count);
576extern void xread(int fd, void *buf, size_t count);
577extern unsigned char xread_char(int fd);
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000578// Reads one line a-la fgets (but doesn't save terminating '\n').
579// Uses single full_read() call, works only on seekable streams.
Denis Vlasenkoea620772006-10-14 02:23:43 +0000580extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000581// Reads one line a-la fgets (but doesn't save terminating '\n').
582// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000583// Bytes are appended to pfx (which must be malloced, or NULL).
Denis Vlasenko0b6c6a92008-03-24 00:04:42 +0000584extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p);
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000585extern ssize_t read_close(int fd, void *buf, size_t maxsz);
586extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000587/* Returns NULL if file can't be opened */
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000588extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000589/* Never returns NULL */
590extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000591
592extern ssize_t safe_write(int fd, const void *buf, size_t count);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000593// NB: will return short write on error, not -1,
594// if some data was written before error occurred
Denis Vlasenkoea620772006-10-14 02:23:43 +0000595extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000596extern void xwrite(int fd, const void *buf, size_t count);
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000597extern void xopen_xwrite_close(const char* file, const char *str);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000598
Denis Vlasenko1de08302006-10-26 23:32:43 +0000599/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000600extern void xprint_and_close_file(FILE *file);
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000601/* Reads up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000602extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000603/* Chops off TERMINATING_STRING from the end: */
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000604extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string);
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000605/* Reads up to (and including) "\n" or NUL byte: */
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000606extern char *xmalloc_fgets(FILE *file);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000607/* Chops off '\n' from the end, unlike fgets: */
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000608extern char *xmalloc_fgetline(FILE *file);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000609extern char *bb_get_chunk_from_file(FILE *file, int *end);
610extern void die_if_ferror(FILE *file, const char *msg);
611extern void die_if_ferror_stdout(void);
612extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000613extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000614extern int fclose_if_not_stdin(FILE *file);
615extern FILE *xfopen(const char *filename, const char *mode);
616/* Prints warning to stderr and returns NULL on failure: */
617extern FILE *fopen_or_warn(const char *filename, const char *mode);
618/* "Opens" stdin if filename is special, else just opens file: */
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000619extern FILE *xfopen_stdin(const char *filename);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000620extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000621
Denis Vlasenkofb290382008-03-02 12:51:26 +0000622int bb_pstrcmp(const void *a, const void *b);
623void qsort_string_vector(char **sv, unsigned count);
624
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000625/* Wrapper which restarts poll on EINTR or ENOMEM.
626 * On other errors complains [perror("poll")] and returns.
627 * Warning! May take (much) longer than timeout_ms to return!
628 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
629int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms);
630
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000631char *safe_gethostname(void);
632
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000633/* Convert each alpha char in str to lower-case */
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000634char* str_tolower(char *str);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000635
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000636char *utoa(unsigned n);
637char *itoa(int n);
Denis Vlasenko10457b92007-03-27 22:01:31 +0000638/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000639char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
640char *itoa_to_buf(int n, char *buf, unsigned buflen);
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000641/* Intelligent formatters of bignums */
642void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale);
643void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale);
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000644//TODO: provide pointer to buf (avoid statics)?
645const char *make_human_readable_str(unsigned long long size,
646 unsigned long block_size, unsigned long display_unit);
647/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
648char *bin2hex(char *buf, const char *cp, int count);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000649
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000650/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000651struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000652 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000653 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000654};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000655#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000656/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000657/* Using xatoi() instead of naive atoi() is not always convenient -
658 * in many places people want *non-negative* values, but store them
659 * in signed int. Therefore we need this one:
660 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
661int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000662/* Useful for reading port numbers */
663uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000664
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000665
Eric Andersenaad1a882001-03-16 22:47:14 +0000666/* These parse entries in /etc/passwd and /etc/group. This is desirable
667 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000668 * increases target size and is often not needed on embedded systems. */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000669long xuname2uid(const char *name);
670long xgroup2gid(const char *name);
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000671/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000672unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000673/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000674struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000675 uid_t uid;
676 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000677};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000678/* always sets uid and gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000679int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
Denis Vlasenkocce38582007-02-26 22:47:42 +0000680/* chown-like handling of "user[:[group]" */
681void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
Denis Vlasenko3734b942007-07-27 11:20:10 +0000682/* bb_getpwuid, bb_getgrgid:
Denis Vlasenko1d10aaf2007-07-27 11:22:34 +0000683 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
684 * as a string to buf, return user/group name or NULL
685 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
686 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
Denis Vlasenko3734b942007-07-27 11:20:10 +0000687*/
688char *bb_getpwuid(char *name, int bufsize, long uid);
689char *bb_getgrgid(char *group, int bufsize, long gid);
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000690/* versions which cache results (useful for ps, ls etc) */
691const char* get_cached_username(uid_t uid);
692const char* get_cached_groupname(gid_t gid);
693void clear_username_cache(void);
694/* internally usernames are saved in fixed-sized char[] buffers */
695enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000696#if ENABLE_FEATURE_CHECK_NAMES
697void die_if_bad_username(const char* name);
698#else
699#define die_if_bad_username(name) ((void)(name))
700#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000701
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000702int execable_file(const char *name);
703char *find_execable(const char *filename);
704int exists_execable(const char *filename);
705
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000706/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
707 * but it may exec busybox and call applet instead of searching PATH.
708 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000709#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000710int bb_execvp(const char *file, char *const argv[]);
711#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
712#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000713 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000714 cmd, __VA_ARGS__)
715#else
716#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
717#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
718#endif
719
720/* NOMMU friendy fork+exec */
721pid_t spawn(char **argv);
722pid_t xspawn(char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000723
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000724int safe_waitpid(int pid, int *wstat, int options);
725/* Unlike waitpid, waits ONLY for one process.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000726 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000727 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000728 * IOW: rc = wait4pid(spawn(argv));
729 * if (rc < 0) bb_perror_msg("%s", argv[0]);
730 * if (rc > 0) bb_error_msg("exit code: %d", rc);
731 */
Denis Vlasenko473dae02007-04-11 07:04:23 +0000732int wait4pid(int pid);
Denis Vlasenkofb0eba72008-01-02 19:55:04 +0000733int wait_any_nohang(int *wstat);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000734#define wait_crashed(w) ((w) & 127)
735#define wait_exitcode(w) ((w) >> 8)
736#define wait_stopsig(w) ((w) >> 8)
737#define wait_stopped(w) (((w) & 127) == 127)
738/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
739int spawn_and_wait(char **argv);
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000740struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000741 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000742 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000743 int xfunc_error_retval;
744 uint32_t option_mask32;
745 int die_sleep;
746 smallint saved;
747};
748void save_nofork_data(struct nofork_save_area *save);
749void restore_nofork_data(struct nofork_save_area *save);
750/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000751int run_nofork_applet(int applet_no, char **argv);
752int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000753
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000754/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000755 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000756 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000757 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000758 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
759 * rexec's itself on NOMMU with argv passed as command line.
760 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
761 * from the start. (It will detect it and not reexec again second time).
762 * You have to audit carefully that you don't do something twice as a result
763 * (opening files/sockets, parsing config files etc...)!
764 *
765 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
766 * (will do setsid()).
767 *
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000768 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
769 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenkob44c7902008-03-17 09:29:43 +0000770 * Currently used for openvt and setsid. On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000771 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000772 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000773 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000774 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
775 * to /dev/null if they are not.
776 */
777enum {
778 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000779 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000780 DAEMON_CLOSE_EXTRA_FDS = 4,
781 DAEMON_ONLY_SANITIZE = 8, /* internal use */
782};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000783#if BB_MMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000784 void forkexit_or_rexec(void);
Denis Vlasenko367960b2007-08-18 14:20:21 +0000785 enum { re_execed = 0 };
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000786# define forkexit_or_rexec(argv) forkexit_or_rexec()
787# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
788# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000789#else
Denis Vlasenko367960b2007-08-18 14:20:21 +0000790 void re_exec(char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkoc52248e2008-03-20 14:04:30 +0000791 void forkexit_or_rexec(char **argv);
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000792 extern bool re_execed;
Denis Vlasenko05743d72008-02-10 12:10:08 +0000793 int BUG_fork_is_unavailable_on_nommu(void);
794 int BUG_daemon_is_unavailable_on_nommu(void);
795 void BUG_bb_daemonize_is_unavailable_on_nommu(void);
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000796# define fork() BUG_fork_is_unavailable_on_nommu()
797# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
798# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000799#endif
800void bb_daemonize_or_rexec(int flags, char **argv);
801void bb_sanitize_stdio(void);
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000802/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
803int sanitize_env_if_suid(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000804
805
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000806extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000807extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000808#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000809#define No_argument "\0"
810#define Required_argument "\001"
811#define Optional_argument "\002"
812extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000813#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000814extern uint32_t option_mask32;
Denis Vlasenkod37f2222007-08-19 13:42:08 +0000815extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000816
817
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000818typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000819 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000820 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000821} llist_t;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000822void llist_add_to(llist_t **old_head, void *data);
823void llist_add_to_end(llist_t **list_head, void *data);
824void *llist_pop(llist_t **elm);
825void llist_unlink(llist_t **head, llist_t *elm);
826void llist_free(llist_t *elm, void (*freeit)(void *data));
827llist_t *llist_rev(llist_t *list);
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000828/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000829 * llist_t *llist_add_to(llist_t *old_head, void *data)
830 * etc does not result in smaller code... */
831
Denis Vlasenko80edead2007-08-02 22:31:05 +0000832/* start_stop_daemon and udhcpc are special - they want
833 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000834#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000835/* True only if we created pidfile which is *file*, not /dev/null etc */
836extern smallint wrote_pidfile;
837void write_pidfile(const char *path);
838#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000839#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000840enum { wrote_pidfile = 0 };
841#define write_pidfile(path) ((void)0)
842#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000843#endif
844
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000845enum {
846 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000847 LOGMODE_STDIO = (1 << 0),
848 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000849 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
850};
851extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000852extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000853extern int die_sleep;
854extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000855extern jmp_buf die_jmp;
Denis Vlasenko335b63d2007-04-10 21:38:30 +0000856extern void xfunc_die(void) ATTRIBUTE_NORETURN;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000857extern void bb_show_usage(void) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000858extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
859extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
860extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000861extern void bb_simple_perror_msg(const char *s);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000862extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000863extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000864extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
865extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
866extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
867extern void bb_perror_nomsg(void);
868extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000869extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000870
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000871/* We need to export XXX_main from libbusybox
872 * only if we build "individual" binaries
873 */
874#if ENABLE_FEATURE_INDIVIDUAL
875#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
876#else
877#define MAIN_EXTERNALLY_VISIBLE
878#endif
879
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000880
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000881/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000882int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000883/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko468aea22008-04-01 14:47:57 +0000884int echo_main(int argc, char** argv) USE_ECHO(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000885int printf_main(int argc, char **argv) USE_PRINTF(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000886int test_main(int argc, char **argv) USE_TEST(MAIN_EXTERNALLY_VISIBLE);
887int kill_main(int argc, char **argv) USE_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000888/* Similar, but used by chgrp, not shell */
889int chown_main(int argc, char **argv) USE_CHOWN(MAIN_EXTERNALLY_VISIBLE);
890/* Don't need USE_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000891int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000892int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000893int bbunpack(char **argv,
Denis Vlasenkoc86e0522007-03-20 11:30:28 +0000894 char* (*make_new_name)(char *filename),
895 USE_DESKTOP(long long) int (*unpacker)(void)
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000896);
Denis Vlasenko468aea22008-04-01 14:47:57 +0000897#if ENABLE_ROUTE
898void bb_displayroutes(int noresolve, int netstatfmt);
899#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000900
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000901
902/* Networking */
903int create_icmp_socket(void);
904int create_icmp6_socket(void);
905/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000906/* This structure defines protocol families and their handlers. */
907struct aftype {
908 const char *name;
909 const char *title;
910 int af;
911 int alen;
912 char *(*print) (unsigned char *);
913 const char *(*sprint) (struct sockaddr *, int numeric);
914 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
915 void (*herror) (char *text);
916 int (*rprint) (int options);
917 int (*rinput) (int typ, int ext, char **argv);
918
919 /* may modify src */
920 int (*getmask) (char *src, struct sockaddr * mask, char *name);
921};
922/* This structure defines hardware protocols and their handlers. */
923struct hwtype {
924 const char *name;
925 const char *title;
926 int type;
927 int alen;
928 char *(*print) (unsigned char *);
929 int (*input) (const char *, struct sockaddr *);
930 int (*activate) (int fd);
931 int suppress_null_addr;
932};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000933extern smallint interface_opt_a;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000934int display_interfaces(char *ifname);
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000935#if ENABLE_FEATURE_HWIB
936int in_ib(const char *bufp, struct sockaddr *sap);
Denis Vlasenko3b162ec2008-06-04 07:59:51 +0000937#else
938#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +0000939#endif
Denis Vlasenko1cc70222007-03-15 19:46:43 +0000940const struct aftype *get_aftype(const char *name);
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000941const struct hwtype *get_hwtype(const char *name);
942const struct hwtype *get_hwntype(int type);
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000943
944
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000945#ifndef BUILD_INDIVIDUAL
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000946extern int find_applet_by_name(const char *name);
Denis Vlasenko32b633a2007-04-09 03:05:48 +0000947/* Returns only if applet is not found. */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000948extern void run_applet_and_exit(const char *name, char **argv);
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000949extern void run_applet_no_and_exit(int a, char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000950#endif
951
Mike Frysinger9412ec72008-02-07 22:41:33 +0000952#ifdef HAVE_MNTENT_H
Denis Vlasenkobf295dd2007-04-05 21:57:47 +0000953extern int match_fstype(const struct mntent *mt, const char *fstypes);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000954extern struct mntent *find_mount_point(const char *name, const char *table);
Mike Frysinger9412ec72008-02-07 22:41:33 +0000955#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000956extern void erase_mtab(const char * name);
957extern unsigned int tty_baud_to_value(speed_t speed);
958extern speed_t tty_value_to_baud(unsigned int value);
959extern void bb_warn_ignoring_args(int n);
960
961extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000962
Rob Landley1d589b22005-11-29 23:47:10 +0000963extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000964extern int del_loop(const char *device);
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +0000965/* If *devname is not NULL, use that name, otherwise try to find free one,
966 * malloc and return it in *devname.
967 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
968extern int set_loop(char **devname, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000969
Eric Andersenaad1a882001-03-16 22:47:14 +0000970
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000971//TODO: pass buf pointer or return allocated buf (avoid statics)?
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000972char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000973int bb_ask_confirmation(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000974
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000975extern int bb_parse_mode(const char* s, mode_t* theMode);
976
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +0000977/* Concatenate path and filename to new allocated buffer.
978 * Add "/" only as needed (no duplicate "//" are produced).
979 * If path is NULL, it is assumed to be "/".
980 * filename should not be NULL. */
Eric Andersene5dfced2001-04-09 22:48:12 +0000981char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000982char *concat_subpath_file(const char *path, const char *filename);
Denis Vlasenkodc757aa2007-06-30 08:04:05 +0000983const char *bb_basename(const char *name);
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000984/* NB: can violate const-ness (similarly to strchr) */
Eric Andersenc911a432001-05-15 17:42:16 +0000985char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000986
Denis Vlasenko4921b542007-02-03 02:17:41 +0000987
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000988USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
989int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000990
Denis Vlasenko14579152006-10-26 01:09:46 +0000991
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000992int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000993
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000994int get_signum(const char *name);
995const char *get_signame(int number);
Denis Vlasenkoa4f4de92007-09-30 16:32:01 +0000996void print_signames(void);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000997
Manuel Novoa III cad53642003-03-19 09:13:01 +0000998char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000999
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001000#define FAIL_DELAY 3
1001extern void bb_do_delay(int seconds);
1002extern void change_identity(const struct passwd *pw);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001003extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001004extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001005#if ENABLE_SELINUX
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001006extern void renew_current_security_context(void);
1007extern void set_current_security_context(security_context_t sid);
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001008extern context_t set_security_context_component(security_context_t cur_context,
1009 char *user, char *role, char *type, char *range);
Denis Vlasenko39c651e2007-03-12 18:22:55 +00001010extern void setfscreatecon_or_die(security_context_t scontext);
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001011extern void selinux_preserve_fcontext(int fdesc);
1012#else
1013#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001014#endif
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001015extern void selinux_or_die(void);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001016extern int restricted_shell(const char *shell);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001017
1018/* setup_environment:
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001019 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001020 * TERM=(old value)
1021 * USER=pw->pw_name, LOGNAME=pw->pw_name
1022 * PATH=bb_default_[root_]path
1023 * HOME=pw->pw_dir
1024 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001025 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001026 * if not root (if pw->pw_uid != 0):
1027 * USER=pw->pw_name, LOGNAME=pw->pw_name
1028 * HOME=pw->pw_dir
1029 * SHELL=shell
1030 * else does nothing
1031 */
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001032extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001033extern int correct_password(const struct passwd *pw);
Denis Vlasenko21d10142007-07-20 21:28:41 +00001034/* Returns a ptr to static storage */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001035extern char *pw_encrypt(const char *clear, const char *salt);
1036extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001037
1038int index_in_str_array(const char *const string_array[], const char *key);
1039int index_in_strings(const char *strings, const char *key);
1040int index_in_substr_array(const char *const string_array[], const char *key);
1041int index_in_substrings(const char *strings, const char *key);
1042const char *nth_string(const char *strings, int n);
1043
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001044extern void print_login_issue(const char *issue_file, const char *tty);
1045extern void print_login_prompt(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001046
Denis Vlasenko21d10142007-07-20 21:28:41 +00001047/* rnd is additional random input. New one is returned.
1048 * Useful if you call crypt_make_salt many times in a row:
1049 * rnd = crypt_make_salt(buf1, 4, 0);
1050 * rnd = crypt_make_salt(buf2, 4, rnd);
1051 * rnd = crypt_make_salt(buf3, 4, rnd);
1052 * (otherwise we risk having same salt generated)
1053 */
1054extern int crypt_make_salt(char *p, int cnt, int rnd);
1055
1056/* Returns number of lines changed, or -1 on error */
1057extern int update_passwd(const char *filename, const char *username,
1058 const char *new_pw);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001059
Denis Vlasenkof893da82007-08-09 08:27:24 +00001060/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenko55995022008-05-18 22:28:26 +00001061int get_terminal_width_height(int fd, unsigned *width, unsigned *height);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001062
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001063/* NB: "unsigned request" is crucial! "int request" will break some arches! */
1064int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
1065int 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 +00001066#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001067int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name);
1068int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name);
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001069#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1070#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1071#else
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001072int bb_ioctl_or_warn(int fd, unsigned request, void *argp);
1073int bb_xioctl(int fd, unsigned request, void *argp);
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001074#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1075#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1076#endif
1077
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001078char *is_in_ino_dev_hashtable(const struct stat *statbuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001079void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
1080void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +00001081#ifdef __GLIBC__
1082/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001083unsigned long long bb_makedev(unsigned int major, unsigned int minor);
Denis Vlasenko0b354702006-11-24 14:54:27 +00001084#undef makedev
1085#define makedev(a,b) bb_makedev(a,b)
1086#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001087
1088
Denis Vlasenko38f63192007-01-22 09:03:07 +00001089#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001090/* It's NOT just ENABLEd or disabled. It's a number: */
Denis Vlasenko38f63192007-01-22 09:03:07 +00001091#ifdef CONFIG_FEATURE_EDITING_HISTORY
1092#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001093#else
1094#define MAX_HISTORY 0
1095#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001096typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001097 int flags;
1098 const char *path_lookup;
1099#if MAX_HISTORY
1100 int cnt_history;
1101 int cur_history;
Denis Vlasenko38f63192007-01-22 09:03:07 +00001102 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001103 char *history[MAX_HISTORY + 1];
1104#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001105} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001106enum {
1107 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001108 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1109 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1110 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1111 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001112 WITH_PATH_LOOKUP = 0x20,
1113 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1114};
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001115line_input_t *new_line_input_t(int flags);
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001116/* Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001117 * -1 on read errors or EOF, or on bare Ctrl-D,
1118 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001119 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001120 */
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001121int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
1122#else
1123int read_line_input(const char* prompt, char* command, int maxsize);
1124#define read_line_input(prompt, command, maxsize, state) \
1125 read_line_input(prompt, command, maxsize)
1126#endif
1127
1128
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001129#ifndef COMM_LEN
1130#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001131enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001132#else
1133/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001134enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001135#endif
1136#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001137typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001138 DIR *dir;
Denis Vlasenko512499c2007-08-26 18:23:13 +00001139 uint8_t shift_pages_to_bytes;
1140 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001141/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001142 char *argv0;
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001143 USE_SELINUX(char *context;)
1144 /* Everything below must contain no ptrs to malloc'ed data:
1145 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001146 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001147 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001148 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001149 unsigned pid;
1150 unsigned ppid;
1151 unsigned pgid;
1152 unsigned sid;
1153 unsigned uid;
1154 unsigned gid;
Denis Vlasenko31789a82007-06-19 14:43:17 +00001155 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001156#if ENABLE_FEATURE_TOPMEM
1157 unsigned long mapped_rw;
1158 unsigned long mapped_ro;
1159 unsigned long shared_clean;
1160 unsigned long shared_dirty;
1161 unsigned long private_clean;
1162 unsigned long private_dirty;
1163 unsigned long stack;
1164#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001165 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001166 /* basename of executable in exec(2), read from /proc/N/stat
1167 * (if executable is symlink or script, it is NOT replaced
1168 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001169 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001170 /* user/group? - use passwd/group parsing functions */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001171} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001172enum {
1173 PSSCAN_PID = 1 << 0,
1174 PSSCAN_PPID = 1 << 1,
1175 PSSCAN_PGID = 1 << 2,
1176 PSSCAN_SID = 1 << 3,
1177 PSSCAN_UIDGID = 1 << 4,
1178 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001179 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001180 PSSCAN_ARGV0 = 1 << 7,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001181 /* PSSCAN_EXE = 1 << 8, - not implemented */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001182 PSSCAN_STATE = 1 << 9,
1183 PSSCAN_VSZ = 1 << 10,
1184 PSSCAN_RSS = 1 << 11,
1185 PSSCAN_STIME = 1 << 12,
1186 PSSCAN_UTIME = 1 << 13,
1187 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001188 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko72e1c892007-09-29 22:26:01 +00001189 PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1190 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001191 PSSCAN_START_TIME = 1 << 18,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001192 /* These are all retrieved from proc/NN/stat in one go: */
1193 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1194 | PSSCAN_COMM | PSSCAN_STATE
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001195 | PSSCAN_VSZ | PSSCAN_RSS
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001196 | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001197 | PSSCAN_TTY,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001198};
Denis Vlasenko68404f12008-03-17 09:00:54 +00001199//procps_status_t* alloc_procps_scan(void);
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001200void free_procps_scan(procps_status_t* sp);
1201procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001202/* Format cmdline (up to col chars) into char buf[col+1] */
1203/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1204void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
Denis Vlasenko35fb5122006-11-01 09:16:49 +00001205pid_t *find_pid_by_name(const char* procName);
1206pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001207
1208
1209extern const char bb_uuenc_tbl_base64[];
1210extern const char bb_uuenc_tbl_std[];
Denis Vlasenkoe8240f12007-06-26 15:59:37 +00001211void bb_uuencode(char *store, const void *s, int length, const char *tbl);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001212
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001213typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001214 uint32_t count[2];
1215 uint32_t hash[5];
1216 uint32_t wbuf[16];
1217} sha1_ctx_t;
1218void sha1_begin(sha1_ctx_t *ctx);
1219void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
1220void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
1221
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001222typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001223 uint32_t A;
1224 uint32_t B;
1225 uint32_t C;
1226 uint32_t D;
1227 uint64_t total;
1228 uint32_t buflen;
1229 char buffer[128];
1230} md5_ctx_t;
1231void md5_begin(md5_ctx_t *ctx);
1232void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
1233void *md5_end(void *resbuf, md5_ctx_t *ctx);
1234
Denis Vlasenkoc6758a02007-04-10 21:40:19 +00001235uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001236
1237
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001238extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001239/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001240extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001241extern const char bb_msg_memory_exhausted[];
1242extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001243extern const char bb_msg_read_error[];
1244extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001245extern const char bb_msg_unknown[];
1246extern const char bb_msg_can_not_create_raw_socket[];
1247extern const char bb_msg_perm_denied_are_you_root[];
1248extern const char bb_msg_requires_arg[];
1249extern const char bb_msg_invalid_arg[];
1250extern const char bb_msg_standard_input[];
1251extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001252
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001253extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001254/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001255extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001256
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001257extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001258extern const char bb_path_passwd_file[];
1259extern const char bb_path_shadow_file[];
1260extern const char bb_path_gshadow_file[];
1261extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001262extern const char bb_path_motd_file[];
1263extern const char bb_path_wtmp_file[];
1264extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001265extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001266/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1267 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001268extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1269#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1270#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001271
Denis Vlasenko703e2022007-01-22 14:12:08 +00001272extern const int const_int_0;
1273extern const int const_int_1;
1274
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001275
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001276#ifndef BUFSIZ
1277#define BUFSIZ 4096
1278#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001279/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001280enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1281extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001282/* This struct is deliberately not defined. */
1283/* See docs/keep_data_small.txt */
1284struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001285/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001286 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001287 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001288extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001289/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1290#define barrier() asm volatile("":::"memory")
1291#define SET_PTR_TO_GLOBALS(x) do { \
1292 (*(struct globals**)&ptr_to_globals) = (x); \
1293 barrier(); \
1294} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001295
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001296/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1297 * use bb_default_login_shell and following defines.
1298 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1299 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001300#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001301extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001302/* "/bin/sh" */
1303#define DEFAULT_SHELL (bb_default_login_shell+1)
1304/* "sh" */
1305#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1306
1307
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001308#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001309# define CURRENT_VC "/dev/vc/0"
1310# define VC_1 "/dev/vc/1"
1311# define VC_2 "/dev/vc/2"
1312# define VC_3 "/dev/vc/3"
1313# define VC_4 "/dev/vc/4"
1314# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001315#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1316/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1317 respective serial ports .. as such, we can't use the common device paths for
1318 these. -- PFM */
1319# define SC_0 "/dev/ttsc/0"
1320# define SC_1 "/dev/ttsc/1"
1321# define SC_FORMAT "/dev/ttsc/%d"
1322#else
1323# define SC_0 "/dev/tts/0"
1324# define SC_1 "/dev/tts/1"
1325# define SC_FORMAT "/dev/tts/%d"
1326#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001327# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001328# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001329# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001330# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001331# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001332#else
1333# define CURRENT_VC "/dev/tty0"
1334# define VC_1 "/dev/tty1"
1335# define VC_2 "/dev/tty2"
1336# define VC_3 "/dev/tty3"
1337# define VC_4 "/dev/tty4"
1338# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001339#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1340# define SC_0 "/dev/ttySC0"
1341# define SC_1 "/dev/ttySC1"
1342# define SC_FORMAT "/dev/ttySC%d"
1343#else
1344# define SC_0 "/dev/ttyS0"
1345# define SC_1 "/dev/ttyS1"
1346# define SC_FORMAT "/dev/ttyS%d"
1347#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001348# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001349# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001350# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001351# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001352# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001353#endif
1354
1355/* The following devices are the same on devfs and non-devfs systems. */
1356#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001357#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001358
Rob Landleyc57ec372006-04-10 17:07:15 +00001359
Rob Landleyb623a542006-05-31 22:09:03 +00001360#ifndef RB_POWER_OFF
1361/* Stop system and switch power off if possible. */
1362#define RB_POWER_OFF 0x4321fedc
1363#endif
1364
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001365/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001366#undef isalnum
1367#undef isalpha
1368#undef isascii
1369#undef isblank
1370#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001371#undef isgraph
1372#undef islower
1373#undef isprint
1374#undef ispunct
1375#undef isspace
1376#undef isupper
1377#undef isxdigit
1378
Denis Vlasenko459903b2006-11-27 14:44:18 +00001379/* This one is more efficient - we save ~400 bytes */
1380#undef isdigit
1381#define isdigit(a) ((unsigned)((a) - '0') <= 9)
1382
Denis Vlasenko6b06cb82008-05-15 21:30:45 +00001383#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denis Vlasenko459903b2006-11-27 14:44:18 +00001384
Denis Vlasenko98636eb2008-05-09 17:59:34 +00001385
1386#if __GNUC_PREREQ(4,1)
1387# pragma GCC visibility pop
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001388#endif
1389
Denis Vlasenko80b8b392007-06-25 10:55:35 +00001390
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +00001391#endif /* __LIBBUSYBOX_H__ */