blob: 09e8d28e721954df473dc9217e54f810bc748c2a [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 Vlasenko89f5bfd2011-05-12 23:03:18 +020023#if defined __UCLIBC__ /* TODO: and glibc? */
24/* use inlined versions of these: */
25# define sigfillset(s) __sigfillset(s)
26# define sigemptyset(s) __sigemptyset(s)
27# define sigisemptyset(s) __sigisemptyset(s)
28#endif
Denys Vlasenko5b9b1362010-02-02 03:08:57 +010029#include <stdint.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000030#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000031#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000032#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000033#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000034#include <string.h>
Denys Vlasenkod48fdde2011-09-10 13:48:34 +020035/* There are two incompatible basename's, let not use them! */
36/* See the dirname/basename man page for details */
37#include <libgen.h> /* dirname,basename */
38#undef basename
39#define basename dont_use_basename
Denis Vlasenkob308d812007-08-28 19:35:34 +000040#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000041#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000042#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000043#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000044#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000045#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000046#include <sys/types.h>
Denys Vlasenkodd807c12011-02-07 14:58:57 +010047#ifndef major
48# include <sys/sysmacros.h>
49#endif
Rob Landleyc9c1a412006-07-12 19:17:55 +000050#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000051#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000052#include <time.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000053#include <sys/param.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000054#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020055# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000056#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000057#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020058# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000059#endif
Denys Vlasenko67905e22011-07-26 13:42:12 +020060/* Don't do this here:
61 * #include <sys/sysinfo.h>
62 * Some linux/ includes pull in conflicting definition
63 * of struct sysinfo (only in some toolchanins), which breaks build.
64 * Include sys/sysinfo.h only in those files which need it.
65 */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000066#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020067# include <selinux/selinux.h>
68# include <selinux/context.h>
69# include <selinux/flask.h>
70# include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000071#endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +010072#if ENABLE_FEATURE_UTMP
73# include <utmp.h>
74#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000075#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +020076# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000077#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +020078# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000079#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000080#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +020081# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000082#endif
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000083#include <pwd.h>
84#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000085#if ENABLE_FEATURE_SHADOWPASSWDS
Mike Frysinger52a42672009-07-09 01:33:20 -040086# if !ENABLE_USE_BB_SHADOW
87/* If using busybox's shadow implementation, do not include the shadow.h
88 * header as the toolchain may not provide it at all.
89 */
90# include <shadow.h>
91# endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000092#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +010093/* Just in case libc doesn't define some of these... */
94#ifndef _PATH_PASSWD
95#define _PATH_PASSWD "/etc/passwd"
96#endif
97#ifndef _PATH_GROUP
98#define _PATH_GROUP "/etc/group"
99#endif
100#ifndef _PATH_SHADOW
101#define _PATH_SHADOW "/etc/shadow"
102#endif
103#ifndef _PATH_GSHADOW
104#define _PATH_GSHADOW "/etc/gshadow"
105#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200106#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100107# include <netinet/in.h>
108# include <arpa/inet.h>
109#elif defined __APPLE__
110# include <netinet/in.h>
111#else
112# include <arpa/inet.h>
113# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
114/* We #define socklen_t *after* includes, otherwise we get
115 * typedef redefinition errors from system headers
116 * (in case "is it defined already" detection above failed)
117 */
118# define socklen_t bb_socklen_t
119 typedef unsigned socklen_t;
120# endif
121#endif
Chris Rees330718e2011-01-24 17:07:06 +0100122#ifndef HAVE_CLEARENV
123# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
124#endif
125#ifndef HAVE_FDATASYNC
126# define fdatasync fsync
127#endif
128#ifndef HAVE_XTABS
129# define XTABS TAB3
130#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100131
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000132
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000133/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000134
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000135extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000136#if defined(__GLIBC__) && __GLIBC__ < 2
137int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +0000138#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000139/* klogctl is in libc's klog.h, but we cheat and not #include that */
140int klogctl(int type, char *b, int len);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100141#ifndef PATH_MAX
142# define PATH_MAX 256
143#endif
144#ifndef BUFSIZ
145# define BUFSIZ 4096
146#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000147
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000148
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200149/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200150#ifdef HAVE_UNLOCKED_STDIO
151# undef getc
152# define getc(stream) getc_unlocked(stream)
153# undef getchar
154# define getchar() getchar_unlocked()
155# undef putc
156# define putc(c, stream) putc_unlocked(c, stream)
157# undef putchar
158# define putchar(c) putchar_unlocked(c)
159# undef fgetc
160# define fgetc(stream) getc_unlocked(stream)
161# undef fputc
162# define fputc(c, stream) putc_unlocked(c, stream)
163#endif
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200164/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200165#ifdef HAVE_UNLOCKED_LINE_OPS
166# undef fgets
167# define fgets(s, n, stream) fgets_unlocked(s, n, stream)
168# undef fputs
169# define fputs(s, stream) fputs_unlocked(s, stream)
170#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200171
172
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000173/* Make all declarations hidden (-fvisibility flag only affects definitions) */
174/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000175PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000176
177
178#if ENABLE_USE_BB_PWD_GRP
179# include "pwd_.h"
180# include "grp_.h"
181#endif
182#if ENABLE_FEATURE_SHADOWPASSWDS
183# if ENABLE_USE_BB_SHADOW
184# include "shadow_.h"
185# endif
186#endif
187
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000188/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000189#define MAXINT(T) (T)( \
190 ((T)-1) > 0 \
191 ? (T)-1 \
192 : (T)~((T)1 << (sizeof(T)*8-1)) \
193 )
194
195#define MININT(T) (T)( \
196 ((T)-1) > 0 \
197 ? (T)0 \
198 : ((T)1 << (sizeof(T)*8-1)) \
199 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000200
Denis Vlasenko56254152006-10-07 16:24:46 +0000201/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000202/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000203 * (stat, lseek etc) mapped to "largefile" variants by libc.
204 * Practically it means that open() automatically has O_LARGEFILE added
205 * and all filesize/file_offset parameters and struct members are "large"
206 * (in today's world - signed 64bit). For full support of large files,
207 * we need a few helper #defines (below) and careful use of off_t
208 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000209#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000210/* CONFIG_LFS is on */
211# if ULONG_MAX > 0xffffffff
212/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000213typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000214# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000215/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
216# define BB_STRTOOFF bb_strtoul
217# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000218/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
219# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000220# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000221/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000222typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000223# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000224# define BB_STRTOOFF bb_strtoull
225# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000226# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000227# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000228#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000229/* CONFIG_LFS is off */
230# if UINT_MAX == 0xffffffff
231/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
232 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000233typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200234# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000235# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000236# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000237# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000238# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000239typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000240# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
241# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000242# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000243# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000244# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000245#endif
246/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000247#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000248
Eric Andersenaad1a882001-03-16 22:47:14 +0000249/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000250#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000251#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000252#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000253#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000254#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000255#define SKIP ((int) 2)
256
Eric Andersenaad1a882001-03-16 22:47:14 +0000257/* Macros for min/max. */
258#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200259#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000260#endif
261
262#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200263#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000264#endif
265
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000266/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000267#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000268#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000269#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
270#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
271#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000272#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000273#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
274#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
275#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
276#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000277#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
278#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
279#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000280#endif
281#endif
282
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000283#if defined(__GLIBC__)
284/* glibc uses __errno_location() to get a ptr to errno */
285/* We can just memorize it once - no multithreading in busybox :) */
286extern int *const bb_errno;
287#undef errno
288#define errno (*bb_errno)
289#endif
290
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200291#if !(ULONG_MAX > 0xffffffff)
292/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
293uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
294#endif
295
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000296unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000297unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100298unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000299unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000300
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000301extern void chomp(char *s) FAST_FUNC;
302extern void trim(char *s) FAST_FUNC;
303extern char *skip_whitespace(const char *) FAST_FUNC;
304extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200305extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
306
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000307extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000308
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000309//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000310extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
311extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000312enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100313 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
314 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
315 FILEUTILS_RECUR = 1 << 2, /* -R */
316 FILEUTILS_FORCE = 1 << 3, /* -f */
317 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
318 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
319 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
320 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
321 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000322#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100323 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
324 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000325#endif
326};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100327#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000328extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000329/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
330 * the source, not copy (unless "source" is a directory).
331 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
332 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000333extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000334
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000335enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000336 ACTION_RECURSE = (1 << 0),
337 ACTION_FOLLOWLINKS = (1 << 1),
338 ACTION_FOLLOWLINKS_L0 = (1 << 2),
339 ACTION_DEPTHFIRST = (1 << 3),
340 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000341 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200342 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000343};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200344typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000345extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000346 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
347 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
348 void* userData, unsigned depth) FAST_FUNC;
349extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000350enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000351extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000352extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000353extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
354extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000355/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000356extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
357extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
358extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000359/* "short" copy can be detected by return value < size */
360/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000361extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200362
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000363extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200364char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000365/* xxxx_strip version can modify its parameter:
366 * "/" -> "/"
367 * "abc" -> "abc"
368 * "abc/def" -> "def"
369 * "abc/def/" -> "def" !!
370 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200371char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000372/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200373char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
374/* Simpler version: does not special case "/" string */
375const char *bb_basename(const char *name) FAST_FUNC;
376/* NB: can violate const-ness (similarly to strchr) */
377char *last_char_is(const char *s, int c) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000378
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100379void ndelay_on(int fd) FAST_FUNC;
380void ndelay_off(int fd) FAST_FUNC;
381void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000382void xdup2(int, int) FAST_FUNC;
383void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000384
385
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000386DIR *xopendir(const char *path) FAST_FUNC;
387DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000388
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100389char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100390char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
391char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100392/* !RETURNS_MALLOC: it's a realloc-like function */
393char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000394
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100395char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000396
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000397
Denis Vlasenko33196372008-02-23 01:25:38 +0000398enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000399 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000400 * otherwise would kill us, except for those resulting from bugs:
401 * SIGSEGV, SIGILL, SIGFPE.
402 * Other fatal signals not included (TODO?):
403 * SIGBUS Bus error (bad memory access)
404 * SIGPOLL Pollable event. Synonym of SIGIO
405 * SIGPROF Profiling timer expired
406 * SIGSYS Bad argument to routine
407 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000408 *
409 * The only known arch with some of these sigs not fitting
410 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
411 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000412 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000413 BB_FATAL_SIGS = (int)(0
414 + (1LL << SIGHUP)
415 + (1LL << SIGINT)
416 + (1LL << SIGTERM)
417 + (1LL << SIGPIPE) // Write to pipe with no readers
418 + (1LL << SIGQUIT) // Quit from keyboard
419 + (1LL << SIGABRT) // Abort signal from abort(3)
420 + (1LL << SIGALRM) // Timer signal from alarm(2)
421 + (1LL << SIGVTALRM) // Virtual alarm clock
422 + (1LL << SIGXCPU) // CPU time limit exceeded
423 + (1LL << SIGXFSZ) // File size limit exceeded
424 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
425 + (1LL << SIGUSR2)
426 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000427};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000428void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000429/* Unlike signal() and bb_signals, sets handler with sigaction()
430 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000431 * will be blocked; syscalls will not be restarted: */
432void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000433/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000434void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000435/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000436void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
437void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000438void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000439void sig_block(int sig) FAST_FUNC;
440void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000441/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000442int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000443/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000444int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000445/* Standard handler which just records signo */
446extern smallint bb_got_signal;
447void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000448
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000449
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000450void xsetgid(gid_t gid) FAST_FUNC;
451void xsetuid(uid_t uid) FAST_FUNC;
452void xchdir(const char *path) FAST_FUNC;
453void xchroot(const char *path) FAST_FUNC;
454void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000455void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200456void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000457void xunlink(const char *pathname) FAST_FUNC;
458void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200459void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200460int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100461int xopen_nonblocking(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000462int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
463int open_or_warn(const char *pathname, int flags) FAST_FUNC;
464int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
465int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200466int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000467void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
468int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
469off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200470int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000471off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000472
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100473uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
474 const char *override,
475 unsigned override_units,
476 int extend);
477
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000478void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000479/* In this form code with pipes is much more readable */
480struct fd_pair { int rd; int wr; };
481#define piped_pair(pair) pipe(&((pair).rd))
482#define xpiped_pair(pair) xpipe(&((pair).rd))
483
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000484/* Useful for having small structure members/global variables */
485typedef int8_t socktype_t;
486typedef int8_t family_t;
487struct BUG_too_small {
488 char BUG_socktype_t_too_small[(0
489 | SOCK_STREAM
490 | SOCK_DGRAM
491 | SOCK_RDM
492 | SOCK_SEQPACKET
493 | SOCK_RAW
494 ) <= 127 ? 1 : -1];
495 char BUG_family_t_too_small[(0
496 | AF_UNSPEC
497 | AF_INET
498 | AF_INET6
499 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000500#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000501 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000502#endif
503#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000504 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000505#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000506 /* | AF_DECnet */
507 /* | AF_IPX */
508 ) <= 127 ? 1 : -1];
509};
510
511
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100512void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
513time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200514
515
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000516int xsocket(int domain, int type, int protocol) FAST_FUNC;
517void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
518void xlisten(int s, int backlog) FAST_FUNC;
519void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000520ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000521 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000522/* SO_REUSEADDR allows a server to rebind to an address that is already
523 * "in use" by old connections to e.g. previous server instance which is
524 * killed or crashed. Without it bind will fail until all such connections
525 * time out. Linux does not allow multiple live binds on same ip:port
526 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
527 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000528void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
529int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000530int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000531/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000532unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000533typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000534 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000535 union {
536 struct sockaddr sa;
537 struct sockaddr_in sin;
538#if ENABLE_FEATURE_IPV6
539 struct sockaddr_in6 sin6;
540#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000541 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000542} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000543enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000544 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000545 LSA_SIZEOF_SA = sizeof(
546 union {
547 struct sockaddr sa;
548 struct sockaddr_in sin;
549#if ENABLE_FEATURE_IPV6
550 struct sockaddr_in6 sin6;
551#endif
552 }
553 )
554};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000555/* Create stream socket, and allocate suitable lsa.
556 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000557 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100558 * and if kernel doesn't support it, fall back to IPv4.
559 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000560 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000561#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000562int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000563#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000564int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000565#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
566#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000567int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000568/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000569 * numeric IP ("N.N.N.N") or numeric IPv6 address,
570 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000571 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000572/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000573int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
574int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000575/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
576 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
577 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
578 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000579int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000580/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000581int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000582/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100583len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200584/* Get remote address of connected or accepted socket */
585len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000586/* Return malloc'ed len_and_sockaddr with socket address of host:port
587 * Currently will return IPv4 or IPv6 sockaddrs only
588 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000589 * UNIX socket address being returned, IPX sockaddr etc...
590 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100591len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000592/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100593len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
594len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000595/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000596#if !ENABLE_FEATURE_IPV6
597#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
598#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
599#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100600len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
601len_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 +0000602#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000603/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000604 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000605 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200606void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000607/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000608int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000609/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100610char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000611/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100612char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000613/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100614char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000615/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100616char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
617char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000618// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000619// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000620struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000621// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000622// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000623
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000624
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000625void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000626ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000627 const struct sockaddr *to,
628 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000629 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000630ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000631 struct sockaddr *from,
632 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000633 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000634
Baruch Siache8f36332011-09-07 17:52:37 +0200635uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100636
637char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
638char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000639void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000640char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000641char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000642/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000643 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000644int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200645/* Note: does not use stdio, writes to fd 2 directly */
646int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100647char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000648// gcc-4.1.1 still isn't good enough at optimizing it
649// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000650//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000651//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000652//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000653//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000654#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000655#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000656#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000657#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000658#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000659
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100660typedef struct uni_stat_t {
661 unsigned byte_count;
662 unsigned unicode_count;
663 unsigned unicode_width;
664} uni_stat_t;
665/* Returns a string with unprintable chars replaced by '?' or
666 * SUBST_WCHAR. This function is unicode-aware. */
667const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
668/* Prints unprintable char ch as ^C or M-c to file
669 * (M-c is used only if ch is ORed with PRINTABLE_META),
670 * else it is printed as-is (except for ch = 0x9b) */
671enum { PRINTABLE_META = 0x100 };
672void fputc_printable(int ch, FILE *file) FAST_FUNC;
673
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000674/* dmalloc will redefine these to it's own implementation. It is safe
675 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100676void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
677void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
678void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000679void *xrealloc(void *old, size_t size) FAST_FUNC;
Denys Vlasenko16714242011-09-21 01:59:15 +0200680/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
Denis Vlasenko27842282008-08-04 13:20:36 +0000681 * at least v[idx] and v[idx+1], for all idx values.
Denys Vlasenko16714242011-09-21 01:59:15 +0200682 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
683 * when all elements are used up. New elements are zeroed out.
684 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
685 * skipping an index is a bad bug - it may miss a realloc!
686 */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000687#define xrealloc_vector(vector, shift, idx) \
688 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
689void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
690
Eric Andersenaad1a882001-03-16 22:47:14 +0000691
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000692extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denys Vlasenko80542ba2011-05-08 21:23:43 +0200693extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count, int loop_on_EINTR) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000694// NB: will return short read on error, not -1,
695// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000696extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
697extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
698extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000699extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
700extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000701// Reads one line a-la fgets (but doesn't save terminating '\n').
702// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000703// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200704extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000705/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100706extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000707/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100708extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100709/* Never returns NULL */
710extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000711/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
712#if ENABLE_FEATURE_SEAMLESS_LZMA \
713 || ENABLE_FEATURE_SEAMLESS_BZ2 \
714 || ENABLE_FEATURE_SEAMLESS_GZ \
715 /* || ENABLE_FEATURE_SEAMLESS_Z */
Denys Vlasenko6948f212010-05-30 04:18:13 +0200716extern void setup_unzip_on_fd(int fd /*, int fail_if_not_detected*/) FAST_FUNC;
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000717#else
718# define setup_unzip_on_fd(...) ((void)0)
719#endif
Denis Vlasenkob6052722008-07-10 17:43:01 +0000720/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000721extern int open_zipped(const char *fname) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100722extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000723
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000724extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000725// NB: will return short write on error, not -1,
726// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000727extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
728extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000729extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200730extern ssize_t full_write1_str(const char *str) FAST_FUNC;
731extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000732extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000733
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200734/* Close fd, but check for failures (some types of write errors) */
735extern void xclose(int fd) FAST_FUNC;
736
Denis Vlasenko1de08302006-10-26 23:32:43 +0000737/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000738extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000739
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200740/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
741 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
742 * end of line. If end isn't NULL, length of the chunk is stored in it.
743 * Returns NULL if EOF/error.
744 */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000745extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000746/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100747extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000748/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100749extern 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 +0000750/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100751extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000752/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100753extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000754/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100755extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000756/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100757/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000758
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100759void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
760void die_if_ferror_stdout(void) FAST_FUNC;
761int fflush_all(void) FAST_FUNC;
762void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
763int fclose_if_not_stdin(FILE *file) FAST_FUNC;
764FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000765/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100766FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000767/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100768FILE* xfopen_stdin(const char *filename) FAST_FUNC;
769FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
770FILE* fopen_for_read(const char *path) FAST_FUNC;
771FILE* xfopen_for_read(const char *path) FAST_FUNC;
772FILE* fopen_for_write(const char *path) FAST_FUNC;
773FILE* xfopen_for_write(const char *path) FAST_FUNC;
774FILE* xfdopen_for_read(int fd) FAST_FUNC;
775FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000776
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000777int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
778void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000779
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000780/* Wrapper which restarts poll on EINTR or ENOMEM.
781 * On other errors complains [perror("poll")] and returns.
782 * Warning! May take (much) longer than timeout_ms to return!
783 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000784int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000785
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000786char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000787char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000788
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000789/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000790char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000791
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000792char *utoa(unsigned n) FAST_FUNC;
793char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000794/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000795char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
796char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000797/* Intelligent formatters of bignums */
Kevin Cernekeeccb07042010-10-25 02:00:24 +0200798void smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000799void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200800/* If block_size == 0, display size without fractional part,
801 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100802 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200803 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100804#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
805#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000806//TODO: provide pointer to buf (avoid statics)?
807const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000808 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000809/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200810char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200811/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200812char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000813
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200814/* Generate a UUID */
815void generate_uuid(uint8_t *buf) FAST_FUNC;
816
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000817/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000818struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000819 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000820 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000821};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000822#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000823/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200824
Denis Vlasenko13858992006-10-08 12:49:22 +0000825/* Using xatoi() instead of naive atoi() is not always convenient -
826 * in many places people want *non-negative* values, but store them
827 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200828 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
829 * It should really be named xatoi_nonnegative (since it allows 0),
830 * but that would be too long.
831 */
832int xatoi_positive(const char *numstr) FAST_FUNC;
833
Denis Vlasenko13858992006-10-08 12:49:22 +0000834/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000835uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000836
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000837
Eric Andersenaad1a882001-03-16 22:47:14 +0000838/* These parse entries in /etc/passwd and /etc/group. This is desirable
839 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000840 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000841long xuname2uid(const char *name) FAST_FUNC;
842long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000843/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000844unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000845/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000846struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000847 uid_t uid;
848 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000849};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000850/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000851int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000852/* always sets uid and gid, allows numeric; exits on failure */
853void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000854/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000855void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000856struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000857struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000858struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
859struct group* xgetgrgid(gid_t gid) FAST_FUNC;
860char* xuid2uname(uid_t uid) FAST_FUNC;
861char* xgid2group(gid_t gid) FAST_FUNC;
862char* uid2uname(uid_t uid) FAST_FUNC;
863char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100864char* uid2uname_utoa(uid_t uid) FAST_FUNC;
865char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000866/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000867const char* get_cached_username(uid_t uid) FAST_FUNC;
868const char* get_cached_groupname(gid_t gid) FAST_FUNC;
869void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000870/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100871enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000872#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000873void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000874#else
875#define die_if_bad_username(name) ((void)(name))
876#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000877
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200878#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200879void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
880void 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 +0200881#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200882# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
883# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200884#endif
885
Denys Vlasenkob72baeb2011-02-02 18:38:57 +0100886
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000887int execable_file(const char *name) FAST_FUNC;
888char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
889int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000890
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000891/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
892 * but it may exec busybox and call applet instead of searching PATH.
893 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000894#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100895int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000896#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100897 do { \
898 if (find_applet_by_name(prog) >= 0) \
899 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
900 execlp(prog, cmd, __VA_ARGS__); \
901 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000902#else
903#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100904#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000905#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200906int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000907
Pascal Bellard926031b2010-07-04 15:32:38 +0200908/* xvfork() can't be a _function_, return after vfork mangles stack
909 * in the parent. It must be a macro. */
910#define xvfork() \
911({ \
912 pid_t bb__xvfork_pid = vfork(); \
913 if (bb__xvfork_pid < 0) \
914 bb_perror_msg_and_die("vfork"); \
915 bb__xvfork_pid; \
916})
917#if BB_MMU
918pid_t xfork(void) FAST_FUNC;
919#endif
920
Denys Vlasenko8531d762010-03-18 22:44:00 +0100921/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000922pid_t spawn(char **argv) FAST_FUNC;
923pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000924
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000925pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100926pid_t wait_any_nohang(int *wstat) FAST_FUNC;
927/* wait4pid: unlike waitpid, waits ONLY for one process.
928 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000929 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000930 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000931 * IOW: rc = wait4pid(spawn(argv));
932 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +0100933 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000934 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000935int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100936/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200937int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000938/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000939int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000940
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000941/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000942 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000943 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000944 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000945 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
946 * rexec's itself on NOMMU with argv passed as command line.
947 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
948 * from the start. (It will detect it and not reexec again second time).
949 * You have to audit carefully that you don't do something twice as a result
950 * (opening files/sockets, parsing config files etc...)!
951 *
952 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
953 * (will do setsid()).
954 *
Pascal Bellard926031b2010-07-04 15:32:38 +0200955 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000956 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000957 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000958 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000959 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000960 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000961 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
962 * to /dev/null if they are not.
963 */
964enum {
965 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000966 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000967 DAEMON_CLOSE_EXTRA_FDS = 4,
968 DAEMON_ONLY_SANITIZE = 8, /* internal use */
Peter Korsgaard743edac2011-11-09 19:44:37 +0100969 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000970};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000971#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +0000972 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +0200973# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000974# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
975# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000976#else
Pascal Bellard926031b2010-07-04 15:32:38 +0200977 extern bool re_execed;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000978 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000979 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000980 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
981 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
982 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000983# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +0200984# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000985# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
986# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000987#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000988void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
989void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000990/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000991int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000992
993
Denys Vlasenkoe992bae2009-11-28 15:18:53 +0100994char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000995extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000996extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200997#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000998#define No_argument "\0"
999#define Required_argument "\001"
1000#define Optional_argument "\002"
1001extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +00001002#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001003extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001004extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001005
1006
Denys Vlasenko9be47022011-05-16 12:21:31 +02001007/* Having next pointer as a first member allows easy creation
1008 * of "llist-compatible" structs, and using llist_FOO functions
1009 * on them.
1010 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001011typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001012 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001013 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001014} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001015void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1016void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1017void *llist_pop(llist_t **elm) FAST_FUNC;
1018void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1019void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1020llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001021llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001022/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001023 * llist_t *llist_add_to(llist_t *old_head, void *data)
1024 * etc does not result in smaller code... */
1025
Denis Vlasenko80edead2007-08-02 22:31:05 +00001026/* start_stop_daemon and udhcpc are special - they want
1027 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001028#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001029/* True only if we created pidfile which is *file*, not /dev/null etc */
1030extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001031void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001032#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001033#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001034enum { wrote_pidfile = 0 };
1035#define write_pidfile(path) ((void)0)
1036#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001037#endif
1038
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001039enum {
1040 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001041 LOGMODE_STDIO = (1 << 0),
1042 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001043 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1044};
1045extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001046extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001047extern int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001048extern uint8_t xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +00001049extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001050extern void xfunc_die(void) NORETURN FAST_FUNC;
1051extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001052extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1053extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1054extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1055extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1056extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001057extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001058extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1059extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001060extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001061extern void bb_perror_nomsg(void) FAST_FUNC;
1062extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1063extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001064
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001065/* We need to export XXX_main from libbusybox
1066 * only if we build "individual" binaries
1067 */
1068#if ENABLE_FEATURE_INDIVIDUAL
1069#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1070#else
1071#define MAIN_EXTERNALLY_VISIBLE
1072#endif
1073
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001074
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001075/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001076int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001077/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001078int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1079int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1080int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1081int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001082/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001083int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001084/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001085int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1086/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001087int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001088int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001089
Denis Vlasenko468aea22008-04-01 14:47:57 +00001090#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001091void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001092#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001093
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001094
1095/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001096int create_icmp_socket(void) FAST_FUNC;
1097int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001098/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001099/* This structure defines protocol families and their handlers. */
1100struct aftype {
1101 const char *name;
1102 const char *title;
1103 int af;
1104 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001105 char* FAST_FUNC (*print)(unsigned char *);
1106 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1107 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1108 void FAST_FUNC (*herror)(char *text);
1109 int FAST_FUNC (*rprint)(int options);
1110 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001111 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001112 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001113};
1114/* This structure defines hardware protocols and their handlers. */
1115struct hwtype {
1116 const char *name;
1117 const char *title;
1118 int type;
1119 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001120 char* FAST_FUNC (*print)(unsigned char *);
1121 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1122 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001123 int suppress_null_addr;
1124};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001125extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001126int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001127#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001128int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001129#else
1130#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001131#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001132const struct aftype *get_aftype(const char *name) FAST_FUNC;
1133const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1134const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001135
1136
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001137#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001138extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001139/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001140extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001141extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001142#endif
1143
Mike Frysinger9412ec72008-02-07 22:41:33 +00001144#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001145extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001146extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001147#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001148extern void erase_mtab(const char * name) FAST_FUNC;
1149extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1150extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001151#if ENABLE_DESKTOP
1152extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1153#else
1154# define bb_warn_ignoring_args(arg) ((void)0)
1155#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001156
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001157extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001158
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001159extern char *query_loop(const char *device) FAST_FUNC;
1160extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001161/* If *devname is not NULL, use that name, otherwise try to find free one,
1162 * malloc and return it in *devname.
1163 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denys Vlasenko13e709c2011-09-12 02:13:47 +02001164extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001165
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001166/* Like bb_ask below, but asks on stdin with no timeout. */
1167char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001168//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001169char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001170int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001171
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001172int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001173
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001174/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001175 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001176 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001177enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001178 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1179 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1180// TODO: COLLAPSE and TRIM seem to always go in pair
1181 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1182 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001183 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001184 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001185// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1186 // NORMAL is:
1187 // * remove leading and trailing delimiters and collapse
1188 // multiple delimiters into one
1189 // * warn and continue if less than mintokens delimiters found
1190 // * grab everything into last token
1191 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001192};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001193typedef struct parser_t {
1194 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001195 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001196 char *line, *nline;
1197 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001198 int lineno;
1199} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001200parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001201parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001202/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001203int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1204#define config_read(parser, tokens, max, min, str, flags) \
1205 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001206void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001207
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001208/* Concatenate path and filename to new allocated buffer.
1209 * Add "/" only as needed (no duplicate "//" are produced).
1210 * If path is NULL, it is assumed to be "/".
1211 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001212char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001213/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001214char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001215
Denis Vlasenko4921b542007-02-03 02:17:41 +00001216
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001217int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001218
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001219int get_signum(const char *name) FAST_FUNC;
1220const char *get_signame(int number) FAST_FUNC;
1221void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001222
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001223char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001224/* Returns ptr to NUL */
1225char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001226
Denys Vlasenko681efe22011-03-08 21:00:36 +01001227#define LOGIN_FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001228extern void bb_do_delay(int seconds) FAST_FUNC;
1229extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001230extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001231
1232/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1233 * Note that getpwuid result might need xstrdup'ing
1234 * if there is a possibility of intervening getpwxxx() calls.
1235 */
1236const char *get_shell_name(void);
1237
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001238#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001239extern void renew_current_security_context(void) FAST_FUNC;
1240extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001241extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001242 char *user, char *role, char *type, char *range) FAST_FUNC;
1243extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1244extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001245#else
1246#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001247#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001248extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001249
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001250
1251/* systemd support */
1252#define SD_LISTEN_FDS_START 3
1253int sd_listen_fds(void);
1254
1255
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001256/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001257 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001258 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001259 * TERM=(old value)
1260 * USER=pw->pw_name, LOGNAME=pw->pw_name
1261 * PATH=bb_default_[root_]path
1262 * HOME=pw->pw_dir
1263 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001264 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001265 * if not root (if pw->pw_uid != 0):
1266 * USER=pw->pw_name, LOGNAME=pw->pw_name
1267 * HOME=pw->pw_dir
1268 * SHELL=shell
1269 * else does nothing
1270 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001271#define SETUP_ENV_CHANGEENV (1 << 0)
1272#define SETUP_ENV_CLEARENV (1 << 1)
1273#define SETUP_ENV_TO_TMP (1 << 2)
1274extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001275extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001276/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001277#if !ENABLE_USE_BB_CRYPT
1278#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1279#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001280extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1281extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001282/*
1283 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001284 * Useful if you call crypt_make_salt many times in a row:
1285 * rnd = crypt_make_salt(buf1, 4, 0);
1286 * rnd = crypt_make_salt(buf2, 4, rnd);
1287 * rnd = crypt_make_salt(buf3, 4, rnd);
1288 * (otherwise we risk having same salt generated)
1289 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001290extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1291/* "$N$" + sha_salt_16_bytes + NUL */
1292#define MAX_PW_SALT_LEN (3 + 16 + 1)
1293extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1294
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001295
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001296/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001297#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1298#define update_passwd(filename, username, data, member) \
1299 update_passwd(filename, username, data)
1300#endif
1301extern int update_passwd(const char *filename,
1302 const char *username,
1303 const char *data,
1304 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001305
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001306int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1307int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1308int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1309int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1310const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001311
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001312extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1313extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001314
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001315char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001316/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001317int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001318
Denis Vlasenko202ac502008-11-05 13:20:58 +00001319int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1320
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001321/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001322int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1323int 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 +00001324#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001325int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1326int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001327#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1328#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1329#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001330int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1331int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001332#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1333#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1334#endif
1335
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001336char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1337void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1338void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001339#ifdef __GLIBC__
1340/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001341unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001342#undef makedev
1343#define makedev(a,b) bb_makedev(a,b)
1344#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001345
1346
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001347/* "Keycodes" that report an escape sequence.
1348 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001349 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001350 * Also, -1 is reserved for error indication and we don't use it. */
1351enum {
1352 KEYCODE_UP = -2,
1353 KEYCODE_DOWN = -3,
1354 KEYCODE_RIGHT = -4,
1355 KEYCODE_LEFT = -5,
1356 KEYCODE_HOME = -6,
1357 KEYCODE_END = -7,
1358 KEYCODE_INSERT = -8,
1359 KEYCODE_DELETE = -9,
1360 KEYCODE_PAGEUP = -10,
1361 KEYCODE_PAGEDOWN = -11,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001362 // -12 is reserved for Alt/Ctrl/Shift-TAB
1363#if 0
1364 KEYCODE_FUN1 = -13,
1365 KEYCODE_FUN2 = -14,
1366 KEYCODE_FUN3 = -15,
1367 KEYCODE_FUN4 = -16,
1368 KEYCODE_FUN5 = -17,
1369 KEYCODE_FUN6 = -18,
1370 KEYCODE_FUN7 = -19,
1371 KEYCODE_FUN8 = -20,
1372 KEYCODE_FUN9 = -21,
1373 KEYCODE_FUN10 = -22,
1374 KEYCODE_FUN11 = -23,
1375 KEYCODE_FUN12 = -24,
1376#endif
1377 /* Be sure that last defined value is small enough
1378 * to not interfere with Alt/Ctrl/Shift bits.
1379 * So far we do not exceed -31 (0xfff..fffe1),
1380 * which gives us three upper bits in LSB to play with.
1381 */
1382 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1383 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1384 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1385 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001386 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1387 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001388 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1389 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1390 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1391 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1392
Denys Vlasenko180f5852009-10-26 00:59:59 +01001393 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001394 /* How long is the longest ESC sequence we know?
1395 * We want it big enough to be able to contain
1396 * cursor position sequence "ESC [ 9999 ; 9999 R"
1397 */
1398 KEYCODE_BUFFER_SIZE = 16
1399};
1400/* Note: fd may be in blocking or non-blocking mode, both make sense.
1401 * For one, less uses non-blocking mode.
1402 * Only the first read syscall inside read_key may block indefinitely
1403 * (unless fd is in non-blocking mode),
1404 * subsequent reads will time out after a few milliseconds.
1405 * Return of -1 means EOF or error (errno == 0 on EOF).
1406 * buffer[0] is used as a counter of buffered chars and must be 0
1407 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001408 * timeout:
1409 * -2: do not poll for input;
1410 * -1: poll(-1) (i.e. block);
1411 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001412 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001413int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001414void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001415
1416
Denis Vlasenko38f63192007-01-22 09:03:07 +00001417#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001418/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001419# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001420# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001421unsigned size_from_HISTFILESIZE(const char *hp);
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001422# else
1423# define MAX_HISTORY 0
1424# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001425typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001426 int flags;
1427 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001428# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001429 int cnt_history;
1430 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001431 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001432# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001433 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1434 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1435 * in on-disk history"
1436 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1437 * also in on-disk history (and thus need to be skipped on save)"
1438 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001439 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001440 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001441# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001442 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001443# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001444} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001445enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001446 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1447 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1448 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1449 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1450 WITH_PATH_LOOKUP = 0x10,
1451 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001452};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001453line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001454/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denys Vlasenko046341e2011-02-04 17:53:59 +01001455/*
1456 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001457 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001458 * -1 on read errors or EOF, or on bare Ctrl-D,
1459 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001460 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001461 */
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001462int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001463# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1464void save_history(line_input_t *st);
1465# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001466#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001467#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001468int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001469#define read_line_input(state, prompt, command, maxsize, timeout) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001470 read_line_input(prompt, command, maxsize)
1471#endif
1472
1473
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001474#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001475# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001476enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001477# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001478/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001479enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001480# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001481#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001482
1483struct smaprec {
1484 unsigned long mapped_rw;
1485 unsigned long mapped_ro;
1486 unsigned long shared_clean;
1487 unsigned long shared_dirty;
1488 unsigned long private_clean;
1489 unsigned long private_dirty;
1490 unsigned long stack;
1491 unsigned long smap_pss, smap_swap;
1492 unsigned long smap_size;
1493 unsigned long smap_start;
1494 char smap_mode[5];
1495 char *smap_name;
1496};
1497
1498#if !ENABLE_PMAP
1499#define procps_read_smaps(pid, total, cb, data) \
1500 procps_read_smaps(pid, total)
1501#endif
1502int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1503 void (*cb)(struct smaprec *, void *), void *data);
1504
Denis Vlasenko512499c2007-08-26 18:23:13 +00001505typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001506 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001507 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001508 uint8_t shift_pages_to_bytes;
1509 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001510/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001511 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001512 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001513 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001514 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001515 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001516 /* Everything below must contain no ptrs to malloc'ed data:
1517 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001518 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001519 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001520 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001521 unsigned pid;
1522 unsigned ppid;
1523 unsigned pgid;
1524 unsigned sid;
1525 unsigned uid;
1526 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001527#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1528 unsigned ruid;
1529 unsigned rgid;
1530 int niceness;
1531#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001532 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001533#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001534 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001535#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001536 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001537 /* basename of executable in exec(2), read from /proc/N/stat
1538 * (if executable is symlink or script, it is NOT replaced
1539 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001540 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001541 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001542#if ENABLE_FEATURE_TOP_SMP_PROCESS
1543 int last_seen_on_cpu;
1544#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001545} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001546/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001547enum {
1548 PSSCAN_PID = 1 << 0,
1549 PSSCAN_PPID = 1 << 1,
1550 PSSCAN_PGID = 1 << 2,
1551 PSSCAN_SID = 1 << 3,
1552 PSSCAN_UIDGID = 1 << 4,
1553 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001554 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001555 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001556 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001557 PSSCAN_STATE = 1 << 9,
1558 PSSCAN_VSZ = 1 << 10,
1559 PSSCAN_RSS = 1 << 11,
1560 PSSCAN_STIME = 1 << 12,
1561 PSSCAN_UTIME = 1 << 13,
1562 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001563 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001564 /* NB: used by find_pid_by_name(). Any applet using it
1565 * needs to be mentioned here. */
1566 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1567 || ENABLE_PGREP || ENABLE_PKILL
1568 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001569 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001570 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001571 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001572 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001573 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1574 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1575 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001576 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001577};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001578//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1579void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1580procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001581/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001582/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001583void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001584pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1585pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001586int starts_with_cpu(const char *str) FAST_FUNC;
1587unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001588
1589
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02001590/* Use strict=1 if you process input from untrusted source:
1591 * it will return NULL on invalid %xx (bad hex chars)
1592 * and str + 1 if decoded char is / or NUL.
1593 * In non-strict mode, it always succeeds (returns str),
1594 * and also it additionally decoded '+' to space.
1595 */
1596char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1597
1598
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001599extern const char bb_uuenc_tbl_base64[];
1600extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001601void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001602enum {
1603 BASE64_FLAG_UU_STOP = 0x100,
1604 /* Sign-extends to a value which never matches fgetc result: */
1605 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1606};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02001607const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1608void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001609
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001610typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001611 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1612 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001613 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001614 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1615} md5_ctx_t;
1616typedef struct md5_ctx_t sha1_ctx_t;
1617typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001618typedef struct sha512_ctx_t {
1619 uint64_t total64[2]; /* must be directly before hash[] */
1620 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001621 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001622} sha512_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001623void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1624void md5_hash(md5_ctx_t *ctx, const void *data, size_t length) FAST_FUNC;
1625void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1626void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1627#define sha1_hash md5_hash
1628void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1629void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1630#define sha256_hash md5_hash
1631#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001632void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1633void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1634void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001635
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001636extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001637uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001638uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1639uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001640
1641typedef struct masks_labels_t {
1642 const char *labels;
1643 const int masks[];
1644} masks_labels_t;
1645int print_flags_separated(const int *masks, const char *labels,
1646 int flags, const char *separator) FAST_FUNC;
1647int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001648
Magnus Dammf5914992009-11-08 16:34:43 +01001649typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01001650 unsigned last_size;
1651 unsigned last_update_sec;
1652 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01001653 unsigned start_sec;
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001654 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01001655} bb_progress_t;
1656
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001657#define is_bb_progress_inited(p) ((p)->curfile != NULL)
1658#define bb_progress_free(p) do { \
1659 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1660 (p)->curfile = NULL; \
1661} while (0)
1662void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1663void bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01001664 uoff_t beg_range,
1665 uoff_t transferred,
1666 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001667
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001668
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001669extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001670
1671/* Some older linkers don't perform string merging, we used to have common strings
1672 * as global arrays to do it by hand. But:
1673 * (1) newer linkers do it themselves,
1674 * (2) however, they DONT merge string constants with global arrays,
1675 * even if the value is the same (!). Thus global arrays actually
1676 * increased size a bit: for example, "/etc/passwd" string from libc
1677 * wasn't merged with bb_path_passwd_file[] array!
1678 * Therefore now we use #defines.
1679 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001680/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001681extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001682extern const char bb_msg_memory_exhausted[];
1683extern const char bb_msg_invalid_date[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001684#define bb_msg_read_error "read error"
1685#define bb_msg_write_error "write error"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001686extern const char bb_msg_unknown[];
1687extern const char bb_msg_can_not_create_raw_socket[];
1688extern const char bb_msg_perm_denied_are_you_root[];
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01001689extern const char bb_msg_you_must_be_root[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001690extern const char bb_msg_requires_arg[];
1691extern const char bb_msg_invalid_arg[];
1692extern const char bb_msg_standard_input[];
1693extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001694
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001695/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001696extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001697
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001698extern const char bb_path_wtmp_file[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001699
1700/* Busybox mount uses either /proc/mounts or /etc/mtab to
1701 * get the list of currently mounted filesystems */
1702#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1703
Tito Ragusaad3d72f2011-01-16 23:39:45 +01001704#define bb_path_passwd_file _PATH_PASSWD
1705#define bb_path_group_file _PATH_GROUP
1706#define bb_path_shadow_file _PATH_SHADOW
1707#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02001708
1709#define bb_path_motd_file "/etc/motd"
1710
1711#define bb_dev_null "/dev/null"
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001712extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001713/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1714 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001715extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1716#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1717#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001718
Denis Vlasenko703e2022007-01-22 14:12:08 +00001719extern const int const_int_0;
1720extern const int const_int_1;
1721
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001722
Denis Vlasenko85818632007-04-19 14:47:11 +00001723/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001724enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1725extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001726/* This struct is deliberately not defined. */
1727/* See docs/keep_data_small.txt */
1728struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001729/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001730 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001731 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001732extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001733/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001734#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001735#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001736 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001737 barrier(); \
1738} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001739
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001740/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1741 * use bb_default_login_shell and following defines.
1742 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1743 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001744#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001745extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001746/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001747#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001748/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001749#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001750
Jeremie Koenig816ed972010-05-27 15:46:29 +02001751/* The following devices are the same on all systems. */
1752#define CURRENT_TTY "/dev/tty"
1753#define DEV_CONSOLE "/dev/console"
1754
1755#if defined(__FreeBSD_kernel__)
1756# define CURRENT_VC CURRENT_TTY
1757# define VC_1 "/dev/ttyv0"
1758# define VC_2 "/dev/ttyv1"
1759# define VC_3 "/dev/ttyv2"
1760# define VC_4 "/dev/ttyv3"
1761# define VC_5 "/dev/ttyv4"
1762# define VC_FORMAT "/dev/ttyv%d"
1763#elif defined(__GNU__)
1764# define CURRENT_VC CURRENT_TTY
1765# define VC_1 "/dev/tty1"
1766# define VC_2 "/dev/tty2"
1767# define VC_3 "/dev/tty3"
1768# define VC_4 "/dev/tty4"
1769# define VC_5 "/dev/tty5"
1770# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001771#elif ENABLE_FEATURE_DEVFS
1772/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001773# define CURRENT_VC "/dev/vc/0"
1774# define VC_1 "/dev/vc/1"
1775# define VC_2 "/dev/vc/2"
1776# define VC_3 "/dev/vc/3"
1777# define VC_4 "/dev/vc/4"
1778# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001779# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001780# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001781# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001782# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001783# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001784#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001785/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001786# define CURRENT_VC "/dev/tty0"
1787# define VC_1 "/dev/tty1"
1788# define VC_2 "/dev/tty2"
1789# define VC_3 "/dev/tty3"
1790# define VC_4 "/dev/tty4"
1791# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001792# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001793# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001794# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001795# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001796# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001797#endif
1798
Rob Landleyc57ec372006-04-10 17:07:15 +00001799
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001800#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1801
Rob Landleyb623a542006-05-31 22:09:03 +00001802
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001803/* We redefine ctype macros. Unicode-correct handling of char types
1804 * can't be done with such byte-oriented operations anyway,
1805 * we don't lose anything.
1806 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001807#undef isalnum
1808#undef isalpha
1809#undef isascii
1810#undef isblank
1811#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001812#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001813#undef isgraph
1814#undef islower
1815#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001816#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001817#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001818#undef isupper
1819#undef isxdigit
1820#undef toupper
1821#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001822
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001823/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001824 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001825
1826/* These work the same for ASCII and Unicode,
1827 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001828#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001829#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001830#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1831#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001832#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001833#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1834#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001835/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001836 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001837 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001838#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001839// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1840#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1841// 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 +02001842#define isalnum(a) bb_ascii_isalnum(a)
1843static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1844{
1845 unsigned char b = a - '0';
1846 if (b <= 9)
1847 return (b <= 9);
1848 b = (a|0x20) - 'a';
1849 return b <= 'z' - 'a';
1850}
1851#define isxdigit(a) bb_ascii_isxdigit(a)
1852static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1853{
1854 unsigned char b = a - '0';
1855 if (b <= 9)
1856 return (b <= 9);
1857 b = (a|0x20) - 'a';
1858 return b <= 'f' - 'a';
1859}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001860#define toupper(a) bb_ascii_toupper(a)
1861static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1862{
1863 unsigned char b = a - 'a';
1864 if (b <= ('z' - 'a'))
1865 a -= 'a' - 'A';
1866 return a;
1867}
1868#define tolower(a) bb_ascii_tolower(a)
1869static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1870{
1871 unsigned char b = a - 'A';
1872 if (b <= ('Z' - 'A'))
1873 a += 'a' - 'A';
1874 return a;
1875}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001876
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001877/* In ASCII and Unicode, these are likely to be very different.
1878 * Let's prevent ambiguous usage from the start */
1879#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1880#define isprint(a) isprint_is_ambiguous_dont_use(a)
1881/* NB: must not treat EOF as isgraph or isprint */
1882#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1883#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1884
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001885
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001886POP_SAVED_FUNCTION_VISIBILITY
1887
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001888#endif