blob: 794e4388984f2fd85c77d21f9499cc67781fdf3d [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Eric Andersenaad1a882001-03-16 22:47:14 +00006 * Permission has been granted to redistribute this code under the GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Rob Landleyeb84a422006-09-20 21:41:13 +00008 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000010#ifndef LIBBB_H
11#define LIBBB_H 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
20#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000021#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000022#include <signal.h>
Denys Vlasenko5b9b1362010-02-02 03:08:57 +010023#include <stdint.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000024#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000025#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000026#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000027#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000028#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000029#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000030#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000031#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000032#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000033#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000034#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000035#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000036#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000037#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000038#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000039#include <unistd.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000040/* Try to pull in PATH_MAX */
41#include <limits.h>
42#include <sys/param.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000043#ifdef HAVE_MNTENT_H
44#include <mntent.h>
45#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000046#ifdef HAVE_SYS_STATFS_H
47#include <sys/statfs.h>
48#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000049#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000050#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000051#include <selinux/context.h>
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +000052#include <selinux/flask.h>
53#include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000054#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000055#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +020056# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000057#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +020058# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000059#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000060#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +020061# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000062#endif
Denis Vlasenkoee5dce32008-09-26 10:35:55 +000063#include <pwd.h>
64#include <grp.h>
Denis Vlasenko98636eb2008-05-09 17:59:34 +000065#if ENABLE_FEATURE_SHADOWPASSWDS
Mike Frysinger52a42672009-07-09 01:33:20 -040066# if !ENABLE_USE_BB_SHADOW
67/* If using busybox's shadow implementation, do not include the shadow.h
68 * header as the toolchain may not provide it at all.
69 */
70# include <shadow.h>
71# endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000072#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +010073#if defined __FreeBSD__
74# include <netinet/in.h>
75# include <arpa/inet.h>
76#elif defined __APPLE__
77# include <netinet/in.h>
78#else
79# include <arpa/inet.h>
80# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
81/* We #define socklen_t *after* includes, otherwise we get
82 * typedef redefinition errors from system headers
83 * (in case "is it defined already" detection above failed)
84 */
85# define socklen_t bb_socklen_t
86 typedef unsigned socklen_t;
87# endif
88#endif
89
Denis Vlasenko98636eb2008-05-09 17:59:34 +000090
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +000091/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +000092
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +000093extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000094#if defined(__GLIBC__) && __GLIBC__ < 2
95int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000096#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000097/* klogctl is in libc's klog.h, but we cheat and not #include that */
98int klogctl(int type, char *b, int len);
99/* This is declared here rather than #including <libgen.h> in order to avoid
100 * confusing the two versions of basename. See the dirname/basename man page
101 * for details. */
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200102#if !defined __FreeBSD__
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000103char *dirname(char *path);
Denys Vlasenko9b1b62a2009-07-05 03:34:12 +0200104#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000105/* Include our own copy of struct sysinfo to avoid binary compatibility
106 * problems with Linux 2.4, which changed things. Grumble, grumble. */
107struct sysinfo {
108 long uptime; /* Seconds since boot */
109 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
110 unsigned long totalram; /* Total usable main memory size */
111 unsigned long freeram; /* Available memory size */
112 unsigned long sharedram; /* Amount of shared memory */
113 unsigned long bufferram; /* Memory used by buffers */
114 unsigned long totalswap; /* Total swap space size */
115 unsigned long freeswap; /* swap space still available */
116 unsigned short procs; /* Number of current processes */
117 unsigned short pad; /* Padding needed for m68k */
118 unsigned long totalhigh; /* Total high memory size */
119 unsigned long freehigh; /* Available high memory size */
120 unsigned int mem_unit; /* Memory unit size in bytes */
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000121 char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000122};
123int sysinfo(struct sysinfo* info);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100124#ifndef PATH_MAX
125# define PATH_MAX 256
126#endif
127#ifndef BUFSIZ
128# define BUFSIZ 4096
129#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000130
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000131
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000132/* Make all declarations hidden (-fvisibility flag only affects definitions) */
133/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000134PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000135
136
137#if ENABLE_USE_BB_PWD_GRP
138# include "pwd_.h"
139# include "grp_.h"
140#endif
141#if ENABLE_FEATURE_SHADOWPASSWDS
142# if ENABLE_USE_BB_SHADOW
143# include "shadow_.h"
144# endif
145#endif
146
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000147/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000148#define MAXINT(T) (T)( \
149 ((T)-1) > 0 \
150 ? (T)-1 \
151 : (T)~((T)1 << (sizeof(T)*8-1)) \
152 )
153
154#define MININT(T) (T)( \
155 ((T)-1) > 0 \
156 ? (T)0 \
157 : ((T)1 << (sizeof(T)*8-1)) \
158 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000159
Denis Vlasenko56254152006-10-07 16:24:46 +0000160/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000161/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000162 * (stat, lseek etc) mapped to "largefile" variants by libc.
163 * Practically it means that open() automatically has O_LARGEFILE added
164 * and all filesize/file_offset parameters and struct members are "large"
165 * (in today's world - signed 64bit). For full support of large files,
166 * we need a few helper #defines (below) and careful use of off_t
167 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000168#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000169/* CONFIG_LFS is on */
170# if ULONG_MAX > 0xffffffff
171/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000172typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000173# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000174/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
175# define BB_STRTOOFF bb_strtoul
176# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000177/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
178# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000179# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000180/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000181typedef unsigned long long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000182# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000183# define BB_STRTOOFF bb_strtoull
184# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000185# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000186# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000187#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000188/* CONFIG_LFS is off */
189# if UINT_MAX == 0xffffffff
190/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
191 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000192typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000193# define XATOOFF(a) xatoi_u(a)
194# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000195# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000196# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000197# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000198typedef unsigned long uoff_t;
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000199# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
200# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000201# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000202# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000203# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000204#endif
205/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000206#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000207
Eric Andersenaad1a882001-03-16 22:47:14 +0000208/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000209#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000210#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000211#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000212#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000213#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000214#define SKIP ((int) 2)
215
216/* for mtab.c */
217#define MTAB_GETMOUNTPT '1'
218#define MTAB_GETDEVICE '2'
219
220#define BUF_SIZE 8192
221#define EXPAND_ALLOC 1024
222
Eric Andersenaad1a882001-03-16 22:47:14 +0000223/* Macros for min/max. */
224#ifndef MIN
225#define MIN(a,b) (((a)<(b))?(a):(b))
226#endif
227
228#ifndef MAX
229#define MAX(a,b) (((a)>(b))?(a):(b))
230#endif
231
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000232/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000233#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000234#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000235#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
236#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
237#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000238#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000239#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
240#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
241#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
242#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000243#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
244#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
245#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000246#endif
247#endif
248
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000249#if defined(__GLIBC__)
250/* glibc uses __errno_location() to get a ptr to errno */
251/* We can just memorize it once - no multithreading in busybox :) */
252extern int *const bb_errno;
253#undef errno
254#define errno (*bb_errno)
255#endif
256
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000257unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000258unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100259unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000260unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000261
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000262extern void chomp(char *s) FAST_FUNC;
263extern void trim(char *s) FAST_FUNC;
264extern char *skip_whitespace(const char *) FAST_FUNC;
265extern char *skip_non_whitespace(const char *) FAST_FUNC;
266extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000267
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000268//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000269extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
270extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000271enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100272 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
273 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
274 FILEUTILS_RECUR = 1 << 2, /* -R */
275 FILEUTILS_FORCE = 1 << 3, /* -f */
276 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
277 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
278 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
279 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
280 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000281#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100282 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
283 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000284#endif
285};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100286#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000287extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000288/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
289 * the source, not copy (unless "source" is a directory).
290 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
291 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000292extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000293
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000294enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000295 ACTION_RECURSE = (1 << 0),
296 ACTION_FOLLOWLINKS = (1 << 1),
297 ACTION_FOLLOWLINKS_L0 = (1 << 2),
298 ACTION_DEPTHFIRST = (1 << 3),
299 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000300 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200301 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000302};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200303typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000304extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000305 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
306 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
307 void* userData, unsigned depth) FAST_FUNC;
308extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000309enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000310extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000311extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000312extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
313extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000314/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000315extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
316extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
317extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000318/* "short" copy can be detected by return value < size */
319/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000320extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000321extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000322/* xxxx_strip version can modify its parameter:
323 * "/" -> "/"
324 * "abc" -> "abc"
325 * "abc/def" -> "def"
326 * "abc/def/" -> "def" !!
327 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000328extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000329/* "abc/def/" -> "" and it never modifies 'path' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000330extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000331
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000332int ndelay_on(int fd) FAST_FUNC;
333int ndelay_off(int fd) FAST_FUNC;
334int close_on_exec_on(int fd) FAST_FUNC;
335void xdup2(int, int) FAST_FUNC;
336void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000337
338
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000339DIR *xopendir(const char *path) FAST_FUNC;
340DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000341
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100342char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100343char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
344char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100345/* !RETURNS_MALLOC: it's a realloc-like function */
346char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000347
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100348char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000349
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000350
Denis Vlasenko33196372008-02-23 01:25:38 +0000351enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000352 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000353 * otherwise would kill us, except for those resulting from bugs:
354 * SIGSEGV, SIGILL, SIGFPE.
355 * Other fatal signals not included (TODO?):
356 * SIGBUS Bus error (bad memory access)
357 * SIGPOLL Pollable event. Synonym of SIGIO
358 * SIGPROF Profiling timer expired
359 * SIGSYS Bad argument to routine
360 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000361 *
362 * The only known arch with some of these sigs not fitting
363 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
364 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000365 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000366 BB_FATAL_SIGS = (int)(0
367 + (1LL << SIGHUP)
368 + (1LL << SIGINT)
369 + (1LL << SIGTERM)
370 + (1LL << SIGPIPE) // Write to pipe with no readers
371 + (1LL << SIGQUIT) // Quit from keyboard
372 + (1LL << SIGABRT) // Abort signal from abort(3)
373 + (1LL << SIGALRM) // Timer signal from alarm(2)
374 + (1LL << SIGVTALRM) // Virtual alarm clock
375 + (1LL << SIGXCPU) // CPU time limit exceeded
376 + (1LL << SIGXFSZ) // File size limit exceeded
377 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
378 + (1LL << SIGUSR2)
379 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000380};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000381void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000382/* Unlike signal() and bb_signals, sets handler with sigaction()
383 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000384 * will be blocked; syscalls will not be restarted: */
385void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000386/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000387void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000388/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000389void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
390void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000391void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000392void sig_block(int sig) FAST_FUNC;
393void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000394/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000395int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000396/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000397int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000398/* Standard handler which just records signo */
399extern smallint bb_got_signal;
400void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000401
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000402
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000403void xsetgid(gid_t gid) FAST_FUNC;
404void xsetuid(uid_t uid) FAST_FUNC;
405void xchdir(const char *path) FAST_FUNC;
406void xchroot(const char *path) FAST_FUNC;
407void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000408void bb_unsetenv(const char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000409void xunlink(const char *pathname) FAST_FUNC;
410void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200411int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100412int xopen_nonblocking(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000413int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
414int open_or_warn(const char *pathname, int flags) FAST_FUNC;
415int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
416int open_or_warn_stdin(const char *pathname) FAST_FUNC;
417void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
418int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
419off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
420off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000421
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100422uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
423 const char *override,
424 unsigned override_units,
425 int extend);
426
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000427void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000428/* In this form code with pipes is much more readable */
429struct fd_pair { int rd; int wr; };
430#define piped_pair(pair) pipe(&((pair).rd))
431#define xpiped_pair(pair) xpipe(&((pair).rd))
432
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000433/* Useful for having small structure members/global variables */
434typedef int8_t socktype_t;
435typedef int8_t family_t;
436struct BUG_too_small {
437 char BUG_socktype_t_too_small[(0
438 | SOCK_STREAM
439 | SOCK_DGRAM
440 | SOCK_RDM
441 | SOCK_SEQPACKET
442 | SOCK_RAW
443 ) <= 127 ? 1 : -1];
444 char BUG_family_t_too_small[(0
445 | AF_UNSPEC
446 | AF_INET
447 | AF_INET6
448 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000449#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000450 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000451#endif
452#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000453 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000454#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000455 /* | AF_DECnet */
456 /* | AF_IPX */
457 ) <= 127 ? 1 : -1];
458};
459
460
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100461void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
462time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200463
464
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000465int xsocket(int domain, int type, int protocol) FAST_FUNC;
466void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
467void xlisten(int s, int backlog) FAST_FUNC;
468void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000469ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000470 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000471/* SO_REUSEADDR allows a server to rebind to an address that is already
472 * "in use" by old connections to e.g. previous server instance which is
473 * killed or crashed. Without it bind will fail until all such connections
474 * time out. Linux does not allow multiple live binds on same ip:port
475 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
476 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000477void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
478int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000479int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000480/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000481unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000482typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000483 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000484 union {
485 struct sockaddr sa;
486 struct sockaddr_in sin;
487#if ENABLE_FEATURE_IPV6
488 struct sockaddr_in6 sin6;
489#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000490 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000491} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000492enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000493 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000494 LSA_SIZEOF_SA = sizeof(
495 union {
496 struct sockaddr sa;
497 struct sockaddr_in sin;
498#if ENABLE_FEATURE_IPV6
499 struct sockaddr_in6 sin6;
500#endif
501 }
502 )
503};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000504/* Create stream socket, and allocate suitable lsa.
505 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000506 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100507 * and if kernel doesn't support it, fall back to IPv4.
508 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000509 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000510#if ENABLE_FEATURE_IPV6
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000511int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000512#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000513int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000514#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
515#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000516int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000517/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000518 * numeric IP ("N.N.N.N") or numeric IPv6 address,
519 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000520 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000521/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000522int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
523int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000524/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
525 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
526 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
527 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000528int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000529/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000530int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000531/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100532len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000533/* Return malloc'ed len_and_sockaddr with socket address of host:port
534 * Currently will return IPv4 or IPv6 sockaddrs only
535 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000536 * UNIX socket address being returned, IPX sockaddr etc...
537 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100538len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000539/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100540len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
541len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000542/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000543#if !ENABLE_FEATURE_IPV6
544#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
545#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
546#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100547len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
548len_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 +0000549#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000550/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000551 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000552 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000553void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000554/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000555int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000556/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100557char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000558/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100559char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000560/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100561char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000562/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100563char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
564char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000565// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000566// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000567struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000568// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000569// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000570
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000571
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000572void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000573ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000574 const struct sockaddr *to,
575 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000576 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000577ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000578 struct sockaddr *from,
579 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000580 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000581
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100582
583char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
584char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000585void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000586char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000587char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000588/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000589 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000590int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100591char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000592// gcc-4.1.1 still isn't good enough at optimizing it
593// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000594//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000595//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000596//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000597//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000598#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000599#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000600#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000601#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000602#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000603
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100604typedef struct uni_stat_t {
605 unsigned byte_count;
606 unsigned unicode_count;
607 unsigned unicode_width;
608} uni_stat_t;
609/* Returns a string with unprintable chars replaced by '?' or
610 * SUBST_WCHAR. This function is unicode-aware. */
611const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
612/* Prints unprintable char ch as ^C or M-c to file
613 * (M-c is used only if ch is ORed with PRINTABLE_META),
614 * else it is printed as-is (except for ch = 0x9b) */
615enum { PRINTABLE_META = 0x100 };
616void fputc_printable(int ch, FILE *file) FAST_FUNC;
617
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000618/* dmalloc will redefine these to it's own implementation. It is safe
619 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100620void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
621void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
622void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000623void *xrealloc(void *old, size_t size) FAST_FUNC;
Denis Vlasenko27842282008-08-04 13:20:36 +0000624/* After xrealloc_vector(v, 4, idx) it's ok to use
625 * at least v[idx] and v[idx+1], for all idx values.
626 * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
627 * when all elements are used up. New elements are zeroed out. */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000628#define xrealloc_vector(vector, shift, idx) \
629 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
630void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
631
Eric Andersenaad1a882001-03-16 22:47:14 +0000632
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000633extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
634extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000635// NB: will return short read on error, not -1,
636// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000637extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
638extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
639extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000640extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
641extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000642// Reads one line a-la fgets (but doesn't save terminating '\n').
643// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000644// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100645extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000646/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100647extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000648/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100649extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000650/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000651extern int open_zipped(const char *fname) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100652extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000653/* Never returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100654extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000655
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000656extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000657// NB: will return short write on error, not -1,
658// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000659extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
660extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000661extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000662extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000663
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200664/* Close fd, but check for failures (some types of write errors) */
665extern void xclose(int fd) FAST_FUNC;
666
Denis Vlasenko1de08302006-10-26 23:32:43 +0000667/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000668extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000669
670extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenko69f4f9a2008-08-09 17:16:40 +0000671extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000672/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100673extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000674/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100675extern 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 +0000676/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100677extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000678/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100679extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000680/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100681extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000682/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100683/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000684
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100685void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
686void die_if_ferror_stdout(void) FAST_FUNC;
687int fflush_all(void) FAST_FUNC;
688void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
689int fclose_if_not_stdin(FILE *file) FAST_FUNC;
690FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000691/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100692FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000693/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100694FILE* xfopen_stdin(const char *filename) FAST_FUNC;
695FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
696FILE* fopen_for_read(const char *path) FAST_FUNC;
697FILE* xfopen_for_read(const char *path) FAST_FUNC;
698FILE* fopen_for_write(const char *path) FAST_FUNC;
699FILE* xfopen_for_write(const char *path) FAST_FUNC;
700FILE* xfdopen_for_read(int fd) FAST_FUNC;
701FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000702
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000703int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
704void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000705
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000706/* Wrapper which restarts poll on EINTR or ENOMEM.
707 * On other errors complains [perror("poll")] and returns.
708 * Warning! May take (much) longer than timeout_ms to return!
709 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000710int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000711
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000712char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenkoc94d3562008-06-30 13:30:21 +0000713char *safe_getdomainname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000714
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000715/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000716char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000717
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000718char *utoa(unsigned n) FAST_FUNC;
719char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000720/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000721char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
722char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000723/* Intelligent formatters of bignums */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000724void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
725void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200726/* If block_size == 0, display size without fractional part,
727 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100728 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200729 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100730#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
731#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000732//TODO: provide pointer to buf (avoid statics)?
733const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000734 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000735/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000736char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000737
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200738/* Generate a UUID */
739void generate_uuid(uint8_t *buf) FAST_FUNC;
740
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000741/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000742struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000743 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000744 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000745};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000746#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000747/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000748/* Using xatoi() instead of naive atoi() is not always convenient -
749 * in many places people want *non-negative* values, but store them
750 * in signed int. Therefore we need this one:
751 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000752int xatoi_u(const char *numstr) FAST_FUNC;
Denis Vlasenko13858992006-10-08 12:49:22 +0000753/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000754uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000755
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000756
Eric Andersenaad1a882001-03-16 22:47:14 +0000757/* These parse entries in /etc/passwd and /etc/group. This is desirable
758 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000759 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000760long xuname2uid(const char *name) FAST_FUNC;
761long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000762/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000763unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000764/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000765struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000766 uid_t uid;
767 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000768};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000769/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000770int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000771/* always sets uid and gid, allows numeric; exits on failure */
772void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000773/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000774void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000775struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000776struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000777struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
778struct group* xgetgrgid(gid_t gid) FAST_FUNC;
779char* xuid2uname(uid_t uid) FAST_FUNC;
780char* xgid2group(gid_t gid) FAST_FUNC;
781char* uid2uname(uid_t uid) FAST_FUNC;
782char* gid2group(gid_t gid) FAST_FUNC;
783char* uid2uname_utoa(long uid) FAST_FUNC;
784char* gid2group_utoa(long gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000785/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000786const char* get_cached_username(uid_t uid) FAST_FUNC;
787const char* get_cached_groupname(gid_t gid) FAST_FUNC;
788void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000789/* internally usernames are saved in fixed-sized char[] buffers */
790enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000791#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000792void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000793#else
794#define die_if_bad_username(name) ((void)(name))
795#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000796
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000797int execable_file(const char *name) FAST_FUNC;
798char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
799int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000800
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000801/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
802 * but it may exec busybox and call applet instead of searching PATH.
803 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000804#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000805int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000806#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
807#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000808 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000809 cmd, __VA_ARGS__)
810#else
811#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
812#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
813#endif
814
Denys Vlasenko8531d762010-03-18 22:44:00 +0100815/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000816pid_t spawn(char **argv) FAST_FUNC;
817pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000818
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000819pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100820pid_t wait_any_nohang(int *wstat) FAST_FUNC;
821/* wait4pid: unlike waitpid, waits ONLY for one process.
822 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000823 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000824 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000825 * IOW: rc = wait4pid(spawn(argv));
826 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +0100827 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000828 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000829int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100830/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200831int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000832struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000833 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000834 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000835 int xfunc_error_retval;
836 uint32_t option_mask32;
837 int die_sleep;
838 smallint saved;
839};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000840void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
841void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000842/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000843int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
844int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000845
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000846/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000847 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000848 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000849 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000850 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
851 * rexec's itself on NOMMU with argv passed as command line.
852 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
853 * from the start. (It will detect it and not reexec again second time).
854 * You have to audit carefully that you don't do something twice as a result
855 * (opening files/sockets, parsing config files etc...)!
856 *
857 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
858 * (will do setsid()).
859 *
Denis Vlasenko83518d12009-03-20 22:17:13 +0000860 * fork_or_rexec(argv) = bare-bones "fork" on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000861 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000862 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000863 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000864 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000865 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000866 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
867 * to /dev/null if they are not.
868 */
869enum {
870 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000871 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000872 DAEMON_CLOSE_EXTRA_FDS = 4,
873 DAEMON_ONLY_SANITIZE = 8, /* internal use */
874};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000875#if BB_MMU
Denis Vlasenko83518d12009-03-20 22:17:13 +0000876 pid_t fork_or_rexec(void) FAST_FUNC;
Denis Vlasenko367960b2007-08-18 14:20:21 +0000877 enum { re_execed = 0 };
Denis Vlasenko83518d12009-03-20 22:17:13 +0000878# define fork_or_rexec(argv) fork_or_rexec()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000879# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
880# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000881#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000882 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000883 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000884 extern bool re_execed;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000885 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
886 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
887 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000888# define fork() BUG_fork_is_unavailable_on_nommu()
889# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
890# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000891#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000892void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
893void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000894/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000895int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000896
897
Denys Vlasenkoe992bae2009-11-28 15:18:53 +0100898char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000899extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000900extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +0200901#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000902#define No_argument "\0"
903#define Required_argument "\001"
904#define Optional_argument "\002"
905extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000906#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000907extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000908extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000909
910
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000911typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000912 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000913 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000914} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000915void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
916void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
917void *llist_pop(llist_t **elm) FAST_FUNC;
918void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
919void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
920llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +0000921llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000922/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000923 * llist_t *llist_add_to(llist_t *old_head, void *data)
924 * etc does not result in smaller code... */
925
Denis Vlasenko80edead2007-08-02 22:31:05 +0000926/* start_stop_daemon and udhcpc are special - they want
927 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000928#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000929/* True only if we created pidfile which is *file*, not /dev/null etc */
930extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000931void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000932#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000933#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000934enum { wrote_pidfile = 0 };
935#define write_pidfile(path) ((void)0)
936#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000937#endif
938
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000939enum {
940 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000941 LOGMODE_STDIO = (1 << 0),
942 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000943 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
944};
945extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000946extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000947extern int die_sleep;
948extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000949extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000950extern void xfunc_die(void) NORETURN FAST_FUNC;
951extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000952extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
953extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
954extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
955extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
956extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +0000957extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000958extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
959extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000960extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000961extern void bb_perror_nomsg(void) FAST_FUNC;
962extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
963extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000964
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000965/* We need to export XXX_main from libbusybox
966 * only if we build "individual" binaries
967 */
968#if ENABLE_FEATURE_INDIVIDUAL
969#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
970#else
971#define MAIN_EXTERNALLY_VISIBLE
972#endif
973
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000974
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000975/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000976int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000977/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000978int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
979int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
980int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
981int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +0000982/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000983int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +0000984/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +0000985int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
986/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000987int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000988int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +0000989
Denis Vlasenko468aea22008-04-01 14:47:57 +0000990#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000991void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +0000992#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000993
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000994
995/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000996int create_icmp_socket(void) FAST_FUNC;
997int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000998/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000999/* This structure defines protocol families and their handlers. */
1000struct aftype {
1001 const char *name;
1002 const char *title;
1003 int af;
1004 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001005 char* FAST_FUNC (*print)(unsigned char *);
1006 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1007 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1008 void FAST_FUNC (*herror)(char *text);
1009 int FAST_FUNC (*rprint)(int options);
1010 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001011 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001012 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001013};
1014/* This structure defines hardware protocols and their handlers. */
1015struct hwtype {
1016 const char *name;
1017 const char *title;
1018 int type;
1019 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001020 char* FAST_FUNC (*print)(unsigned char *);
1021 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1022 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001023 int suppress_null_addr;
1024};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001025extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001026int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001027#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001028int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001029#else
1030#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001031#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001032const struct aftype *get_aftype(const char *name) FAST_FUNC;
1033const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1034const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001035
1036
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001037#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001038extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001039/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001040extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001041extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001042#endif
1043
Mike Frysinger9412ec72008-02-07 22:41:33 +00001044#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001045extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001046extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001047#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001048extern void erase_mtab(const char * name) FAST_FUNC;
1049extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1050extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001051#if ENABLE_DESKTOP
1052extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1053#else
1054# define bb_warn_ignoring_args(arg) ((void)0)
1055#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001056
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001057extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001058
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001059extern char *query_loop(const char *device) FAST_FUNC;
1060extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001061/* If *devname is not NULL, use that name, otherwise try to find free one,
1062 * malloc and return it in *devname.
1063 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001064extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001065
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001066/* Like bb_ask below, but asks on stdin with no timeout. */
1067char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001068//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001069char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001070int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001071
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001072int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001073
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001074/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001075 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001076 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001077enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001078 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1079 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1080// TODO: COLLAPSE and TRIM seem to always go in pair
1081 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1082 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001083 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001084 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denis Vlasenko084266e2008-07-26 23:08:31 +00001085// PARSE_ESCAPE = 0x00400000, // process escape sequences in tokens
1086 // NORMAL is:
1087 // * remove leading and trailing delimiters and collapse
1088 // multiple delimiters into one
1089 // * warn and continue if less than mintokens delimiters found
1090 // * grab everything into last token
1091 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001092};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001093typedef struct parser_t {
1094 FILE *fp;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001095 char *line;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001096 char *data;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001097 int lineno;
1098} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001099parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001100parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001101int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1102#define config_read(parser, tokens, max, min, str, flags) \
1103 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001104void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001105
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001106/* Concatenate path and filename to new allocated buffer.
1107 * Add "/" only as needed (no duplicate "//" are produced).
1108 * If path is NULL, it is assumed to be "/".
1109 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001110char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1111char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1112const char *bb_basename(const char *name) FAST_FUNC;
Denis Vlasenko7e84e532007-05-08 17:52:17 +00001113/* NB: can violate const-ness (similarly to strchr) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001114char *last_char_is(const char *s, int c) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001115
Denis Vlasenko4921b542007-02-03 02:17:41 +00001116
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001117int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001118
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001119int get_signum(const char *name) FAST_FUNC;
1120const char *get_signame(int number) FAST_FUNC;
1121void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001122
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001123char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001124/* Returns ptr to NUL */
1125char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001126
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001127#define FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001128extern void bb_do_delay(int seconds) FAST_FUNC;
1129extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001130extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001131extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001132#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001133extern void renew_current_security_context(void) FAST_FUNC;
1134extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001135extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001136 char *user, char *role, char *type, char *range) FAST_FUNC;
1137extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1138extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001139#else
1140#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001141#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001142extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001143
1144/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001145 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001146 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001147 * TERM=(old value)
1148 * USER=pw->pw_name, LOGNAME=pw->pw_name
1149 * PATH=bb_default_[root_]path
1150 * HOME=pw->pw_dir
1151 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001152 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001153 * if not root (if pw->pw_uid != 0):
1154 * USER=pw->pw_name, LOGNAME=pw->pw_name
1155 * HOME=pw->pw_dir
1156 * SHELL=shell
1157 * else does nothing
1158 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001159#define SETUP_ENV_CHANGEENV (1 << 0)
1160#define SETUP_ENV_CLEARENV (1 << 1)
1161#define SETUP_ENV_TO_TMP (1 << 2)
1162extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001163extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001164/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001165#if !ENABLE_USE_BB_CRYPT
1166#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1167#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001168extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1169extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001170/* rnd is additional random input. New one is returned.
1171 * Useful if you call crypt_make_salt many times in a row:
1172 * rnd = crypt_make_salt(buf1, 4, 0);
1173 * rnd = crypt_make_salt(buf2, 4, rnd);
1174 * rnd = crypt_make_salt(buf3, 4, rnd);
1175 * (otherwise we risk having same salt generated)
1176 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001177extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001178
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001179/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001180#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1181#define update_passwd(filename, username, data, member) \
1182 update_passwd(filename, username, data)
1183#endif
1184extern int update_passwd(const char *filename,
1185 const char *username,
1186 const char *data,
1187 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001188
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001189int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1190int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1191int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1192int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1193const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001194
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001195extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1196extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001197
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001198char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001199/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001200int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001201
Denis Vlasenko202ac502008-11-05 13:20:58 +00001202int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1203
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001204/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001205int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1206int 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 +00001207#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001208int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1209int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001210#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1211#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1212#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001213int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1214int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001215#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1216#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1217#endif
1218
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001219char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1220void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1221void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001222#ifdef __GLIBC__
1223/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001224unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001225#undef makedev
1226#define makedev(a,b) bb_makedev(a,b)
1227#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001228
1229
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001230/* "Keycodes" that report an escape sequence.
1231 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001232 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001233 * Also, -1 is reserved for error indication and we don't use it. */
1234enum {
1235 KEYCODE_UP = -2,
1236 KEYCODE_DOWN = -3,
1237 KEYCODE_RIGHT = -4,
1238 KEYCODE_LEFT = -5,
1239 KEYCODE_HOME = -6,
1240 KEYCODE_END = -7,
1241 KEYCODE_INSERT = -8,
1242 KEYCODE_DELETE = -9,
1243 KEYCODE_PAGEUP = -10,
1244 KEYCODE_PAGEDOWN = -11,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001245
1246 KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1247 KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
1248 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1249 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001250#if 0
1251 KEYCODE_FUN1 = -12,
1252 KEYCODE_FUN2 = -13,
1253 KEYCODE_FUN3 = -14,
1254 KEYCODE_FUN4 = -15,
1255 KEYCODE_FUN5 = -16,
1256 KEYCODE_FUN6 = -17,
1257 KEYCODE_FUN7 = -18,
1258 KEYCODE_FUN8 = -19,
1259 KEYCODE_FUN9 = -20,
1260 KEYCODE_FUN10 = -21,
1261 KEYCODE_FUN11 = -22,
1262 KEYCODE_FUN12 = -23,
1263#endif
Denys Vlasenko180f5852009-10-26 00:59:59 +01001264 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001265 /* How long is the longest ESC sequence we know?
1266 * We want it big enough to be able to contain
1267 * cursor position sequence "ESC [ 9999 ; 9999 R"
1268 */
1269 KEYCODE_BUFFER_SIZE = 16
1270};
1271/* Note: fd may be in blocking or non-blocking mode, both make sense.
1272 * For one, less uses non-blocking mode.
1273 * Only the first read syscall inside read_key may block indefinitely
1274 * (unless fd is in non-blocking mode),
1275 * subsequent reads will time out after a few milliseconds.
1276 * Return of -1 means EOF or error (errno == 0 on EOF).
1277 * buffer[0] is used as a counter of buffered chars and must be 0
1278 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001279 * timeout:
1280 * -2: do not poll for input;
1281 * -1: poll(-1) (i.e. block);
1282 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001283 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001284int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001285void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001286
1287
Denis Vlasenko38f63192007-01-22 09:03:07 +00001288#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001289/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001290# ifdef CONFIG_FEATURE_EDITING_HISTORY
1291# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1292# else
1293# define MAX_HISTORY 0
1294# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001295typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001296 int flags;
1297 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001298# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001299 int cnt_history;
1300 int cur_history;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001301# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001302 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001303 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001304# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001305 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001306# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001307} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001308enum {
1309 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001310 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1311 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1312 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1313 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001314 WITH_PATH_LOOKUP = 0x20,
1315 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1316};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001317line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001318/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1319/* maxsize must be >= 2.
1320 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001321 * -1 on read errors or EOF, or on bare Ctrl-D,
1322 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001323 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001324 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001325int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001326#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001327#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001328int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001329#define read_line_input(prompt, command, maxsize, state) \
1330 read_line_input(prompt, command, maxsize)
1331#endif
1332
1333
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001334#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001335# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001336enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001337# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001338/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001339enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001340# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001341#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001342typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001343 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001344 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001345 uint8_t shift_pages_to_bytes;
1346 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001347/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001348 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001349 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001350 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001351 IF_SELINUX(char *context;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001352 /* Everything below must contain no ptrs to malloc'ed data:
1353 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001354 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001355 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001356 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001357 unsigned pid;
1358 unsigned ppid;
1359 unsigned pgid;
1360 unsigned sid;
1361 unsigned uid;
1362 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001363#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1364 unsigned ruid;
1365 unsigned rgid;
1366 int niceness;
1367#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001368 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001369#if ENABLE_FEATURE_TOPMEM
1370 unsigned long mapped_rw;
1371 unsigned long mapped_ro;
1372 unsigned long shared_clean;
1373 unsigned long shared_dirty;
1374 unsigned long private_clean;
1375 unsigned long private_dirty;
1376 unsigned long stack;
1377#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001378 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001379 /* basename of executable in exec(2), read from /proc/N/stat
1380 * (if executable is symlink or script, it is NOT replaced
1381 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001382 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001383 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001384#if ENABLE_FEATURE_TOP_SMP_PROCESS
1385 int last_seen_on_cpu;
1386#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001387} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001388/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001389enum {
1390 PSSCAN_PID = 1 << 0,
1391 PSSCAN_PPID = 1 << 1,
1392 PSSCAN_PGID = 1 << 2,
1393 PSSCAN_SID = 1 << 3,
1394 PSSCAN_UIDGID = 1 << 4,
1395 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001396 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001397 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001398 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001399 PSSCAN_STATE = 1 << 9,
1400 PSSCAN_VSZ = 1 << 10,
1401 PSSCAN_RSS = 1 << 11,
1402 PSSCAN_STIME = 1 << 12,
1403 PSSCAN_UTIME = 1 << 13,
1404 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001405 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001406 /* NB: used by find_pid_by_name(). Any applet using it
1407 * needs to be mentioned here. */
1408 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1409 || ENABLE_PGREP || ENABLE_PKILL
1410 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001411 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001412 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001413 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001414 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001415 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1416 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1417 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001418 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001419 /* These are all retrieved from proc/NN/stat in one go: */
1420 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001421 /**/ | PSSCAN_COMM | PSSCAN_STATE
1422 /**/ | PSSCAN_VSZ | PSSCAN_RSS
1423 /**/ | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001424 /**/ | PSSCAN_TTY | PSSCAN_NICE
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001425 /**/ | PSSCAN_CPU
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001426};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001427//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1428void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1429procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001430/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001431/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001432void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001433pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1434pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001435
1436
1437extern const char bb_uuenc_tbl_base64[];
1438extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001439void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001440
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001441typedef struct sha1_ctx_t {
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001442 uint32_t hash[8]; /* 5, +3 elements for sha256 */
Denis Vlasenko98c87f72009-03-11 21:15:51 +00001443 uint64_t total64;
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001444 uint8_t wbuffer[64]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko8ec8d5e2009-03-15 02:56:00 +00001445 void (*process_block)(struct sha1_ctx_t*) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001446} sha1_ctx_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001447void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1448void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001449void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001450typedef struct sha1_ctx_t sha256_ctx_t;
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001451void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001452#define sha256_hash sha1_hash
1453#define sha256_end sha1_end
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001454typedef struct sha512_ctx_t {
Denis Vlasenkocd2cd312009-03-12 15:40:27 +00001455 uint64_t hash[8];
Denis Vlasenkoe9afc462009-03-15 02:28:05 +00001456 uint64_t total64[2];
Denis Vlasenkoc8329c92009-03-12 19:06:18 +00001457 uint8_t wbuffer[128]; /* NB: always correctly aligned for uint64_t */
Denis Vlasenko56dceb92008-11-10 13:32:50 +00001458} sha512_ctx_t;
1459void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1460void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001461void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1462#if 1
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001463typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001464 uint32_t A;
1465 uint32_t B;
1466 uint32_t C;
1467 uint32_t D;
1468 uint64_t total;
1469 uint32_t buflen;
1470 char buffer[128];
1471} md5_ctx_t;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001472#else
1473/* libbb/md5prime.c uses a bit different one: */
1474typedef struct md5_ctx_t {
1475 uint32_t state[4]; /* state (ABCD) */
1476 uint32_t count[2]; /* number of bits, modulo 2^64 (lsb first) */
1477 unsigned char buffer[64]; /* input buffer */
1478} md5_ctx_t;
1479#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001480void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1481void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001482void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1483
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001484
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001485uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1486
1487typedef struct masks_labels_t {
1488 const char *labels;
1489 const int masks[];
1490} masks_labels_t;
1491int print_flags_separated(const int *masks, const char *labels,
1492 int flags, const char *separator) FAST_FUNC;
1493int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001494
Magnus Dammf5914992009-11-08 16:34:43 +01001495typedef struct bb_progress_t {
1496 off_t lastsize;
1497 unsigned lastupdate_sec;
1498 unsigned start_sec;
Denys Vlasenkocbcc1232010-03-05 23:38:54 +01001499 smallint inited;
Magnus Dammf5914992009-11-08 16:34:43 +01001500} bb_progress_t;
1501
1502void bb_progress_init(bb_progress_t *p) FAST_FUNC;
1503void bb_progress_update(bb_progress_t *p, const char *curfile,
1504 off_t beg_range, off_t transferred,
1505 off_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001506
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001507extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001508/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001509extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001510extern const char bb_msg_memory_exhausted[];
1511extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001512extern const char bb_msg_read_error[];
1513extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001514extern const char bb_msg_unknown[];
1515extern const char bb_msg_can_not_create_raw_socket[];
1516extern const char bb_msg_perm_denied_are_you_root[];
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01001517extern const char bb_msg_you_must_be_root[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001518extern const char bb_msg_requires_arg[];
1519extern const char bb_msg_invalid_arg[];
1520extern const char bb_msg_standard_input[];
1521extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001522
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001523extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001524/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001525extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001526
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001527extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001528extern const char bb_path_passwd_file[];
1529extern const char bb_path_shadow_file[];
1530extern const char bb_path_gshadow_file[];
1531extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001532extern const char bb_path_motd_file[];
1533extern const char bb_path_wtmp_file[];
1534extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001535extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001536/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1537 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001538extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1539#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1540#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001541
Denis Vlasenko703e2022007-01-22 14:12:08 +00001542extern const int const_int_0;
1543extern const int const_int_1;
1544
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001545
Denis Vlasenko85818632007-04-19 14:47:11 +00001546/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001547enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1548extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001549/* This struct is deliberately not defined. */
1550/* See docs/keep_data_small.txt */
1551struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001552/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001553 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001554 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001555extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001556/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001557#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001558#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001559 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001560 barrier(); \
1561} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001562
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001563/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1564 * use bb_default_login_shell and following defines.
1565 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1566 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001567#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001568extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001569/* "/bin/sh" */
1570#define DEFAULT_SHELL (bb_default_login_shell+1)
1571/* "sh" */
1572#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1573
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001574#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001575# define CURRENT_VC "/dev/vc/0"
1576# define VC_1 "/dev/vc/1"
1577# define VC_2 "/dev/vc/2"
1578# define VC_3 "/dev/vc/3"
1579# define VC_4 "/dev/vc/4"
1580# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001581#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1582/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1583 respective serial ports .. as such, we can't use the common device paths for
1584 these. -- PFM */
1585# define SC_0 "/dev/ttsc/0"
1586# define SC_1 "/dev/ttsc/1"
1587# define SC_FORMAT "/dev/ttsc/%d"
1588#else
1589# define SC_0 "/dev/tts/0"
1590# define SC_1 "/dev/tts/1"
1591# define SC_FORMAT "/dev/tts/%d"
1592#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001593# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001594# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001595# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001596# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001597# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001598#else
1599# define CURRENT_VC "/dev/tty0"
1600# define VC_1 "/dev/tty1"
1601# define VC_2 "/dev/tty2"
1602# define VC_3 "/dev/tty3"
1603# define VC_4 "/dev/tty4"
1604# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001605#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1606# define SC_0 "/dev/ttySC0"
1607# define SC_1 "/dev/ttySC1"
1608# define SC_FORMAT "/dev/ttySC%d"
1609#else
1610# define SC_0 "/dev/ttyS0"
1611# define SC_1 "/dev/ttyS1"
1612# define SC_FORMAT "/dev/ttyS%d"
1613#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001614# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001615# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001616# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001617# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001618# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001619#endif
1620
1621/* The following devices are the same on devfs and non-devfs systems. */
1622#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001623#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001624
Rob Landleyc57ec372006-04-10 17:07:15 +00001625
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001626#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1627
Rob Landleyb623a542006-05-31 22:09:03 +00001628
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001629/* We redefine ctype macros. Unicode-correct handling of char types
1630 * can't be done with such byte-oriented operations anyway,
1631 * we don't lose anything.
1632 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001633#undef isalnum
1634#undef isalpha
1635#undef isascii
1636#undef isblank
1637#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001638#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001639#undef isgraph
1640#undef islower
1641#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001642#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001643#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001644#undef isupper
1645#undef isxdigit
1646#undef toupper
1647#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001648
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001649/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001650 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001651
1652/* These work the same for ASCII and Unicode,
1653 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001654#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001655#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001656#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1657#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001658#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001659#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1660#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001661/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001662 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001663 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001664#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001665// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1666#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1667// 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 +02001668#define isalnum(a) bb_ascii_isalnum(a)
1669static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1670{
1671 unsigned char b = a - '0';
1672 if (b <= 9)
1673 return (b <= 9);
1674 b = (a|0x20) - 'a';
1675 return b <= 'z' - 'a';
1676}
1677#define isxdigit(a) bb_ascii_isxdigit(a)
1678static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1679{
1680 unsigned char b = a - '0';
1681 if (b <= 9)
1682 return (b <= 9);
1683 b = (a|0x20) - 'a';
1684 return b <= 'f' - 'a';
1685}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001686#define toupper(a) bb_ascii_toupper(a)
1687static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1688{
1689 unsigned char b = a - 'a';
1690 if (b <= ('z' - 'a'))
1691 a -= 'a' - 'A';
1692 return a;
1693}
1694#define tolower(a) bb_ascii_tolower(a)
1695static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1696{
1697 unsigned char b = a - 'A';
1698 if (b <= ('Z' - 'A'))
1699 a += 'a' - 'A';
1700 return a;
1701}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001702
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001703/* In ASCII and Unicode, these are likely to be very different.
1704 * Let's prevent ambiguous usage from the start */
1705#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1706#define isprint(a) isprint_is_ambiguous_dont_use(a)
1707/* NB: must not treat EOF as isgraph or isprint */
1708#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1709#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1710
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001711
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001712POP_SAVED_FUNCTION_VISIBILITY
1713
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001714#endif