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