new xmalloc_readlink_follow() routine to fully expand trailing symlinks
[people/mcb30/busybox.git] / include / libbb.h
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 __LIBBUSYBOX_H__
11 #define __LIBBUSYBOX_H__    1
12
13 #include "platform.h"
14
15 #include <ctype.h>
16 #include <dirent.h>
17 #include <errno.h>
18 #include <fcntl.h>
19 #include <inttypes.h>
20 #include <mntent.h>
21 #include <netdb.h>
22 #include <setjmp.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <stdarg.h>
27 #include <stddef.h>
28 #include <string.h>
29 /* #include <strings.h> - said to be obsolete */
30 #include <sys/poll.h>
31 #include <sys/ioctl.h>
32 #include <sys/mman.h>
33 #include <sys/socket.h>
34 #include <sys/stat.h>
35 #include <sys/statfs.h>
36 #include <sys/time.h>
37 #include <sys/types.h>
38 #include <sys/wait.h>
39 #include <termios.h>
40 #include <time.h>
41 #include <unistd.h>
42 #include <utime.h>
43
44 #if ENABLE_SELINUX
45 #include <selinux/selinux.h>
46 #include <selinux/context.h>
47 #include <selinux/flask.h>
48 #include <selinux/av_permissions.h>
49 #endif
50
51 #if ENABLE_LOCALE_SUPPORT
52 #include <locale.h>
53 #else
54 #define setlocale(x,y) ((void)0)
55 #endif
56
57 #include "pwd_.h"
58 #include "grp_.h"
59 /* ifdef it out, because it may include <shadow.h> */
60 /* and we may not even _have_ <shadow.h>! */
61 #if ENABLE_FEATURE_SHADOWPASSWDS
62 #include "shadow_.h"
63 #endif
64
65 /* Try to pull in PATH_MAX */
66 #include <limits.h>
67 #include <sys/param.h>
68 #ifndef PATH_MAX
69 #define PATH_MAX 256
70 #endif
71
72 /* Tested to work correctly (IIRC :]) */
73 #define MAXINT(T) (T)( \
74         ((T)-1) > 0 \
75         ? (T)-1 \
76         : (T)~((T)1 << (sizeof(T)*8-1)) \
77         )
78
79 #define MININT(T) (T)( \
80         ((T)-1) > 0 \
81         ? (T)0 \
82         : ((T)1 << (sizeof(T)*8-1)) \
83         )
84
85 /* Large file support */
86 /* Note that CONFIG_LFS forces bbox to be built with all common ops
87  * (stat, lseek etc) mapped to "largefile" variants by libc.
88  * Practically it means that open() automatically has O_LARGEFILE added
89  * and all filesize/file_offset parameters and struct members are "large"
90  * (in today's world - signed 64bit). For full support of large files,
91  * we need a few helper #defines (below) and careful use of off_t
92  * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
93 #if ENABLE_LFS
94 /* CONFIG_LFS is on */
95 # if ULONG_MAX > 0xffffffff
96 /* "long" is long enough on this system */
97 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
98 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
99 #  define BB_STRTOOFF bb_strtoul
100 #  define STRTOOFF strtoul
101 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
102 #  define OFF_FMT "l"
103 # else
104 /* "long" is too short, need "long long" */
105 #  define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
106 #  define BB_STRTOOFF bb_strtoull
107 #  define STRTOOFF strtoull
108 #  define OFF_FMT "ll"
109 # endif
110 #else
111 /* CONFIG_LFS is off */
112 # if UINT_MAX == 0xffffffff
113 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
114  * gcc will throw warnings on printf("%d", off_t). Crap... */
115 #  define XATOOFF(a) xatoi_u(a)
116 #  define BB_STRTOOFF bb_strtou
117 #  define STRTOOFF strtol
118 #  define OFF_FMT "l"
119 # else
120 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
121 #  define BB_STRTOOFF bb_strtoul
122 #  define STRTOOFF strtol
123 #  define OFF_FMT "l"
124 # endif
125 #endif
126 /* scary. better ideas? (but do *test* them first!) */
127 #define OFF_T_MAX  ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
128
129 /* Some useful definitions */
130 #undef FALSE
131 #define FALSE   ((int) 0)
132 #undef TRUE
133 #define TRUE    ((int) 1)
134 #undef SKIP
135 #define SKIP    ((int) 2)
136
137 /* for mtab.c */
138 #define MTAB_GETMOUNTPT '1'
139 #define MTAB_GETDEVICE  '2'
140
141 #define BUF_SIZE        8192
142 #define EXPAND_ALLOC    1024
143
144 /* Macros for min/max.  */
145 #ifndef MIN
146 #define MIN(a,b) (((a)<(b))?(a):(b))
147 #endif
148
149 #ifndef MAX
150 #define MAX(a,b) (((a)>(b))?(a):(b))
151 #endif
152
153 /* buffer allocation schemes */
154 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
155 #define RESERVE_CONFIG_BUFFER(buffer,len)  char buffer[len]
156 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
157 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
158 #else
159 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
160 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
161 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
162 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
163 #else
164 #define RESERVE_CONFIG_BUFFER(buffer,len)  char *buffer = xmalloc(len)
165 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
166 #define RELEASE_CONFIG_BUFFER(buffer)      free(buffer)
167 #endif
168 #endif
169
170
171 #if defined(__GLIBC__)
172 /* glibc uses __errno_location() to get a ptr to errno */
173 /* We can just memorize it once - no multithreading in busybox :) */
174 extern int *const bb_errno;
175 #undef errno
176 #define errno (*bb_errno)
177 #endif
178
179 #if defined(__GLIBC__) && __GLIBC__ < 2
180 int vdprintf(int d, const char *format, va_list ap);
181 #endif
182 // This is declared here rather than #including <libgen.h> in order to avoid
183 // confusing the two versions of basename.  See the dirname/basename man page
184 // for details.
185 char *dirname(char *path);
186 /* Include our own copy of struct sysinfo to avoid binary compatibility
187  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
188 struct sysinfo {
189         long uptime;                    /* Seconds since boot */
190         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
191         unsigned long totalram;         /* Total usable main memory size */
192         unsigned long freeram;          /* Available memory size */
193         unsigned long sharedram;        /* Amount of shared memory */
194         unsigned long bufferram;        /* Memory used by buffers */
195         unsigned long totalswap;        /* Total swap space size */
196         unsigned long freeswap;         /* swap space still available */
197         unsigned short procs;           /* Number of current processes */
198         unsigned short pad;                     /* Padding needed for m68k */
199         unsigned long totalhigh;        /* Total high memory size */
200         unsigned long freehigh;         /* Available high memory size */
201         unsigned int mem_unit;          /* Memory unit size in bytes */
202         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
203 };
204 int sysinfo(struct sysinfo* info);
205
206 unsigned long long monotonic_us(void);
207 unsigned monotonic_sec(void);
208
209 extern void chomp(char *s);
210 extern void trim(char *s);
211 extern char *skip_whitespace(const char *);
212 extern char *skip_non_whitespace(const char *);
213
214 //TODO: supply a pointer to char[11] buffer (avoid statics)?
215 extern const char *bb_mode_string(mode_t mode);
216 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
217 extern int remove_file(const char *path, int flags);
218 extern int copy_file(const char *source, const char *dest, int flags);
219 enum {
220         ACTION_RECURSE        = (1 << 0),
221         ACTION_FOLLOWLINKS    = (1 << 1),
222         ACTION_FOLLOWLINKS_L0 = (1 << 2),
223         ACTION_DEPTHFIRST     = (1 << 3),
224         /*ACTION_REVERSE      = (1 << 4), - unused */
225 };
226 extern int recursive_action(const char *fileName, unsigned flags,
227         int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
228         int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
229         void* userData, unsigned depth);
230 extern int device_open(const char *device, int mode);
231 extern int get_console_fd(void);
232 extern char *find_block_device(const char *path);
233 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
234 extern off_t bb_copyfd_eof(int fd1, int fd2);
235 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
236 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
237 /* "short" copy can be detected by return value < size */
238 /* this helper yells "short read!" if param is not -1 */
239 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
240 extern char bb_process_escape_sequence(const char **ptr);
241 /* xxxx_strip version can modify its parameter:
242  * "/"        -> "/"
243  * "abc"      -> "abc"
244  * "abc/def"  -> "def"
245  * "abc/def/" -> "def" !!
246  */
247 extern char *bb_get_last_path_component_strip(char *path);
248 /* "abc/def/" -> "" and it never modifies 'path' */
249 extern char *bb_get_last_path_component_nostrip(const char *path);
250
251 int ndelay_on(int fd);
252 int ndelay_off(int fd);
253 int close_on_exec_on(int fd);
254 void xdup2(int, int);
255 void xmove_fd(int, int);
256
257
258 DIR *xopendir(const char *path);
259 DIR *warn_opendir(const char *path);
260
261 /* UNUSED: char *xmalloc_realpath(const char *path); */
262 char *xmalloc_readlink(const char *path);
263 char *xmalloc_readlink_follow(const char *path);
264 char *xmalloc_readlink_or_warn(const char *path);
265 char *xrealloc_getcwd_or_warn(char *cwd);
266
267
268 //TODO: signal(sid, f) is the same? then why?
269 extern void sig_catch(int,void (*)(int));
270 //#define sig_ignore(s) (sig_catch((s), SIG_IGN))
271 //#define sig_uncatch(s) (sig_catch((s), SIG_DFL))
272 extern void sig_block(int);
273 extern void sig_unblock(int);
274 /* UNUSED: extern void sig_blocknone(void); */
275 extern void sig_pause(void);
276
277
278 void xsetgid(gid_t gid);
279 void xsetuid(uid_t uid);
280 void xchdir(const char *path);
281 void xsetenv(const char *key, const char *value);
282 void xunlink(const char *pathname);
283 void xstat(const char *pathname, struct stat *buf);
284 int xopen(const char *pathname, int flags);
285 int xopen3(const char *pathname, int flags, int mode);
286 int open_or_warn(const char *pathname, int flags);
287 int open3_or_warn(const char *pathname, int flags, int mode);
288 void xpipe(int filedes[2]);
289 off_t xlseek(int fd, off_t offset, int whence);
290 off_t fdlength(int fd);
291
292 int xsocket(int domain, int type, int protocol);
293 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
294 void xlisten(int s, int backlog);
295 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
296 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
297                                 socklen_t tolen);
298 /* SO_REUSEADDR allows a server to rebind to an address that is already
299  * "in use" by old connections to e.g. previous server instance which is
300  * killed or crashed. Without it bind will fail until all such connections
301  * time out. Linux does not allow multiple live binds on same ip:port
302  * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
303  * Turn it on before you call bind(). */
304 void setsockopt_reuseaddr(int fd); /* On Linux this never fails. */
305 int setsockopt_broadcast(int fd);
306 /* NB: returns port in host byte order */
307 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
308 typedef struct len_and_sockaddr {
309         socklen_t len;
310         union {
311                 struct sockaddr sa;
312                 struct sockaddr_in sin;
313 #if ENABLE_FEATURE_IPV6
314                 struct sockaddr_in6 sin6;
315 #endif
316         };
317 } len_and_sockaddr;
318 enum {
319         LSA_SIZEOF_SA = sizeof(
320                 union {
321                         struct sockaddr sa;
322                         struct sockaddr_in sin;
323 #if ENABLE_FEATURE_IPV6
324                         struct sockaddr_in6 sin6;
325 #endif
326                 }
327         )
328 };
329 /* Create stream socket, and allocate suitable lsa.
330  * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
331  * af == AF_UNSPEC will result in trying to create IPv6 socket,
332  * and if kernel doesn't support it, IPv4.
333  */
334 int xsocket_type(len_and_sockaddr **lsap, USE_FEATURE_IPV6(int af,) int sock_type);
335 int xsocket_stream(len_and_sockaddr **lsap);
336 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
337  * numeric IP ("N.N.N.N") or numeric IPv6 address,
338  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
339  * Only if there is no suffix, port argument is used */
340 /* NB: these set SO_REUSEADDR before bind */
341 int create_and_bind_stream_or_die(const char *bindaddr, int port);
342 int create_and_bind_dgram_or_die(const char *bindaddr, int port);
343 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
344  * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
345  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
346  * If there is no suffix, port argument is used */
347 int create_and_connect_stream_or_die(const char *peer, int port);
348 /* Connect to peer identified by lsa */
349 int xconnect_stream(const len_and_sockaddr *lsa);
350 /* Return malloc'ed len_and_sockaddr with socket address of host:port
351  * Currently will return IPv4 or IPv6 sockaddrs only
352  * (depending on host), but in theory nothing prevents e.g.
353  * UNIX socket address being returned, IPX sockaddr etc...
354  * On error does bb_error_msg and returns NULL */
355 len_and_sockaddr* host2sockaddr(const char *host, int port);
356 /* Version which dies on error */
357 len_and_sockaddr* xhost2sockaddr(const char *host, int port);
358 len_and_sockaddr* xdotted2sockaddr(const char *host, int port);
359 #if ENABLE_FEATURE_IPV6
360 /* Same, useful if you want to force family (e.g. IPv6) */
361 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af);
362 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af);
363 #else
364 /* [we evaluate af: think about "host_and_af2sockaddr(..., af++)"] */
365 #define host_and_af2sockaddr(host, port, af) ((void)(af), host2sockaddr((host), (port)))
366 #define xhost_and_af2sockaddr(host, port, af) ((void)(af), xhost2sockaddr((host), (port)))
367 #endif
368 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
369  * otherwise no-op. Useful for ftp.
370  * NB: does NOT do htons() internally, just direct assignment. */
371 void set_nport(len_and_sockaddr *lsa, unsigned port);
372 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
373 int get_nport(const struct sockaddr *sa);
374 /* Reverse DNS. Returns NULL on failure. */
375 char* xmalloc_sockaddr2host(const struct sockaddr *sa);
376 /* This one doesn't append :PORTNUM */
377 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa);
378 /* This one also doesn't fall back to dotted IP (returns NULL) */
379 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa);
380 /* inet_[ap]ton on steroids */
381 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa);
382 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa);
383 // "old" (ipv4 only) API
384 // users: traceroute.c hostname.c - use _list_ of all IPs
385 struct hostent *xgethostbyname(const char *name);
386 // Also mount.c and inetd.c are using gethostbyname(),
387 // + inet_common.c has additional IPv4-only stuff
388
389
390 void socket_want_pktinfo(int fd);
391 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
392                 const struct sockaddr *from, const struct sockaddr *to,
393                 socklen_t tolen);
394 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
395                 struct sockaddr *from, struct sockaddr *to,
396                 socklen_t sa_size);
397
398 char *xstrdup(const char *s);
399 char *xstrndup(const char *s, int n);
400 char *safe_strncpy(char *dst, const char *src, size_t size);
401 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
402  * But potentially slow, don't use in one-billion-times loops */
403 int bb_putchar(int ch);
404 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
405 // gcc-4.1.1 still isn't good enough at optimizing it
406 // (+200 bytes compared to macro)
407 //static ALWAYS_INLINE
408 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
409 //static ALWAYS_INLINE
410 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
411 #define LONE_DASH(s)     ((s)[0] == '-' && !(s)[1])
412 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
413 #define LONE_CHAR(s,c)     ((s)[0] == (c) && !(s)[1])
414 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
415 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
416
417 /* dmalloc will redefine these to it's own implementation. It is safe
418  * to have the prototypes here unconditionally.  */
419 extern void *malloc_or_warn(size_t size);
420 extern void *xmalloc(size_t size);
421 extern void *xzalloc(size_t size);
422 extern void *xrealloc(void *old, size_t size);
423
424 extern ssize_t safe_read(int fd, void *buf, size_t count);
425 extern ssize_t full_read(int fd, void *buf, size_t count);
426 extern void xread(int fd, void *buf, size_t count);
427 extern unsigned char xread_char(int fd);
428 // Read one line a-la fgets. Uses one read(), works only on seekable streams
429 extern char *reads(int fd, char *buf, size_t count);
430 // Read one line a-la fgets. Reads byte-by-byte.
431 // Useful when it is important to not read ahead.
432 extern char *xmalloc_reads(int fd, char *pfx);
433 extern ssize_t read_close(int fd, void *buf, size_t count);
434 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
435 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
436
437 extern ssize_t safe_write(int fd, const void *buf, size_t count);
438 extern ssize_t full_write(int fd, const void *buf, size_t count);
439 extern void xwrite(int fd, const void *buf, size_t count);
440
441 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
442 extern void xprint_and_close_file(FILE *file);
443 extern char *xmalloc_fgets(FILE *file);
444 /* Read up to (and including) TERMINATING_STRING: */
445 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
446 /* Chops off '\n' from the end, unlike fgets: */
447 extern char *xmalloc_getline(FILE *file);
448 extern char *bb_get_chunk_from_file(FILE *file, int *end);
449 extern void die_if_ferror(FILE *file, const char *msg);
450 extern void die_if_ferror_stdout(void);
451 extern void xfflush_stdout(void);
452 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
453 extern int fclose_if_not_stdin(FILE *file);
454 extern FILE *xfopen(const char *filename, const char *mode);
455 /* Prints warning to stderr and returns NULL on failure: */
456 extern FILE *fopen_or_warn(const char *filename, const char *mode);
457 /* "Opens" stdin if filename is special, else just opens file: */
458 extern FILE *fopen_or_warn_stdin(const char *filename);
459
460 /* Wrapper which restarts poll on EINTR or ENOMEM.
461  * On other errors complains [perror("poll")] and returns.
462  * Warning! May take (much) longer than timeout_ms to return!
463  * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
464 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms);
465
466 /* Convert each alpha char in str to lower-case */
467 char* str_tolower(char *str);
468
469 char *utoa(unsigned n);
470 char *itoa(int n);
471 /* Returns a pointer past the formatted number, does NOT null-terminate */
472 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen);
473 char *itoa_to_buf(int n, char *buf, unsigned buflen);
474 void smart_ulltoa5(unsigned long long ul, char buf[5]);
475 //TODO: provide pointer to buf (avoid statics)?
476 const char *make_human_readable_str(unsigned long long size,
477                 unsigned long block_size, unsigned long display_unit);
478 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
479 char *bin2hex(char *buf, const char *cp, int count);
480
481 /* Last element is marked by mult == 0 */
482 struct suffix_mult {
483         char suffix[4];
484         unsigned mult;
485 };
486 #include "xatonum.h"
487 /* Specialized: */
488 /* Using xatoi() instead of naive atoi() is not always convenient -
489  * in many places people want *non-negative* values, but store them
490  * in signed int. Therefore we need this one:
491  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
492 int xatoi_u(const char *numstr);
493 /* Useful for reading port numbers */
494 uint16_t xatou16(const char *numstr);
495
496
497 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
498  * for BusyBox since we want to avoid using the glibc NSS stuff, which
499  * increases target size and is often not needed on embedded systems.  */
500 long xuname2uid(const char *name);
501 long xgroup2gid(const char *name);
502 /* wrapper: allows string to contain numeric uid or gid */
503 unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
504 /* from chpst. Does not die, returns 0 on failure */
505 struct bb_uidgid_t {
506         uid_t uid;
507         gid_t gid;
508 };
509 /* always sets uid and gid */
510 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
511 /* chown-like handling of "user[:[group]" */
512 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group);
513 /* bb_getpwuid, bb_getgrgid:
514  * bb_getXXXid(buf, bufsz, id) - copy user/group name or id
515  *              as a string to buf, return user/group name or NULL
516  * bb_getXXXid(NULL, 0, id) - return user/group name or NULL
517  * bb_getXXXid(NULL, -1, id) - return user/group name or exit
518 */
519 char *bb_getpwuid(char *name, int bufsize, long uid);
520 char *bb_getgrgid(char *group, int bufsize, long gid);
521 /* versions which cache results (useful for ps, ls etc) */
522 const char* get_cached_username(uid_t uid);
523 const char* get_cached_groupname(gid_t gid);
524 void clear_username_cache(void);
525 /* internally usernames are saved in fixed-sized char[] buffers */
526 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
527
528
529 struct bb_applet;
530 int execable_file(const char *name);
531 char *find_execable(const char *filename);
532 int exists_execable(const char *filename);
533
534 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
535  * but it may exec busybox and call applet instead of searching PATH.
536  */
537 #if ENABLE_FEATURE_PREFER_APPLETS
538 int bb_execvp(const char *file, char *const argv[]);
539 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
540 #define BB_EXECLP(prog,cmd,...) \
541         execlp((find_applet_by_name(prog)) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
542                 cmd, __VA_ARGS__)
543 #else
544 #define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
545 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
546 #endif
547
548 /* NOMMU friendy fork+exec */
549 pid_t spawn(char **argv);
550 pid_t xspawn(char **argv);
551
552 /* Unlike waitpid, waits ONLY for one process,
553  * It's safe to pass negative 'pids' from failed [v]fork -
554  * wait4pid will return -1 (and will not clobber [v]fork's errno).
555  * IOW: rc = wait4pid(spawn(argv));
556  *      if (rc < 0) bb_perror_msg("%s", argv[0]);
557  *      if (rc > 0) bb_error_msg("exit code: %d", rc);
558  */
559 int wait4pid(int pid);
560 int wait_pid(int *wstat, int pid);
561 int wait_nohang(int *wstat);
562 #define wait_crashed(w) ((w) & 127)
563 #define wait_exitcode(w) ((w) >> 8)
564 #define wait_stopsig(w) ((w) >> 8)
565 #define wait_stopped(w) (((w) & 127) == 127)
566 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
567 int spawn_and_wait(char **argv);
568 struct nofork_save_area {
569         jmp_buf die_jmp;
570         const char *applet_name;
571         int xfunc_error_retval;
572         uint32_t option_mask32;
573         int die_sleep;
574         smallint saved;
575 };
576 void save_nofork_data(struct nofork_save_area *save);
577 void restore_nofork_data(struct nofork_save_area *save);
578 /* Does NOT check that applet is NOFORK, just blindly runs it */
579 int run_nofork_applet(const struct bb_applet *a, char **argv);
580 int run_nofork_applet_prime(struct nofork_save_area *old, const struct bb_applet *a, char **argv);
581
582 /* Helpers for daemonization.
583  *
584  * bb_daemonize(flags) = daemonize, does not compile on NOMMU
585  *
586  * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
587  *      rexec's itself on NOMMU with argv passed as command line.
588  * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
589  * from the start. (It will detect it and not reexec again second time).
590  * You have to audit carefully that you don't do something twice as a result
591  * (opening files/sockets, parsing config files etc...)!
592  *
593  * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
594  * (will do setsid()).
595  *
596  * forkexit_or_rexec(argv) = bare-bones "fork + parent exits" on MMU,
597  *      "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
598  *      Currently used for openvt. On MMU ignores argv.
599  *
600  * Helper for network daemons in foreground mode:
601  *
602  * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
603  * to /dev/null if they are not.
604  */
605 enum {
606         DAEMON_CHDIR_ROOT = 1,
607         DAEMON_DEVNULL_STDIO = 2,
608         DAEMON_CLOSE_EXTRA_FDS = 4,
609         DAEMON_ONLY_SANITIZE = 8, /* internal use */
610 };
611 #if BB_MMU
612   void forkexit_or_rexec(void);
613   enum { re_execed = 0 };
614 # define forkexit_or_rexec(argv)            forkexit_or_rexec()
615 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
616 # define bb_daemonize(flags)                bb_daemonize_or_rexec(flags, bogus)
617 #else
618   void re_exec(char **argv) ATTRIBUTE_NORETURN;
619   void forkexit_or_rexec(char **argv);
620   extern bool re_execed;
621 # define fork()          BUG_fork_is_unavailable_on_nommu()
622 # define daemon(a,b)     BUG_daemon_is_unavailable_on_nommu()
623 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
624 #endif
625 void bb_daemonize_or_rexec(int flags, char **argv);
626 void bb_sanitize_stdio(void);
627 /* Clear dangerous stuff, set PATH */
628 void sanitize_env_for_suid(void);
629
630
631 extern const char *opt_complementary;
632 #if ENABLE_GETOPT_LONG
633 #define No_argument "\0"
634 #define Required_argument "\001"
635 #define Optional_argument "\002"
636 extern const char *applet_long_options;
637 #endif
638 extern uint32_t option_mask32;
639 extern uint32_t getopt32(char **argv, const char *applet_opts, ...);
640
641
642 typedef struct llist_t {
643         char *data;
644         struct llist_t *link;
645 } llist_t;
646 void llist_add_to(llist_t **old_head, void *data);
647 void llist_add_to_end(llist_t **list_head, void *data);
648 void *llist_pop(llist_t **elm);
649 void llist_unlink(llist_t **head, llist_t *elm);
650 void llist_free(llist_t *elm, void (*freeit)(void *data));
651 llist_t *llist_rev(llist_t *list);
652 /* BTW, surprisingly, changing API to
653  *   llist_t *llist_add_to(llist_t *old_head, void *data)
654  * etc does not result in smaller code... */
655
656 /* start_stop_daemon and udhcpc are special - they want
657  * to create pidfiles regardless of FEATURE_PIDFILE */
658 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
659 /* True only if we created pidfile which is *file*, not /dev/null etc */
660 extern smallint wrote_pidfile;
661 void write_pidfile(const char *path);
662 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
663 #else
664 enum { wrote_pidfile = 0 };
665 #define write_pidfile(path)  ((void)0)
666 #define remove_pidfile(path) ((void)0)
667 #endif
668
669 enum {
670         LOGMODE_NONE = 0,
671         LOGMODE_STDIO = (1 << 0),
672         LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
673         LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
674 };
675 extern const char *msg_eol;
676 extern smallint logmode;
677 extern int die_sleep;
678 extern int xfunc_error_retval;
679 extern jmp_buf die_jmp;
680 extern void xfunc_die(void) ATTRIBUTE_NORETURN;
681 extern void bb_show_usage(void) ATTRIBUTE_NORETURN;
682 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
683 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
684 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
685 extern void bb_simple_perror_msg(const char *s);
686 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
687 extern void bb_simple_perror_msg_and_die(const char *s) __attribute__ ((noreturn));
688 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
689 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
690 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
691 extern void bb_perror_nomsg(void);
692 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
693 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
694
695 /* We need to export XXX_main from libbusybox
696  * only if we build "individual" binaries
697  */
698 #if ENABLE_FEATURE_INDIVIDUAL
699 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
700 #else
701 #define MAIN_EXTERNALLY_VISIBLE
702 #endif
703
704
705 /* applets which are useful from another applets */
706 int bb_cat(char** argv);
707 int bb_echo(char** argv);
708 int test_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
709 int kill_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
710 #if ENABLE_ROUTE
711 void bb_displayroutes(int noresolve, int netstatfmt);
712 #endif
713 int chown_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
714 #if ENABLE_GUNZIP
715 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
716 #endif
717 #if ENABLE_BUNZIP2
718 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
719 #endif
720 int bbunpack(char **argv,
721         char* (*make_new_name)(char *filename),
722         USE_DESKTOP(long long) int (*unpacker)(void)
723 );
724
725
726 /* Networking */
727 int create_icmp_socket(void);
728 int create_icmp6_socket(void);
729 /* interface.c */
730 /* This structure defines protocol families and their handlers. */
731 struct aftype {
732         const char *name;
733         const char *title;
734         int af;
735         int alen;
736         char *(*print) (unsigned char *);
737         const char *(*sprint) (struct sockaddr *, int numeric);
738         int (*input) (/*int type,*/ const char *bufp, struct sockaddr *);
739         void (*herror) (char *text);
740         int (*rprint) (int options);
741         int (*rinput) (int typ, int ext, char **argv);
742
743         /* may modify src */
744         int (*getmask) (char *src, struct sockaddr * mask, char *name);
745 };
746 /* This structure defines hardware protocols and their handlers. */
747 struct hwtype {
748         const char *name;
749         const char *title;
750         int type;
751         int alen;
752         char *(*print) (unsigned char *);
753         int (*input) (const char *, struct sockaddr *);
754         int (*activate) (int fd);
755         int suppress_null_addr;
756 };
757 extern smallint interface_opt_a;
758 int display_interfaces(char *ifname);
759 const struct aftype *get_aftype(const char *name);
760 const struct hwtype *get_hwtype(const char *name);
761 const struct hwtype *get_hwntype(int type);
762
763
764 #ifndef BUILD_INDIVIDUAL
765 extern const struct bb_applet *find_applet_by_name(const char *name);
766 /* Returns only if applet is not found. */
767 extern void run_applet_and_exit(const char *name, char **argv);
768 extern void run_appletstruct_and_exit(const struct bb_applet *a, char **argv) ATTRIBUTE_NORETURN;
769 #endif
770
771 extern int match_fstype(const struct mntent *mt, const char *fstypes);
772 extern struct mntent *find_mount_point(const char *name, const char *table);
773 extern void erase_mtab(const char * name);
774 extern unsigned int tty_baud_to_value(speed_t speed);
775 extern speed_t tty_value_to_baud(unsigned int value);
776 extern void bb_warn_ignoring_args(int n);
777
778 extern int get_linux_version_code(void);
779
780 extern char *query_loop(const char *device);
781 extern int del_loop(const char *device);
782 /* If *devname is not NULL, use that name, otherwise try to find free one,
783  * malloc and return it in *devname.
784  * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
785 extern int set_loop(char **devname, const char *file, unsigned long long offset);
786
787
788 //TODO: pass buf pointer or return allocated buf (avoid statics)?
789 char *bb_askpass(int timeout, const char * prompt);
790 int bb_ask_confirmation(void);
791 int klogctl(int type, char * b, int len);
792
793 extern int bb_parse_mode(const char* s, mode_t* theMode);
794
795 char *concat_path_file(const char *path, const char *filename);
796 char *concat_subpath_file(const char *path, const char *filename);
797 const char *bb_basename(const char *name);
798 /* NB: can violate const-ness (similarly to strchr) */
799 char *last_char_is(const char *s, int c);
800
801
802 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
803 int inflate(int in, int out);
804
805
806 int bb_make_directory(char *path, long mode, int flags);
807
808 int get_signum(const char *name);
809 const char *get_signame(int number);
810 void print_signames(void);
811
812 char *bb_simplify_path(const char *path);
813
814 #define FAIL_DELAY 3
815 extern void bb_do_delay(int seconds);
816 extern void change_identity(const struct passwd *pw);
817 extern const char *change_identity_e2str(const struct passwd *pw);
818 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) ATTRIBUTE_NORETURN;
819 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
820 #if ENABLE_SELINUX
821 extern void renew_current_security_context(void);
822 extern void set_current_security_context(security_context_t sid);
823 extern context_t set_security_context_component(security_context_t cur_context,
824                                                 char *user, char *role, char *type, char *range);
825 extern void setfscreatecon_or_die(security_context_t scontext);
826 extern void selinux_preserve_fcontext(int fdesc);
827 #else
828 #define selinux_preserve_fcontext(fdesc) ((void)0)
829 #endif
830 extern void selinux_or_die(void);
831 extern int restricted_shell(const char *shell);
832
833 /* setup_environment:
834  * if loginshell = 1: cd(pw->pw_dir), clear environment, then set
835  *   TERM=(old value)
836  *   USER=pw->pw_name, LOGNAME=pw->pw_name
837  *   PATH=bb_default_[root_]path
838  *   HOME=pw->pw_dir
839  *   SHELL=shell
840  * else if changeenv = 1:
841  *   if not root (if pw->pw_uid != 0):
842  *     USER=pw->pw_name, LOGNAME=pw->pw_name
843  *   HOME=pw->pw_dir
844  *   SHELL=shell
845  * else does nothing
846  */
847 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
848 extern int correct_password(const struct passwd *pw);
849 /* Returns a ptr to static storage */
850 extern char *pw_encrypt(const char *clear, const char *salt);
851 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
852
853 int index_in_str_array(const char *const string_array[], const char *key);
854 int index_in_strings(const char *strings, const char *key);
855 int index_in_substr_array(const char *const string_array[], const char *key);
856 int index_in_substrings(const char *strings, const char *key);
857 const char *nth_string(const char *strings, int n);
858
859 extern void print_login_issue(const char *issue_file, const char *tty);
860 extern void print_login_prompt(void);
861
862 /* rnd is additional random input. New one is returned.
863  * Useful if you call crypt_make_salt many times in a row:
864  * rnd = crypt_make_salt(buf1, 4, 0);
865  * rnd = crypt_make_salt(buf2, 4, rnd);
866  * rnd = crypt_make_salt(buf3, 4, rnd);
867  * (otherwise we risk having same salt generated)
868  */
869 extern int crypt_make_salt(char *p, int cnt, int rnd);
870
871 /* Returns number of lines changed, or -1 on error */
872 extern int update_passwd(const char *filename, const char *username,
873                         const char *new_pw);
874
875 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
876 int get_terminal_width_height(int fd, int *width, int *height);
877
878 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
879 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5)));
880 #if ENABLE_IOCTL_HEX2STR_ERROR
881 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name);
882 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name);
883 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
884 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp,#request)
885 #else
886 int bb_ioctl_or_warn(int fd, int request, void *argp);
887 void bb_xioctl(int fd, int request, void *argp);
888 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
889 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp)
890 #endif
891
892 char *is_in_ino_dev_hashtable(const struct stat *statbuf);
893 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
894 void reset_ino_dev_hashtable(void);
895 #ifdef __GLIBC__
896 /* At least glibc has horrendously large inline for this, so wrap it */
897 unsigned long long bb_makedev(unsigned int major, unsigned int minor);
898 #undef makedev
899 #define makedev(a,b) bb_makedev(a,b)
900 #endif
901
902
903 #if ENABLE_FEATURE_EDITING
904 /* It's NOT just ENABLEd or disabled. It's a number: */
905 #ifdef CONFIG_FEATURE_EDITING_HISTORY
906 #define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
907 #else
908 #define MAX_HISTORY 0
909 #endif
910 typedef struct line_input_t {
911         int flags;
912         const char *path_lookup;
913 #if MAX_HISTORY
914         int cnt_history;
915         int cur_history;
916         USE_FEATURE_EDITING_SAVEHISTORY(const char *hist_file;)
917         char *history[MAX_HISTORY + 1];
918 #endif
919 } line_input_t;
920 enum {
921         DO_HISTORY = 1 * (MAX_HISTORY > 0),
922         SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
923         TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
924         USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
925         VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
926         WITH_PATH_LOOKUP = 0x20,
927         FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
928 };
929 line_input_t *new_line_input_t(int flags);
930 /* Returns:
931  * -1 on read errors or EOF, or on bare Ctrl-D.
932  * 0  on ctrl-C,
933  * >0 length of input string, including terminating '\n'
934  * [is this true? stores "" in 'command' if return value is 0 or -1]
935  */
936 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
937 #else
938 int read_line_input(const char* prompt, char* command, int maxsize);
939 #define read_line_input(prompt, command, maxsize, state) \
940         read_line_input(prompt, command, maxsize)
941 #endif
942
943
944 #ifndef COMM_LEN
945 #ifdef TASK_COMM_LEN
946 enum { COMM_LEN = TASK_COMM_LEN };
947 #else
948 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
949 enum { COMM_LEN = 16 };
950 #endif
951 #endif
952 typedef struct procps_status_t {
953         DIR *dir;
954         uint8_t shift_pages_to_bytes;
955         uint8_t shift_pages_to_kb;
956 /* Fields are set to 0/NULL if failed to determine (or not requested) */
957         char *argv0;
958         USE_SELINUX(char *context;)
959         /* Everything below must contain no ptrs to malloc'ed data:
960          * it is memset(0) for each process in procps_scan() */
961         unsigned long vsz, rss; /* we round it to kbytes */
962         unsigned long stime, utime;
963         unsigned pid;
964         unsigned ppid;
965         unsigned pgid;
966         unsigned sid;
967         unsigned uid;
968         unsigned gid;
969         unsigned tty_major,tty_minor;
970 #if ENABLE_FEATURE_TOPMEM
971         unsigned long mapped_rw;
972         unsigned long mapped_ro;
973         unsigned long shared_clean;
974         unsigned long shared_dirty;
975         unsigned long private_clean;
976         unsigned long private_dirty;
977         unsigned long stack;
978 #endif
979         char state[4];
980         /* basename of executable in exec(2), read from /proc/N/stat
981          * (if executable is symlink or script, it is NOT replaced
982          * by link target or interpreter name) */
983         char comm[COMM_LEN];
984         /* user/group? - use passwd/group parsing functions */
985 } procps_status_t;
986 enum {
987         PSSCAN_PID      = 1 << 0,
988         PSSCAN_PPID     = 1 << 1,
989         PSSCAN_PGID     = 1 << 2,
990         PSSCAN_SID      = 1 << 3,
991         PSSCAN_UIDGID   = 1 << 4,
992         PSSCAN_COMM     = 1 << 5,
993         /* PSSCAN_CMD      = 1 << 6, - use read_cmdline instead */
994         PSSCAN_ARGV0    = 1 << 7,
995         /* PSSCAN_EXE      = 1 << 8, - not implemented */
996         PSSCAN_STATE    = 1 << 9,
997         PSSCAN_VSZ      = 1 << 10,
998         PSSCAN_RSS      = 1 << 11,
999         PSSCAN_STIME    = 1 << 12,
1000         PSSCAN_UTIME    = 1 << 13,
1001         PSSCAN_TTY      = 1 << 14,
1002         PSSCAN_SMAPS    = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1003         PSSCAN_ARGVN    = (1 << 16) * (ENABLE_PGREP | ENABLE_PKILL),
1004         USE_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
1005         /* These are all retrieved from proc/NN/stat in one go: */
1006         PSSCAN_STAT     = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1007                         | PSSCAN_COMM | PSSCAN_STATE
1008                         | PSSCAN_VSZ | PSSCAN_RSS
1009                         | PSSCAN_STIME | PSSCAN_UTIME
1010                         | PSSCAN_TTY,
1011 };
1012 procps_status_t* alloc_procps_scan(int flags);
1013 void free_procps_scan(procps_status_t* sp);
1014 procps_status_t* procps_scan(procps_status_t* sp, int flags);
1015 /* Format cmdline (up to col chars) into char buf[col+1] */
1016 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1017 void read_cmdline(char *buf, int col, unsigned pid, const char *comm);
1018 pid_t *find_pid_by_name(const char* procName);
1019 pid_t *pidlist_reverse(pid_t *pidList);
1020
1021
1022 extern const char bb_uuenc_tbl_base64[];
1023 extern const char bb_uuenc_tbl_std[];
1024 void bb_uuencode(char *store, const void *s, int length, const char *tbl);
1025
1026 typedef struct sha1_ctx_t {
1027         uint32_t count[2];
1028         uint32_t hash[5];
1029         uint32_t wbuf[16];
1030 } sha1_ctx_t;
1031 void sha1_begin(sha1_ctx_t *ctx);
1032 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
1033 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
1034
1035 typedef struct md5_ctx_t {
1036         uint32_t A;
1037         uint32_t B;
1038         uint32_t C;
1039         uint32_t D;
1040         uint64_t total;
1041         uint32_t buflen;
1042         char buffer[128];
1043 } md5_ctx_t;
1044 void md5_begin(md5_ctx_t *ctx);
1045 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
1046 void *md5_end(void *resbuf, md5_ctx_t *ctx);
1047
1048 uint32_t *crc32_filltable(uint32_t *tbl256, int endian);
1049
1050
1051 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c, mv.c, install.c depend on them. */
1052         FILEUTILS_PRESERVE_STATUS = 1,
1053         FILEUTILS_DEREFERENCE = 2,
1054         FILEUTILS_RECUR = 4,
1055         FILEUTILS_FORCE = 8,
1056         FILEUTILS_INTERACTIVE = 0x10,
1057         FILEUTILS_MAKE_HARDLINK = 0x20,
1058         FILEUTILS_MAKE_SOFTLINK = 0x40,
1059 #if ENABLE_SELINUX
1060         FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x80,
1061         FILEUTILS_SET_SECURITY_CONTEXT = 0x100
1062 #endif
1063 };
1064
1065 #define FILEUTILS_CP_OPTSTR "pdRfils" USE_SELINUX("c")
1066 extern const char *applet_name;
1067 /* "BusyBox vN.N.N (timestamp or extra_vestion)" */
1068 extern const char bb_banner[];
1069 extern const char bb_msg_memory_exhausted[];
1070 extern const char bb_msg_invalid_date[];
1071 extern const char bb_msg_read_error[];
1072 extern const char bb_msg_write_error[];
1073 extern const char bb_msg_unknown[];
1074 extern const char bb_msg_can_not_create_raw_socket[];
1075 extern const char bb_msg_perm_denied_are_you_root[];
1076 extern const char bb_msg_requires_arg[];
1077 extern const char bb_msg_invalid_arg[];
1078 extern const char bb_msg_standard_input[];
1079 extern const char bb_msg_standard_output[];
1080
1081 extern const char bb_str_default[];
1082 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1083 extern const char bb_hexdigits_upcase[];
1084
1085 extern const char bb_path_mtab_file[];
1086 extern const char bb_path_passwd_file[];
1087 extern const char bb_path_shadow_file[];
1088 extern const char bb_path_gshadow_file[];
1089 extern const char bb_path_group_file[];
1090 extern const char bb_path_motd_file[];
1091 extern const char bb_path_wtmp_file[];
1092 extern const char bb_dev_null[];
1093 extern const char bb_busybox_exec_path[];
1094 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1095  * but I want to save a few bytes here */
1096 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1097 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1098 #define bb_default_path      (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1099
1100 extern const int const_int_0;
1101 extern const int const_int_1;
1102
1103
1104 #ifndef BUFSIZ
1105 #define BUFSIZ 4096
1106 #endif
1107 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1108 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1109 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1110 /* This struct is deliberately not defined. */
1111 /* See docs/keep_data_small.txt */
1112 struct globals;
1113 /* '*const' ptr makes gcc optimize code much better.
1114  * Magic prevents ptr_to_globals from going into rodata.
1115  * If you want to assign a value, use PTR_TO_GLOBALS = xxx */
1116 extern struct globals *const ptr_to_globals;
1117 #define PTR_TO_GLOBALS (*(struct globals**)&ptr_to_globals)
1118
1119
1120 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1121  * use bb_default_login_shell and following defines.
1122  * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1123  * don't forget to change increment constant. */
1124 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
1125 extern const char bb_default_login_shell[];
1126 /* "/bin/sh" */
1127 #define DEFAULT_SHELL     (bb_default_login_shell+1)
1128 /* "sh" */
1129 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
1130
1131
1132 #if ENABLE_FEATURE_DEVFS
1133 # define CURRENT_VC "/dev/vc/0"
1134 # define VC_1 "/dev/vc/1"
1135 # define VC_2 "/dev/vc/2"
1136 # define VC_3 "/dev/vc/3"
1137 # define VC_4 "/dev/vc/4"
1138 # define VC_5 "/dev/vc/5"
1139 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1140 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1141    respective serial ports .. as such, we can't use the common device paths for
1142    these. -- PFM */
1143 #  define SC_0 "/dev/ttsc/0"
1144 #  define SC_1 "/dev/ttsc/1"
1145 #  define SC_FORMAT "/dev/ttsc/%d"
1146 #else
1147 #  define SC_0 "/dev/tts/0"
1148 #  define SC_1 "/dev/tts/1"
1149 #  define SC_FORMAT "/dev/tts/%d"
1150 #endif
1151 # define VC_FORMAT "/dev/vc/%d"
1152 # define LOOP_FORMAT "/dev/loop/%d"
1153 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1154 # define LOOP_NAME "/dev/loop/"
1155 # define FB_0 "/dev/fb/0"
1156 #else
1157 # define CURRENT_VC "/dev/tty0"
1158 # define VC_1 "/dev/tty1"
1159 # define VC_2 "/dev/tty2"
1160 # define VC_3 "/dev/tty3"
1161 # define VC_4 "/dev/tty4"
1162 # define VC_5 "/dev/tty5"
1163 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1164 #  define SC_0 "/dev/ttySC0"
1165 #  define SC_1 "/dev/ttySC1"
1166 #  define SC_FORMAT "/dev/ttySC%d"
1167 #else
1168 #  define SC_0 "/dev/ttyS0"
1169 #  define SC_1 "/dev/ttyS1"
1170 #  define SC_FORMAT "/dev/ttyS%d"
1171 #endif
1172 # define VC_FORMAT "/dev/tty%d"
1173 # define LOOP_FORMAT "/dev/loop%d"
1174 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1175 # define LOOP_NAME "/dev/loop"
1176 # define FB_0 "/dev/fb0"
1177 #endif
1178
1179 /* The following devices are the same on devfs and non-devfs systems.  */
1180 #define CURRENT_TTY "/dev/tty"
1181 #define DEV_CONSOLE "/dev/console"
1182
1183
1184 #ifndef RB_POWER_OFF
1185 /* Stop system and switch power off if possible.  */
1186 #define RB_POWER_OFF   0x4321fedc
1187 #endif
1188
1189 /* Make sure we call functions instead of macros.  */
1190 #undef isalnum
1191 #undef isalpha
1192 #undef isascii
1193 #undef isblank
1194 #undef iscntrl
1195 #undef isgraph
1196 #undef islower
1197 #undef isprint
1198 #undef ispunct
1199 #undef isspace
1200 #undef isupper
1201 #undef isxdigit
1202
1203 /* This one is more efficient - we save ~400 bytes */
1204 #undef isdigit
1205 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1206
1207
1208 #ifdef DMALLOC
1209 #include <dmalloc.h>
1210 #endif
1211
1212 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
1213
1214 #endif /* __LIBBUSYBOX_H__ */