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