libbb.h 67 KB

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