blob: 19b3bba5feba11f2ac6c748a0d5a6e18d7341218 [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Eric Andersenaad1a882001-03-16 22:47:14 +00006 * Permission has been granted to redistribute this code under the GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Rob Landleyeb84a422006-09-20 21:41:13 +00008 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +000010#ifndef __LIBBUSYBOX_H__
11#define __LIBBUSYBOX_H__ 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
20#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000021#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000022#include <signal.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000023#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000024#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000025#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000026#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000027#include <string.h>
Denis Vlasenkob308d812007-08-28 19:35:34 +000028#include <sys/poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000029#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000030#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000031#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000032#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000033#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000034#include <sys/types.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000035#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000036#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000037#include <time.h>
Rob Landleyb13fee42006-06-20 22:38:00 +000038#include <unistd.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000039#include <utime.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000040/* Try to pull in PATH_MAX */
41#include <limits.h>
42#include <sys/param.h>
43#ifndef PATH_MAX
44#define PATH_MAX 256
45#endif
Rob Landley299a6b42006-05-27 21:42:58 +000046
Mike Frysinger22876c72008-02-07 22:10:07 +000047#ifdef HAVE_MNTENT_H
48#include <mntent.h>
49#endif
50
Mike Frysinger9412ec72008-02-07 22:41:33 +000051#ifdef HAVE_SYS_STATFS_H
52#include <sys/statfs.h>
53#endif
54
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000055#if ENABLE_SELINUX
Bernhard Reutner-Fischerd4cffd12005-09-21 17:38:30 +000056#include <selinux/selinux.h>
Denis Vlasenko1203c9b2007-03-11 22:16:02 +000057#include <selinux/context.h>
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +000058#include <selinux/flask.h>
59#include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000060#endif
Robert Grieblc9aca452002-06-04 20:06:25 +000061
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000062#if ENABLE_LOCALE_SUPPORT
Rob Landleyd921b2e2006-08-03 15:41:12 +000063#include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000064#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000065#define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000066#endif
67
Eric Andersen887ca792002-07-03 23:19:26 +000068#include "pwd_.h"
69#include "grp_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000070/* ifdef it out, because it may include <shadow.h> */
71/* and we may not even _have_ <shadow.h>! */
72#if ENABLE_FEATURE_SHADOWPASSWDS
Eric Andersen27f64e12002-06-23 04:24:25 +000073#include "shadow_.h"
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000074#endif
Eric Andersen27f64e12002-06-23 04:24:25 +000075
Denis Vlasenko847fa772008-01-28 22:45:43 +000076/* Some libc's don't declare it, help them */
77extern char **environ;
78
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000079#if defined(__GLIBC__) && __GLIBC__ < 2
80int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +000081#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000082/* klogctl is in libc's klog.h, but we cheat and not #include that */
83int klogctl(int type, char *b, int len);
84/* This is declared here rather than #including <libgen.h> in order to avoid
85 * confusing the two versions of basename. See the dirname/basename man page
86 * for details. */
87char *dirname(char *path);
88/* Include our own copy of struct sysinfo to avoid binary compatibility
89 * problems with Linux 2.4, which changed things. Grumble, grumble. */
90struct sysinfo {
91 long uptime; /* Seconds since boot */
92 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
93 unsigned long totalram; /* Total usable main memory size */
94 unsigned long freeram; /* Available memory size */
95 unsigned long sharedram; /* Amount of shared memory */
96 unsigned long bufferram; /* Memory used by buffers */
97 unsigned long totalswap; /* Total swap space size */
98 unsigned long freeswap; /* swap space still available */
99 unsigned short procs; /* Number of current processes */
100 unsigned short pad; /* Padding needed for m68k */
101 unsigned long totalhigh; /* Total high memory size */
102 unsigned long freehigh; /* Available high memory size */
103 unsigned int mem_unit; /* Memory unit size in bytes */
104 char _f[20 - 2*sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
105};
106int sysinfo(struct sysinfo* info);
Rob Landley362dc2b2006-06-05 17:35:24 +0000107
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000108
109/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000110#define MAXINT(T) (T)( \
111 ((T)-1) > 0 \
112 ? (T)-1 \
113 : (T)~((T)1 << (sizeof(T)*8-1)) \
114 )
115
116#define MININT(T) (T)( \
117 ((T)-1) > 0 \
118 ? (T)0 \
119 : ((T)1 << (sizeof(T)*8-1)) \
120 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000121
Denis Vlasenko56254152006-10-07 16:24:46 +0000122/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000123/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000124 * (stat, lseek etc) mapped to "largefile" variants by libc.
125 * Practically it means that open() automatically has O_LARGEFILE added
126 * and all filesize/file_offset parameters and struct members are "large"
127 * (in today's world - signed 64bit). For full support of large files,
128 * we need a few helper #defines (below) and careful use of off_t
129 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000130#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000131/* CONFIG_LFS is on */
132# if ULONG_MAX > 0xffffffff
133/* "long" is long enough on this system */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000134# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000135/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
136# define BB_STRTOOFF bb_strtoul
137# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000138/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
139# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000140# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000141/* "long" is too short, need "long long" */
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000142# define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000143# define BB_STRTOOFF bb_strtoull
144# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000145# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000146# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000147#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000148/* CONFIG_LFS is off */
149# if UINT_MAX == 0xffffffff
150/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
151 * gcc will throw warnings on printf("%d", off_t). Crap... */
152# define XATOOFF(a) xatoi_u(a)
153# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000154# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000155# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000156# else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000157# define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
158# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000159# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000160# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000161# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000162#endif
163/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000164#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denis Vlasenko56254152006-10-07 16:24:46 +0000165
Eric Andersenaad1a882001-03-16 22:47:14 +0000166/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000167#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000168#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000169#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000170#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000171#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000172#define SKIP ((int) 2)
173
174/* for mtab.c */
175#define MTAB_GETMOUNTPT '1'
176#define MTAB_GETDEVICE '2'
177
178#define BUF_SIZE 8192
179#define EXPAND_ALLOC 1024
180
Eric Andersenaad1a882001-03-16 22:47:14 +0000181/* Macros for min/max. */
182#ifndef MIN
183#define MIN(a,b) (((a)<(b))?(a):(b))
184#endif
185
186#ifndef MAX
187#define MAX(a,b) (((a)>(b))?(a):(b))
188#endif
189
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000190/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000191#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000192#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000193#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
194#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
195#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000196#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000197#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
198#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
199#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
200#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000201#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
202#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
203#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000204#endif
205#endif
206
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000207#if defined(__GLIBC__)
208/* glibc uses __errno_location() to get a ptr to errno */
209/* We can just memorize it once - no multithreading in busybox :) */
210extern int *const bb_errno;
211#undef errno
212#define errno (*bb_errno)
213#endif
214
Denis Vlasenko459be352007-06-17 19:09:05 +0000215unsigned long long monotonic_us(void);
Denis Vlasenkobd7bb292007-06-17 23:40:26 +0000216unsigned monotonic_sec(void);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000217
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000218extern void chomp(char *s);
219extern void trim(char *s);
220extern char *skip_whitespace(const char *);
Denis Vlasenko0de93752006-12-26 02:51:29 +0000221extern char *skip_non_whitespace(const char *);
Paul Fox0b621582005-08-09 19:38:05 +0000222
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000223//TODO: supply a pointer to char[11] buffer (avoid statics)?
Bernhard Reutner-Fischer835f5752007-01-22 17:48:08 +0000224extern const char *bb_mode_string(mode_t mode);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000225extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000226extern int remove_file(const char *path, int flags);
227extern int copy_file(const char *source, const char *dest, int flags);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000228enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000229 ACTION_RECURSE = (1 << 0),
230 ACTION_FOLLOWLINKS = (1 << 1),
231 ACTION_FOLLOWLINKS_L0 = (1 << 2),
232 ACTION_DEPTHFIRST = (1 << 3),
233 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000234};
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000235extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenko8c35d652006-10-27 23:42:25 +0000236 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
237 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
Denis Vlasenkod166f832007-07-05 00:12:55 +0000238 void* userData, unsigned depth);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000239extern int device_open(const char *device, int mode);
Denis Vlasenko85c24712008-03-17 09:04:04 +0000240enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
241extern int getpty(char *line);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000242extern int get_console_fd(void);
Denis Vlasenkoa41fdf32007-01-29 22:51:00 +0000243extern char *find_block_device(const char *path);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000244/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000245extern off_t bb_copyfd_eof(int fd1, int fd2);
Denis Vlasenko714701c2006-12-22 00:21:07 +0000246extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
247extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
248/* "short" copy can be detected by return value < size */
249/* this helper yells "short read!" if param is not -1 */
250extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000251extern char bb_process_escape_sequence(const char **ptr);
Denis Vlasenko818322b2007-09-24 18:27:04 +0000252/* xxxx_strip version can modify its parameter:
253 * "/" -> "/"
254 * "abc" -> "abc"
255 * "abc/def" -> "def"
256 * "abc/def/" -> "def" !!
257 */
258extern char *bb_get_last_path_component_strip(char *path);
259/* "abc/def/" -> "" and it never modifies 'path' */
260extern char *bb_get_last_path_component_nostrip(const char *path);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000261
262int ndelay_on(int fd);
263int ndelay_off(int fd);
Denis Vlasenko96e1b382007-09-30 23:50:48 +0000264int close_on_exec_on(int fd);
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000265void xdup2(int, int);
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000266void xmove_fd(int, int);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000267
268
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000269DIR *xopendir(const char *path);
270DIR *warn_opendir(const char *path);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000271
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000272/* UNUSED: char *xmalloc_realpath(const char *path); */
273char *xmalloc_readlink(const char *path);
Denis Vlasenko6ca04442007-02-11 16:19:28 +0000274char *xmalloc_readlink_or_warn(const char *path);
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000275char *xrealloc_getcwd_or_warn(char *cwd);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000276
Paul Fox599bbfb2007-11-08 20:00:36 +0000277char *xmalloc_follow_symlinks(const char *path);
Denis Vlasenko473dae02007-04-11 07:04:23 +0000278
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000279
Denis Vlasenko33196372008-02-23 01:25:38 +0000280enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000281 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000282 * otherwise would kill us, except for those resulting from bugs:
283 * SIGSEGV, SIGILL, SIGFPE.
284 * Other fatal signals not included (TODO?):
285 * SIGBUS Bus error (bad memory access)
286 * SIGPOLL Pollable event. Synonym of SIGIO
287 * SIGPROF Profiling timer expired
288 * SIGSYS Bad argument to routine
289 * SIGTRAP Trace/breakpoint trap
290 */
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000291 BB_FATAL_SIGS = 0
Denis Vlasenko33196372008-02-23 01:25:38 +0000292 + (1 << SIGHUP)
293 + (1 << SIGINT)
294 + (1 << SIGTERM)
295 + (1 << SIGPIPE) // Write to pipe with no readers
296 + (1 << SIGQUIT) // Quit from keyboard
297 + (1 << SIGABRT) // Abort signal from abort(3)
298 + (1 << SIGALRM) // Timer signal from alarm(2)
299 + (1 << SIGVTALRM) // Virtual alarm clock
300 + (1 << SIGXCPU) // CPU time limit exceeded
301 + (1 << SIGXFSZ) // File size limit exceeded
302 + (1 << SIGUSR1) // Yes kids, these are also fatal!
303 + (1 << SIGUSR2)
304 + 0,
305};
Denis Vlasenko25591c32008-02-16 22:58:56 +0000306void bb_signals(int sigs, void (*f)(int));
307/* Unlike signal() and bb_signals, sets handler with sigaction()
308 * and in a way that while signal handler is run, no other signals
309 * will be blocked: */
310void bb_signals_recursive(int sigs, void (*f)(int));
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000311/* syscalls like read() will be interrupted with EINTR: */
312void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int));
313/* syscalls like read() won't be interrupted (though select/poll will be): */
314void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int));
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000315void wait_for_any_sig(void);
Denis Vlasenko400d8bb2008-02-24 13:36:01 +0000316void kill_myself_with_sig(int sig) ATTRIBUTE_NORETURN;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000317void sig_block(int sig);
318void sig_unblock(int sig);
319/* Will do sigaction(signum, act, NULL): */
320int sigaction_set(int sig, const struct sigaction *act);
321/* SIG_BLOCK/SIG_UNBLOCK all signals: */
322int sigprocmask_allsigs(int how);
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000323
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000324
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000325void xsetgid(gid_t gid);
326void xsetuid(uid_t uid);
327void xchdir(const char *path);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000328void xchroot(const char *path);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000329void xsetenv(const char *key, const char *value);
330void xunlink(const char *pathname);
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000331void xstat(const char *pathname, struct stat *buf);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000332int xopen(const char *pathname, int flags);
333int xopen3(const char *pathname, int flags, int mode);
Denis Vlasenko50f7f442007-04-11 23:20:53 +0000334int open_or_warn(const char *pathname, int flags);
335int open3_or_warn(const char *pathname, int flags, int mode);
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000336int open_or_warn_stdin(const char *pathname);
Denis Vlasenkocb448fe2008-02-17 14:28:53 +0000337void xrename(const char *oldpath, const char *newpath);
338int rename_or_warn(const char *oldpath, const char *newpath);
Denis Vlasenko1bb552b2007-04-05 21:25:15 +0000339off_t xlseek(int fd, off_t offset, int whence);
340off_t fdlength(int fd);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000341
Denis Vlasenko37188322008-02-16 13:20:56 +0000342void xpipe(int filedes[2]);
343/* In this form code with pipes is much more readable */
344struct fd_pair { int rd; int wr; };
345#define piped_pair(pair) pipe(&((pair).rd))
346#define xpiped_pair(pair) xpipe(&((pair).rd))
347
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000348/* Useful for having small structure members/global variables */
349typedef int8_t socktype_t;
350typedef int8_t family_t;
351struct BUG_too_small {
352 char BUG_socktype_t_too_small[(0
353 | SOCK_STREAM
354 | SOCK_DGRAM
355 | SOCK_RDM
356 | SOCK_SEQPACKET
357 | SOCK_RAW
358 ) <= 127 ? 1 : -1];
359 char BUG_family_t_too_small[(0
360 | AF_UNSPEC
361 | AF_INET
362 | AF_INET6
363 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000364#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000365 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000366#endif
367#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000368 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000369#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000370 /* | AF_DECnet */
371 /* | AF_IPX */
372 ) <= 127 ? 1 : -1];
373};
374
375
Denis Vlasenko448f0242007-01-22 22:43:05 +0000376int xsocket(int domain, int type, int protocol);
377void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
378void xlisten(int s, int backlog);
379void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000380ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Bernhard Reutner-Fischerb2908892007-04-12 11:34:39 +0000381 socklen_t tolen);
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000382/* SO_REUSEADDR allows a server to rebind to an address that is already
383 * "in use" by old connections to e.g. previous server instance which is
384 * killed or crashed. Without it bind will fail until all such connections
385 * time out. Linux does not allow multiple live binds on same ip:port
386 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
387 * Turn it on before you call bind(). */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000388void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000389int setsockopt_broadcast(int fd);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000390/* NB: returns port in host byte order */
391unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000392typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000393 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000394 union {
395 struct sockaddr sa;
396 struct sockaddr_in sin;
397#if ENABLE_FEATURE_IPV6
398 struct sockaddr_in6 sin6;
399#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000400 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000401} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000402enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000403 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000404 LSA_SIZEOF_SA = sizeof(
405 union {
406 struct sockaddr sa;
407 struct sockaddr_in sin;
408#if ENABLE_FEATURE_IPV6
409 struct sockaddr_in6 sin6;
410#endif
411 }
412 )
413};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000414/* Create stream socket, and allocate suitable lsa.
415 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000416 * af == AF_UNSPEC will result in trying to create IPv6 socket,
417 * and if kernel doesn't support it, IPv4.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000418 */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000419#if ENABLE_FEATURE_IPV6
420int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type);
421#else
422int xsocket_type(len_and_sockaddr **lsap, int sock_type);
423#define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
424#endif
Denis Vlasenko5d687242007-01-12 20:59:31 +0000425int xsocket_stream(len_and_sockaddr **lsap);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000426/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000427 * numeric IP ("N.N.N.N") or numeric IPv6 address,
428 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000429 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000430/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000431int create_and_bind_stream_or_die(const char *bindaddr, int port);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000432int create_and_bind_dgram_or_die(const char *bindaddr, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000433/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
434 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
435 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
436 * If there is no suffix, port argument is used */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000437int create_and_connect_stream_or_die(const char *peer, int port);
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000438/* Connect to peer identified by lsa */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000439int xconnect_stream(const len_and_sockaddr *lsa);
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000440/* Return malloc'ed len_and_sockaddr with socket address of host:port
441 * Currently will return IPv4 or IPv6 sockaddrs only
442 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000443 * UNIX socket address being returned, IPX sockaddr etc...
444 * On error does bb_error_msg and returns NULL */
445len_and_sockaddr* host2sockaddr(const char *host, int port);
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000446/* Version which dies on error */
Denis Vlasenko42823d52007-02-04 02:39:08 +0000447len_and_sockaddr* xhost2sockaddr(const char *host, int port);
Denis Vlasenko9ca26d32007-02-09 17:32:16 +0000448len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000449/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000450#if !ENABLE_FEATURE_IPV6
451#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
452#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
453#else
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000454len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko42823d52007-02-04 02:39:08 +0000455len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000456#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000457/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000458 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000459 * NB: does NOT do htons() internally, just direct assignment. */
Denis Vlasenko448f0242007-01-22 22:43:05 +0000460void set_nport(len_and_sockaddr *lsa, unsigned port);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000461/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000462int get_nport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000463/* Reverse DNS. Returns NULL on failure. */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000464char* xmalloc_sockaddr2host(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000465/* This one doesn't append :PORTNUM */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000466char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000467/* This one also doesn't fall back to dotted IP (returns NULL) */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000468char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
Denis Vlasenko448f0242007-01-22 22:43:05 +0000469/* inet_[ap]ton on steroids */
Denis Vlasenkoa27a11b2007-08-18 14:16:39 +0000470char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
471char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
Denis Vlasenko85629f02007-01-22 09:36:41 +0000472// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000473// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenko448f0242007-01-22 22:43:05 +0000474struct hostent *xgethostbyname(const char *name);
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000475// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000476// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000477
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000478
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000479void socket_want_pktinfo(int fd);
480ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000481 const struct sockaddr *to,
482 const struct sockaddr *from,
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000483 socklen_t tolen);
484ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000485 struct sockaddr *from,
486 struct sockaddr *to,
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000487 socklen_t sa_size);
488
Denis Vlasenko4daad902007-09-27 10:20:47 +0000489char *xstrdup(const char *s);
490char *xstrndup(const char *s, int n);
491char *safe_strncpy(char *dst, const char *src, size_t size);
492/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000493 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenko4daad902007-09-27 10:20:47 +0000494int bb_putchar(int ch);
495char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkod3c042f2007-12-30 01:59:53 +0000496/* Prints unprintable chars ch as ^C or M-c to file
497 * (M-c is used only if ch is ORed with PRINTABLE_META),
498 * else it is printed as-is (except for ch = 0x9b) */
499enum { PRINTABLE_META = 0x100 };
500void fputc_printable(int ch, FILE *file);
Denis Vlasenko9f739442006-12-16 23:49:13 +0000501// gcc-4.1.1 still isn't good enough at optimizing it
502// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000503//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000504//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000505//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000506//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000507#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000508#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000509#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000510#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000511#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000512
513/* dmalloc will redefine these to it's own implementation. It is safe
514 * to have the prototypes here unconditionally. */
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000515extern void *malloc_or_warn(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000516extern void *xmalloc(size_t size);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000517extern void *xzalloc(size_t size);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000518extern void *xrealloc(void *old, size_t size);
Eric Andersenaad1a882001-03-16 22:47:14 +0000519
Denis Vlasenkoea620772006-10-14 02:23:43 +0000520extern ssize_t safe_read(int fd, void *buf, size_t count);
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000521extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000522// NB: will return short read on error, not -1,
523// if some data was read before error occurred
Denis Vlasenkoea620772006-10-14 02:23:43 +0000524extern ssize_t full_read(int fd, void *buf, size_t count);
525extern void xread(int fd, void *buf, size_t count);
526extern unsigned char xread_char(int fd);
Denis Vlasenkod67cef22007-06-13 06:47:47 +0000527// Read one line a-la fgets. Uses one read(), works only on seekable streams
Denis Vlasenkoea620772006-10-14 02:23:43 +0000528extern char *reads(int fd, char *buf, size_t count);
Denis Vlasenkod67cef22007-06-13 06:47:47 +0000529// Read one line a-la fgets. Reads byte-by-byte.
530// Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000531// Bytes are appended to pfx (which must be malloced, or NULL).
Denis Vlasenkod67cef22007-06-13 06:47:47 +0000532extern char *xmalloc_reads(int fd, char *pfx);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000533extern ssize_t read_close(int fd, void *buf, size_t count);
534extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
535extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000536
537extern ssize_t safe_write(int fd, const void *buf, size_t count);
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000538// NB: will return short write on error, not -1,
539// if some data was written before error occurred
Denis Vlasenkoea620772006-10-14 02:23:43 +0000540extern ssize_t full_write(int fd, const void *buf, size_t count);
Denis Vlasenko2d27e4c2006-11-25 23:50:28 +0000541extern void xwrite(int fd, const void *buf, size_t count);
Denis Vlasenkoea620772006-10-14 02:23:43 +0000542
Denis Vlasenko1de08302006-10-26 23:32:43 +0000543/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000544extern void xprint_and_close_file(FILE *file);
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000545/* Reads up to (and including) TERMINATING_STRING: */
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000546extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000547/* Chops off TERMINATING_STRING: from the end: */
548extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string);
549/* Reads up to (and including) "\n" or NUL byte */
550extern char *xmalloc_fgets(FILE *file);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000551/* Chops off '\n' from the end, unlike fgets: */
552extern char *xmalloc_getline(FILE *file);
553extern char *bb_get_chunk_from_file(FILE *file, int *end);
554extern void die_if_ferror(FILE *file, const char *msg);
555extern void die_if_ferror_stdout(void);
556extern void xfflush_stdout(void);
Denis Vlasenkof0ed3762006-10-26 23:21:47 +0000557extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000558extern int fclose_if_not_stdin(FILE *file);
559extern FILE *xfopen(const char *filename, const char *mode);
560/* Prints warning to stderr and returns NULL on failure: */
561extern FILE *fopen_or_warn(const char *filename, const char *mode);
562/* "Opens" stdin if filename is special, else just opens file: */
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000563extern FILE *xfopen_stdin(const char *filename);
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000564extern FILE *fopen_or_warn_stdin(const char *filename);
Eric Andersen8876fb22003-06-20 09:01:58 +0000565
Denis Vlasenkofb290382008-03-02 12:51:26 +0000566int bb_pstrcmp(const void *a, const void *b);
567void qsort_string_vector(char **sv, unsigned count);
568
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000569/* Wrapper which restarts poll on EINTR or ENOMEM.
570 * On other errors complains [perror("poll")] and returns.
571 * Warning! May take (much) longer than timeout_ms to return!
572 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
573int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms);
574
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000575char *safe_gethostname(void);
576
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000577/* Convert each alpha char in str to lower-case */
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000578char* str_tolower(char *str);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000579
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000580char *utoa(unsigned n);
581char *itoa(int n);
Denis Vlasenko10457b92007-03-27 22:01:31 +0000582/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000583char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
584char *itoa_to_buf(int n, char *buf, unsigned buflen);
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000585/* Intelligent formatters of bignums */
586void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale);
587void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale);
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000588//TODO: provide pointer to buf (avoid statics)?
589const char *make_human_readable_str(unsigned long long size,
590 unsigned long block_size, unsigned long display_unit);
591/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
592char *bin2hex(char *buf, const char *cp, int count);
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000593
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000594/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000595struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000596 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000597 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000598};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000599#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000600/* Specialized: */
Denis Vlasenko13858992006-10-08 12:49:22 +0000601/* Using xatoi() instead of naive atoi() is not always convenient -
602 * in many places people want *non-negative* values, but store them
603 * in signed int. Therefore we need this one:
604 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
605int xatoi_u(const char *numstr);
Denis Vlasenko13858992006-10-08 12:49:22 +0000606/* Useful for reading port numbers */
607uint16_t xatou16(const char *numstr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000608
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000609
Eric Andersenaad1a882001-03-16 22:47:14 +0000610/* These parse entries in /etc/passwd and /etc/group. This is desirable
611 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000612 * increases target size and is often not needed on embedded systems. */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000613long xuname2uid(const char *name);
614long xgroup2gid(const char *name);
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000615/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000616unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000617/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000618struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000619 uid_t uid;
620 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000621};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000622/* always sets uid and gid */
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000623int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
Denis Vlasenkocce38582007-02-26 22:47:42 +0000624/* chown-like handling of "user[:[group]" */
625void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
Denis Vlasenko3734b942007-07-27 11:20:10 +0000626/* bb_getpwuid, bb_getgrgid:
Denis Vlasenko1d10aaf2007-07-27 11:22:34 +0000627 * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
628 * as a string to buf, return user/group name or NULL
629 * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
630 * bb_getXXXid(NULL, -1, id) - return user/group name or exit
Denis Vlasenko3734b942007-07-27 11:20:10 +0000631*/
632char *bb_getpwuid(char *name, int bufsize, long uid);
633char *bb_getgrgid(char *group, int bufsize, long gid);
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000634/* versions which cache results (useful for ps, ls etc) */
635const char* get_cached_username(uid_t uid);
636const char* get_cached_groupname(gid_t gid);
637void clear_username_cache(void);
638/* internally usernames are saved in fixed-sized char[] buffers */
639enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000640#if ENABLE_FEATURE_CHECK_NAMES
641void die_if_bad_username(const char* name);
642#else
643#define die_if_bad_username(name) ((void)(name))
644#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000645
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000646int execable_file(const char *name);
647char *find_execable(const char *filename);
648int exists_execable(const char *filename);
649
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000650/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
651 * but it may exec busybox and call applet instead of searching PATH.
652 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000653#if ENABLE_FEATURE_PREFER_APPLETS
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000654int bb_execvp(const char *file, char *const argv[]);
655#define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
656#define BB_EXECLP(prog,cmd,...) \
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000657 execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000658 cmd, __VA_ARGS__)
659#else
660#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
661#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
662#endif
663
664/* NOMMU friendy fork+exec */
665pid_t spawn(char **argv);
666pid_t xspawn(char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000667
Denis Vlasenko284d0fa2008-02-16 13:18:17 +0000668int safe_waitpid(int pid, int *wstat, int options);
669/* Unlike waitpid, waits ONLY for one process.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000670 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000671 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000672 * IOW: rc = wait4pid(spawn(argv));
673 * if (rc < 0) bb_perror_msg("%s", argv[0]);
674 * if (rc > 0) bb_error_msg("exit code: %d", rc);
675 */
Denis Vlasenko473dae02007-04-11 07:04:23 +0000676int wait4pid(int pid);
Denis Vlasenkofb0eba72008-01-02 19:55:04 +0000677int wait_any_nohang(int *wstat);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000678#define wait_crashed(w) ((w) & 127)
679#define wait_exitcode(w) ((w) >> 8)
680#define wait_stopsig(w) ((w) >> 8)
681#define wait_stopped(w) (((w) & 127) == 127)
682/* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
683int spawn_and_wait(char **argv);
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000684struct nofork_save_area {
Denis Vlasenkob0550012007-05-24 12:18:16 +0000685 jmp_buf die_jmp;
Denis Vlasenko82d38da2007-10-10 14:38:47 +0000686 const char *applet_name;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000687 int xfunc_error_retval;
688 uint32_t option_mask32;
689 int die_sleep;
690 smallint saved;
691};
692void save_nofork_data(struct nofork_save_area *save);
693void restore_nofork_data(struct nofork_save_area *save);
694/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000695int run_nofork_applet(int applet_no, char **argv);
696int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000697
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000698/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000699 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000700 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000701 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000702 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
703 * rexec's itself on NOMMU with argv passed as command line.
704 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
705 * from the start. (It will detect it and not reexec again second time).
706 * You have to audit carefully that you don't do something twice as a result
707 * (opening files/sockets, parsing config files etc...)!
708 *
709 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
710 * (will do setsid()).
711 *
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000712 * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
713 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenkob44c7902008-03-17 09:29:43 +0000714 * Currently used for openvt and setsid. On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000715 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000716 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000717 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000718 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
719 * to /dev/null if they are not.
720 */
721enum {
722 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000723 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000724 DAEMON_CLOSE_EXTRA_FDS = 4,
725 DAEMON_ONLY_SANITIZE = 8, /* internal use */
726};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000727#if BB_MMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000728 void forkexit_or_rexec(void);
Denis Vlasenko367960b2007-08-18 14:20:21 +0000729 enum { re_execed = 0 };
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000730# define forkexit_or_rexec(argv) forkexit_or_rexec()
731# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
732# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000733#else
Denis Vlasenko367960b2007-08-18 14:20:21 +0000734 void re_exec(char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkob44c7902008-03-17 09:29:43 +0000735 void forkexit_or_rexec(char **argv) ATTRIBUTE_NORETURN;
Bernhard Reutner-Fischer163516d2007-04-10 14:16:19 +0000736 extern bool re_execed;
Denis Vlasenko05743d72008-02-10 12:10:08 +0000737 int BUG_fork_is_unavailable_on_nommu(void);
738 int BUG_daemon_is_unavailable_on_nommu(void);
739 void BUG_bb_daemonize_is_unavailable_on_nommu(void);
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000740# define fork() BUG_fork_is_unavailable_on_nommu()
741# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
742# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000743#endif
744void bb_daemonize_or_rexec(int flags, char **argv);
745void bb_sanitize_stdio(void);
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +0000746/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
747int sanitize_env_if_suid(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000748
749
Denis Vlasenko62a90cd2008-03-17 09:07:36 +0000750extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000751extern const char *opt_complementary;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000752#if ENABLE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +0000753#define No_argument "\0"
754#define Required_argument "\001"
755#define Optional_argument "\002"
756extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +0000757#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000758extern uint32_t option_mask32;
Denis Vlasenkod37f2222007-08-19 13:42:08 +0000759extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000760
761
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000762typedef struct llist_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000763 char *data;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000764 struct llist_t *link;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000765} llist_t;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000766void llist_add_to(llist_t **old_head, void *data);
767void llist_add_to_end(llist_t **list_head, void *data);
768void *llist_pop(llist_t **elm);
769void llist_unlink(llist_t **head, llist_t *elm);
770void llist_free(llist_t *elm, void (*freeit)(void *data));
771llist_t *llist_rev(llist_t *list);
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000772/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000773 * llist_t *llist_add_to(llist_t *old_head, void *data)
774 * etc does not result in smaller code... */
775
Denis Vlasenko80edead2007-08-02 22:31:05 +0000776/* start_stop_daemon and udhcpc are special - they want
777 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +0000778#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000779/* True only if we created pidfile which is *file*, not /dev/null etc */
780extern smallint wrote_pidfile;
781void write_pidfile(const char *path);
782#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000783#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +0000784enum { wrote_pidfile = 0 };
785#define write_pidfile(path) ((void)0)
786#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +0000787#endif
788
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000789enum {
790 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +0000791 LOGMODE_STDIO = (1 << 0),
792 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000793 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
794};
795extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +0000796extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000797extern int die_sleep;
798extern int xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +0000799extern jmp_buf die_jmp;
Denis Vlasenko335b63d2007-04-10 21:38:30 +0000800extern void xfunc_die(void) ATTRIBUTE_NORETURN;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000801extern void bb_show_usage(void) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000802extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
803extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
804extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000805extern void bb_simple_perror_msg(const char *s);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000806extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Denis Vlasenko0c97c9d2007-10-01 11:58:38 +0000807extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000808extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
809extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
810extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
811extern void bb_perror_nomsg(void);
812extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000813extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000814
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000815/* We need to export XXX_main from libbusybox
816 * only if we build "individual" binaries
817 */
818#if ENABLE_FEATURE_INDIVIDUAL
819#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
820#else
821#define MAIN_EXTERNALLY_VISIBLE
822#endif
823
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000824
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000825/* applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +0000826int bb_cat(char** argv);
Denis Vlasenkofe5e23b2007-11-24 02:23:51 +0000827int echo_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000828int test_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
829int kill_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko703e2022007-01-22 14:12:08 +0000830#if ENABLE_ROUTE
Denis Vlasenko06af2162007-02-03 17:28:39 +0000831void bb_displayroutes(int noresolve, int netstatfmt);
832#endif
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000833int chown_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko06af2162007-02-03 17:28:39 +0000834#if ENABLE_GUNZIP
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +0000835int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko703e2022007-01-22 14:12:08 +0000836#endif
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000837#if ENABLE_BUNZIP2
838int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
839#endif
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000840int bbunpack(char **argv,
Denis Vlasenkoc86e0522007-03-20 11:30:28 +0000841 char* (*make_new_name)(char *filename),
842 USE_DESKTOP(long long) int (*unpacker)(void)
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000843);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000844
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000845
846/* Networking */
847int create_icmp_socket(void);
848int create_icmp6_socket(void);
849/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000850/* This structure defines protocol families and their handlers. */
851struct aftype {
852 const char *name;
853 const char *title;
854 int af;
855 int alen;
856 char *(*print) (unsigned char *);
857 const char *(*sprint) (struct sockaddr *, int numeric);
858 int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
859 void (*herror) (char *text);
860 int (*rprint) (int options);
861 int (*rinput) (int typ, int ext, char **argv);
862
863 /* may modify src */
864 int (*getmask) (char *src, struct sockaddr * mask, char *name);
865};
866/* This structure defines hardware protocols and their handlers. */
867struct hwtype {
868 const char *name;
869 const char *title;
870 int type;
871 int alen;
872 char *(*print) (unsigned char *);
873 int (*input) (const char *, struct sockaddr *);
874 int (*activate) (int fd);
875 int suppress_null_addr;
876};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +0000877extern smallint interface_opt_a;
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000878int display_interfaces(char *ifname);
Denis Vlasenko1cc70222007-03-15 19:46:43 +0000879const struct aftype *get_aftype(const char *name);
Denis Vlasenkofa85b862007-01-07 01:24:12 +0000880const struct hwtype *get_hwtype(const char *name);
881const struct hwtype *get_hwntype(int type);
Denis Vlasenko270c17c2006-12-26 17:40:33 +0000882
883
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000884#ifndef BUILD_INDIVIDUAL
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000885extern int find_applet_by_name(const char *name);
Denis Vlasenko32b633a2007-04-09 03:05:48 +0000886/* Returns only if applet is not found. */
Denis Vlasenkof5294e12007-04-14 10:09:57 +0000887extern void run_applet_and_exit(const char *name, char **argv);
Denis Vlasenko1aa7e472007-11-28 06:49:03 +0000888extern void run_applet_no_and_exit(int a, char **argv) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000889#endif
890
Mike Frysinger9412ec72008-02-07 22:41:33 +0000891#ifdef HAVE_MNTENT_H
Denis Vlasenkobf295dd2007-04-05 21:57:47 +0000892extern int match_fstype(const struct mntent *mt, const char *fstypes);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000893extern struct mntent *find_mount_point(const char *name, const char *table);
Mike Frysinger9412ec72008-02-07 22:41:33 +0000894#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000895extern void erase_mtab(const char * name);
896extern unsigned int tty_baud_to_value(speed_t speed);
897extern speed_t tty_value_to_baud(unsigned int value);
898extern void bb_warn_ignoring_args(int n);
899
900extern int get_linux_version_code(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000901
Rob Landley1d589b22005-11-29 23:47:10 +0000902extern char *query_loop(const char *device);
Eric Andersenaad1a882001-03-16 22:47:14 +0000903extern int del_loop(const char *device);
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +0000904/* If *devname is not NULL, use that name, otherwise try to find free one,
905 * malloc and return it in *devname.
906 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
907extern int set_loop(char **devname, const char *file, unsigned long long offset);
Eric Andersenaad1a882001-03-16 22:47:14 +0000908
Eric Andersenaad1a882001-03-16 22:47:14 +0000909
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000910//TODO: pass buf pointer or return allocated buf (avoid statics)?
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000911char *bb_askpass(int timeout, const char * prompt);
Manuel Novoa III cad53642003-03-19 09:13:01 +0000912int bb_ask_confirmation(void);
Eric Andersenaad1a882001-03-16 22:47:14 +0000913
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000914extern int bb_parse_mode(const char* s, mode_t* theMode);
915
Eric Andersene5dfced2001-04-09 22:48:12 +0000916char *concat_path_file(const char *path, const char *filename);
Glenn L McGrath393183d2003-05-26 14:07:50 +0000917char *concat_subpath_file(const char *path, const char *filename);
Denis Vlasenkodc757aa2007-06-30 08:04:05 +0000918const char *bb_basename(const char *name);
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000919/* NB: can violate const-ness (similarly to strchr) */
Eric Andersenc911a432001-05-15 17:42:16 +0000920char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000921
Denis Vlasenko4921b542007-02-03 02:17:41 +0000922
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000923USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
924int inflate(int in, int out);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000925
Denis Vlasenko14579152006-10-26 01:09:46 +0000926
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000927int bb_make_directory(char *path, long mode, int flags);
Matt Kraaiceeff732001-06-21 19:41:37 +0000928
Denis Vlasenkoa77947f2006-09-27 14:19:16 +0000929int get_signum(const char *name);
930const char *get_signame(int number);
Denis Vlasenkoa4f4de92007-09-30 16:32:01 +0000931void print_signames(void);
Rob Landleyc9c1a412006-07-12 19:17:55 +0000932
Manuel Novoa III cad53642003-03-19 09:13:01 +0000933char *bb_simplify_path(const char *path);
Eric Andersen34506362001-08-02 05:02:46 +0000934
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000935#define FAIL_DELAY 3
936extern void bb_do_delay(int seconds);
937extern void change_identity(const struct passwd *pw);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000938extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000939extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000940#if ENABLE_SELINUX
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000941extern void renew_current_security_context(void);
942extern void set_current_security_context(security_context_t sid);
Denis Vlasenko1203c9b2007-03-11 22:16:02 +0000943extern context_t set_security_context_component(security_context_t cur_context,
944 char *user, char *role, char *type, char *range);
Denis Vlasenko39c651e2007-03-12 18:22:55 +0000945extern void setfscreatecon_or_die(security_context_t scontext);
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +0000946extern void selinux_preserve_fcontext(int fdesc);
947#else
948#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000949#endif
Denis Vlasenkod46d3c22007-02-06 19:28:50 +0000950extern void selinux_or_die(void);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000951extern int restricted_shell(const char *shell);
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000952
953/* setup_environment:
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000954 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000955 * TERM=(old value)
956 * USER=pw->pw_name, LOGNAME=pw->pw_name
957 * PATH=bb_default_[root_]path
958 * HOME=pw->pw_dir
959 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000960 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +0000961 * if not root (if pw->pw_uid != 0):
962 * USER=pw->pw_name, LOGNAME=pw->pw_name
963 * HOME=pw->pw_dir
964 * SHELL=shell
965 * else does nothing
966 */
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000967extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000968extern int correct_password(const struct passwd *pw);
Denis Vlasenko21d10142007-07-20 21:28:41 +0000969/* Returns a ptr to static storage */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000970extern char *pw_encrypt(const char *clear, const char *salt);
971extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
Denis Vlasenkobfc3d822007-11-04 04:10:17 +0000972
973int index_in_str_array(const char *const string_array[], const char *key);
974int index_in_strings(const char *strings, const char *key);
975int index_in_substr_array(const char *const string_array[], const char *key);
976int index_in_substrings(const char *strings, const char *key);
977const char *nth_string(const char *strings, int n);
978
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000979extern void print_login_issue(const char *issue_file, const char *tty);
980extern void print_login_prompt(void);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000981
Denis Vlasenko21d10142007-07-20 21:28:41 +0000982/* rnd is additional random input. New one is returned.
983 * Useful if you call crypt_make_salt many times in a row:
984 * rnd = crypt_make_salt(buf1, 4, 0);
985 * rnd = crypt_make_salt(buf2, 4, rnd);
986 * rnd = crypt_make_salt(buf3, 4, rnd);
987 * (otherwise we risk having same salt generated)
988 */
989extern int crypt_make_salt(char *p, int cnt, int rnd);
990
991/* Returns number of lines changed, or -1 on error */
992extern int update_passwd(const char *filename, const char *username,
993 const char *new_pw);
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000994
Denis Vlasenkof893da82007-08-09 08:27:24 +0000995/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
996int get_terminal_width_height(int fd, int *width, int *height);
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000997
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +0000998int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
999void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
1000#if ENABLE_IOCTL_HEX2STR_ERROR
1001int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name);
1002void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name);
1003#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1004#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1005#else
1006int bb_ioctl_or_warn(int fd, int request, void *argp);
1007void bb_xioctl(int fd, int request, void *argp);
1008#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1009#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1010#endif
1011
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001012char *is_in_ino_dev_hashtable(const struct stat *statbuf);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001013void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
1014void reset_ino_dev_hashtable(void);
Denis Vlasenko0b354702006-11-24 14:54:27 +00001015#ifdef __GLIBC__
1016/* At least glibc has horrendously large inline for this, so wrap it */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001017unsigned long long bb_makedev(unsigned int major, unsigned int minor);
Denis Vlasenko0b354702006-11-24 14:54:27 +00001018#undef makedev
1019#define makedev(a,b) bb_makedev(a,b)
1020#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001021
1022
Denis Vlasenko38f63192007-01-22 09:03:07 +00001023#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001024/* It's NOT just ENABLEd or disabled. It's a number: */
Denis Vlasenko38f63192007-01-22 09:03:07 +00001025#ifdef CONFIG_FEATURE_EDITING_HISTORY
1026#define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001027#else
1028#define MAX_HISTORY 0
1029#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001030typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001031 int flags;
1032 const char *path_lookup;
1033#if MAX_HISTORY
1034 int cnt_history;
1035 int cur_history;
Denis Vlasenko38f63192007-01-22 09:03:07 +00001036 USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001037 char *history[MAX_HISTORY + 1];
1038#endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001039} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001040enum {
1041 DO_HISTORY = 1 * (MAX_HISTORY > 0),
Denis Vlasenko38f63192007-01-22 09:03:07 +00001042 SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1043 TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1044 USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1045 VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001046 WITH_PATH_LOOKUP = 0x20,
1047 FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1048};
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001049line_input_t *new_line_input_t(int flags);
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001050/* Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001051 * -1 on read errors or EOF, or on bare Ctrl-D,
1052 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001053 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001054 */
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001055int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
1056#else
1057int read_line_input(const char* prompt, char* command, int maxsize);
1058#define read_line_input(prompt, command, maxsize, state) \
1059 read_line_input(prompt, command, maxsize)
1060#endif
1061
1062
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001063#ifndef COMM_LEN
1064#ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001065enum { COMM_LEN = TASK_COMM_LEN };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001066#else
1067/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001068enum { COMM_LEN = 16 };
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001069#endif
1070#endif
Denis Vlasenko512499c2007-08-26 18:23:13 +00001071typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001072 DIR *dir;
Denis Vlasenko512499c2007-08-26 18:23:13 +00001073 uint8_t shift_pages_to_bytes;
1074 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001075/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001076 char *argv0;
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001077 USE_SELINUX(char *context;)
1078 /* Everything below must contain no ptrs to malloc'ed data:
1079 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001080 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001081 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001082 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001083 unsigned pid;
1084 unsigned ppid;
1085 unsigned pgid;
1086 unsigned sid;
1087 unsigned uid;
1088 unsigned gid;
Denis Vlasenko31789a82007-06-19 14:43:17 +00001089 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001090#if ENABLE_FEATURE_TOPMEM
1091 unsigned long mapped_rw;
1092 unsigned long mapped_ro;
1093 unsigned long shared_clean;
1094 unsigned long shared_dirty;
1095 unsigned long private_clean;
1096 unsigned long private_dirty;
1097 unsigned long stack;
1098#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001099 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001100 /* basename of executable in exec(2), read from /proc/N/stat
1101 * (if executable is symlink or script, it is NOT replaced
1102 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001103 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001104 /* user/group? - use passwd/group parsing functions */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001105} procps_status_t;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001106enum {
1107 PSSCAN_PID = 1 << 0,
1108 PSSCAN_PPID = 1 << 1,
1109 PSSCAN_PGID = 1 << 2,
1110 PSSCAN_SID = 1 << 3,
1111 PSSCAN_UIDGID = 1 << 4,
1112 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001113 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001114 PSSCAN_ARGV0 = 1 << 7,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001115 /* PSSCAN_EXE = 1 << 8, - not implemented */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001116 PSSCAN_STATE = 1 << 9,
1117 PSSCAN_VSZ = 1 << 10,
1118 PSSCAN_RSS = 1 << 11,
1119 PSSCAN_STIME = 1 << 12,
1120 PSSCAN_UTIME = 1 << 13,
1121 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001122 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko72e1c892007-09-29 22:26:01 +00001123 PSSCAN_ARGVN = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1124 USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001125 PSSCAN_START_TIME = 1 << 18,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001126 /* These are all retrieved from proc/NN/stat in one go: */
1127 PSSCAN_STAT = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1128 | PSSCAN_COMM | PSSCAN_STATE
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001129 | PSSCAN_VSZ | PSSCAN_RSS
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001130 | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
Denis Vlasenko516a0ca2007-04-19 14:46:14 +00001131 | PSSCAN_TTY,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001132};
Denis Vlasenko68404f12008-03-17 09:00:54 +00001133//procps_status_t* alloc_procps_scan(void);
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001134void free_procps_scan(procps_status_t* sp);
1135procps_status_t* procps_scan(procps_status_t* sp, int flags);
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001136/* Format cmdline (up to col chars) into char buf[col+1] */
1137/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1138void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
Denis Vlasenko35fb5122006-11-01 09:16:49 +00001139pid_t *find_pid_by_name(const char* procName);
1140pid_t *pidlist_reverse(pid_t *pidList);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001141
1142
1143extern const char bb_uuenc_tbl_base64[];
1144extern const char bb_uuenc_tbl_std[];
Denis Vlasenkoe8240f12007-06-26 15:59:37 +00001145void bb_uuencode(char *store, const void *s, int length, const char *tbl);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001146
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001147typedef struct sha1_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001148 uint32_t count[2];
1149 uint32_t hash[5];
1150 uint32_t wbuf[16];
1151} sha1_ctx_t;
1152void sha1_begin(sha1_ctx_t *ctx);
1153void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
1154void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
1155
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001156typedef struct md5_ctx_t {
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001157 uint32_t A;
1158 uint32_t B;
1159 uint32_t C;
1160 uint32_t D;
1161 uint64_t total;
1162 uint32_t buflen;
1163 char buffer[128];
1164} md5_ctx_t;
1165void md5_begin(md5_ctx_t *ctx);
1166void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
1167void *md5_end(void *resbuf, md5_ctx_t *ctx);
1168
Denis Vlasenkoc6758a02007-04-10 21:40:19 +00001169uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001170
1171
Denis Vlasenko49622d72007-03-10 16:58:49 +00001172enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Matt Kraai01441032001-04-24 01:30:02 +00001173 FILEUTILS_PRESERVE_STATUS = 1,
Matt Kraai4c557bf2001-10-05 01:35:10 +00001174 FILEUTILS_DEREFERENCE = 2,
Matt Kraai01441032001-04-24 01:30:02 +00001175 FILEUTILS_RECUR = 4,
1176 FILEUTILS_FORCE = 8,
Denis Vlasenkof24e1f42006-10-21 23:40:20 +00001177 FILEUTILS_INTERACTIVE = 0x10,
1178 FILEUTILS_MAKE_HARDLINK = 0x20,
1179 FILEUTILS_MAKE_SOFTLINK = 0x40,
Denis Vlasenko49622d72007-03-10 16:58:49 +00001180#if ENABLE_SELINUX
1181 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
1182 FILEUTILS_SET_SECURITY_CONTEXT = 0x100
1183#endif
Matt Kraai91b28552001-04-23 18:53:07 +00001184};
1185
Denis Vlasenko49622d72007-03-10 16:58:49 +00001186#define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001187extern const char *applet_name;
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001188/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001189extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001190extern const char bb_msg_memory_exhausted[];
1191extern const char bb_msg_invalid_date[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001192extern const char bb_msg_read_error[];
1193extern const char bb_msg_write_error[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001194extern const char bb_msg_unknown[];
1195extern const char bb_msg_can_not_create_raw_socket[];
1196extern const char bb_msg_perm_denied_are_you_root[];
1197extern const char bb_msg_requires_arg[];
1198extern const char bb_msg_invalid_arg[];
1199extern const char bb_msg_standard_input[];
1200extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001201
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001202extern const char bb_str_default[];
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001203/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001204extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001205
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001206extern const char bb_path_mtab_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001207extern const char bb_path_passwd_file[];
1208extern const char bb_path_shadow_file[];
1209extern const char bb_path_gshadow_file[];
1210extern const char bb_path_group_file[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001211extern const char bb_path_motd_file[];
1212extern const char bb_path_wtmp_file[];
1213extern const char bb_dev_null[];
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001214extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001215/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1216 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001217extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1218#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1219#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001220
Denis Vlasenko703e2022007-01-22 14:12:08 +00001221extern const int const_int_0;
1222extern const int const_int_1;
1223
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001224
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001225#ifndef BUFSIZ
1226#define BUFSIZ 4096
1227#endif
Denis Vlasenko85818632007-04-19 14:47:11 +00001228/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001229enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1230extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001231/* This struct is deliberately not defined. */
1232/* See docs/keep_data_small.txt */
1233struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001234/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001235 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001236 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001237extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001238/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1239#define barrier() asm volatile("":::"memory")
1240#define SET_PTR_TO_GLOBALS(x) do { \
1241 (*(struct globals**)&ptr_to_globals) = (x); \
1242 barrier(); \
1243} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001244
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001245/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1246 * use bb_default_login_shell and following defines.
1247 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1248 * don't forget to change increment constant. */
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001249#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001250extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001251/* "/bin/sh" */
1252#define DEFAULT_SHELL (bb_default_login_shell+1)
1253/* "sh" */
1254#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
1255
1256
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001257#if ENABLE_FEATURE_DEVFS
Matt Kraai439e3df2001-07-23 14:52:08 +00001258# define CURRENT_VC "/dev/vc/0"
1259# define VC_1 "/dev/vc/1"
1260# define VC_2 "/dev/vc/2"
1261# define VC_3 "/dev/vc/3"
1262# define VC_4 "/dev/vc/4"
1263# define VC_5 "/dev/vc/5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001264#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1265/* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1266 respective serial ports .. as such, we can't use the common device paths for
1267 these. -- PFM */
1268# define SC_0 "/dev/ttsc/0"
1269# define SC_1 "/dev/ttsc/1"
1270# define SC_FORMAT "/dev/ttsc/%d"
1271#else
1272# define SC_0 "/dev/tts/0"
1273# define SC_1 "/dev/tts/1"
1274# define SC_FORMAT "/dev/tts/%d"
1275#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001276# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001277# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001278# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001279# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001280# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001281#else
1282# define CURRENT_VC "/dev/tty0"
1283# define VC_1 "/dev/tty1"
1284# define VC_2 "/dev/tty2"
1285# define VC_3 "/dev/tty3"
1286# define VC_4 "/dev/tty4"
1287# define VC_5 "/dev/tty5"
Eric Andersen592ebd52003-07-22 07:33:14 +00001288#if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1289# define SC_0 "/dev/ttySC0"
1290# define SC_1 "/dev/ttySC1"
1291# define SC_FORMAT "/dev/ttySC%d"
1292#else
1293# define SC_0 "/dev/ttyS0"
1294# define SC_1 "/dev/ttyS1"
1295# define SC_FORMAT "/dev/ttyS%d"
1296#endif
Matt Kraai439e3df2001-07-23 14:52:08 +00001297# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001298# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001299# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001300# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001301# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001302#endif
1303
1304/* The following devices are the same on devfs and non-devfs systems. */
1305#define CURRENT_TTY "/dev/tty"
Denis Vlasenkoec27feb2007-02-17 15:52:02 +00001306#define DEV_CONSOLE "/dev/console"
Matt Kraai439e3df2001-07-23 14:52:08 +00001307
Rob Landleyc57ec372006-04-10 17:07:15 +00001308
Rob Landleyb623a542006-05-31 22:09:03 +00001309#ifndef RB_POWER_OFF
1310/* Stop system and switch power off if possible. */
1311#define RB_POWER_OFF 0x4321fedc
1312#endif
1313
Denis Vlasenkocf30cc82006-11-24 14:53:18 +00001314/* Make sure we call functions instead of macros. */
Rob Landley4ae905a2006-07-06 17:22:54 +00001315#undef isalnum
1316#undef isalpha
1317#undef isascii
1318#undef isblank
1319#undef iscntrl
Rob Landley4ae905a2006-07-06 17:22:54 +00001320#undef isgraph
1321#undef islower
1322#undef isprint
1323#undef ispunct
1324#undef isspace
1325#undef isupper
1326#undef isxdigit
1327
Denis Vlasenko459903b2006-11-27 14:44:18 +00001328/* This one is more efficient - we save ~400 bytes */
1329#undef isdigit
1330#define isdigit(a) ((unsigned)((a) - '0') <= 9)
1331
1332
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001333#ifdef DMALLOC
1334#include <dmalloc.h>
1335#endif
1336
Denis Vlasenko80b8b392007-06-25 10:55:35 +00001337#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
1338
Bernhard Reutner-Fischer86f5c992006-01-22 22:55:11 +00001339#endif /* __LIBBUSYBOX_H__ */