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