blob: 182b479884138b0b22c79ef360af97b8cf0bb5b4 [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
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02006 * Permission has been granted to redistribute this code under GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02008 * Licensed under GPLv2, see file LICENSE in this source tree.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000010#ifndef LIBBB_H
11#define LIBBB_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>
Denys Vlasenko5b9b1362010-02-02 03:08:57 +010023#include <stdint.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000024#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000025#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000026#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000027#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000028#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000029#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000030#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000031#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000032#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000033#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000034#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000035#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000036#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000037#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000038#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000039#include <unistd.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000040#include <sys/param.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000041#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020042# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000043#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000044#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020045# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000046#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000047#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020048# include <selinux/selinux.h>
49# include <selinux/context.h>
50# include <selinux/flask.h>
51# include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000052#endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +010053#if ENABLE_FEATURE_UTMP
54# include <utmp.h>
55#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000056#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +020057# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000058#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +020059# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000060#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000061#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +020062# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000063#endif
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000064#include <pwd.h>
65#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000066#if ENABLE_FEATURE_SHADOWPASSWDS
Mike Frysinger52a42672009-07-09 01:33:20 -040067# if !ENABLE_USE_BB_SHADOW
68/* If using busybox's shadow implementation, do not include the shadow.h
69 * header as the toolchain may not provide it at all.
70 */
71# include <shadow.h>
72# endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000073#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +010074/* Just in case libc doesn't define some of these... */
75#ifndef _PATH_PASSWD
76#define _PATH_PASSWD "/etc/passwd"
77#endif
78#ifndef _PATH_GROUP
79#define _PATH_GROUP "/etc/group"
80#endif
81#ifndef _PATH_SHADOW
82#define _PATH_SHADOW "/etc/shadow"
83#endif
84#ifndef _PATH_GSHADOW
85#define _PATH_GSHADOW "/etc/gshadow"
86#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020087#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +010088# include <netinet/in.h>
89# include <arpa/inet.h>
90#elif defined __APPLE__
91# include <netinet/in.h>
92#else
93# include <arpa/inet.h>
94# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
95/* We #define socklen_t *after* includes, otherwise we get
96 * typedef redefinition errors from system headers
97 * (in case "is it defined already" detection above failed)
98 */
99# define socklen_t bb_socklen_t
100 typedef unsigned socklen_t;
101# endif
102#endif
Chris Rees330718e2011-01-24 17:07:06 +0100103#ifndef HAVE_CLEARENV
104# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
105#endif
106#ifndef HAVE_FDATASYNC
107# define fdatasync fsync
108#endif
109#ifndef HAVE_XTABS
110# define XTABS TAB3
111#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100112
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000113
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000114/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000115
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000116extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000117#if defined(__GLIBC__) && __GLIBC__ < 2
118int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +0000119#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000120/* klogctl is in libc's klog.h, but we cheat and not #include that */
121int klogctl(int type, char *b, int len);
122/* This is declared here rather than #including <libgen.h> in order to avoid
123 * confusing the two versions of basename. See the dirname/basename man page
124 * for details. */
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200125#if !defined __FreeBSD__
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000126char *dirname(char *path);
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200127#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000128/* Include our own copy of struct sysinfo to avoid binary compatibility
129 * problems with Linux 2.4, which changed things. Grumble, grumble. */
130struct sysinfo {
131 long uptime; /* Seconds since boot */
132 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
133 unsigned long totalram; /* Total usable main memory size */
134 unsigned long freeram; /* Available memory size */
135 unsigned long sharedram; /* Amount of shared memory */
136 unsigned long bufferram; /* Memory used by buffers */
137 unsigned long totalswap; /* Total swap space size */
138 unsigned long freeswap; /* swap space still available */
139 unsigned short procs; /* Number of current processes */
140 unsigned short pad; /* Padding needed for m68k */
141 unsigned long totalhigh; /* Total high memory size */
142 unsigned long freehigh; /* Available high memory size */
143 unsigned int mem_unit; /* Memory unit size in bytes */
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000144 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000145};
146int sysinfo(struct sysinfo* info);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100147#ifndef PATH_MAX
148# define PATH_MAX 256
149#endif
150#ifndef BUFSIZ
151# define BUFSIZ 4096
152#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000153
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000154
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000155/* Make all declarations hidden (-fvisibility flag only affects definitions) */
156/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000157PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000158
159
160#if ENABLE_USE_BB_PWD_GRP
161# include "pwd_.h"
162# include "grp_.h"
163#endif
164#if ENABLE_FEATURE_SHADOWPASSWDS
165# if ENABLE_USE_BB_SHADOW
166# include "shadow_.h"
167# endif
168#endif
169
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000170/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000171#define MAXINT(T) (T)( \
172 ((T)-1) > 0 \
173 ? (T)-1 \
174 : (T)~((T)1 << (sizeof(T)*8-1)) \
175 )
176
177#define MININT(T) (T)( \
178 ((T)-1) > 0 \
179 ? (T)0 \
180 : ((T)1 << (sizeof(T)*8-1)) \
181 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000182
Denis Vlasenko56254152006-10-07 16:24:46 +0000183/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000184/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000185 * (stat, lseek etc) mapped to "largefile" variants by libc.
186 * Practically it means that open() automatically has O_LARGEFILE added
187 * and all filesize/file_offset parameters and struct members are "large"
188 * (in today's world - signed 64bit). For full support of large files,
189 * we need a few helper #defines (below) and careful use of off_t
190 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000191#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000192/* CONFIG_LFS is on */
193# if ULONG_MAX > 0xffffffff
194/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000195typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000196# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000197/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
198# define BB_STRTOOFF bb_strtoul
199# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000200/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
201# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000202# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000203/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000204typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000205# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000206# define BB_STRTOOFF bb_strtoull
207# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000208# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000209# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000210#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000211/* CONFIG_LFS is off */
212# if UINT_MAX == 0xffffffff
213/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
214 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000215typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200216# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000217# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000218# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000219# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000220# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000221typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000222# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
223# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000224# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000225# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000226# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000227#endif
228/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000229#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000230
Eric Andersenaad1a882001-03-16 22:47:14 +0000231/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000232#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000233#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000234#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000235#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000236#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000237#define SKIP ((int) 2)
238
239/* for mtab.c */
240#define MTAB_GETMOUNTPT '1'
241#define MTAB_GETDEVICE '2'
242
243#define BUF_SIZE 8192
244#define EXPAND_ALLOC 1024
245
Eric Andersenaad1a882001-03-16 22:47:14 +0000246/* Macros for min/max. */
247#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200248#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000249#endif
250
251#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200252#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000253#endif
254
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000255/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000256#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000257#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000258#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
259#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
260#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000261#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000262#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
263#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
264#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
265#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000266#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
267#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
268#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000269#endif
270#endif
271
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000272#if defined(__GLIBC__)
273/* glibc uses __errno_location() to get a ptr to errno */
274/* We can just memorize it once - no multithreading in busybox :) */
275extern int *const bb_errno;
276#undef errno
277#define errno (*bb_errno)
278#endif
279
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200280#if !(ULONG_MAX > 0xffffffff)
281/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
282uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
283#endif
284
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000285unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000286unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100287unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000288unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000289
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000290extern void chomp(char *s) FAST_FUNC;
291extern void trim(char *s) FAST_FUNC;
292extern char *skip_whitespace(const char *) FAST_FUNC;
293extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200294extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
295
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000296extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000297
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000298//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000299extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
300extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000301enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100302 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
303 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
304 FILEUTILS_RECUR = 1 << 2, /* -R */
305 FILEUTILS_FORCE = 1 << 3, /* -f */
306 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
307 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
308 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
309 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
310 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000311#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100312 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
313 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000314#endif
315};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100316#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000317extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000318/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
319 * the source, not copy (unless "source" is a directory).
320 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
321 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000322extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000323
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000324enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000325 ACTION_RECURSE = (1 << 0),
326 ACTION_FOLLOWLINKS = (1 << 1),
327 ACTION_FOLLOWLINKS_L0 = (1 << 2),
328 ACTION_DEPTHFIRST = (1 << 3),
329 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000330 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200331 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000332};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200333typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000334extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000335 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
336 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
337 void* userData, unsigned depth) FAST_FUNC;
338extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000339enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000340extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000341extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000342extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
343extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000344/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000345extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
346extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
347extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000348/* "short" copy can be detected by return value < size */
349/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000350extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000351extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200352char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000353/* xxxx_strip version can modify its parameter:
354 * "/" -> "/"
355 * "abc" -> "abc"
356 * "abc/def" -> "def"
357 * "abc/def/" -> "def" !!
358 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000359extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000360/* "abc/def/" -> "" and it never modifies 'path' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000361extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000362
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100363void ndelay_on(int fd) FAST_FUNC;
364void ndelay_off(int fd) FAST_FUNC;
365void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000366void xdup2(int, int) FAST_FUNC;
367void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000368
369
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000370DIR *xopendir(const char *path) FAST_FUNC;
371DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000372
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100373char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100374char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
375char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100376/* !RETURNS_MALLOC: it's a realloc-like function */
377char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000378
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100379char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000380
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000381
Denis Vlasenko33196372008-02-23 01:25:38 +0000382enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000383 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000384 * otherwise would kill us, except for those resulting from bugs:
385 * SIGSEGV, SIGILL, SIGFPE.
386 * Other fatal signals not included (TODO?):
387 * SIGBUS Bus error (bad memory access)
388 * SIGPOLL Pollable event. Synonym of SIGIO
389 * SIGPROF Profiling timer expired
390 * SIGSYS Bad argument to routine
391 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000392 *
393 * The only known arch with some of these sigs not fitting
394 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
395 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000396 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000397 BB_FATAL_SIGS = (int)(0
398 + (1LL << SIGHUP)
399 + (1LL << SIGINT)
400 + (1LL << SIGTERM)
401 + (1LL << SIGPIPE) // Write to pipe with no readers
402 + (1LL << SIGQUIT) // Quit from keyboard
403 + (1LL << SIGABRT) // Abort signal from abort(3)
404 + (1LL << SIGALRM) // Timer signal from alarm(2)
405 + (1LL << SIGVTALRM) // Virtual alarm clock
406 + (1LL << SIGXCPU) // CPU time limit exceeded
407 + (1LL << SIGXFSZ) // File size limit exceeded
408 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
409 + (1LL << SIGUSR2)
410 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000411};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000412void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000413/* Unlike signal() and bb_signals, sets handler with sigaction()
414 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000415 * will be blocked; syscalls will not be restarted: */
416void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000417/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000418void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000419/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000420void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
421void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000422void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000423void sig_block(int sig) FAST_FUNC;
424void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000425/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000426int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000427/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000428int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000429/* Standard handler which just records signo */
430extern smallint bb_got_signal;
431void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000432
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000433
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000434void xsetgid(gid_t gid) FAST_FUNC;
435void xsetuid(uid_t uid) FAST_FUNC;
436void xchdir(const char *path) FAST_FUNC;
437void xchroot(const char *path) FAST_FUNC;
438void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000439void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200440void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000441void xunlink(const char *pathname) FAST_FUNC;
442void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200443void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200444int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100445int xopen_nonblocking(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000446int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
447int open_or_warn(const char *pathname, int flags) FAST_FUNC;
448int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
449int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200450int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000451void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
452int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
453off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200454int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000455off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000456
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100457uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
458 const char *override,
459 unsigned override_units,
460 int extend);
461
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000462void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000463/* In this form code with pipes is much more readable */
464struct fd_pair { int rd; int wr; };
465#define piped_pair(pair) pipe(&((pair).rd))
466#define xpiped_pair(pair) xpipe(&((pair).rd))
467
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000468/* Useful for having small structure members/global variables */
469typedef int8_t socktype_t;
470typedef int8_t family_t;
471struct BUG_too_small {
472 char BUG_socktype_t_too_small[(0
473 | SOCK_STREAM
474 | SOCK_DGRAM
475 | SOCK_RDM
476 | SOCK_SEQPACKET
477 | SOCK_RAW
478 ) <= 127 ? 1 : -1];
479 char BUG_family_t_too_small[(0
480 | AF_UNSPEC
481 | AF_INET
482 | AF_INET6
483 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000484#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000485 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000486#endif
487#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000488 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000489#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000490 /* | AF_DECnet */
491 /* | AF_IPX */
492 ) <= 127 ? 1 : -1];
493};
494
495
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100496void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
497time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200498
499
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000500int xsocket(int domain, int type, int protocol) FAST_FUNC;
501void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
502void xlisten(int s, int backlog) FAST_FUNC;
503void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000504ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000505 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000506/* SO_REUSEADDR allows a server to rebind to an address that is already
507 * "in use" by old connections to e.g. previous server instance which is
508 * killed or crashed. Without it bind will fail until all such connections
509 * time out. Linux does not allow multiple live binds on same ip:port
510 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
511 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000512void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
513int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000514int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000515/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000516unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000517typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000518 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000519 union {
520 struct sockaddr sa;
521 struct sockaddr_in sin;
522#if ENABLE_FEATURE_IPV6
523 struct sockaddr_in6 sin6;
524#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000525 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000526} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000527enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000528 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000529 LSA_SIZEOF_SA = sizeof(
530 union {
531 struct sockaddr sa;
532 struct sockaddr_in sin;
533#if ENABLE_FEATURE_IPV6
534 struct sockaddr_in6 sin6;
535#endif
536 }
537 )
538};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000539/* Create stream socket, and allocate suitable lsa.
540 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000541 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100542 * and if kernel doesn't support it, fall back to IPv4.
543 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000544 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000545#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000546int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000547#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000548int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000549#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
550#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000551int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000552/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000553 * numeric IP ("N.N.N.N") or numeric IPv6 address,
554 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000555 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000556/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000557int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
558int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000559/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
560 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
561 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
562 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000563int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000564/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000565int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000566/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100567len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200568/* Get remote address of connected or accepted socket */
569len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000570/* Return malloc'ed len_and_sockaddr with socket address of host:port
571 * Currently will return IPv4 or IPv6 sockaddrs only
572 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000573 * UNIX socket address being returned, IPX sockaddr etc...
574 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100575len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000576/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100577len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
578len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000579/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000580#if !ENABLE_FEATURE_IPV6
581#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
582#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
583#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100584len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
585len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000586#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000587/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000588 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000589 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000590void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000591/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000592int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000593/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100594char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000595/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100596char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000597/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100598char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000599/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100600char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
601char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000602// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000603// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000604struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000605// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000606// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000607
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000608
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000609void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000610ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000611 const struct sockaddr *to,
612 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000613 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000614ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000615 struct sockaddr *from,
616 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000617 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000618
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100619
620char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
621char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000622void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000623char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000624char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000625/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000626 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000627int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200628/* Note: does not use stdio, writes to fd 2 directly */
629int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100630char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000631// gcc-4.1.1 still isn't good enough at optimizing it
632// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000633//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000634//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000635//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000636//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000637#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000638#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000639#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000640#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000641#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000642
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100643typedef struct uni_stat_t {
644 unsigned byte_count;
645 unsigned unicode_count;
646 unsigned unicode_width;
647} uni_stat_t;
648/* Returns a string with unprintable chars replaced by '?' or
649 * SUBST_WCHAR. This function is unicode-aware. */
650const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
651/* Prints unprintable char ch as ^C or M-c to file
652 * (M-c is used only if ch is ORed with PRINTABLE_META),
653 * else it is printed as-is (except for ch = 0x9b) */
654enum { PRINTABLE_META = 0x100 };
655void fputc_printable(int ch, FILE *file) FAST_FUNC;
656
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000657/* dmalloc will redefine these to it's own implementation. It is safe
658 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100659void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
660void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
661void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000662void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000663/* After xrealloc_vector(v, 4, idx) it's ok to use
664 * at least v[idx] and v[idx+1], for all idx values.
665 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
666 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000667#define xrealloc_vector(vector, shift, idx) \
668 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
669void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
670
Eric Andersenaad1a882001-03-16 22:47:14 +0000671
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000672extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
673extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000674// NB: will return short read on error, not -1,
675// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000676extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
677extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
678extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000679extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
680extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000681// Reads one line a-la fgets (but doesn't save terminating '\n').
682// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000683// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100684extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000685/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100686extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000687/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100688extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100689/* Never returns NULL */
690extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000691/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
692#if ENABLE_FEATURE_SEAMLESS_LZMA \
693 || ENABLE_FEATURE_SEAMLESS_BZ2 \
694 || ENABLE_FEATURE_SEAMLESS_GZ \
695 /* || ENABLE_FEATURE_SEAMLESS_Z */
Denys Vlasenko6948f212010-05-30 04:18:13 +0200696extern void setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/) FAST_FUNC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000697#else
698# define setup_unzip_on_fd(...) ((void)0)
699#endif
Denis Vlasenkob6052722008-07-10 17:43:01 +0000700/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000701extern int open_zipped(const char *fname) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100702extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000703
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000704extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000705// NB: will return short write on error, not -1,
706// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000707extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
708extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000709extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200710extern ssize_t full_write1_str(const char *str) FAST_FUNC;
711extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000712extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000713
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200714/* Close fd, but check for failures (some types of write errors) */
715extern void xclose(int fd) FAST_FUNC;
716
Denis Vlasenko1de08302006-10-26 23:32:43 +0000717/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000718extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000719
720extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenko69f4f9a2008-08-09 17:16:40 +0000721extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000722/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100723extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000724/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100725extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000726/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100727extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000728/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100729extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000730/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100731extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000732/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100733/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000734
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100735void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
736void die_if_ferror_stdout(void) FAST_FUNC;
737int fflush_all(void) FAST_FUNC;
738void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
739int fclose_if_not_stdin(FILE *file) FAST_FUNC;
740FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000741/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100742FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000743/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100744FILE* xfopen_stdin(const char *filename) FAST_FUNC;
745FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
746FILE* fopen_for_read(const char *path) FAST_FUNC;
747FILE* xfopen_for_read(const char *path) FAST_FUNC;
748FILE* fopen_for_write(const char *path) FAST_FUNC;
749FILE* xfopen_for_write(const char *path) FAST_FUNC;
750FILE* xfdopen_for_read(int fd) FAST_FUNC;
751FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000752
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000753int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
754void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000755
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000756/* Wrapper which restarts poll on EINTR or ENOMEM.
757 * On other errors complains [perror("poll")] and returns.
758 * Warning! May take (much) longer than timeout_ms to return!
759 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000760int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000761
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000762char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000763char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000764
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000765/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000766char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000767
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000768char *utoa(unsigned n) FAST_FUNC;
769char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000770/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000771char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
772char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000773/* Intelligent formatters of bignums */
Kevin Cernekeeccb07042010-10-25 02:00:24 +0200774void smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000775void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200776/* If block_size == 0, display size without fractional part,
777 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100778 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200779 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100780#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
781#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000782//TODO: provide pointer to buf (avoid statics)?
783const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000784 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000785/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000786char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200787/* Reverse */
788char* hex2bin(char *dst, const char *str, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000789
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200790/* Generate a UUID */
791void generate_uuid(uint8_t *buf) FAST_FUNC;
792
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000793/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000794struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000795 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000796 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000797};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000798#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000799/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200800
Denis Vlasenko13858992006-10-08 12:49:22 +0000801/* Using xatoi() instead of naive atoi() is not always convenient -
802 * in many places people want *non-negative* values, but store them
803 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200804 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
805 * It should really be named xatoi_nonnegative (since it allows 0),
806 * but that would be too long.
807 */
808int xatoi_positive(const char *numstr) FAST_FUNC;
809
Denis Vlasenko13858992006-10-08 12:49:22 +0000810/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000811uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000812
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000813
Eric Andersenaad1a882001-03-16 22:47:14 +0000814/* These parse entries in /etc/passwd and /etc/group. This is desirable
815 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000816 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000817long xuname2uid(const char *name) FAST_FUNC;
818long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000819/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000820unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000821/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000822struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000823 uid_t uid;
824 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000825};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000826/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000827int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000828/* always sets uid and gid, allows numeric; exits on failure */
829void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000830/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000831void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000832struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000833struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000834struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
835struct group* xgetgrgid(gid_t gid) FAST_FUNC;
836char* xuid2uname(uid_t uid) FAST_FUNC;
837char* xgid2group(gid_t gid) FAST_FUNC;
838char* uid2uname(uid_t uid) FAST_FUNC;
839char* gid2group(gid_t gid) FAST_FUNC;
840char* uid2uname_utoa(long uid) FAST_FUNC;
841char* gid2group_utoa(long gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000842/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000843const char* get_cached_username(uid_t uid) FAST_FUNC;
844const char* get_cached_groupname(gid_t gid) FAST_FUNC;
845void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000846/* internally usernames are saved in fixed-sized char[] buffers */
847enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000848#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000849void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000850#else
851#define die_if_bad_username(name) ((void)(name))
852#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000853
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200854#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200855void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
856void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200857#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200858# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
859# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200860#endif
861
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000862int execable_file(const char *name) FAST_FUNC;
863char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
864int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000865
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000866/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
867 * but it may exec busybox and call applet instead of searching PATH.
868 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000869#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000870int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000871#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
872#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000873 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000874 cmd, __VA_ARGS__)
875#else
876#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
877#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
878#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200879int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000880
Pascal Bellard926031b2010-07-04 15:32:38 +0200881/* xvfork() can't be a _function_, return after vfork mangles stack
882 * in the parent. It must be a macro. */
883#define xvfork() \
884({ \
885 pid_t bb__xvfork_pid = vfork(); \
886 if (bb__xvfork_pid < 0) \
887 bb_perror_msg_and_die("vfork"); \
888 bb__xvfork_pid; \
889})
890#if BB_MMU
891pid_t xfork(void) FAST_FUNC;
892#endif
893
Denys Vlasenko8531d762010-03-18 22:44:00 +0100894/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000895pid_t spawn(char **argv) FAST_FUNC;
896pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000897
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000898pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100899pid_t wait_any_nohang(int *wstat) FAST_FUNC;
900/* wait4pid: unlike waitpid, waits ONLY for one process.
901 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000902 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000903 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000904 * IOW: rc = wait4pid(spawn(argv));
905 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +0100906 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000907 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000908int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100909/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200910int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000911struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000912 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000913 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000914 uint32_t option_mask32;
915 int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +0200916 uint8_t xfunc_error_retval;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000917 smallint saved;
918};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000919void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
920void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000921/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000922int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
923int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000924
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000925/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000926 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000927 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000928 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000929 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
930 * rexec's itself on NOMMU with argv passed as command line.
931 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
932 * from the start. (It will detect it and not reexec again second time).
933 * You have to audit carefully that you don't do something twice as a result
934 * (opening files/sockets, parsing config files etc...)!
935 *
936 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
937 * (will do setsid()).
938 *
Pascal Bellard926031b2010-07-04 15:32:38 +0200939 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000940 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000941 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000942 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000943 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000944 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000945 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
946 * to /dev/null if they are not.
947 */
948enum {
949 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000950 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000951 DAEMON_CLOSE_EXTRA_FDS = 4,
952 DAEMON_ONLY_SANITIZE = 8, /* internal use */
953};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000954#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +0000955 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +0200956# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000957# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
958# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000959#else
Pascal Bellard926031b2010-07-04 15:32:38 +0200960 extern bool re_execed;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000961 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000962 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000963 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
964 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
965 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000966# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +0200967# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000968# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
969# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000970#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000971void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
972void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000973/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000974int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000975
976
Denys Vlasenkoe992bae2009-11-28 15:18:53 +0100977char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000978extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000979extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200980#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000981#define No_argument "\0"
982#define Required_argument "\001"
983#define Optional_argument "\002"
984extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000985#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000986extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000987extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000988
989
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000990typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000991 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000992 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000993} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000994void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
995void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
996void *llist_pop(llist_t **elm) FAST_FUNC;
997void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
998void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
999llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001000llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001001/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001002 * llist_t *llist_add_to(llist_t *old_head, void *data)
1003 * etc does not result in smaller code... */
1004
Denis Vlasenko80edead2007-08-02 22:31:05 +00001005/* start_stop_daemon and udhcpc are special - they want
1006 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001007#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001008/* True only if we created pidfile which is *file*, not /dev/null etc */
1009extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001010void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001011#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001012#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001013enum { wrote_pidfile = 0 };
1014#define write_pidfile(path) ((void)0)
1015#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001016#endif
1017
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001018enum {
1019 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001020 LOGMODE_STDIO = (1 << 0),
1021 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001022 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1023};
1024extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001025extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001026extern int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001027extern uint8_t xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +00001028extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001029extern void xfunc_die(void) NORETURN FAST_FUNC;
1030extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001031extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1032extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1033extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1034extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1035extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001036extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001037extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1038extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001039extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001040extern void bb_perror_nomsg(void) FAST_FUNC;
1041extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1042extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001043
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001044/* We need to export XXX_main from libbusybox
1045 * only if we build "individual" binaries
1046 */
1047#if ENABLE_FEATURE_INDIVIDUAL
1048#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1049#else
1050#define MAIN_EXTERNALLY_VISIBLE
1051#endif
1052
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001053
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001054/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001055int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001056/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001057int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1058int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1059int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1060int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001061/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001062int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001063/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001064int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1065/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001066int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001067int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001068
Denis Vlasenko468aea22008-04-01 14:47:57 +00001069#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001070void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001071#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001072
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001073
1074/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001075int create_icmp_socket(void) FAST_FUNC;
1076int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001077/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001078/* This structure defines protocol families and their handlers. */
1079struct aftype {
1080 const char *name;
1081 const char *title;
1082 int af;
1083 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001084 char* FAST_FUNC (*print)(unsigned char *);
1085 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1086 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1087 void FAST_FUNC (*herror)(char *text);
1088 int FAST_FUNC (*rprint)(int options);
1089 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001090 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001091 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001092};
1093/* This structure defines hardware protocols and their handlers. */
1094struct hwtype {
1095 const char *name;
1096 const char *title;
1097 int type;
1098 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001099 char* FAST_FUNC (*print)(unsigned char *);
1100 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1101 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001102 int suppress_null_addr;
1103};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001104extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001105int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001106#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001107int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001108#else
1109#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001110#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001111const struct aftype *get_aftype(const char *name) FAST_FUNC;
1112const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1113const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001114
1115
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001116#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001117extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001118/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001119extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001120extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001121#endif
1122
Mike Frysinger9412ec72008-02-07 22:41:33 +00001123#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001124extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001125extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001126#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001127extern void erase_mtab(const char * name) FAST_FUNC;
1128extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1129extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001130#if ENABLE_DESKTOP
1131extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1132#else
1133# define bb_warn_ignoring_args(arg) ((void)0)
1134#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001135
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001136extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001137
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001138extern char *query_loop(const char *device) FAST_FUNC;
1139extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001140/* If *devname is not NULL, use that name, otherwise try to find free one,
1141 * malloc and return it in *devname.
1142 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001143extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001144
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001145/* Like bb_ask below, but asks on stdin with no timeout. */
1146char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001147//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001148char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001149int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001150
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001151int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001152
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001153/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001154 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001155 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001156enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001157 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1158 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1159// TODO: COLLAPSE and TRIM seem to always go in pair
1160 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1161 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001162 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001163 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001164// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1165 // NORMAL is:
1166 // * remove leading and trailing delimiters and collapse
1167 // multiple delimiters into one
1168 // * warn and continue if less than mintokens delimiters found
1169 // * grab everything into last token
1170 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001171};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001172typedef struct parser_t {
1173 FILE *fp;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001174 char *line;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001175 char *data;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001176 int lineno;
1177} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001178parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001179parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001180/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001181int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1182#define config_read(parser, tokens, max, min, str, flags) \
1183 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001184void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001185
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001186/* Concatenate path and filename to new allocated buffer.
1187 * Add "/" only as needed (no duplicate "//" are produced).
1188 * If path is NULL, it is assumed to be "/".
1189 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001190char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1191char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1192const char *bb_basename(const char *name) FAST_FUNC;
Denis Vlasenko7e84e532007-05-08 17:52:17 +00001193/* NB: can violate const-ness (similarly to strchr) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001194char *last_char_is(const char *s, int c) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001195
Denis Vlasenko4921b542007-02-03 02:17:41 +00001196
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001197int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001198
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001199int get_signum(const char *name) FAST_FUNC;
1200const char *get_signame(int number) FAST_FUNC;
1201void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001202
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001203char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001204/* Returns ptr to NUL */
1205char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001206
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001207#define FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001208extern void bb_do_delay(int seconds) FAST_FUNC;
1209extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001210extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001211#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001212extern void renew_current_security_context(void) FAST_FUNC;
1213extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001214extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001215 char *user, char *role, char *type, char *range) FAST_FUNC;
1216extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1217extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001218#else
1219#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001220#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001221extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001222
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001223
1224/* systemd support */
1225#define SD_LISTEN_FDS_START 3
1226int sd_listen_fds(void);
1227
1228
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001229/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001230 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001231 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001232 * TERM=(old value)
1233 * USER=pw->pw_name, LOGNAME=pw->pw_name
1234 * PATH=bb_default_[root_]path
1235 * HOME=pw->pw_dir
1236 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001237 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001238 * if not root (if pw->pw_uid != 0):
1239 * USER=pw->pw_name, LOGNAME=pw->pw_name
1240 * HOME=pw->pw_dir
1241 * SHELL=shell
1242 * else does nothing
1243 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001244#define SETUP_ENV_CHANGEENV (1 << 0)
1245#define SETUP_ENV_CLEARENV (1 << 1)
1246#define SETUP_ENV_TO_TMP (1 << 2)
1247extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001248extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001249/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001250#if !ENABLE_USE_BB_CRYPT
1251#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1252#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001253extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1254extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001255/* rnd is additional random input. New one is returned.
1256 * Useful if you call crypt_make_salt many times in a row:
1257 * rnd = crypt_make_salt(buf1, 4, 0);
1258 * rnd = crypt_make_salt(buf2, 4, rnd);
1259 * rnd = crypt_make_salt(buf3, 4, rnd);
1260 * (otherwise we risk having same salt generated)
1261 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001262extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001263
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001264/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001265#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1266#define update_passwd(filename, username, data, member) \
1267 update_passwd(filename, username, data)
1268#endif
1269extern int update_passwd(const char *filename,
1270 const char *username,
1271 const char *data,
1272 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001273
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001274int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1275int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1276int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1277int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1278const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001279
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001280extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1281extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001282
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001283char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001284/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001285int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001286
Denis Vlasenko202ac502008-11-05 13:20:58 +00001287int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1288
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001289/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001290int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1291int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001292#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001293int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1294int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001295#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1296#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1297#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001298int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1299int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001300#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1301#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1302#endif
1303
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001304char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1305void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1306void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001307#ifdef __GLIBC__
1308/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001309unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001310#undef makedev
1311#define makedev(a,b) bb_makedev(a,b)
1312#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001313
1314
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001315/* "Keycodes" that report an escape sequence.
1316 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001317 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001318 * Also, -1 is reserved for error indication and we don't use it. */
1319enum {
1320 KEYCODE_UP = -2,
1321 KEYCODE_DOWN = -3,
1322 KEYCODE_RIGHT = -4,
1323 KEYCODE_LEFT = -5,
1324 KEYCODE_HOME = -6,
1325 KEYCODE_END = -7,
1326 KEYCODE_INSERT = -8,
1327 KEYCODE_DELETE = -9,
1328 KEYCODE_PAGEUP = -10,
1329 KEYCODE_PAGEDOWN = -11,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001330
1331 KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1332 KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1333 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1334 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001335#if 0
1336 KEYCODE_FUN1 = -12,
1337 KEYCODE_FUN2 = -13,
1338 KEYCODE_FUN3 = -14,
1339 KEYCODE_FUN4 = -15,
1340 KEYCODE_FUN5 = -16,
1341 KEYCODE_FUN6 = -17,
1342 KEYCODE_FUN7 = -18,
1343 KEYCODE_FUN8 = -19,
1344 KEYCODE_FUN9 = -20,
1345 KEYCODE_FUN10 = -21,
1346 KEYCODE_FUN11 = -22,
1347 KEYCODE_FUN12 = -23,
1348#endif
Denys Vlasenko180f5852009-10-26 00:59:59 +01001349 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001350 /* How long is the longest ESC sequence we know?
1351 * We want it big enough to be able to contain
1352 * cursor position sequence "ESC [ 9999 ; 9999 R"
1353 */
1354 KEYCODE_BUFFER_SIZE = 16
1355};
1356/* Note: fd may be in blocking or non-blocking mode, both make sense.
1357 * For one, less uses non-blocking mode.
1358 * Only the first read syscall inside read_key may block indefinitely
1359 * (unless fd is in non-blocking mode),
1360 * subsequent reads will time out after a few milliseconds.
1361 * Return of -1 means EOF or error (errno == 0 on EOF).
1362 * buffer[0] is used as a counter of buffered chars and must be 0
1363 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001364 * timeout:
1365 * -2: do not poll for input;
1366 * -1: poll(-1) (i.e. block);
1367 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001368 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001369int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001370void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001371
1372
Denis Vlasenko38f63192007-01-22 09:03:07 +00001373#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001374/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001375# ifdef CONFIG_FEATURE_EDITING_HISTORY
1376# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1377# else
1378# define MAX_HISTORY 0
1379# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001380typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001381 int flags;
1382 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001383# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001384 int cnt_history;
1385 int cur_history;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001386# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001387 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001388 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001389# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001390 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001391# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001392} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001393enum {
1394 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001395 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1396 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1397 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1398 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001399 WITH_PATH_LOOKUP = 0x20,
1400 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1401};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001402line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001403/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1404/* maxsize must be >= 2.
1405 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001406 * -1 on read errors or EOF, or on bare Ctrl-D,
1407 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001408 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001409 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001410int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001411#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001412#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001413int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001414#define read_line_input(prompt, command, maxsize, state) \
1415 read_line_input(prompt, command, maxsize)
1416#endif
1417
1418
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001419#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001420# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001421enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001422# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001423/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001424enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001425# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001426#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001427
1428struct smaprec {
1429 unsigned long mapped_rw;
1430 unsigned long mapped_ro;
1431 unsigned long shared_clean;
1432 unsigned long shared_dirty;
1433 unsigned long private_clean;
1434 unsigned long private_dirty;
1435 unsigned long stack;
1436 unsigned long smap_pss, smap_swap;
1437 unsigned long smap_size;
1438 unsigned long smap_start;
1439 char smap_mode[5];
1440 char *smap_name;
1441};
1442
1443#if !ENABLE_PMAP
1444#define procps_read_smaps(pid, total, cb, data) \
1445 procps_read_smaps(pid, total)
1446#endif
1447int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1448 void (*cb)(struct smaprec *, void *), void *data);
1449
Denis Vlasenko512499c2007-08-26 18:23:13 +00001450typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001451 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001452 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001453 uint8_t shift_pages_to_bytes;
1454 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001455/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001456 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001457 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001458 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001459 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001460 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001461 /* Everything below must contain no ptrs to malloc'ed data:
1462 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001463 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001464 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001465 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001466 unsigned pid;
1467 unsigned ppid;
1468 unsigned pgid;
1469 unsigned sid;
1470 unsigned uid;
1471 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001472#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1473 unsigned ruid;
1474 unsigned rgid;
1475 int niceness;
1476#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001477 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001478#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001479 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001480#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001481 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001482 /* basename of executable in exec(2), read from /proc/N/stat
1483 * (if executable is symlink or script, it is NOT replaced
1484 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001485 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001486 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001487#if ENABLE_FEATURE_TOP_SMP_PROCESS
1488 int last_seen_on_cpu;
1489#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001490} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001491/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001492enum {
1493 PSSCAN_PID = 1 << 0,
1494 PSSCAN_PPID = 1 << 1,
1495 PSSCAN_PGID = 1 << 2,
1496 PSSCAN_SID = 1 << 3,
1497 PSSCAN_UIDGID = 1 << 4,
1498 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001499 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001500 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001501 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001502 PSSCAN_STATE = 1 << 9,
1503 PSSCAN_VSZ = 1 << 10,
1504 PSSCAN_RSS = 1 << 11,
1505 PSSCAN_STIME = 1 << 12,
1506 PSSCAN_UTIME = 1 << 13,
1507 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001508 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001509 /* NB: used by find_pid_by_name(). Any applet using it
1510 * needs to be mentioned here. */
1511 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1512 || ENABLE_PGREP || ENABLE_PKILL
1513 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001514 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001515 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001516 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001517 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001518 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1519 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1520 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001521 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001522 /* These are all retrieved from proc/NN/stat in one go: */
1523 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001524 /**/ | PSSCAN_COMM | PSSCAN_STATE
1525 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1526 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001527 /**/ | PSSCAN_TTY | PSSCAN_NICE
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001528 /**/ | PSSCAN_CPU
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001529};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001530//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1531void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1532procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001533/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001534/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001535void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001536pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1537pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001538int starts_with_cpu(const char *str) FAST_FUNC;
1539unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001540
1541
1542extern const char bb_uuenc_tbl_base64[];
1543extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001544void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001545enum {
1546 BASE64_FLAG_UU_STOP = 0x100,
1547 /* Sign-extends to a value which never matches fgetc result: */
1548 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1549};
1550void FAST_FUNC read_base64(FILE *src_stream, FILE *dst_stream, int flags);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001551
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001552typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001553 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1554 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001555 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001556 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1557} md5_ctx_t;
1558typedef struct md5_ctx_t sha1_ctx_t;
1559typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001560typedef struct sha512_ctx_t {
1561 uint64_t total64[2]; /* must be directly before hash[] */
1562 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001563 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001564} sha512_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001565void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1566void md5_hash(md5_ctx_t *ctx, const void *data, size_t length) FAST_FUNC;
1567void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1568void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1569#define sha1_hash md5_hash
1570void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1571void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1572#define sha256_hash md5_hash
1573#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001574void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1575void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1576void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001577
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001578extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001579uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001580uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1581uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001582
1583typedef struct masks_labels_t {
1584 const char *labels;
1585 const int masks[];
1586} masks_labels_t;
1587int print_flags_separated(const int *masks, const char *labels,
1588 int flags, const char *separator) FAST_FUNC;
1589int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001590
Magnus Dammf5914992009-11-08 16:34:43 +01001591typedef struct bb_progress_t {
1592 off_t lastsize;
1593 unsigned lastupdate_sec;
1594 unsigned start_sec;
Denys Vlasenkocbcc1232010-03-05 23:38:54 +01001595 smallint inited;
Magnus Dammf5914992009-11-08 16:34:43 +01001596} bb_progress_t;
1597
1598void bb_progress_init(bb_progress_t *p) FAST_FUNC;
1599void bb_progress_update(bb_progress_t *p, const char *curfile,
1600 off_t beg_range, off_t transferred,
1601 off_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001602
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001603extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001604
1605/* Some older linkers don't perform string merging, we used to have common strings
1606 * as global arrays to do it by hand. But:
1607 * (1) newer linkers do it themselves,
1608 * (2) however, they DONT merge string constants with global arrays,
1609 * even if the value is the same (!). Thus global arrays actually
1610 * increased size a bit: for example, "/etc/passwd" string from libc
1611 * wasn't merged with bb_path_passwd_file[] array!
1612 * Therefore now we use #defines.
1613 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001614/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001615extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001616extern const char bb_msg_memory_exhausted[];
1617extern const char bb_msg_invalid_date[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001618#define bb_msg_read_error "read error"
1619#define bb_msg_write_error "write error"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001620extern const char bb_msg_unknown[];
1621extern const char bb_msg_can_not_create_raw_socket[];
1622extern const char bb_msg_perm_denied_are_you_root[];
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01001623extern const char bb_msg_you_must_be_root[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001624extern const char bb_msg_requires_arg[];
1625extern const char bb_msg_invalid_arg[];
1626extern const char bb_msg_standard_input[];
1627extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001628
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001629/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001630extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001631
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001632extern const char bb_path_wtmp_file[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001633
1634/* Busybox mount uses either /proc/mounts or /etc/mtab to
1635 * get the list of currently mounted filesystems */
1636#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1637
Tito Ragusaad3d72f2011-01-16 23:39:45 +01001638#define bb_path_passwd_file _PATH_PASSWD
1639#define bb_path_group_file _PATH_GROUP
1640#define bb_path_shadow_file _PATH_SHADOW
1641#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02001642
1643#define bb_path_motd_file "/etc/motd"
1644
1645#define bb_dev_null "/dev/null"
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001646extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001647/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1648 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001649extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1650#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1651#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001652
Denis Vlasenko703e2022007-01-22 14:12:08 +00001653extern const int const_int_0;
1654extern const int const_int_1;
1655
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001656
Denis Vlasenko85818632007-04-19 14:47:11 +00001657/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001658enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1659extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001660/* This struct is deliberately not defined. */
1661/* See docs/keep_data_small.txt */
1662struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001663/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001664 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001665 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001666extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001667/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001668#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001669#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001670 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001671 barrier(); \
1672} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001673
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001674/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1675 * use bb_default_login_shell and following defines.
1676 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1677 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001678#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001679extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001680/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001681#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001682/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001683#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001684
Jeremie Koenig816ed972010-05-27 15:46:29 +02001685/* The following devices are the same on all systems. */
1686#define CURRENT_TTY "/dev/tty"
1687#define DEV_CONSOLE "/dev/console"
1688
1689#if defined(__FreeBSD_kernel__)
1690# define CURRENT_VC CURRENT_TTY
1691# define VC_1 "/dev/ttyv0"
1692# define VC_2 "/dev/ttyv1"
1693# define VC_3 "/dev/ttyv2"
1694# define VC_4 "/dev/ttyv3"
1695# define VC_5 "/dev/ttyv4"
1696# define VC_FORMAT "/dev/ttyv%d"
1697#elif defined(__GNU__)
1698# define CURRENT_VC CURRENT_TTY
1699# define VC_1 "/dev/tty1"
1700# define VC_2 "/dev/tty2"
1701# define VC_3 "/dev/tty3"
1702# define VC_4 "/dev/tty4"
1703# define VC_5 "/dev/tty5"
1704# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001705#elif ENABLE_FEATURE_DEVFS
1706/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001707# define CURRENT_VC "/dev/vc/0"
1708# define VC_1 "/dev/vc/1"
1709# define VC_2 "/dev/vc/2"
1710# define VC_3 "/dev/vc/3"
1711# define VC_4 "/dev/vc/4"
1712# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001713# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001714# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001715# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001716# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001717# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001718#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001719/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001720# define CURRENT_VC "/dev/tty0"
1721# define VC_1 "/dev/tty1"
1722# define VC_2 "/dev/tty2"
1723# define VC_3 "/dev/tty3"
1724# define VC_4 "/dev/tty4"
1725# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001726# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001727# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001728# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001729# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001730# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001731#endif
1732
Rob Landleyc57ec372006-04-10 17:07:15 +00001733
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001734#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1735
Rob Landleyb623a542006-05-31 22:09:03 +00001736
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001737/* We redefine ctype macros. Unicode-correct handling of char types
1738 * can't be done with such byte-oriented operations anyway,
1739 * we don't lose anything.
1740 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001741#undef isalnum
1742#undef isalpha
1743#undef isascii
1744#undef isblank
1745#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001746#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001747#undef isgraph
1748#undef islower
1749#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001750#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001751#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001752#undef isupper
1753#undef isxdigit
1754#undef toupper
1755#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001756
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001757/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001758 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001759
1760/* These work the same for ASCII and Unicode,
1761 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001762#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001763#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001764#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1765#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001766#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001767#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1768#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001769/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001770 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001771 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001772#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001773// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1774#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1775// Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
Denys Vlasenko11c12c42009-10-23 13:57:24 +02001776#define isalnum(a) bb_ascii_isalnum(a)
1777static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1778{
1779 unsigned char b = a - '0';
1780 if (b <= 9)
1781 return (b <= 9);
1782 b = (a|0x20) - 'a';
1783 return b <= 'z' - 'a';
1784}
1785#define isxdigit(a) bb_ascii_isxdigit(a)
1786static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1787{
1788 unsigned char b = a - '0';
1789 if (b <= 9)
1790 return (b <= 9);
1791 b = (a|0x20) - 'a';
1792 return b <= 'f' - 'a';
1793}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001794#define toupper(a) bb_ascii_toupper(a)
1795static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1796{
1797 unsigned char b = a - 'a';
1798 if (b <= ('z' - 'a'))
1799 a -= 'a' - 'A';
1800 return a;
1801}
1802#define tolower(a) bb_ascii_tolower(a)
1803static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1804{
1805 unsigned char b = a - 'A';
1806 if (b <= ('Z' - 'A'))
1807 a += 'a' - 'A';
1808 return a;
1809}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001810
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001811/* In ASCII and Unicode, these are likely to be very different.
1812 * Let's prevent ambiguous usage from the start */
1813#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1814#define isprint(a) isprint_is_ambiguous_dont_use(a)
1815/* NB: must not treat EOF as isgraph or isprint */
1816#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1817#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1818
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001819
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001820POP_SAVED_FUNCTION_VISIBILITY
1821
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001822#endif