libbb.h 72 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911
  1. /* vi: set sw=4 ts=4: */
  2. /*
  3. * Busybox main internal header file
  4. *
  5. * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
  6. * Permission has been granted to redistribute this code under GPL.
  7. *
  8. * Licensed under GPLv2, see file LICENSE in this source tree.
  9. */
  10. #ifndef LIBBB_H
  11. #define LIBBB_H 1
  12. #include "platform.h"
  13. #include <ctype.h>
  14. #include <dirent.h>
  15. #include <errno.h>
  16. #include <fcntl.h>
  17. #include <inttypes.h>
  18. #include <netdb.h>
  19. #include <setjmp.h>
  20. #include <signal.h>
  21. #if defined __UCLIBC__ /* TODO: and glibc? */
  22. /* use inlined versions of these: */
  23. # define sigfillset(s) __sigfillset(s)
  24. # define sigemptyset(s) __sigemptyset(s)
  25. # define sigisemptyset(s) __sigisemptyset(s)
  26. #endif
  27. #include <stdint.h>
  28. #include <stdio.h>
  29. #include <stdlib.h>
  30. #include <stdarg.h>
  31. #include <stddef.h>
  32. #include <string.h>
  33. /* There are two incompatible basename's, let not use them! */
  34. /* See the dirname/basename man page for details */
  35. #include <libgen.h> /* dirname,basename */
  36. #undef basename
  37. #define basename dont_use_basename
  38. #include <sys/poll.h>
  39. #include <sys/ioctl.h>
  40. #include <sys/mman.h>
  41. #include <sys/socket.h>
  42. #include <sys/stat.h>
  43. #include <sys/time.h>
  44. #include <sys/types.h>
  45. #ifndef major
  46. # include <sys/sysmacros.h>
  47. #endif
  48. #include <sys/wait.h>
  49. #include <termios.h>
  50. #include <time.h>
  51. #include <sys/param.h>
  52. #include <pwd.h>
  53. #include <grp.h>
  54. #if ENABLE_FEATURE_SHADOWPASSWDS
  55. # if !ENABLE_USE_BB_SHADOW
  56. /* If using busybox's shadow implementation, do not include the shadow.h
  57. * header as the toolchain may not provide it at all.
  58. */
  59. # include <shadow.h>
  60. # endif
  61. #endif
  62. #if defined(ANDROID) || defined(__ANDROID__)
  63. # define endpwent() ((void)0)
  64. # define endgrent() ((void)0)
  65. #endif
  66. #ifdef HAVE_MNTENT_H
  67. # include <mntent.h>
  68. #endif
  69. #ifdef HAVE_SYS_STATFS_H
  70. # include <sys/statfs.h>
  71. #endif
  72. /* Don't do this here:
  73. * #include <sys/sysinfo.h>
  74. * Some linux/ includes pull in conflicting definition
  75. * of struct sysinfo (only in some toolchanins), which breaks build.
  76. * Include sys/sysinfo.h only in those files which need it.
  77. */
  78. #if ENABLE_SELINUX
  79. # include <selinux/selinux.h>
  80. # include <selinux/context.h>
  81. # include <selinux/flask.h>
  82. # include <selinux/av_permissions.h>
  83. #endif
  84. #if ENABLE_FEATURE_UTMP
  85. # include <utmp.h>
  86. #endif
  87. #if ENABLE_LOCALE_SUPPORT
  88. # include <locale.h>
  89. #else
  90. # define setlocale(x,y) ((void)0)
  91. #endif
  92. #ifdef DMALLOC
  93. # include <dmalloc.h>
  94. #endif
  95. /* Just in case libc doesn't define some of these... */
  96. #ifndef _PATH_PASSWD
  97. #define _PATH_PASSWD "/etc/passwd"
  98. #endif
  99. #ifndef _PATH_GROUP
  100. #define _PATH_GROUP "/etc/group"
  101. #endif
  102. #ifndef _PATH_SHADOW
  103. #define _PATH_SHADOW "/etc/shadow"
  104. #endif
  105. #ifndef _PATH_GSHADOW
  106. #define _PATH_GSHADOW "/etc/gshadow"
  107. #endif
  108. #if defined __FreeBSD__ || defined __OpenBSD__
  109. # include <netinet/in.h>
  110. # include <arpa/inet.h>
  111. #elif defined __APPLE__
  112. # include <netinet/in.h>
  113. #else
  114. # include <arpa/inet.h>
  115. # if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
  116. /* We #define socklen_t *after* includes, otherwise we get
  117. * typedef redefinition errors from system headers
  118. * (in case "is it defined already" detection above failed)
  119. */
  120. # define socklen_t bb_socklen_t
  121. typedef unsigned socklen_t;
  122. # endif
  123. #endif
  124. #ifndef HAVE_CLEARENV
  125. # define clearenv() do { if (environ) environ[0] = NULL; } while (0)
  126. #endif
  127. #ifndef HAVE_FDATASYNC
  128. # define fdatasync fsync
  129. #endif
  130. #ifndef HAVE_XTABS
  131. # define XTABS TAB3
  132. #endif
  133. /* Some libc's forget to declare these, do it ourself */
  134. extern char **environ;
  135. #if defined(__GLIBC__) && __GLIBC__ < 2
  136. int vdprintf(int d, const char *format, va_list ap);
  137. #endif
  138. /* klogctl is in libc's klog.h, but we cheat and not #include that */
  139. int klogctl(int type, char *b, int len);
  140. #ifndef PATH_MAX
  141. # define PATH_MAX 256
  142. #endif
  143. #ifndef BUFSIZ
  144. # define BUFSIZ 4096
  145. #endif
  146. /* Busybox does not use threads, we can speed up stdio. */
  147. #ifdef HAVE_UNLOCKED_STDIO
  148. # undef getc
  149. # define getc(stream) getc_unlocked(stream)
  150. # undef getchar
  151. # define getchar() getchar_unlocked()
  152. # undef putc
  153. # define putc(c, stream) putc_unlocked(c, stream)
  154. # undef putchar
  155. # define putchar(c) putchar_unlocked(c)
  156. # undef fgetc
  157. # define fgetc(stream) getc_unlocked(stream)
  158. # undef fputc
  159. # define fputc(c, stream) putc_unlocked(c, stream)
  160. #endif
  161. /* Above functions are required by POSIX.1-2008, below ones are extensions */
  162. #ifdef HAVE_UNLOCKED_LINE_OPS
  163. # undef fgets
  164. # define fgets(s, n, stream) fgets_unlocked(s, n, stream)
  165. # undef fputs
  166. # define fputs(s, stream) fputs_unlocked(s, stream)
  167. #endif
  168. /* Make all declarations hidden (-fvisibility flag only affects definitions) */
  169. /* (don't include system headers after this until corresponding pop!) */
  170. PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
  171. #if ENABLE_USE_BB_PWD_GRP
  172. # include "pwd_.h"
  173. # include "grp_.h"
  174. #endif
  175. #if ENABLE_FEATURE_SHADOWPASSWDS
  176. # if ENABLE_USE_BB_SHADOW
  177. # include "shadow_.h"
  178. # endif
  179. #endif
  180. /* Tested to work correctly with all int types (IIRC :]) */
  181. #define MAXINT(T) (T)( \
  182. ((T)-1) > 0 \
  183. ? (T)-1 \
  184. : (T)~((T)1 << (sizeof(T)*8-1)) \
  185. )
  186. #define MININT(T) (T)( \
  187. ((T)-1) > 0 \
  188. ? (T)0 \
  189. : ((T)1 << (sizeof(T)*8-1)) \
  190. )
  191. /* Large file support */
  192. /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
  193. * (stat, lseek etc) mapped to "largefile" variants by libc.
  194. * Practically it means that open() automatically has O_LARGEFILE added
  195. * and all filesize/file_offset parameters and struct members are "large"
  196. * (in today's world - signed 64bit). For full support of large files,
  197. * we need a few helper #defines (below) and careful use of off_t
  198. * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
  199. #if ENABLE_LFS
  200. /* CONFIG_LFS is on */
  201. # if ULONG_MAX > 0xffffffff
  202. /* "long" is long enough on this system */
  203. typedef unsigned long uoff_t;
  204. # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
  205. /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
  206. # define BB_STRTOOFF bb_strtoul
  207. # define STRTOOFF strtoul
  208. /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
  209. # define OFF_FMT "l"
  210. # else
  211. /* "long" is too short, need "long long" */
  212. typedef unsigned long long uoff_t;
  213. # define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
  214. # define BB_STRTOOFF bb_strtoull
  215. # define STRTOOFF strtoull
  216. # define OFF_FMT "ll"
  217. # endif
  218. #else
  219. /* CONFIG_LFS is off */
  220. # if UINT_MAX == 0xffffffff
  221. /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
  222. * gcc will throw warnings on printf("%d", off_t). Crap... */
  223. typedef unsigned long uoff_t;
  224. # define XATOOFF(a) xatoi_positive(a)
  225. # define BB_STRTOOFF bb_strtou
  226. # define STRTOOFF strtol
  227. # define OFF_FMT "l"
  228. # else
  229. typedef unsigned long uoff_t;
  230. # define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
  231. # define BB_STRTOOFF bb_strtoul
  232. # define STRTOOFF strtol
  233. # define OFF_FMT "l"
  234. # endif
  235. #endif
  236. /* scary. better ideas? (but do *test* them first!) */
  237. #define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
  238. /* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
  239. * We misdetected that. Don't let it build:
  240. */
  241. struct BUG_off_t_size_is_misdetected {
  242. char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
  243. };
  244. /* Some useful definitions */
  245. #undef FALSE
  246. #define FALSE ((int) 0)
  247. #undef TRUE
  248. #define TRUE ((int) 1)
  249. #undef SKIP
  250. #define SKIP ((int) 2)
  251. /* Macros for min/max. */
  252. #ifndef MIN
  253. #define MIN(a,b) (((a)<(b))?(a):(b))
  254. #endif
  255. #ifndef MAX
  256. #define MAX(a,b) (((a)>(b))?(a):(b))
  257. #endif
  258. /* buffer allocation schemes */
  259. #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
  260. #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
  261. #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
  262. #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
  263. #else
  264. #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
  265. #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
  266. #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
  267. #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
  268. #else
  269. #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
  270. #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
  271. #define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
  272. #endif
  273. #endif
  274. #if defined(__GLIBC__)
  275. /* glibc uses __errno_location() to get a ptr to errno */
  276. /* We can just memorize it once - no multithreading in busybox :) */
  277. extern int *const bb_errno;
  278. #undef errno
  279. #define errno (*bb_errno)
  280. #endif
  281. #if !(ULONG_MAX > 0xffffffff)
  282. /* Only 32-bit CPUs need this, 64-bit ones use inlined version */
  283. uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
  284. #endif
  285. unsigned long long monotonic_ns(void) FAST_FUNC;
  286. unsigned long long monotonic_us(void) FAST_FUNC;
  287. unsigned long long monotonic_ms(void) FAST_FUNC;
  288. unsigned monotonic_sec(void) FAST_FUNC;
  289. extern void chomp(char *s) FAST_FUNC;
  290. extern void trim(char *s) FAST_FUNC;
  291. extern char *skip_whitespace(const char *) FAST_FUNC;
  292. extern char *skip_non_whitespace(const char *) FAST_FUNC;
  293. extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
  294. extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
  295. //TODO: supply a pointer to char[11] buffer (avoid statics)?
  296. extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
  297. extern int is_directory(const char *name, int followLinks) FAST_FUNC;
  298. enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
  299. FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
  300. FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
  301. FILEUTILS_RECUR = 1 << 2, /* -R */
  302. FILEUTILS_FORCE = 1 << 3, /* -f */
  303. FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
  304. FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
  305. FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
  306. FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
  307. FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
  308. #if ENABLE_SELINUX
  309. FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
  310. FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
  311. #endif
  312. FILEUTILS_IGNORE_CHMOD_ERR = 1 << 11,
  313. };
  314. #define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
  315. extern int remove_file(const char *path, int flags) FAST_FUNC;
  316. /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
  317. * the source, not copy (unless "source" is a directory).
  318. * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
  319. * work coreutils-compatibly. */
  320. extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
  321. enum {
  322. ACTION_RECURSE = (1 << 0),
  323. ACTION_FOLLOWLINKS = (1 << 1),
  324. ACTION_FOLLOWLINKS_L0 = (1 << 2),
  325. ACTION_DEPTHFIRST = (1 << 3),
  326. /*ACTION_REVERSE = (1 << 4), - unused */
  327. ACTION_QUIET = (1 << 5),
  328. ACTION_DANGLING_OK = (1 << 6),
  329. };
  330. typedef uint8_t recurse_flags_t;
  331. extern int recursive_action(const char *fileName, unsigned flags,
  332. int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
  333. int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
  334. void* userData, unsigned depth) FAST_FUNC;
  335. extern int device_open(const char *device, int mode) FAST_FUNC;
  336. enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
  337. extern int xgetpty(char *line) FAST_FUNC;
  338. extern int get_console_fd_or_die(void) FAST_FUNC;
  339. extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
  340. extern char *find_block_device(const char *path) FAST_FUNC;
  341. /* bb_copyfd_XX print read/write errors and return -1 if they occur */
  342. extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
  343. extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
  344. extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
  345. /* "short" copy can be detected by return value < size */
  346. /* this helper yells "short read!" if param is not -1 */
  347. extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
  348. extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
  349. char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
  350. /* xxxx_strip version can modify its parameter:
  351. * "/" -> "/"
  352. * "abc" -> "abc"
  353. * "abc/def" -> "def"
  354. * "abc/def/" -> "def" !!
  355. */
  356. char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
  357. /* "abc/def/" -> "" and it never modifies 'path' */
  358. char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
  359. /* Simpler version: does not special case "/" string */
  360. const char *bb_basename(const char *name) FAST_FUNC;
  361. /* NB: can violate const-ness (similarly to strchr) */
  362. char *last_char_is(const char *s, int c) FAST_FUNC;
  363. void ndelay_on(int fd) FAST_FUNC;
  364. void ndelay_off(int fd) FAST_FUNC;
  365. void close_on_exec_on(int fd) FAST_FUNC;
  366. void xdup2(int, int) FAST_FUNC;
  367. void xmove_fd(int, int) FAST_FUNC;
  368. DIR *xopendir(const char *path) FAST_FUNC;
  369. DIR *warn_opendir(const char *path) FAST_FUNC;
  370. char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
  371. char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
  372. char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
  373. /* !RETURNS_MALLOC: it's a realloc-like function */
  374. char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
  375. char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
  376. enum {
  377. /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
  378. * otherwise would kill us, except for those resulting from bugs:
  379. * SIGSEGV, SIGILL, SIGFPE.
  380. * Other fatal signals not included (TODO?):
  381. * SIGBUS Bus error (bad memory access)
  382. * SIGPOLL Pollable event. Synonym of SIGIO
  383. * SIGPROF Profiling timer expired
  384. * SIGSYS Bad argument to routine
  385. * SIGTRAP Trace/breakpoint trap
  386. *
  387. * The only known arch with some of these sigs not fitting
  388. * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
  389. * Dance around with long long to guard against that...
  390. */
  391. BB_FATAL_SIGS = (int)(0
  392. + (1LL << SIGHUP)
  393. + (1LL << SIGINT)
  394. + (1LL << SIGTERM)
  395. + (1LL << SIGPIPE) // Write to pipe with no readers
  396. + (1LL << SIGQUIT) // Quit from keyboard
  397. + (1LL << SIGABRT) // Abort signal from abort(3)
  398. + (1LL << SIGALRM) // Timer signal from alarm(2)
  399. + (1LL << SIGVTALRM) // Virtual alarm clock
  400. + (1LL << SIGXCPU) // CPU time limit exceeded
  401. + (1LL << SIGXFSZ) // File size limit exceeded
  402. + (1LL << SIGUSR1) // Yes kids, these are also fatal!
  403. + (1LL << SIGUSR2)
  404. + 0),
  405. };
  406. void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
  407. /* Unlike signal() and bb_signals, sets handler with sigaction()
  408. * and in a way that while signal handler is run, no other signals
  409. * will be blocked; syscalls will not be restarted: */
  410. void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
  411. /* syscalls like read() will be interrupted with EINTR: */
  412. void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
  413. /* syscalls like read() won't be interrupted (though select/poll will be): */
  414. void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
  415. void wait_for_any_sig(void) FAST_FUNC;
  416. void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
  417. void sig_block(int sig) FAST_FUNC;
  418. void sig_unblock(int sig) FAST_FUNC;
  419. /* Will do sigaction(signum, act, NULL): */
  420. int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
  421. /* SIG_BLOCK/SIG_UNBLOCK all signals: */
  422. int sigprocmask_allsigs(int how) FAST_FUNC;
  423. /* Standard handler which just records signo */
  424. extern smallint bb_got_signal;
  425. void record_signo(int signo); /* not FAST_FUNC! */
  426. void xsetgid(gid_t gid) FAST_FUNC;
  427. void xsetuid(uid_t uid) FAST_FUNC;
  428. void xchdir(const char *path) FAST_FUNC;
  429. void xchroot(const char *path) FAST_FUNC;
  430. void xsetenv(const char *key, const char *value) FAST_FUNC;
  431. void bb_unsetenv(const char *key) FAST_FUNC;
  432. void bb_unsetenv_and_free(char *key) FAST_FUNC;
  433. void xunlink(const char *pathname) FAST_FUNC;
  434. void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
  435. void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
  436. int xopen(const char *pathname, int flags) FAST_FUNC;
  437. int xopen_nonblocking(const char *pathname) FAST_FUNC;
  438. int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
  439. int open_or_warn(const char *pathname, int flags) FAST_FUNC;
  440. int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
  441. int open_or_warn_stdin(const char *pathname) FAST_FUNC;
  442. int xopen_stdin(const char *pathname) FAST_FUNC;
  443. void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
  444. int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
  445. off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
  446. int xmkstemp(char *template) FAST_FUNC;
  447. off_t fdlength(int fd) FAST_FUNC;
  448. uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
  449. const char *override,
  450. unsigned override_units,
  451. int extend);
  452. void xpipe(int filedes[2]) FAST_FUNC;
  453. /* In this form code with pipes is much more readable */
  454. struct fd_pair { int rd; int wr; };
  455. #define piped_pair(pair) pipe(&((pair).rd))
  456. #define xpiped_pair(pair) xpipe(&((pair).rd))
  457. /* Useful for having small structure members/global variables */
  458. typedef int8_t socktype_t;
  459. typedef int8_t family_t;
  460. struct BUG_too_small {
  461. char BUG_socktype_t_too_small[(0
  462. | SOCK_STREAM
  463. | SOCK_DGRAM
  464. | SOCK_RDM
  465. | SOCK_SEQPACKET
  466. | SOCK_RAW
  467. ) <= 127 ? 1 : -1];
  468. char BUG_family_t_too_small[(0
  469. | AF_UNSPEC
  470. | AF_INET
  471. | AF_INET6
  472. | AF_UNIX
  473. #ifdef AF_PACKET
  474. | AF_PACKET
  475. #endif
  476. #ifdef AF_NETLINK
  477. | AF_NETLINK
  478. #endif
  479. /* | AF_DECnet */
  480. /* | AF_IPX */
  481. ) <= 127 ? 1 : -1];
  482. };
  483. void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
  484. time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
  485. int xsocket(int domain, int type, int protocol) FAST_FUNC;
  486. void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
  487. void xlisten(int s, int backlog) FAST_FUNC;
  488. void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
  489. ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
  490. socklen_t tolen) FAST_FUNC;
  491. /* SO_REUSEADDR allows a server to rebind to an address that is already
  492. * "in use" by old connections to e.g. previous server instance which is
  493. * killed or crashed. Without it bind will fail until all such connections
  494. * time out. Linux does not allow multiple live binds on same ip:port
  495. * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
  496. * Turn it on before you call bind(). */
  497. void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
  498. int setsockopt_broadcast(int fd) FAST_FUNC;
  499. int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
  500. /* NB: returns port in host byte order */
  501. unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
  502. typedef struct len_and_sockaddr {
  503. socklen_t len;
  504. union {
  505. struct sockaddr sa;
  506. struct sockaddr_in sin;
  507. #if ENABLE_FEATURE_IPV6
  508. struct sockaddr_in6 sin6;
  509. #endif
  510. } u;
  511. } len_and_sockaddr;
  512. enum {
  513. LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
  514. LSA_SIZEOF_SA = sizeof(
  515. union {
  516. struct sockaddr sa;
  517. struct sockaddr_in sin;
  518. #if ENABLE_FEATURE_IPV6
  519. struct sockaddr_in6 sin6;
  520. #endif
  521. }
  522. )
  523. };
  524. /* Create stream socket, and allocate suitable lsa.
  525. * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
  526. * af == AF_UNSPEC will result in trying to create IPv6 socket,
  527. * and if kernel doesn't support it, fall back to IPv4.
  528. * This is useful if you plan to bind to resulting local lsa.
  529. */
  530. int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
  531. int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
  532. /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
  533. * numeric IP ("N.N.N.N") or numeric IPv6 address,
  534. * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
  535. * Only if there is no suffix, port argument is used */
  536. /* NB: these set SO_REUSEADDR before bind */
  537. int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
  538. int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
  539. /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
  540. * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
  541. * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
  542. * If there is no suffix, port argument is used */
  543. int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
  544. /* Connect to peer identified by lsa */
  545. int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
  546. /* Get local address of bound or accepted socket */
  547. len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
  548. /* Get remote address of connected or accepted socket */
  549. len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
  550. /* Return malloc'ed len_and_sockaddr with socket address of host:port
  551. * Currently will return IPv4 or IPv6 sockaddrs only
  552. * (depending on host), but in theory nothing prevents e.g.
  553. * UNIX socket address being returned, IPX sockaddr etc...
  554. * On error does bb_error_msg and returns NULL */
  555. len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
  556. /* Version which dies on error */
  557. len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
  558. len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
  559. /* Same, useful if you want to force family (e.g. IPv6) */
  560. #if !ENABLE_FEATURE_IPV6
  561. #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
  562. #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
  563. #else
  564. len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
  565. len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
  566. #endif
  567. /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
  568. * otherwise no-op. Useful for ftp.
  569. * NB: does NOT do htons() internally, just direct assignment. */
  570. void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
  571. /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
  572. int get_nport(const struct sockaddr *sa) FAST_FUNC;
  573. /* Reverse DNS. Returns NULL on failure. */
  574. char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
  575. /* This one doesn't append :PORTNUM */
  576. char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
  577. /* This one also doesn't fall back to dotted IP (returns NULL) */
  578. char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
  579. /* inet_[ap]ton on steroids */
  580. char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
  581. char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
  582. // "old" (ipv4 only) API
  583. // users: traceroute.c hostname.c - use _list_ of all IPs
  584. struct hostent *xgethostbyname(const char *name) FAST_FUNC;
  585. // Also mount.c and inetd.c are using gethostbyname(),
  586. // + inet_common.c has additional IPv4-only stuff
  587. void socket_want_pktinfo(int fd) FAST_FUNC;
  588. ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
  589. const struct sockaddr *to,
  590. const struct sockaddr *from,
  591. socklen_t tolen) FAST_FUNC;
  592. ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
  593. struct sockaddr *from,
  594. struct sockaddr *to,
  595. socklen_t sa_size) FAST_FUNC;
  596. uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
  597. char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
  598. char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
  599. void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
  600. char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
  601. char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
  602. /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
  603. * But potentially slow, don't use in one-billion-times loops */
  604. int bb_putchar(int ch) FAST_FUNC;
  605. /* Note: does not use stdio, writes to fd 2 directly */
  606. int bb_putchar_stderr(char ch) FAST_FUNC;
  607. char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
  608. // gcc-4.1.1 still isn't good enough at optimizing it
  609. // (+200 bytes compared to macro)
  610. //static ALWAYS_INLINE
  611. //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
  612. //static ALWAYS_INLINE
  613. //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
  614. #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
  615. #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
  616. #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
  617. #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
  618. #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
  619. typedef struct uni_stat_t {
  620. unsigned byte_count;
  621. unsigned unicode_count;
  622. unsigned unicode_width;
  623. } uni_stat_t;
  624. /* Returns a string with unprintable chars replaced by '?' or
  625. * SUBST_WCHAR. This function is unicode-aware. */
  626. const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
  627. /* Prints unprintable char ch as ^C or M-c to file
  628. * (M-c is used only if ch is ORed with PRINTABLE_META),
  629. * else it is printed as-is (except for ch = 0x9b) */
  630. enum { PRINTABLE_META = 0x100 };
  631. void fputc_printable(int ch, FILE *file) FAST_FUNC;
  632. /* dmalloc will redefine these to it's own implementation. It is safe
  633. * to have the prototypes here unconditionally. */
  634. void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
  635. void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
  636. void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
  637. void *xrealloc(void *old, size_t size) FAST_FUNC;
  638. /* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
  639. * at least v[idx] and v[idx+1], for all idx values.
  640. * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
  641. * when all elements are used up. New elements are zeroed out.
  642. * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
  643. * skipping an index is a bad bug - it may miss a realloc!
  644. */
  645. #define xrealloc_vector(vector, shift, idx) \
  646. xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
  647. void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
  648. extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
  649. extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count, int loop_on_EINTR) FAST_FUNC;
  650. // NB: will return short read on error, not -1,
  651. // if some data was read before error occurred
  652. extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
  653. extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
  654. extern unsigned char xread_char(int fd) FAST_FUNC;
  655. extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
  656. extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
  657. // Reads one line a-la fgets (but doesn't save terminating '\n').
  658. // Reads byte-by-byte. Useful when it is important to not read ahead.
  659. // Bytes are appended to pfx (which must be malloced, or NULL).
  660. extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
  661. /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
  662. extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
  663. /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
  664. extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
  665. /* Never returns NULL */
  666. extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
  667. #define SEAMLESS_COMPRESSION (0 \
  668. || ENABLE_FEATURE_SEAMLESS_XZ \
  669. || ENABLE_FEATURE_SEAMLESS_LZMA \
  670. || ENABLE_FEATURE_SEAMLESS_BZ2 \
  671. || ENABLE_FEATURE_SEAMLESS_GZ \
  672. || ENABLE_FEATURE_SEAMLESS_Z)
  673. #if SEAMLESS_COMPRESSION
  674. /* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
  675. extern int setup_unzip_on_fd(int fd, int fail_if_not_detected) FAST_FUNC;
  676. /* Autodetects .gz etc */
  677. extern int open_zipped(const char *fname) FAST_FUNC;
  678. #else
  679. # define setup_unzip_on_fd(...) (0)
  680. # define open_zipped(fname) open((fname), O_RDONLY);
  681. #endif
  682. extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
  683. extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
  684. // NB: will return short write on error, not -1,
  685. // if some data was written before error occurred
  686. extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
  687. extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
  688. extern void xwrite_str(int fd, const char *str) FAST_FUNC;
  689. extern ssize_t full_write1_str(const char *str) FAST_FUNC;
  690. extern ssize_t full_write2_str(const char *str) FAST_FUNC;
  691. extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
  692. /* Close fd, but check for failures (some types of write errors) */
  693. extern void xclose(int fd) FAST_FUNC;
  694. /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
  695. extern void xprint_and_close_file(FILE *file) FAST_FUNC;
  696. /* Reads a line from a text file, up to a newline or NUL byte, inclusive.
  697. * Returns malloc'ed char*. If end is NULL '\n' isn't considered
  698. * end of line. If end isn't NULL, length of the chunk is stored in it.
  699. * Returns NULL if EOF/error.
  700. */
  701. extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
  702. /* Reads up to (and including) TERMINATING_STRING: */
  703. extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
  704. /* Same, with limited max size, and returns the length (excluding NUL): */
  705. extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
  706. /* Chops off TERMINATING_STRING from the end: */
  707. extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
  708. /* Reads up to (and including) "\n" or NUL byte: */
  709. extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
  710. /* Chops off '\n' from the end, unlike fgets: */
  711. extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
  712. /* Same, but doesn't try to conserve space (may have some slack after the end) */
  713. /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
  714. void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
  715. void die_if_ferror_stdout(void) FAST_FUNC;
  716. int fflush_all(void) FAST_FUNC;
  717. void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
  718. int fclose_if_not_stdin(FILE *file) FAST_FUNC;
  719. FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
  720. /* Prints warning to stderr and returns NULL on failure: */
  721. FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
  722. /* "Opens" stdin if filename is special, else just opens file: */
  723. FILE* xfopen_stdin(const char *filename) FAST_FUNC;
  724. FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
  725. FILE* fopen_for_read(const char *path) FAST_FUNC;
  726. FILE* xfopen_for_read(const char *path) FAST_FUNC;
  727. FILE* fopen_for_write(const char *path) FAST_FUNC;
  728. FILE* xfopen_for_write(const char *path) FAST_FUNC;
  729. FILE* xfdopen_for_read(int fd) FAST_FUNC;
  730. FILE* xfdopen_for_write(int fd) FAST_FUNC;
  731. int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
  732. void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
  733. /* Wrapper which restarts poll on EINTR or ENOMEM.
  734. * On other errors complains [perror("poll")] and returns.
  735. * Warning! May take (much) longer than timeout_ms to return!
  736. * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
  737. int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
  738. char *safe_gethostname(void) FAST_FUNC;
  739. /* Convert each alpha char in str to lower-case */
  740. char* str_tolower(char *str) FAST_FUNC;
  741. char *utoa(unsigned n) FAST_FUNC;
  742. char *itoa(int n) FAST_FUNC;
  743. /* Returns a pointer past the formatted number, does NOT null-terminate */
  744. char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
  745. char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
  746. /* Intelligent formatters of bignums */
  747. void smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
  748. void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
  749. /* If block_size == 0, display size without fractional part,
  750. * else display (size * block_size) with one decimal digit.
  751. * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
  752. * else divide by display_unit and do not use suffix. */
  753. #define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
  754. #define HUMAN_READABLE_MAX_WIDTH_STR "7"
  755. //TODO: provide pointer to buf (avoid statics)?
  756. const char *make_human_readable_str(unsigned long long size,
  757. unsigned long block_size, unsigned long display_unit) FAST_FUNC;
  758. /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
  759. char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
  760. /* Reverse */
  761. char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
  762. /* Generate a UUID */
  763. void generate_uuid(uint8_t *buf) FAST_FUNC;
  764. /* Last element is marked by mult == 0 */
  765. struct suffix_mult {
  766. char suffix[4];
  767. unsigned mult;
  768. };
  769. #include "xatonum.h"
  770. /* Specialized: */
  771. /* Using xatoi() instead of naive atoi() is not always convenient -
  772. * in many places people want *non-negative* values, but store them
  773. * in signed int. Therefore we need this one:
  774. * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
  775. * It should really be named xatoi_nonnegative (since it allows 0),
  776. * but that would be too long.
  777. */
  778. int xatoi_positive(const char *numstr) FAST_FUNC;
  779. /* Useful for reading port numbers */
  780. uint16_t xatou16(const char *numstr) FAST_FUNC;
  781. /* These parse entries in /etc/passwd and /etc/group. This is desirable
  782. * for BusyBox since we want to avoid using the glibc NSS stuff, which
  783. * increases target size and is often not needed on embedded systems. */
  784. long xuname2uid(const char *name) FAST_FUNC;
  785. long xgroup2gid(const char *name) FAST_FUNC;
  786. /* wrapper: allows string to contain numeric uid or gid */
  787. unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
  788. /* from chpst. Does not die, returns 0 on failure */
  789. struct bb_uidgid_t {
  790. uid_t uid;
  791. gid_t gid;
  792. };
  793. /* always sets uid and gid */
  794. int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
  795. /* always sets uid and gid, allows numeric; exits on failure */
  796. void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
  797. /* chown-like handling of "user[:[group]" */
  798. void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
  799. struct passwd* xgetpwnam(const char *name) FAST_FUNC;
  800. struct group* xgetgrnam(const char *name) FAST_FUNC;
  801. struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
  802. struct group* xgetgrgid(gid_t gid) FAST_FUNC;
  803. char* xuid2uname(uid_t uid) FAST_FUNC;
  804. char* xgid2group(gid_t gid) FAST_FUNC;
  805. char* uid2uname(uid_t uid) FAST_FUNC;
  806. char* gid2group(gid_t gid) FAST_FUNC;
  807. char* uid2uname_utoa(uid_t uid) FAST_FUNC;
  808. char* gid2group_utoa(gid_t gid) FAST_FUNC;
  809. /* versions which cache results (useful for ps, ls etc) */
  810. const char* get_cached_username(uid_t uid) FAST_FUNC;
  811. const char* get_cached_groupname(gid_t gid) FAST_FUNC;
  812. void clear_username_cache(void) FAST_FUNC;
  813. /* internally usernames are saved in fixed-sized char[] buffers */
  814. enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
  815. #if ENABLE_FEATURE_CHECK_NAMES
  816. void die_if_bad_username(const char* name) FAST_FUNC;
  817. #else
  818. #define die_if_bad_username(name) ((void)(name))
  819. #endif
  820. #if ENABLE_FEATURE_UTMP
  821. void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
  822. void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
  823. #else
  824. # define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
  825. # define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
  826. #endif
  827. int execable_file(const char *name) FAST_FUNC;
  828. char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
  829. int exists_execable(const char *filename) FAST_FUNC;
  830. /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
  831. * but it may exec busybox and call applet instead of searching PATH.
  832. */
  833. #if ENABLE_FEATURE_PREFER_APPLETS
  834. int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
  835. #define BB_EXECLP(prog,cmd,...) \
  836. do { \
  837. if (find_applet_by_name(prog) >= 0) \
  838. execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
  839. execlp(prog, cmd, __VA_ARGS__); \
  840. } while (0)
  841. #else
  842. #define BB_EXECVP(prog,cmd) execvp(prog,cmd)
  843. #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
  844. #endif
  845. int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
  846. /* xvfork() can't be a _function_, return after vfork mangles stack
  847. * in the parent. It must be a macro. */
  848. #define xvfork() \
  849. ({ \
  850. pid_t bb__xvfork_pid = vfork(); \
  851. if (bb__xvfork_pid < 0) \
  852. bb_perror_msg_and_die("vfork"); \
  853. bb__xvfork_pid; \
  854. })
  855. #if BB_MMU
  856. pid_t xfork(void) FAST_FUNC;
  857. #endif
  858. /* NOMMU friendy fork+exec: */
  859. pid_t spawn(char **argv) FAST_FUNC;
  860. pid_t xspawn(char **argv) FAST_FUNC;
  861. pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
  862. pid_t wait_any_nohang(int *wstat) FAST_FUNC;
  863. /* wait4pid: unlike waitpid, waits ONLY for one process.
  864. * Returns sig + 0x180 if child is killed by signal.
  865. * It's safe to pass negative 'pids' from failed [v]fork -
  866. * wait4pid will return -1 (and will not clobber [v]fork's errno).
  867. * IOW: rc = wait4pid(spawn(argv));
  868. * if (rc < 0) bb_perror_msg("%s", argv[0]);
  869. * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
  870. */
  871. int wait4pid(pid_t pid) FAST_FUNC;
  872. /* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
  873. int spawn_and_wait(char **argv) FAST_FUNC;
  874. /* Does NOT check that applet is NOFORK, just blindly runs it */
  875. int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
  876. /* Helpers for daemonization.
  877. *
  878. * bb_daemonize(flags) = daemonize, does not compile on NOMMU
  879. *
  880. * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
  881. * rexec's itself on NOMMU with argv passed as command line.
  882. * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
  883. * from the start. (It will detect it and not reexec again second time).
  884. * You have to audit carefully that you don't do something twice as a result
  885. * (opening files/sockets, parsing config files etc...)!
  886. *
  887. * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
  888. * (will do setsid()).
  889. *
  890. * fork_or_rexec(argv) = bare-bones fork on MMU,
  891. * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
  892. * On MMU ignores argv.
  893. *
  894. * Helper for network daemons in foreground mode:
  895. *
  896. * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
  897. * to /dev/null if they are not.
  898. */
  899. enum {
  900. DAEMON_CHDIR_ROOT = 1,
  901. DAEMON_DEVNULL_STDIO = 2,
  902. DAEMON_CLOSE_EXTRA_FDS = 4,
  903. DAEMON_ONLY_SANITIZE = 8, /* internal use */
  904. DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
  905. };
  906. #if BB_MMU
  907. enum { re_execed = 0 };
  908. # define fork_or_rexec(argv) xfork()
  909. # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
  910. # define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
  911. #else
  912. extern bool re_execed;
  913. /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
  914. * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
  915. */
  916. void re_exec(char **argv) NORETURN FAST_FUNC;
  917. pid_t fork_or_rexec(char **argv) FAST_FUNC;
  918. int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
  919. int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
  920. void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
  921. # define fork() BUG_fork_is_unavailable_on_nommu()
  922. # define xfork() BUG_fork_is_unavailable_on_nommu()
  923. # define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
  924. # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
  925. #endif
  926. void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
  927. void bb_sanitize_stdio(void) FAST_FUNC;
  928. /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
  929. int sanitize_env_if_suid(void) FAST_FUNC;
  930. char* single_argv(char **argv) FAST_FUNC;
  931. extern const char *const bb_argv_dash[]; /* "-", NULL */
  932. extern const char *opt_complementary;
  933. #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
  934. #define No_argument "\0"
  935. #define Required_argument "\001"
  936. #define Optional_argument "\002"
  937. extern const char *applet_long_options;
  938. #endif
  939. extern uint32_t option_mask32;
  940. extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
  941. /* Having next pointer as a first member allows easy creation
  942. * of "llist-compatible" structs, and using llist_FOO functions
  943. * on them.
  944. */
  945. typedef struct llist_t {
  946. struct llist_t *link;
  947. char *data;
  948. } llist_t;
  949. void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
  950. void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
  951. void *llist_pop(llist_t **elm) FAST_FUNC;
  952. void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
  953. void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
  954. llist_t *llist_rev(llist_t *list) FAST_FUNC;
  955. llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
  956. /* BTW, surprisingly, changing API to
  957. * llist_t *llist_add_to(llist_t *old_head, void *data)
  958. * etc does not result in smaller code... */
  959. /* start_stop_daemon and udhcpc are special - they want
  960. * to create pidfiles regardless of FEATURE_PIDFILE */
  961. #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
  962. /* True only if we created pidfile which is *file*, not /dev/null etc */
  963. extern smallint wrote_pidfile;
  964. void write_pidfile(const char *path) FAST_FUNC;
  965. #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
  966. #else
  967. enum { wrote_pidfile = 0 };
  968. #define write_pidfile(path) ((void)0)
  969. #define remove_pidfile(path) ((void)0)
  970. #endif
  971. enum {
  972. LOGMODE_NONE = 0,
  973. LOGMODE_STDIO = (1 << 0),
  974. LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
  975. LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
  976. };
  977. extern const char *msg_eol;
  978. extern smallint logmode;
  979. extern int die_sleep;
  980. extern uint8_t xfunc_error_retval;
  981. extern jmp_buf die_jmp;
  982. extern void xfunc_die(void) NORETURN FAST_FUNC;
  983. extern void bb_show_usage(void) NORETURN FAST_FUNC;
  984. extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
  985. extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
  986. extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
  987. extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
  988. extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
  989. extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
  990. extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
  991. extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
  992. extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
  993. extern void bb_perror_nomsg(void) FAST_FUNC;
  994. extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
  995. extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
  996. /* We need to export XXX_main from libbusybox
  997. * only if we build "individual" binaries
  998. */
  999. #if ENABLE_FEATURE_INDIVIDUAL
  1000. #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
  1001. #else
  1002. #define MAIN_EXTERNALLY_VISIBLE
  1003. #endif
  1004. /* Applets which are useful from another applets */
  1005. int bb_cat(char** argv);
  1006. /* If shell needs them, they exist even if not enabled as applets */
  1007. int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
  1008. int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
  1009. int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
  1010. int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
  1011. /* Similar, but used by chgrp, not shell */
  1012. int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
  1013. /* Used by ftpd */
  1014. int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
  1015. /* Don't need IF_xxx() guard for these */
  1016. int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  1017. int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  1018. #if ENABLE_ROUTE
  1019. void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
  1020. #endif
  1021. /* Networking */
  1022. int create_icmp_socket(void) FAST_FUNC;
  1023. int create_icmp6_socket(void) FAST_FUNC;
  1024. /* interface.c */
  1025. /* This structure defines protocol families and their handlers. */
  1026. struct aftype {
  1027. const char *name;
  1028. const char *title;
  1029. int af;
  1030. int alen;
  1031. char* FAST_FUNC (*print)(unsigned char *);
  1032. const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
  1033. int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
  1034. void FAST_FUNC (*herror)(char *text);
  1035. int FAST_FUNC (*rprint)(int options);
  1036. int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
  1037. /* may modify src */
  1038. int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
  1039. };
  1040. /* This structure defines hardware protocols and their handlers. */
  1041. struct hwtype {
  1042. const char *name;
  1043. const char *title;
  1044. int type;
  1045. int alen;
  1046. char* FAST_FUNC (*print)(unsigned char *);
  1047. int FAST_FUNC (*input)(const char *, struct sockaddr *);
  1048. int FAST_FUNC (*activate)(int fd);
  1049. int suppress_null_addr;
  1050. };
  1051. extern smallint interface_opt_a;
  1052. int display_interfaces(char *ifname) FAST_FUNC;
  1053. #if ENABLE_FEATURE_HWIB
  1054. int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
  1055. #else
  1056. #define in_ib(a, b) 1 /* fail */
  1057. #endif
  1058. const struct aftype *get_aftype(const char *name) FAST_FUNC;
  1059. const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
  1060. const struct hwtype *get_hwntype(int type) FAST_FUNC;
  1061. #ifndef BUILD_INDIVIDUAL
  1062. extern int find_applet_by_name(const char *name) FAST_FUNC;
  1063. /* Returns only if applet is not found. */
  1064. extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
  1065. extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
  1066. #endif
  1067. #ifdef HAVE_MNTENT_H
  1068. extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
  1069. extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
  1070. #endif
  1071. extern void erase_mtab(const char * name) FAST_FUNC;
  1072. extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
  1073. extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
  1074. #if ENABLE_DESKTOP
  1075. extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
  1076. #else
  1077. # define bb_warn_ignoring_args(arg) ((void)0)
  1078. #endif
  1079. extern int get_linux_version_code(void) FAST_FUNC;
  1080. extern char *query_loop(const char *device) FAST_FUNC;
  1081. extern int del_loop(const char *device) FAST_FUNC;
  1082. /* If *devname is not NULL, use that name, otherwise try to find free one,
  1083. * malloc and return it in *devname.
  1084. * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
  1085. extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
  1086. /* Like bb_ask below, but asks on stdin with no timeout. */
  1087. char *bb_ask_stdin(const char * prompt) FAST_FUNC;
  1088. //TODO: pass buf pointer or return allocated buf (avoid statics)?
  1089. char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
  1090. int bb_ask_confirmation(void) FAST_FUNC;
  1091. int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
  1092. /*
  1093. * Config file parser
  1094. */
  1095. enum {
  1096. PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
  1097. PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
  1098. // TODO: COLLAPSE and TRIM seem to always go in pair
  1099. PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
  1100. PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
  1101. // keep a copy of current line
  1102. PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
  1103. PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
  1104. // NORMAL is:
  1105. // * remove leading and trailing delimiters and collapse
  1106. // multiple delimiters into one
  1107. // * warn and continue if less than mintokens delimiters found
  1108. // * grab everything into last token
  1109. // * comments are recognized even if they aren't the first char
  1110. PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
  1111. };
  1112. typedef struct parser_t {
  1113. FILE *fp;
  1114. char *data;
  1115. char *line, *nline;
  1116. size_t line_alloc, nline_alloc;
  1117. int lineno;
  1118. } parser_t;
  1119. parser_t* config_open(const char *filename) FAST_FUNC;
  1120. parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
  1121. /* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
  1122. int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
  1123. #define config_read(parser, tokens, max, min, str, flags) \
  1124. config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
  1125. void config_close(parser_t *parser) FAST_FUNC;
  1126. /* Concatenate path and filename to new allocated buffer.
  1127. * Add "/" only as needed (no duplicate "//" are produced).
  1128. * If path is NULL, it is assumed to be "/".
  1129. * filename should not be NULL. */
  1130. char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
  1131. /* Returns NULL on . and .. */
  1132. char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
  1133. int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
  1134. int get_signum(const char *name) FAST_FUNC;
  1135. const char *get_signame(int number) FAST_FUNC;
  1136. void print_signames(void) FAST_FUNC;
  1137. char *bb_simplify_path(const char *path) FAST_FUNC;
  1138. /* Returns ptr to NUL */
  1139. char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
  1140. #define LOGIN_FAIL_DELAY 3
  1141. extern void bb_do_delay(int seconds) FAST_FUNC;
  1142. extern void change_identity(const struct passwd *pw) FAST_FUNC;
  1143. extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
  1144. /* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
  1145. * Note that getpwuid result might need xstrdup'ing
  1146. * if there is a possibility of intervening getpwxxx() calls.
  1147. */
  1148. const char *get_shell_name(void) FAST_FUNC;
  1149. #if ENABLE_SELINUX
  1150. extern void renew_current_security_context(void) FAST_FUNC;
  1151. extern void set_current_security_context(security_context_t sid) FAST_FUNC;
  1152. extern context_t set_security_context_component(security_context_t cur_context,
  1153. char *user, char *role, char *type, char *range) FAST_FUNC;
  1154. extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
  1155. extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
  1156. #else
  1157. #define selinux_preserve_fcontext(fdesc) ((void)0)
  1158. #endif
  1159. extern void selinux_or_die(void) FAST_FUNC;
  1160. /* systemd support */
  1161. #define SD_LISTEN_FDS_START 3
  1162. int sd_listen_fds(void);
  1163. /* setup_environment:
  1164. * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
  1165. * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
  1166. * TERM=(old value)
  1167. * USER=pw->pw_name, LOGNAME=pw->pw_name
  1168. * PATH=bb_default_[root_]path
  1169. * HOME=pw->pw_dir
  1170. * SHELL=shell
  1171. * else if change_env = 1:
  1172. * if not root (if pw->pw_uid != 0):
  1173. * USER=pw->pw_name, LOGNAME=pw->pw_name
  1174. * HOME=pw->pw_dir
  1175. * SHELL=shell
  1176. * else does nothing
  1177. */
  1178. #define SETUP_ENV_CHANGEENV (1 << 0)
  1179. #define SETUP_ENV_CLEARENV (1 << 1)
  1180. #define SETUP_ENV_TO_TMP (1 << 2)
  1181. #define SETUP_ENV_NO_CHDIR (1 << 4)
  1182. extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
  1183. extern int correct_password(const struct passwd *pw) FAST_FUNC;
  1184. /* Returns a malloced string */
  1185. #if !ENABLE_USE_BB_CRYPT
  1186. #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
  1187. #endif
  1188. extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
  1189. extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
  1190. /*
  1191. * rnd is additional random input. New one is returned.
  1192. * Useful if you call crypt_make_salt many times in a row:
  1193. * rnd = crypt_make_salt(buf1, 4, 0);
  1194. * rnd = crypt_make_salt(buf2, 4, rnd);
  1195. * rnd = crypt_make_salt(buf3, 4, rnd);
  1196. * (otherwise we risk having same salt generated)
  1197. */
  1198. extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
  1199. /* "$N$" + sha_salt_16_bytes + NUL */
  1200. #define MAX_PW_SALT_LEN (3 + 16 + 1)
  1201. extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
  1202. /* Returns number of lines changed, or -1 on error */
  1203. #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
  1204. #define update_passwd(filename, username, data, member) \
  1205. update_passwd(filename, username, data)
  1206. #endif
  1207. extern int update_passwd(const char *filename,
  1208. const char *username,
  1209. const char *data,
  1210. const char *member) FAST_FUNC;
  1211. int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
  1212. int index_in_strings(const char *strings, const char *key) FAST_FUNC;
  1213. int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
  1214. int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
  1215. const char *nth_string(const char *strings, int n) FAST_FUNC;
  1216. extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
  1217. extern void print_login_prompt(void) FAST_FUNC;
  1218. char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
  1219. /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
  1220. int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
  1221. int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
  1222. /* NB: "unsigned request" is crucial! "int request" will break some arches! */
  1223. int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
  1224. int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
  1225. #if ENABLE_IOCTL_HEX2STR_ERROR
  1226. int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
  1227. int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
  1228. #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
  1229. #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
  1230. #else
  1231. int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
  1232. int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
  1233. #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
  1234. #define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
  1235. #endif
  1236. char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
  1237. void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
  1238. void reset_ino_dev_hashtable(void) FAST_FUNC;
  1239. #ifdef __GLIBC__
  1240. /* At least glibc has horrendously large inline for this, so wrap it */
  1241. unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
  1242. #undef makedev
  1243. #define makedev(a,b) bb_makedev(a,b)
  1244. #endif
  1245. /* "Keycodes" that report an escape sequence.
  1246. * We use something which fits into signed char,
  1247. * yet doesn't represent any valid Unicode character.
  1248. * Also, -1 is reserved for error indication and we don't use it. */
  1249. enum {
  1250. KEYCODE_UP = -2,
  1251. KEYCODE_DOWN = -3,
  1252. KEYCODE_RIGHT = -4,
  1253. KEYCODE_LEFT = -5,
  1254. KEYCODE_HOME = -6,
  1255. KEYCODE_END = -7,
  1256. KEYCODE_INSERT = -8,
  1257. KEYCODE_DELETE = -9,
  1258. KEYCODE_PAGEUP = -10,
  1259. KEYCODE_PAGEDOWN = -11,
  1260. // -12 is reserved for Alt/Ctrl/Shift-TAB
  1261. #if 0
  1262. KEYCODE_FUN1 = -13,
  1263. KEYCODE_FUN2 = -14,
  1264. KEYCODE_FUN3 = -15,
  1265. KEYCODE_FUN4 = -16,
  1266. KEYCODE_FUN5 = -17,
  1267. KEYCODE_FUN6 = -18,
  1268. KEYCODE_FUN7 = -19,
  1269. KEYCODE_FUN8 = -20,
  1270. KEYCODE_FUN9 = -21,
  1271. KEYCODE_FUN10 = -22,
  1272. KEYCODE_FUN11 = -23,
  1273. KEYCODE_FUN12 = -24,
  1274. #endif
  1275. /* Be sure that last defined value is small enough
  1276. * to not interfere with Alt/Ctrl/Shift bits.
  1277. * So far we do not exceed -31 (0xfff..fffe1),
  1278. * which gives us three upper bits in LSB to play with.
  1279. */
  1280. //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
  1281. //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
  1282. //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
  1283. //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
  1284. KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
  1285. KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
  1286. //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
  1287. //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
  1288. KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
  1289. KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
  1290. KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
  1291. /* How long is the longest ESC sequence we know?
  1292. * We want it big enough to be able to contain
  1293. * cursor position sequence "ESC [ 9999 ; 9999 R"
  1294. */
  1295. KEYCODE_BUFFER_SIZE = 16
  1296. };
  1297. /* Note: fd may be in blocking or non-blocking mode, both make sense.
  1298. * For one, less uses non-blocking mode.
  1299. * Only the first read syscall inside read_key may block indefinitely
  1300. * (unless fd is in non-blocking mode),
  1301. * subsequent reads will time out after a few milliseconds.
  1302. * Return of -1 means EOF or error (errno == 0 on EOF).
  1303. * buffer[0] is used as a counter of buffered chars and must be 0
  1304. * on first call.
  1305. * timeout:
  1306. * -2: do not poll for input;
  1307. * -1: poll(-1) (i.e. block);
  1308. * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
  1309. */
  1310. int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
  1311. void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
  1312. #if ENABLE_FEATURE_EDITING
  1313. /* It's NOT just ENABLEd or disabled. It's a number: */
  1314. # if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
  1315. # define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
  1316. unsigned size_from_HISTFILESIZE(const char *hp);
  1317. # else
  1318. # define MAX_HISTORY 0
  1319. # endif
  1320. typedef struct line_input_t {
  1321. int flags;
  1322. const char *path_lookup;
  1323. # if MAX_HISTORY
  1324. int cnt_history;
  1325. int cur_history;
  1326. int max_history; /* must never be <= 0 */
  1327. # if ENABLE_FEATURE_EDITING_SAVEHISTORY
  1328. /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
  1329. * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
  1330. * in on-disk history"
  1331. * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
  1332. * also in on-disk history (and thus need to be skipped on save)"
  1333. */
  1334. unsigned cnt_history_in_file;
  1335. const char *hist_file;
  1336. # endif
  1337. char *history[MAX_HISTORY + 1];
  1338. # endif
  1339. } line_input_t;
  1340. enum {
  1341. DO_HISTORY = 1 * (MAX_HISTORY > 0),
  1342. TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
  1343. USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
  1344. VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
  1345. WITH_PATH_LOOKUP = 0x10,
  1346. FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
  1347. };
  1348. line_input_t *new_line_input_t(int flags) FAST_FUNC;
  1349. /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
  1350. /*
  1351. * maxsize must be >= 2.
  1352. * Returns:
  1353. * -1 on read errors or EOF, or on bare Ctrl-D,
  1354. * 0 on ctrl-C (the line entered is still returned in 'command'),
  1355. * >0 length of input string, including terminating '\n'
  1356. */
  1357. int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
  1358. # if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
  1359. void save_history(line_input_t *st);
  1360. # endif
  1361. #else
  1362. #define MAX_HISTORY 0
  1363. int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
  1364. #define read_line_input(state, prompt, command, maxsize, timeout) \
  1365. read_line_input(prompt, command, maxsize)
  1366. #endif
  1367. #ifndef COMM_LEN
  1368. # ifdef TASK_COMM_LEN
  1369. enum { COMM_LEN = TASK_COMM_LEN };
  1370. # else
  1371. /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
  1372. enum { COMM_LEN = 16 };
  1373. # endif
  1374. #endif
  1375. struct smaprec {
  1376. unsigned long mapped_rw;
  1377. unsigned long mapped_ro;
  1378. unsigned long shared_clean;
  1379. unsigned long shared_dirty;
  1380. unsigned long private_clean;
  1381. unsigned long private_dirty;
  1382. unsigned long stack;
  1383. unsigned long smap_pss, smap_swap;
  1384. unsigned long smap_size;
  1385. unsigned long smap_start;
  1386. char smap_mode[5];
  1387. char *smap_name;
  1388. };
  1389. #if !ENABLE_PMAP
  1390. #define procps_read_smaps(pid, total, cb, data) \
  1391. procps_read_smaps(pid, total)
  1392. #endif
  1393. int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
  1394. void (*cb)(struct smaprec *, void *), void *data);
  1395. typedef struct procps_status_t {
  1396. DIR *dir;
  1397. IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
  1398. uint8_t shift_pages_to_bytes;
  1399. uint8_t shift_pages_to_kb;
  1400. /* Fields are set to 0/NULL if failed to determine (or not requested) */
  1401. uint16_t argv_len;
  1402. char *argv0;
  1403. char *exe;
  1404. IF_SELINUX(char *context;)
  1405. IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
  1406. /* Everything below must contain no ptrs to malloc'ed data:
  1407. * it is memset(0) for each process in procps_scan() */
  1408. unsigned long vsz, rss; /* we round it to kbytes */
  1409. unsigned long stime, utime;
  1410. unsigned long start_time;
  1411. unsigned pid;
  1412. unsigned ppid;
  1413. unsigned pgid;
  1414. unsigned sid;
  1415. unsigned uid;
  1416. unsigned gid;
  1417. #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
  1418. unsigned ruid;
  1419. unsigned rgid;
  1420. int niceness;
  1421. #endif
  1422. unsigned tty_major,tty_minor;
  1423. #if ENABLE_FEATURE_TOPMEM
  1424. struct smaprec smaps;
  1425. #endif
  1426. char state[4];
  1427. /* basename of executable in exec(2), read from /proc/N/stat
  1428. * (if executable is symlink or script, it is NOT replaced
  1429. * by link target or interpreter name) */
  1430. char comm[COMM_LEN];
  1431. /* user/group? - use passwd/group parsing functions */
  1432. #if ENABLE_FEATURE_TOP_SMP_PROCESS
  1433. int last_seen_on_cpu;
  1434. #endif
  1435. } procps_status_t;
  1436. /* flag bits for procps_scan(xx, flags) calls */
  1437. enum {
  1438. PSSCAN_PID = 1 << 0,
  1439. PSSCAN_PPID = 1 << 1,
  1440. PSSCAN_PGID = 1 << 2,
  1441. PSSCAN_SID = 1 << 3,
  1442. PSSCAN_UIDGID = 1 << 4,
  1443. PSSCAN_COMM = 1 << 5,
  1444. /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
  1445. PSSCAN_ARGV0 = 1 << 7,
  1446. PSSCAN_EXE = 1 << 8,
  1447. PSSCAN_STATE = 1 << 9,
  1448. PSSCAN_VSZ = 1 << 10,
  1449. PSSCAN_RSS = 1 << 11,
  1450. PSSCAN_STIME = 1 << 12,
  1451. PSSCAN_UTIME = 1 << 13,
  1452. PSSCAN_TTY = 1 << 14,
  1453. PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
  1454. /* NB: used by find_pid_by_name(). Any applet using it
  1455. * needs to be mentioned here. */
  1456. PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
  1457. || ENABLE_PGREP || ENABLE_PKILL
  1458. || ENABLE_PIDOF
  1459. || ENABLE_SESTATUS
  1460. ),
  1461. PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
  1462. PSSCAN_START_TIME = 1 << 18,
  1463. PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
  1464. PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
  1465. PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
  1466. PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
  1467. };
  1468. //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
  1469. void free_procps_scan(procps_status_t* sp) FAST_FUNC;
  1470. procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
  1471. /* Format cmdline (up to col chars) into char buf[size] */
  1472. /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
  1473. void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
  1474. pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
  1475. pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
  1476. int starts_with_cpu(const char *str) FAST_FUNC;
  1477. unsigned get_cpu_count(void) FAST_FUNC;
  1478. /* Use strict=1 if you process input from untrusted source:
  1479. * it will return NULL on invalid %xx (bad hex chars)
  1480. * and str + 1 if decoded char is / or NUL.
  1481. * In non-strict mode, it always succeeds (returns str),
  1482. * and also it additionally decoded '+' to space.
  1483. */
  1484. char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
  1485. extern const char bb_uuenc_tbl_base64[] ALIGN1;
  1486. extern const char bb_uuenc_tbl_std[] ALIGN1;
  1487. void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
  1488. enum {
  1489. BASE64_FLAG_UU_STOP = 0x100,
  1490. /* Sign-extends to a value which never matches fgetc result: */
  1491. BASE64_FLAG_NO_STOP_CHAR = 0x80,
  1492. };
  1493. const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
  1494. void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
  1495. typedef struct md5_ctx_t {
  1496. uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
  1497. void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
  1498. uint64_t total64; /* must be directly before hash[] */
  1499. uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
  1500. } md5_ctx_t;
  1501. typedef struct md5_ctx_t sha1_ctx_t;
  1502. typedef struct md5_ctx_t sha256_ctx_t;
  1503. typedef struct sha512_ctx_t {
  1504. uint64_t total64[2]; /* must be directly before hash[] */
  1505. uint64_t hash[8];
  1506. uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
  1507. } sha512_ctx_t;
  1508. typedef struct sha3_ctx_t {
  1509. uint64_t state[25];
  1510. unsigned bytes_queued;
  1511. } sha3_ctx_t;
  1512. void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
  1513. void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
  1514. void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
  1515. void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
  1516. #define sha1_hash md5_hash
  1517. void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
  1518. void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
  1519. #define sha256_hash md5_hash
  1520. #define sha256_end sha1_end
  1521. void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
  1522. void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
  1523. void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
  1524. void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
  1525. void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
  1526. void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
  1527. extern uint32_t *global_crc32_table;
  1528. uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
  1529. uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
  1530. uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
  1531. typedef struct masks_labels_t {
  1532. const char *labels;
  1533. const int masks[];
  1534. } masks_labels_t;
  1535. int print_flags_separated(const int *masks, const char *labels,
  1536. int flags, const char *separator) FAST_FUNC;
  1537. int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
  1538. typedef struct bb_progress_t {
  1539. unsigned last_size;
  1540. unsigned last_update_sec;
  1541. unsigned last_change_sec;
  1542. unsigned start_sec;
  1543. const char *curfile;
  1544. } bb_progress_t;
  1545. #define is_bb_progress_inited(p) ((p)->curfile != NULL)
  1546. #define bb_progress_free(p) do { \
  1547. if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
  1548. (p)->curfile = NULL; \
  1549. } while (0)
  1550. void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
  1551. void bb_progress_update(bb_progress_t *p,
  1552. uoff_t beg_range,
  1553. uoff_t transferred,
  1554. uoff_t totalsize) FAST_FUNC;
  1555. extern const char *applet_name;
  1556. /* Some older linkers don't perform string merging, we used to have common strings
  1557. * as global arrays to do it by hand. But:
  1558. * (1) newer linkers do it themselves,
  1559. * (2) however, they DONT merge string constants with global arrays,
  1560. * even if the value is the same (!). Thus global arrays actually
  1561. * increased size a bit: for example, "/etc/passwd" string from libc
  1562. * wasn't merged with bb_path_passwd_file[] array!
  1563. * Therefore now we use #defines.
  1564. */
  1565. /* "BusyBox vN.N.N (timestamp or extra_version)" */
  1566. extern const char bb_banner[] ALIGN1;
  1567. extern const char bb_msg_memory_exhausted[] ALIGN1;
  1568. extern const char bb_msg_invalid_date[] ALIGN1;
  1569. #define bb_msg_read_error "read error"
  1570. #define bb_msg_write_error "write error"
  1571. extern const char bb_msg_unknown[] ALIGN1;
  1572. extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
  1573. extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
  1574. extern const char bb_msg_you_must_be_root[] ALIGN1;
  1575. extern const char bb_msg_requires_arg[] ALIGN1;
  1576. extern const char bb_msg_invalid_arg[] ALIGN1;
  1577. extern const char bb_msg_standard_input[] ALIGN1;
  1578. extern const char bb_msg_standard_output[] ALIGN1;
  1579. /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
  1580. extern const char bb_hexdigits_upcase[] ALIGN1;
  1581. extern const char bb_path_wtmp_file[] ALIGN1;
  1582. /* Busybox mount uses either /proc/mounts or /etc/mtab to
  1583. * get the list of currently mounted filesystems */
  1584. #define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
  1585. #define bb_path_passwd_file _PATH_PASSWD
  1586. #define bb_path_group_file _PATH_GROUP
  1587. #define bb_path_shadow_file _PATH_SHADOW
  1588. #define bb_path_gshadow_file _PATH_GSHADOW
  1589. #define bb_path_motd_file "/etc/motd"
  1590. #define bb_dev_null "/dev/null"
  1591. extern const char bb_busybox_exec_path[] ALIGN1;
  1592. /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
  1593. * but I want to save a few bytes here */
  1594. extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
  1595. #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
  1596. #define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
  1597. extern const int const_int_0;
  1598. extern const int const_int_1;
  1599. /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
  1600. enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
  1601. extern char bb_common_bufsiz1[COMMON_BUFSIZE];
  1602. /* This struct is deliberately not defined. */
  1603. /* See docs/keep_data_small.txt */
  1604. struct globals;
  1605. /* '*const' ptr makes gcc optimize code much better.
  1606. * Magic prevents ptr_to_globals from going into rodata.
  1607. * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
  1608. extern struct globals *const ptr_to_globals;
  1609. /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
  1610. #define barrier() __asm__ __volatile__("":::"memory")
  1611. #define SET_PTR_TO_GLOBALS(x) do { \
  1612. (*(struct globals**)&ptr_to_globals) = (void*)(x); \
  1613. barrier(); \
  1614. } while (0)
  1615. /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
  1616. * use bb_default_login_shell and following defines.
  1617. * If you change LIBBB_DEFAULT_LOGIN_SHELL,
  1618. * don't forget to change increment constant. */
  1619. #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
  1620. extern const char bb_default_login_shell[] ALIGN1;
  1621. /* "/bin/sh" */
  1622. #define DEFAULT_SHELL (bb_default_login_shell+1)
  1623. /* "sh" */
  1624. #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
  1625. /* The following devices are the same on all systems. */
  1626. #define CURRENT_TTY "/dev/tty"
  1627. #define DEV_CONSOLE "/dev/console"
  1628. #if defined(__FreeBSD_kernel__)
  1629. # define CURRENT_VC CURRENT_TTY
  1630. # define VC_1 "/dev/ttyv0"
  1631. # define VC_2 "/dev/ttyv1"
  1632. # define VC_3 "/dev/ttyv2"
  1633. # define VC_4 "/dev/ttyv3"
  1634. # define VC_5 "/dev/ttyv4"
  1635. # define VC_FORMAT "/dev/ttyv%d"
  1636. #elif defined(__GNU__)
  1637. # define CURRENT_VC CURRENT_TTY
  1638. # define VC_1 "/dev/tty1"
  1639. # define VC_2 "/dev/tty2"
  1640. # define VC_3 "/dev/tty3"
  1641. # define VC_4 "/dev/tty4"
  1642. # define VC_5 "/dev/tty5"
  1643. # define VC_FORMAT "/dev/tty%d"
  1644. #elif ENABLE_FEATURE_DEVFS
  1645. /*Linux, obsolete devfs names */
  1646. # define CURRENT_VC "/dev/vc/0"
  1647. # define VC_1 "/dev/vc/1"
  1648. # define VC_2 "/dev/vc/2"
  1649. # define VC_3 "/dev/vc/3"
  1650. # define VC_4 "/dev/vc/4"
  1651. # define VC_5 "/dev/vc/5"
  1652. # define VC_FORMAT "/dev/vc/%d"
  1653. # define LOOP_FORMAT "/dev/loop/%d"
  1654. # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
  1655. # define LOOP_NAME "/dev/loop/"
  1656. # define FB_0 "/dev/fb/0"
  1657. #else
  1658. /*Linux, normal names */
  1659. # define CURRENT_VC "/dev/tty0"
  1660. # define VC_1 "/dev/tty1"
  1661. # define VC_2 "/dev/tty2"
  1662. # define VC_3 "/dev/tty3"
  1663. # define VC_4 "/dev/tty4"
  1664. # define VC_5 "/dev/tty5"
  1665. # define VC_FORMAT "/dev/tty%d"
  1666. # define LOOP_FORMAT "/dev/loop%d"
  1667. # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
  1668. # define LOOP_NAME "/dev/loop"
  1669. # define FB_0 "/dev/fb0"
  1670. #endif
  1671. #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
  1672. /* We redefine ctype macros. Unicode-correct handling of char types
  1673. * can't be done with such byte-oriented operations anyway,
  1674. * we don't lose anything.
  1675. */
  1676. #undef isalnum
  1677. #undef isalpha
  1678. #undef isascii
  1679. #undef isblank
  1680. #undef iscntrl
  1681. #undef isdigit
  1682. #undef isgraph
  1683. #undef islower
  1684. #undef isprint
  1685. #undef ispunct
  1686. #undef isspace
  1687. #undef isupper
  1688. #undef isxdigit
  1689. #undef toupper
  1690. #undef tolower
  1691. /* We save ~500 bytes on isdigit alone.
  1692. * BTW, x86 likes (unsigned char) cast more than (unsigned). */
  1693. /* These work the same for ASCII and Unicode,
  1694. * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
  1695. #define isascii(a) ((unsigned char)(a) <= 0x7f)
  1696. #define isdigit(a) ((unsigned char)((a) - '0') <= 9)
  1697. #define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
  1698. #define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
  1699. #define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
  1700. #define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
  1701. #define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
  1702. /* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
  1703. * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
  1704. */
  1705. #define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
  1706. // Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
  1707. #define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
  1708. // Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
  1709. #define isalnum(a) bb_ascii_isalnum(a)
  1710. static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
  1711. {
  1712. unsigned char b = a - '0';
  1713. if (b <= 9)
  1714. return (b <= 9);
  1715. b = (a|0x20) - 'a';
  1716. return b <= 'z' - 'a';
  1717. }
  1718. #define isxdigit(a) bb_ascii_isxdigit(a)
  1719. static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
  1720. {
  1721. unsigned char b = a - '0';
  1722. if (b <= 9)
  1723. return (b <= 9);
  1724. b = (a|0x20) - 'a';
  1725. return b <= 'f' - 'a';
  1726. }
  1727. #define toupper(a) bb_ascii_toupper(a)
  1728. static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
  1729. {
  1730. unsigned char b = a - 'a';
  1731. if (b <= ('z' - 'a'))
  1732. a -= 'a' - 'A';
  1733. return a;
  1734. }
  1735. #define tolower(a) bb_ascii_tolower(a)
  1736. static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
  1737. {
  1738. unsigned char b = a - 'A';
  1739. if (b <= ('Z' - 'A'))
  1740. a += 'a' - 'A';
  1741. return a;
  1742. }
  1743. /* In ASCII and Unicode, these are likely to be very different.
  1744. * Let's prevent ambiguous usage from the start */
  1745. #define isgraph(a) isgraph_is_ambiguous_dont_use(a)
  1746. #define isprint(a) isprint_is_ambiguous_dont_use(a)
  1747. /* NB: must not treat EOF as isgraph or isprint */
  1748. #define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
  1749. #define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
  1750. POP_SAVED_FUNCTION_VISIBILITY
  1751. #endif