libbb.h 93 KB

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