blob: d5580b4b07fd497a59d6a59b603a37d786bb051e [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/* Try to pull in PATH_MAX */
41#include <limits.h>
42#include <sys/param.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000043#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020044# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000045#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000046#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020047# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000048#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000049#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020050# include <selinux/selinux.h>
51# include <selinux/context.h>
52# include <selinux/flask.h>
53# include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000054#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000055#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +020056# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000057#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +020058# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000059#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000060#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +020061# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000062#endif
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000063#include <pwd.h>
64#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000065#if ENABLE_FEATURE_SHADOWPASSWDS
Mike Frysinger52a42672009-07-09 01:33:20 -040066# if !ENABLE_USE_BB_SHADOW
67/* If using busybox's shadow implementation, do not include the shadow.h
68 * header as the toolchain may not provide it at all.
69 */
70# include <shadow.h>
71# endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000072#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020073#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +010074# include <netinet/in.h>
75# include <arpa/inet.h>
76#elif defined __APPLE__
77# include <netinet/in.h>
78#else
79# include <arpa/inet.h>
80# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
81/* We #define socklen_t *after* includes, otherwise we get
82 * typedef redefinition errors from system headers
83 * (in case "is it defined already" detection above failed)
84 */
85# define socklen_t bb_socklen_t
86 typedef unsigned socklen_t;
87# endif
88#endif
89
Denis Vlasenko98636eb2008-05-09 17:59:34 +000090
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +000091/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +000092
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +000093extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000094#if defined(__GLIBC__) && __GLIBC__ < 2
95int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000096#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000097/* klogctl is in libc's klog.h, but we cheat and not #include that */
98int klogctl(int type, char *b, int len);
99/* This is declared here rather than #including <libgen.h> in order to avoid
100 * confusing the two versions of basename. See the dirname/basename man page
101 * for details. */
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200102#if !defined __FreeBSD__
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000103char *dirname(char *path);
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200104#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000105/* Include our own copy of struct sysinfo to avoid binary compatibility
106 * problems with Linux 2.4, which changed things. Grumble, grumble. */
107struct sysinfo {
108 long uptime; /* Seconds since boot */
109 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
110 unsigned long totalram; /* Total usable main memory size */
111 unsigned long freeram; /* Available memory size */
112 unsigned long sharedram; /* Amount of shared memory */
113 unsigned long bufferram; /* Memory used by buffers */
114 unsigned long totalswap; /* Total swap space size */
115 unsigned long freeswap; /* swap space still available */
116 unsigned short procs; /* Number of current processes */
117 unsigned short pad; /* Padding needed for m68k */
118 unsigned long totalhigh; /* Total high memory size */
119 unsigned long freehigh; /* Available high memory size */
120 unsigned int mem_unit; /* Memory unit size in bytes */
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000121 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000122};
123int sysinfo(struct sysinfo* info);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100124#ifndef PATH_MAX
125# define PATH_MAX 256
126#endif
127#ifndef BUFSIZ
128# define BUFSIZ 4096
129#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000130
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000131
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000132/* Make all declarations hidden (-fvisibility flag only affects definitions) */
133/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000134PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000135
136
137#if ENABLE_USE_BB_PWD_GRP
138# include "pwd_.h"
139# include "grp_.h"
140#endif
141#if ENABLE_FEATURE_SHADOWPASSWDS
142# if ENABLE_USE_BB_SHADOW
143# include "shadow_.h"
144# endif
145#endif
146
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000147/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000148#define MAXINT(T) (T)( \
149 ((T)-1) > 0 \
150 ? (T)-1 \
151 : (T)~((T)1 << (sizeof(T)*8-1)) \
152 )
153
154#define MININT(T) (T)( \
155 ((T)-1) > 0 \
156 ? (T)0 \
157 : ((T)1 << (sizeof(T)*8-1)) \
158 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000159
Denis Vlasenko56254152006-10-07 16:24:46 +0000160/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000161/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000162 * (stat, lseek etc) mapped to "largefile" variants by libc.
163 * Practically it means that open() automatically has O_LARGEFILE added
164 * and all filesize/file_offset parameters and struct members are "large"
165 * (in today's world - signed 64bit). For full support of large files,
166 * we need a few helper #defines (below) and careful use of off_t
167 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000168#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000169/* CONFIG_LFS is on */
170# if ULONG_MAX > 0xffffffff
171/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000172typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000173# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000174/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
175# define BB_STRTOOFF bb_strtoul
176# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000177/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
178# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000179# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000180/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000181typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000182# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000183# define BB_STRTOOFF bb_strtoull
184# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000185# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000186# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000187#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000188/* CONFIG_LFS is off */
189# if UINT_MAX == 0xffffffff
190/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
191 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000192typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200193# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000194# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000195# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000196# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000197# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000198typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000199# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
200# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000201# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000202# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000203# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000204#endif
205/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000206#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000207
Eric Andersenaad1a882001-03-16 22:47:14 +0000208/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000209#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000210#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000211#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000212#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000213#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000214#define SKIP ((int) 2)
215
216/* for mtab.c */
217#define MTAB_GETMOUNTPT '1'
218#define MTAB_GETDEVICE '2'
219
220#define BUF_SIZE 8192
221#define EXPAND_ALLOC 1024
222
Eric Andersenaad1a882001-03-16 22:47:14 +0000223/* Macros for min/max. */
224#ifndef MIN
225#define MIN(a,b) (((a)<(b))?(a):(b))
226#endif
227
228#ifndef MAX
229#define MAX(a,b) (((a)>(b))?(a):(b))
230#endif
231
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000232/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000233#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000234#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000235#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
236#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
237#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000238#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000239#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
240#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
241#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
242#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000243#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
244#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
245#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000246#endif
247#endif
248
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000249#if defined(__GLIBC__)
250/* glibc uses __errno_location() to get a ptr to errno */
251/* We can just memorize it once - no multithreading in busybox :) */
252extern int *const bb_errno;
253#undef errno
254#define errno (*bb_errno)
255#endif
256
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000257unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000258unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100259unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000260unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000261
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000262extern void chomp(char *s) FAST_FUNC;
263extern void trim(char *s) FAST_FUNC;
264extern char *skip_whitespace(const char *) FAST_FUNC;
265extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200266extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
267
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000268extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000269
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000270//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000271extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
272extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000273enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100274 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
275 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
276 FILEUTILS_RECUR = 1 << 2, /* -R */
277 FILEUTILS_FORCE = 1 << 3, /* -f */
278 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
279 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
280 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
281 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
282 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000283#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100284 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
285 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000286#endif
287};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100288#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000289extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000290/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
291 * the source, not copy (unless "source" is a directory).
292 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
293 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000294extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000295
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000296enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000297 ACTION_RECURSE = (1 << 0),
298 ACTION_FOLLOWLINKS = (1 << 1),
299 ACTION_FOLLOWLINKS_L0 = (1 << 2),
300 ACTION_DEPTHFIRST = (1 << 3),
301 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000302 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200303 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000304};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200305typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000306extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000307 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
308 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
309 void* userData, unsigned depth) FAST_FUNC;
310extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000311enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000312extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000313extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000314extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
315extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000316/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000317extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
318extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
319extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000320/* "short" copy can be detected by return value < size */
321/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000322extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000323extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000324/* xxxx_strip version can modify its parameter:
325 * "/" -> "/"
326 * "abc" -> "abc"
327 * "abc/def" -> "def"
328 * "abc/def/" -> "def" !!
329 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000330extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000331/* "abc/def/" -> "" and it never modifies 'path' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000332extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000333
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000334int ndelay_on(int fd) FAST_FUNC;
335int ndelay_off(int fd) FAST_FUNC;
336int close_on_exec_on(int fd) FAST_FUNC;
337void xdup2(int, int) FAST_FUNC;
338void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000339
340
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000341DIR *xopendir(const char *path) FAST_FUNC;
342DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000343
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100344char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100345char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
346char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100347/* !RETURNS_MALLOC: it's a realloc-like function */
348char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000349
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100350char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000351
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000352
Denis Vlasenko33196372008-02-23 01:25:38 +0000353enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000354 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000355 * otherwise would kill us, except for those resulting from bugs:
356 * SIGSEGV, SIGILL, SIGFPE.
357 * Other fatal signals not included (TODO?):
358 * SIGBUS Bus error (bad memory access)
359 * SIGPOLL Pollable event. Synonym of SIGIO
360 * SIGPROF Profiling timer expired
361 * SIGSYS Bad argument to routine
362 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000363 *
364 * The only known arch with some of these sigs not fitting
365 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
366 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000367 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000368 BB_FATAL_SIGS = (int)(0
369 + (1LL << SIGHUP)
370 + (1LL << SIGINT)
371 + (1LL << SIGTERM)
372 + (1LL << SIGPIPE) // Write to pipe with no readers
373 + (1LL << SIGQUIT) // Quit from keyboard
374 + (1LL << SIGABRT) // Abort signal from abort(3)
375 + (1LL << SIGALRM) // Timer signal from alarm(2)
376 + (1LL << SIGVTALRM) // Virtual alarm clock
377 + (1LL << SIGXCPU) // CPU time limit exceeded
378 + (1LL << SIGXFSZ) // File size limit exceeded
379 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
380 + (1LL << SIGUSR2)
381 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000382};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000383void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000384/* Unlike signal() and bb_signals, sets handler with sigaction()
385 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000386 * will be blocked; syscalls will not be restarted: */
387void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000388/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000389void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000390/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000391void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
392void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000393void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000394void sig_block(int sig) FAST_FUNC;
395void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000396/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000397int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000398/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000399int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000400/* Standard handler which just records signo */
401extern smallint bb_got_signal;
402void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000403
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000404
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000405void xsetgid(gid_t gid) FAST_FUNC;
406void xsetuid(uid_t uid) FAST_FUNC;
407void xchdir(const char *path) FAST_FUNC;
408void xchroot(const char *path) FAST_FUNC;
409void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000410void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200411void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000412void xunlink(const char *pathname) FAST_FUNC;
413void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200414void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200415int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100416int xopen_nonblocking(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000417int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
418int open_or_warn(const char *pathname, int flags) FAST_FUNC;
419int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
420int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200421int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000422void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
423int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
424off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
425off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000426
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100427uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
428 const char *override,
429 unsigned override_units,
430 int extend);
431
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000432void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000433/* In this form code with pipes is much more readable */
434struct fd_pair { int rd; int wr; };
435#define piped_pair(pair) pipe(&((pair).rd))
436#define xpiped_pair(pair) xpipe(&((pair).rd))
437
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000438/* Useful for having small structure members/global variables */
439typedef int8_t socktype_t;
440typedef int8_t family_t;
441struct BUG_too_small {
442 char BUG_socktype_t_too_small[(0
443 | SOCK_STREAM
444 | SOCK_DGRAM
445 | SOCK_RDM
446 | SOCK_SEQPACKET
447 | SOCK_RAW
448 ) <= 127 ? 1 : -1];
449 char BUG_family_t_too_small[(0
450 | AF_UNSPEC
451 | AF_INET
452 | AF_INET6
453 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000454#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000455 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000456#endif
457#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000458 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000459#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000460 /* | AF_DECnet */
461 /* | AF_IPX */
462 ) <= 127 ? 1 : -1];
463};
464
465
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100466void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
467time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200468
469
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000470int xsocket(int domain, int type, int protocol) FAST_FUNC;
471void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
472void xlisten(int s, int backlog) FAST_FUNC;
473void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000474ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000475 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000476/* SO_REUSEADDR allows a server to rebind to an address that is already
477 * "in use" by old connections to e.g. previous server instance which is
478 * killed or crashed. Without it bind will fail until all such connections
479 * time out. Linux does not allow multiple live binds on same ip:port
480 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
481 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000482void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
483int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000484int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000485/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000486unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000487typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000488 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000489 union {
490 struct sockaddr sa;
491 struct sockaddr_in sin;
492#if ENABLE_FEATURE_IPV6
493 struct sockaddr_in6 sin6;
494#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000495 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000496} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000497enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000498 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000499 LSA_SIZEOF_SA = sizeof(
500 union {
501 struct sockaddr sa;
502 struct sockaddr_in sin;
503#if ENABLE_FEATURE_IPV6
504 struct sockaddr_in6 sin6;
505#endif
506 }
507 )
508};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000509/* Create stream socket, and allocate suitable lsa.
510 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000511 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100512 * and if kernel doesn't support it, fall back to IPv4.
513 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000514 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000515#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000516int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000517#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000518int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000519#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
520#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000521int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000522/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000523 * numeric IP ("N.N.N.N") or numeric IPv6 address,
524 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000525 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000526/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000527int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
528int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000529/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
530 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
531 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
532 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000533int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000534/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000535int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000536/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100537len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200538/* Get remote address of connected or accepted socket */
539len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000540/* Return malloc'ed len_and_sockaddr with socket address of host:port
541 * Currently will return IPv4 or IPv6 sockaddrs only
542 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000543 * UNIX socket address being returned, IPX sockaddr etc...
544 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100545len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000546/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100547len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
548len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000549/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000550#if !ENABLE_FEATURE_IPV6
551#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
552#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
553#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100554len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
555len_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 +0000556#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000557/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000558 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000559 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000560void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000561/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000562int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000563/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100564char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000565/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100566char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000567/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100568char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000569/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100570char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
571char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000572// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000573// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000574struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000575// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000576// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000577
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000578
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000579void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000580ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000581 const struct sockaddr *to,
582 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000583 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000584ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000585 struct sockaddr *from,
586 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000587 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000588
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100589
590char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
591char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000592void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000593char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000594char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000595/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000596 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000597int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200598/* Note: does not use stdio, writes to fd 2 directly */
599int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100600char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000601// gcc-4.1.1 still isn't good enough at optimizing it
602// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000603//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000604//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000605//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000606//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000607#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000608#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000609#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000610#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000611#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000612
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100613typedef struct uni_stat_t {
614 unsigned byte_count;
615 unsigned unicode_count;
616 unsigned unicode_width;
617} uni_stat_t;
618/* Returns a string with unprintable chars replaced by '?' or
619 * SUBST_WCHAR. This function is unicode-aware. */
620const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
621/* Prints unprintable char ch as ^C or M-c to file
622 * (M-c is used only if ch is ORed with PRINTABLE_META),
623 * else it is printed as-is (except for ch = 0x9b) */
624enum { PRINTABLE_META = 0x100 };
625void fputc_printable(int ch, FILE *file) FAST_FUNC;
626
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000627/* dmalloc will redefine these to it's own implementation. It is safe
628 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100629void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
630void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
631void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000632void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000633/* After xrealloc_vector(v, 4, idx) it's ok to use
634 * at least v[idx] and v[idx+1], for all idx values.
635 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
636 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000637#define xrealloc_vector(vector, shift, idx) \
638 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
639void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
640
Eric Andersenaad1a882001-03-16 22:47:14 +0000641
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000642extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
643extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000644// NB: will return short read on error, not -1,
645// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000646extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
647extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
648extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000649extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
650extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000651// Reads one line a-la fgets (but doesn't save terminating '\n').
652// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000653// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100654extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000655/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100656extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000657/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100658extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000659/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
660#if ENABLE_FEATURE_SEAMLESS_LZMA \
661 || ENABLE_FEATURE_SEAMLESS_BZ2 \
662 || ENABLE_FEATURE_SEAMLESS_GZ \
663 /* || ENABLE_FEATURE_SEAMLESS_Z */
Denys Vlasenko6948f212010-05-30 04:18:13 +0200664extern void setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/) FAST_FUNC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000665#else
666# define setup_unzip_on_fd(...) ((void)0)
667#endif
Denis Vlasenkob6052722008-07-10 17:43:01 +0000668/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000669extern int open_zipped(const char *fname) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100670extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000671/* Never returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100672extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000673
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000674extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000675// NB: will return short write on error, not -1,
676// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000677extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
678extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000679extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200680extern ssize_t full_write1_str(const char *str) FAST_FUNC;
681extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000682extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000683
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200684/* Close fd, but check for failures (some types of write errors) */
685extern void xclose(int fd) FAST_FUNC;
686
Denis Vlasenko1de08302006-10-26 23:32:43 +0000687/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000688extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000689
690extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenko69f4f9a2008-08-09 17:16:40 +0000691extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000692/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100693extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000694/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100695extern 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 +0000696/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100697extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000698/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100699extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000700/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100701extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000702/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100703/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000704
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100705void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
706void die_if_ferror_stdout(void) FAST_FUNC;
707int fflush_all(void) FAST_FUNC;
708void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
709int fclose_if_not_stdin(FILE *file) FAST_FUNC;
710FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000711/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100712FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000713/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100714FILE* xfopen_stdin(const char *filename) FAST_FUNC;
715FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
716FILE* fopen_for_read(const char *path) FAST_FUNC;
717FILE* xfopen_for_read(const char *path) FAST_FUNC;
718FILE* fopen_for_write(const char *path) FAST_FUNC;
719FILE* xfopen_for_write(const char *path) FAST_FUNC;
720FILE* xfdopen_for_read(int fd) FAST_FUNC;
721FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000722
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000723int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
724void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000725
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000726/* Wrapper which restarts poll on EINTR or ENOMEM.
727 * On other errors complains [perror("poll")] and returns.
728 * Warning! May take (much) longer than timeout_ms to return!
729 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000730int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000731
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000732char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000733char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000734
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000735/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000736char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000737
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000738char *utoa(unsigned n) FAST_FUNC;
739char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000740/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000741char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
742char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000743/* Intelligent formatters of bignums */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000744void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
745void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200746/* If block_size == 0, display size without fractional part,
747 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100748 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200749 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100750#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
751#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000752//TODO: provide pointer to buf (avoid statics)?
753const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000754 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000755/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000756char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200757/* Reverse */
758char* hex2bin(char *dst, const char *str, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000759
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200760/* Generate a UUID */
761void generate_uuid(uint8_t *buf) FAST_FUNC;
762
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000763/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000764struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000765 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000766 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000767};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000768#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000769/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200770
Denis Vlasenko13858992006-10-08 12:49:22 +0000771/* Using xatoi() instead of naive atoi() is not always convenient -
772 * in many places people want *non-negative* values, but store them
773 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200774 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
775 * It should really be named xatoi_nonnegative (since it allows 0),
776 * but that would be too long.
777 */
778int xatoi_positive(const char *numstr) FAST_FUNC;
779
Denis Vlasenko13858992006-10-08 12:49:22 +0000780/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000781uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000782
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000783
Eric Andersenaad1a882001-03-16 22:47:14 +0000784/* These parse entries in /etc/passwd and /etc/group. This is desirable
785 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000786 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000787long xuname2uid(const char *name) FAST_FUNC;
788long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000789/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000790unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000791/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000792struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000793 uid_t uid;
794 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000795};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000796/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000797int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000798/* always sets uid and gid, allows numeric; exits on failure */
799void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000800/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000801void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000802struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000803struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000804struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
805struct group* xgetgrgid(gid_t gid) FAST_FUNC;
806char* xuid2uname(uid_t uid) FAST_FUNC;
807char* xgid2group(gid_t gid) FAST_FUNC;
808char* uid2uname(uid_t uid) FAST_FUNC;
809char* gid2group(gid_t gid) FAST_FUNC;
810char* uid2uname_utoa(long uid) FAST_FUNC;
811char* gid2group_utoa(long gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000812/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000813const char* get_cached_username(uid_t uid) FAST_FUNC;
814const char* get_cached_groupname(gid_t gid) FAST_FUNC;
815void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000816/* internally usernames are saved in fixed-sized char[] buffers */
817enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000818#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000819void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000820#else
821#define die_if_bad_username(name) ((void)(name))
822#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000823
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200824#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200825void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
826void 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 +0200827#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200828# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
829# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200830#endif
831
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000832int execable_file(const char *name) FAST_FUNC;
833char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
834int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000835
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000836/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
837 * but it may exec busybox and call applet instead of searching PATH.
838 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000839#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000840int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000841#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
842#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000843 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000844 cmd, __VA_ARGS__)
845#else
846#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
847#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
848#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200849int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000850
Pascal Bellard926031b2010-07-04 15:32:38 +0200851/* xvfork() can't be a _function_, return after vfork mangles stack
852 * in the parent. It must be a macro. */
853#define xvfork() \
854({ \
855 pid_t bb__xvfork_pid = vfork(); \
856 if (bb__xvfork_pid < 0) \
857 bb_perror_msg_and_die("vfork"); \
858 bb__xvfork_pid; \
859})
860#if BB_MMU
861pid_t xfork(void) FAST_FUNC;
862#endif
863
Denys Vlasenko8531d762010-03-18 22:44:00 +0100864/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000865pid_t spawn(char **argv) FAST_FUNC;
866pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000867
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000868pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100869pid_t wait_any_nohang(int *wstat) FAST_FUNC;
870/* wait4pid: unlike waitpid, waits ONLY for one process.
871 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000872 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000873 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000874 * IOW: rc = wait4pid(spawn(argv));
875 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +0100876 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000877 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000878int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100879/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200880int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000881struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000882 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000883 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000884 uint32_t option_mask32;
885 int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +0200886 uint8_t xfunc_error_retval;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000887 smallint saved;
888};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000889void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
890void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000891/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000892int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
893int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000894
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000895/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000896 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000897 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000898 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000899 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
900 * rexec's itself on NOMMU with argv passed as command line.
901 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
902 * from the start. (It will detect it and not reexec again second time).
903 * You have to audit carefully that you don't do something twice as a result
904 * (opening files/sockets, parsing config files etc...)!
905 *
906 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
907 * (will do setsid()).
908 *
Pascal Bellard926031b2010-07-04 15:32:38 +0200909 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000910 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000911 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000912 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000913 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000914 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000915 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
916 * to /dev/null if they are not.
917 */
918enum {
919 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000920 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000921 DAEMON_CLOSE_EXTRA_FDS = 4,
922 DAEMON_ONLY_SANITIZE = 8, /* internal use */
923};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000924#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +0000925 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +0200926# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000927# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
928# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000929#else
Pascal Bellard926031b2010-07-04 15:32:38 +0200930 extern bool re_execed;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000931 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000932 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000933 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
934 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
935 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000936# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +0200937# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000938# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
939# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000940#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000941void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
942void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000943/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000944int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000945
946
Denys Vlasenkoe992bae2009-11-28 15:18:53 +0100947char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000948extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000949extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200950#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000951#define No_argument "\0"
952#define Required_argument "\001"
953#define Optional_argument "\002"
954extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000955#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000956extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000957extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000958
959
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000960typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000961 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000962 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000963} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000964void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
965void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
966void *llist_pop(llist_t **elm) FAST_FUNC;
967void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
968void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
969llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +0000970llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000971/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000972 * llist_t *llist_add_to(llist_t *old_head, void *data)
973 * etc does not result in smaller code... */
974
Denis Vlasenko80edead2007-08-02 22:31:05 +0000975/* start_stop_daemon and udhcpc are special - they want
976 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000977#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000978/* True only if we created pidfile which is *file*, not /dev/null etc */
979extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000980void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000981#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000982#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000983enum { wrote_pidfile = 0 };
984#define write_pidfile(path) ((void)0)
985#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000986#endif
987
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000988enum {
989 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000990 LOGMODE_STDIO = (1 << 0),
991 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000992 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
993};
994extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000995extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000996extern int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +0200997extern uint8_t xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000998extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000999extern void xfunc_die(void) NORETURN FAST_FUNC;
1000extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001001extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1002extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1003extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1004extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1005extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001006extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001007extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1008extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001009extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001010extern void bb_perror_nomsg(void) FAST_FUNC;
1011extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1012extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001013
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001014/* We need to export XXX_main from libbusybox
1015 * only if we build "individual" binaries
1016 */
1017#if ENABLE_FEATURE_INDIVIDUAL
1018#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1019#else
1020#define MAIN_EXTERNALLY_VISIBLE
1021#endif
1022
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001023
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001024/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001025int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001026/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001027int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1028int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1029int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1030int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001031/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001032int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001033/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001034int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1035/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001036int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001037int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001038
Denis Vlasenko468aea22008-04-01 14:47:57 +00001039#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001040void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001041#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001042
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001043
1044/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001045int create_icmp_socket(void) FAST_FUNC;
1046int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001047/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001048/* This structure defines protocol families and their handlers. */
1049struct aftype {
1050 const char *name;
1051 const char *title;
1052 int af;
1053 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001054 char* FAST_FUNC (*print)(unsigned char *);
1055 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1056 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1057 void FAST_FUNC (*herror)(char *text);
1058 int FAST_FUNC (*rprint)(int options);
1059 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001060 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001061 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001062};
1063/* This structure defines hardware protocols and their handlers. */
1064struct hwtype {
1065 const char *name;
1066 const char *title;
1067 int type;
1068 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001069 char* FAST_FUNC (*print)(unsigned char *);
1070 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1071 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001072 int suppress_null_addr;
1073};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001074extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001075int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001076#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001077int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001078#else
1079#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001080#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001081const struct aftype *get_aftype(const char *name) FAST_FUNC;
1082const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1083const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001084
1085
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001086#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001087extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001088/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001089extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001090extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001091#endif
1092
Mike Frysinger9412ec72008-02-07 22:41:33 +00001093#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001094extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001095extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001096#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001097extern void erase_mtab(const char * name) FAST_FUNC;
1098extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1099extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001100#if ENABLE_DESKTOP
1101extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1102#else
1103# define bb_warn_ignoring_args(arg) ((void)0)
1104#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001105
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001106extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001107
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001108extern char *query_loop(const char *device) FAST_FUNC;
1109extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001110/* If *devname is not NULL, use that name, otherwise try to find free one,
1111 * malloc and return it in *devname.
1112 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001113extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001114
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001115/* Like bb_ask below, but asks on stdin with no timeout. */
1116char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001117//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001118char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001119int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001120
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001121int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001122
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001123/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001124 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001125 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001126enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001127 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1128 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1129// TODO: COLLAPSE and TRIM seem to always go in pair
1130 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1131 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001132 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001133 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001134// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1135 // NORMAL is:
1136 // * remove leading and trailing delimiters and collapse
1137 // multiple delimiters into one
1138 // * warn and continue if less than mintokens delimiters found
1139 // * grab everything into last token
1140 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001141};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001142typedef struct parser_t {
1143 FILE *fp;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001144 char *line;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001145 char *data;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001146 int lineno;
1147} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001148parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001149parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001150/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001151int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1152#define config_read(parser, tokens, max, min, str, flags) \
1153 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001154void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001155
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001156/* Concatenate path and filename to new allocated buffer.
1157 * Add "/" only as needed (no duplicate "//" are produced).
1158 * If path is NULL, it is assumed to be "/".
1159 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001160char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1161char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1162const char *bb_basename(const char *name) FAST_FUNC;
Denis Vlasenko7e84e532007-05-08 17:52:17 +00001163/* NB: can violate const-ness (similarly to strchr) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001164char *last_char_is(const char *s, int c) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001165
Denis Vlasenko4921b542007-02-03 02:17:41 +00001166
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001167int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001168
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001169int get_signum(const char *name) FAST_FUNC;
1170const char *get_signame(int number) FAST_FUNC;
1171void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001172
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001173char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001174/* Returns ptr to NUL */
1175char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001176
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001177#define FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001178extern void bb_do_delay(int seconds) FAST_FUNC;
1179extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001180extern 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 +00001181#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001182extern void renew_current_security_context(void) FAST_FUNC;
1183extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001184extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001185 char *user, char *role, char *type, char *range) FAST_FUNC;
1186extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1187extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001188#else
1189#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001190#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001191extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001192
1193/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001194 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001195 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001196 * TERM=(old value)
1197 * USER=pw->pw_name, LOGNAME=pw->pw_name
1198 * PATH=bb_default_[root_]path
1199 * HOME=pw->pw_dir
1200 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001201 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001202 * if not root (if pw->pw_uid != 0):
1203 * USER=pw->pw_name, LOGNAME=pw->pw_name
1204 * HOME=pw->pw_dir
1205 * SHELL=shell
1206 * else does nothing
1207 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001208#define SETUP_ENV_CHANGEENV (1 << 0)
1209#define SETUP_ENV_CLEARENV (1 << 1)
1210#define SETUP_ENV_TO_TMP (1 << 2)
1211extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001212extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001213/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001214#if !ENABLE_USE_BB_CRYPT
1215#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1216#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001217extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1218extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001219/* rnd is additional random input. New one is returned.
1220 * Useful if you call crypt_make_salt many times in a row:
1221 * rnd = crypt_make_salt(buf1, 4, 0);
1222 * rnd = crypt_make_salt(buf2, 4, rnd);
1223 * rnd = crypt_make_salt(buf3, 4, rnd);
1224 * (otherwise we risk having same salt generated)
1225 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001226extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001227
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001228/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001229#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1230#define update_passwd(filename, username, data, member) \
1231 update_passwd(filename, username, data)
1232#endif
1233extern int update_passwd(const char *filename,
1234 const char *username,
1235 const char *data,
1236 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001237
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001238int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1239int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1240int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1241int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1242const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001243
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001244extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1245extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001246
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001247char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001248/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001249int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001250
Denis Vlasenko202ac502008-11-05 13:20:58 +00001251int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1252
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001253/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001254int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1255int 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 +00001256#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001257int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1258int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001259#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1260#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1261#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001262int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1263int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001264#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1265#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1266#endif
1267
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001268char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1269void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1270void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001271#ifdef __GLIBC__
1272/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001273unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001274#undef makedev
1275#define makedev(a,b) bb_makedev(a,b)
1276#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001277
1278
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001279/* "Keycodes" that report an escape sequence.
1280 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001281 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001282 * Also, -1 is reserved for error indication and we don't use it. */
1283enum {
1284 KEYCODE_UP = -2,
1285 KEYCODE_DOWN = -3,
1286 KEYCODE_RIGHT = -4,
1287 KEYCODE_LEFT = -5,
1288 KEYCODE_HOME = -6,
1289 KEYCODE_END = -7,
1290 KEYCODE_INSERT = -8,
1291 KEYCODE_DELETE = -9,
1292 KEYCODE_PAGEUP = -10,
1293 KEYCODE_PAGEDOWN = -11,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001294
1295 KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1296 KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1297 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1298 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001299#if 0
1300 KEYCODE_FUN1 = -12,
1301 KEYCODE_FUN2 = -13,
1302 KEYCODE_FUN3 = -14,
1303 KEYCODE_FUN4 = -15,
1304 KEYCODE_FUN5 = -16,
1305 KEYCODE_FUN6 = -17,
1306 KEYCODE_FUN7 = -18,
1307 KEYCODE_FUN8 = -19,
1308 KEYCODE_FUN9 = -20,
1309 KEYCODE_FUN10 = -21,
1310 KEYCODE_FUN11 = -22,
1311 KEYCODE_FUN12 = -23,
1312#endif
Denys Vlasenko180f5852009-10-26 00:59:59 +01001313 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001314 /* How long is the longest ESC sequence we know?
1315 * We want it big enough to be able to contain
1316 * cursor position sequence "ESC [ 9999 ; 9999 R"
1317 */
1318 KEYCODE_BUFFER_SIZE = 16
1319};
1320/* Note: fd may be in blocking or non-blocking mode, both make sense.
1321 * For one, less uses non-blocking mode.
1322 * Only the first read syscall inside read_key may block indefinitely
1323 * (unless fd is in non-blocking mode),
1324 * subsequent reads will time out after a few milliseconds.
1325 * Return of -1 means EOF or error (errno == 0 on EOF).
1326 * buffer[0] is used as a counter of buffered chars and must be 0
1327 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001328 * timeout:
1329 * -2: do not poll for input;
1330 * -1: poll(-1) (i.e. block);
1331 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001332 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001333int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001334void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001335
1336
Denis Vlasenko38f63192007-01-22 09:03:07 +00001337#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001338/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001339# ifdef CONFIG_FEATURE_EDITING_HISTORY
1340# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1341# else
1342# define MAX_HISTORY 0
1343# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001344typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001345 int flags;
1346 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001347# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001348 int cnt_history;
1349 int cur_history;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001350# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001351 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001352 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001353# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001354 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001355# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001356} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001357enum {
1358 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001359 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1360 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1361 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1362 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001363 WITH_PATH_LOOKUP = 0x20,
1364 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1365};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001366line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001367/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1368/* maxsize must be >= 2.
1369 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001370 * -1 on read errors or EOF, or on bare Ctrl-D,
1371 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001372 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001373 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001374int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001375#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001376#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001377int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001378#define read_line_input(prompt, command, maxsize, state) \
1379 read_line_input(prompt, command, maxsize)
1380#endif
1381
1382
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001383#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001384# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001385enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001386# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001387/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001388enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001389# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001390#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001391
1392struct smaprec {
1393 unsigned long mapped_rw;
1394 unsigned long mapped_ro;
1395 unsigned long shared_clean;
1396 unsigned long shared_dirty;
1397 unsigned long private_clean;
1398 unsigned long private_dirty;
1399 unsigned long stack;
1400 unsigned long smap_pss, smap_swap;
1401 unsigned long smap_size;
1402 unsigned long smap_start;
1403 char smap_mode[5];
1404 char *smap_name;
1405};
1406
1407#if !ENABLE_PMAP
1408#define procps_read_smaps(pid, total, cb, data) \
1409 procps_read_smaps(pid, total)
1410#endif
1411int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1412 void (*cb)(struct smaprec *, void *), void *data);
1413
Denis Vlasenko512499c2007-08-26 18:23:13 +00001414typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001415 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001416 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001417 uint8_t shift_pages_to_bytes;
1418 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001419/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001420 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001421 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001422 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001423 IF_SELINUX(char *context;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001424 /* Everything below must contain no ptrs to malloc'ed data:
1425 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001426 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001427 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001428 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001429 unsigned pid;
1430 unsigned ppid;
1431 unsigned pgid;
1432 unsigned sid;
1433 unsigned uid;
1434 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001435#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1436 unsigned ruid;
1437 unsigned rgid;
1438 int niceness;
1439#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001440 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001441#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001442 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001443#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001444 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001445 /* basename of executable in exec(2), read from /proc/N/stat
1446 * (if executable is symlink or script, it is NOT replaced
1447 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001448 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001449 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001450#if ENABLE_FEATURE_TOP_SMP_PROCESS
1451 int last_seen_on_cpu;
1452#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001453} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001454/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001455enum {
1456 PSSCAN_PID = 1 << 0,
1457 PSSCAN_PPID = 1 << 1,
1458 PSSCAN_PGID = 1 << 2,
1459 PSSCAN_SID = 1 << 3,
1460 PSSCAN_UIDGID = 1 << 4,
1461 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001462 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001463 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001464 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001465 PSSCAN_STATE = 1 << 9,
1466 PSSCAN_VSZ = 1 << 10,
1467 PSSCAN_RSS = 1 << 11,
1468 PSSCAN_STIME = 1 << 12,
1469 PSSCAN_UTIME = 1 << 13,
1470 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001471 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001472 /* NB: used by find_pid_by_name(). Any applet using it
1473 * needs to be mentioned here. */
1474 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1475 || ENABLE_PGREP || ENABLE_PKILL
1476 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001477 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001478 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001479 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001480 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001481 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1482 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1483 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001484 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001485 /* These are all retrieved from proc/NN/stat in one go: */
1486 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001487 /**/ | PSSCAN_COMM | PSSCAN_STATE
1488 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1489 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001490 /**/ | PSSCAN_TTY | PSSCAN_NICE
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001491 /**/ | PSSCAN_CPU
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001492};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001493//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1494void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1495procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001496/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001497/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001498void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001499pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1500pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001501int starts_with_cpu(const char *str) FAST_FUNC;
1502unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001503
1504
1505extern const char bb_uuenc_tbl_base64[];
1506extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001507void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001508
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001509typedef struct sha1_ctx_t {
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001510 uint32_t hash[8]; /* 5, +3 elements for sha256 */
Denis Vlasenko98c87f72009-03-11 21:15:51 +00001511 uint64_t total64;
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001512 uint8_t wbuffer[64]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko8ec8d5e2009-03-15 02:56:00 +00001513 void (*process_block)(struct sha1_ctx_t*) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001514} sha1_ctx_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001515void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1516void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001517void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001518typedef struct sha1_ctx_t sha256_ctx_t;
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001519void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001520#define sha256_hash sha1_hash
1521#define sha256_end sha1_end
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001522typedef struct sha512_ctx_t {
Denis Vlasenkocd2cd312009-03-12 15:40:27 +00001523 uint64_t hash[8];
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001524 uint64_t total64[2];
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001525 uint8_t wbuffer[128]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001526} sha512_ctx_t;
1527void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1528void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001529void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1530#if 1
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001531typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001532 uint32_t A;
1533 uint32_t B;
1534 uint32_t C;
1535 uint32_t D;
1536 uint64_t total;
1537 uint32_t buflen;
1538 char buffer[128];
1539} md5_ctx_t;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001540#else
1541/* libbb/md5prime.c uses a bit different one: */
1542typedef struct md5_ctx_t {
1543 uint32_t state[4]; /* state (ABCD) */
1544 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1545 unsigned char buffer[64]; /* input buffer */
1546} md5_ctx_t;
1547#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001548void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1549void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001550void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1551
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001552
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001553uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1554
1555typedef struct masks_labels_t {
1556 const char *labels;
1557 const int masks[];
1558} masks_labels_t;
1559int print_flags_separated(const int *masks, const char *labels,
1560 int flags, const char *separator) FAST_FUNC;
1561int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001562
Magnus Dammf5914992009-11-08 16:34:43 +01001563typedef struct bb_progress_t {
1564 off_t lastsize;
1565 unsigned lastupdate_sec;
1566 unsigned start_sec;
Denys Vlasenkocbcc1232010-03-05 23:38:54 +01001567 smallint inited;
Magnus Dammf5914992009-11-08 16:34:43 +01001568} bb_progress_t;
1569
1570void bb_progress_init(bb_progress_t *p) FAST_FUNC;
1571void bb_progress_update(bb_progress_t *p, const char *curfile,
1572 off_t beg_range, off_t transferred,
1573 off_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001574
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001575extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001576
1577/* Some older linkers don't perform string merging, we used to have common strings
1578 * as global arrays to do it by hand. But:
1579 * (1) newer linkers do it themselves,
1580 * (2) however, they DONT merge string constants with global arrays,
1581 * even if the value is the same (!). Thus global arrays actually
1582 * increased size a bit: for example, "/etc/passwd" string from libc
1583 * wasn't merged with bb_path_passwd_file[] array!
1584 * Therefore now we use #defines.
1585 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001586/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001587extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001588extern const char bb_msg_memory_exhausted[];
1589extern const char bb_msg_invalid_date[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001590#define bb_msg_read_error "read error"
1591#define bb_msg_write_error "write error"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001592extern const char bb_msg_unknown[];
1593extern const char bb_msg_can_not_create_raw_socket[];
1594extern const char bb_msg_perm_denied_are_you_root[];
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01001595extern const char bb_msg_you_must_be_root[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001596extern const char bb_msg_requires_arg[];
1597extern const char bb_msg_invalid_arg[];
1598extern const char bb_msg_standard_input[];
1599extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001600
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001601/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001602extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001603
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001604extern const char bb_path_wtmp_file[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001605
1606/* Busybox mount uses either /proc/mounts or /etc/mtab to
1607 * get the list of currently mounted filesystems */
1608#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1609
1610#define bb_path_passwd_file "/etc/passwd"
1611#define bb_path_shadow_file "/etc/shadow"
1612#define bb_path_gshadow_file "/etc/gshadow"
1613#define bb_path_group_file "/etc/group"
1614
1615#define bb_path_motd_file "/etc/motd"
1616
1617#define bb_dev_null "/dev/null"
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001618extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001619/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1620 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001621extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1622#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1623#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001624
Denis Vlasenko703e2022007-01-22 14:12:08 +00001625extern const int const_int_0;
1626extern const int const_int_1;
1627
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001628
Denis Vlasenko85818632007-04-19 14:47:11 +00001629/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001630enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1631extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001632/* This struct is deliberately not defined. */
1633/* See docs/keep_data_small.txt */
1634struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001635/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001636 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001637 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001638extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001639/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001640#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001641#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001642 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001643 barrier(); \
1644} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001645
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001646/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1647 * use bb_default_login_shell and following defines.
1648 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1649 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001650#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001651extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001652/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001653#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001654/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001655#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001656
Jeremie Koenig816ed972010-05-27 15:46:29 +02001657/* The following devices are the same on all systems. */
1658#define CURRENT_TTY "/dev/tty"
1659#define DEV_CONSOLE "/dev/console"
1660
1661#if defined(__FreeBSD_kernel__)
1662# define CURRENT_VC CURRENT_TTY
1663# define VC_1 "/dev/ttyv0"
1664# define VC_2 "/dev/ttyv1"
1665# define VC_3 "/dev/ttyv2"
1666# define VC_4 "/dev/ttyv3"
1667# define VC_5 "/dev/ttyv4"
1668# define VC_FORMAT "/dev/ttyv%d"
1669#elif defined(__GNU__)
1670# define CURRENT_VC CURRENT_TTY
1671# define VC_1 "/dev/tty1"
1672# define VC_2 "/dev/tty2"
1673# define VC_3 "/dev/tty3"
1674# define VC_4 "/dev/tty4"
1675# define VC_5 "/dev/tty5"
1676# define VC_FORMAT "/dev/tty%d"
1677#elif ENABLE_FEATURE_DEVFS /* from now on, assume Linux naming */
Matt Kraai439e3df2001-07-23 14:52:08 +00001678# define CURRENT_VC "/dev/vc/0"
1679# define VC_1 "/dev/vc/1"
1680# define VC_2 "/dev/vc/2"
1681# define VC_3 "/dev/vc/3"
1682# define VC_4 "/dev/vc/4"
1683# define VC_5 "/dev/vc/5"
Lauri Kasanen7c1b2b52010-07-04 00:04:03 +02001684# if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
Eric Andersen592ebd52003-07-22 07:33:14 +00001685/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1686 respective serial ports .. as such, we can't use the common device paths for
1687 these. -- PFM */
1688# define SC_0 "/dev/ttsc/0"
1689# define SC_1 "/dev/ttsc/1"
1690# define SC_FORMAT "/dev/ttsc/%d"
Lauri Kasanen7c1b2b52010-07-04 00:04:03 +02001691# else
Eric Andersen592ebd52003-07-22 07:33:14 +00001692# define SC_0 "/dev/tts/0"
1693# define SC_1 "/dev/tts/1"
1694# define SC_FORMAT "/dev/tts/%d"
Lauri Kasanen7c1b2b52010-07-04 00:04:03 +02001695# endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001696# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001697# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001698# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001699# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001700# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001701#else
1702# define CURRENT_VC "/dev/tty0"
1703# define VC_1 "/dev/tty1"
1704# define VC_2 "/dev/tty2"
1705# define VC_3 "/dev/tty3"
1706# define VC_4 "/dev/tty4"
1707# define VC_5 "/dev/tty5"
Lauri Kasanen7c1b2b52010-07-04 00:04:03 +02001708# if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
Eric Andersen592ebd52003-07-22 07:33:14 +00001709# define SC_0 "/dev/ttySC0"
1710# define SC_1 "/dev/ttySC1"
1711# define SC_FORMAT "/dev/ttySC%d"
Lauri Kasanen7c1b2b52010-07-04 00:04:03 +02001712# else
Eric Andersen592ebd52003-07-22 07:33:14 +00001713# define SC_0 "/dev/ttyS0"
1714# define SC_1 "/dev/ttyS1"
1715# define SC_FORMAT "/dev/ttyS%d"
Lauri Kasanen7c1b2b52010-07-04 00:04:03 +02001716# endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001717# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001718# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001719# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001720# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001721# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001722#endif
1723
Rob Landleyc57ec372006-04-10 17:07:15 +00001724
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001725#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1726
Rob Landleyb623a542006-05-31 22:09:03 +00001727
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001728/* We redefine ctype macros. Unicode-correct handling of char types
1729 * can't be done with such byte-oriented operations anyway,
1730 * we don't lose anything.
1731 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001732#undef isalnum
1733#undef isalpha
1734#undef isascii
1735#undef isblank
1736#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001737#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001738#undef isgraph
1739#undef islower
1740#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001741#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001742#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001743#undef isupper
1744#undef isxdigit
1745#undef toupper
1746#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001747
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001748/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001749 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001750
1751/* These work the same for ASCII and Unicode,
1752 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001753#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001754#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001755#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1756#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001757#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001758#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1759#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001760/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001761 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001762 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001763#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001764// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1765#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1766// 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 +02001767#define isalnum(a) bb_ascii_isalnum(a)
1768static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1769{
1770 unsigned char b = a - '0';
1771 if (b <= 9)
1772 return (b <= 9);
1773 b = (a|0x20) - 'a';
1774 return b <= 'z' - 'a';
1775}
1776#define isxdigit(a) bb_ascii_isxdigit(a)
1777static ALWAYS_INLINE int bb_ascii_isxdigit(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 <= 'f' - 'a';
1784}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001785#define toupper(a) bb_ascii_toupper(a)
1786static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1787{
1788 unsigned char b = a - 'a';
1789 if (b <= ('z' - 'a'))
1790 a -= 'a' - 'A';
1791 return a;
1792}
1793#define tolower(a) bb_ascii_tolower(a)
1794static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1795{
1796 unsigned char b = a - 'A';
1797 if (b <= ('Z' - 'A'))
1798 a += 'a' - 'A';
1799 return a;
1800}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001801
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001802/* In ASCII and Unicode, these are likely to be very different.
1803 * Let's prevent ambiguous usage from the start */
1804#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1805#define isprint(a) isprint_is_ambiguous_dont_use(a)
1806/* NB: must not treat EOF as isgraph or isprint */
1807#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1808#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1809
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001810
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001811POP_SAVED_FUNCTION_VISIBILITY
1812
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001813#endif