3
0

libbb.h 79 KB

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