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