libbb.h 97 KB

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