72261b760f4e0ecfa5fc3efdbe4fe43a4bd530e6
[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 <malloc.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 <string.h>
28 #include <strings.h>
29 #include <sys/ioctl.h>
30 #include <sys/mman.h>
31 #include <sys/socket.h>
32 #include <sys/stat.h>
33 #include <sys/statfs.h>
34 #include <sys/time.h>
35 #include <sys/types.h>
36 #include <sys/wait.h>
37 #include <termios.h>
38 #include <time.h>
39 #include <unistd.h>
40 #include <utime.h>
41
42 #if ENABLE_SELINUX
43 #include <selinux/selinux.h>
44 #endif
45
46 #if ENABLE_LOCALE_SUPPORT
47 #include <locale.h>
48 #else
49 #define setlocale(x,y) ((void)0)
50 #endif
51
52 #include "pwd_.h"
53 #include "grp_.h"
54 /* ifdef it out, because it may include <shadow.h> */
55 /* and we may not even _have_ <shadow.h>! */
56 #if ENABLE_FEATURE_SHADOWPASSWDS
57 #include "shadow_.h"
58 #endif
59
60 /* Try to pull in PATH_MAX */
61 #include <limits.h>
62 #include <sys/param.h>
63 #ifndef PATH_MAX
64 #define PATH_MAX 256
65 #endif
66
67 /* Tested to work correctly (IIRC :]) */
68 #define MAXINT(T) (T)( \
69         ((T)-1) > 0 \
70         ? (T)-1 \
71         : (T)~((T)1 << (sizeof(T)*8-1)) \
72         )
73
74 #define MININT(T) (T)( \
75         ((T)-1) > 0 \
76         ? (T)0 \
77         : ((T)1 << (sizeof(T)*8-1)) \
78         )
79
80 /* Large file support */
81 /* Note that CONFIG_LFS forces bbox to be built with all common ops
82  * (stat, lseek etc) mapped to "largefile" variants by libc.
83  * Practically it means that open() automatically has O_LARGEFILE added
84  * and all filesize/file_offset parameters and struct members are "large"
85  * (in today's world - signed 64bit). For full support of large files,
86  * we need a few helper #defines (below) and careful use of off_t
87  * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
88 #if ENABLE_LFS
89 /* CONFIG_LFS is on */
90 # if ULONG_MAX > 0xffffffff
91 /* "long" is long enough on this system */
92 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
93 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
94 #  define BB_STRTOOFF bb_strtoul
95 #  define STRTOOFF strtoul
96 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
97 #  define OFF_FMT "l"
98 # else
99 /* "long" is too short, need "long long" */
100 #  define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
101 #  define BB_STRTOOFF bb_strtoull
102 #  define STRTOOFF strtoull
103 #  define OFF_FMT "ll"
104 # endif
105 #else
106 /* CONFIG_LFS is off */
107 # if UINT_MAX == 0xffffffff
108 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
109  * gcc will throw warnings on printf("%d", off_t). Crap... */
110 #  define XATOOFF(a) xatoi_u(a)
111 #  define BB_STRTOOFF bb_strtou
112 #  define STRTOOFF strtol
113 #  define OFF_FMT "l"
114 # else
115 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
116 #  define BB_STRTOOFF bb_strtoul
117 #  define STRTOOFF strtol
118 #  define OFF_FMT "l"
119 # endif
120 #endif
121 /* scary. better ideas? (but do *test* them first!) */
122 #define OFF_T_MAX  ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
123
124 /* This structure defines protocol families and their handlers. */
125 struct aftype {
126         char *name;
127         char *title;
128         int af;
129         int alen;
130         char *(*print) (unsigned char *);
131         char *(*sprint) (struct sockaddr *, int numeric);
132         int (*input) (int type, char *bufp, struct sockaddr *);
133         void (*herror) (char *text);
134         int (*rprint) (int options);
135         int (*rinput) (int typ, int ext, char **argv);
136
137         /* may modify src */
138         int (*getmask) (char *src, struct sockaddr * mask, char *name);
139
140         int fd;
141         char *flag_file;
142 };
143
144 /* This structure defines hardware protocols and their handlers. */
145 struct hwtype {
146         char *name;
147         char *title;
148         int type;
149         int alen;
150         char *(*print) (unsigned char *);
151         int (*input) (char *, struct sockaddr *);
152         int (*activate) (int fd);
153         int suppress_null_addr;
154 };
155
156 /* Some useful definitions */
157 #undef FALSE
158 #define FALSE   ((int) 0)
159 #undef TRUE
160 #define TRUE    ((int) 1)
161 #undef SKIP
162 #define SKIP    ((int) 2)
163
164 /* for mtab.c */
165 #define MTAB_GETMOUNTPT '1'
166 #define MTAB_GETDEVICE  '2'
167
168 #define BUF_SIZE        8192
169 #define EXPAND_ALLOC    1024
170
171 /* Macros for min/max.  */
172 #ifndef MIN
173 #define MIN(a,b) (((a)<(b))?(a):(b))
174 #endif
175
176 #ifndef MAX
177 #define MAX(a,b) (((a)>(b))?(a):(b))
178 #endif
179
180 /* buffer allocation schemes */
181 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
182 #define RESERVE_CONFIG_BUFFER(buffer,len)           char buffer[len]
183 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
184 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
185 #else
186 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
187 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
188 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
189 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
190 #else
191 #define RESERVE_CONFIG_BUFFER(buffer,len)           char *buffer=xmalloc(len)
192 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
193 #define RELEASE_CONFIG_BUFFER(buffer)      free (buffer)
194 #endif
195 #endif
196
197
198 #if defined(__GLIBC__) && __GLIBC__ < 2
199 int vdprintf(int d, const char *format, va_list ap);
200 #endif
201 // This is declared here rather than #including <libgen.h> in order to avoid
202 // confusing the two versions of basename.  See the dirname/basename man page
203 // for details.
204 char *dirname(char *path);
205 /* Include our own copy of struct sysinfo to avoid binary compatibility
206  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
207 struct sysinfo {
208         long uptime;                    /* Seconds since boot */
209         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
210         unsigned long totalram;         /* Total usable main memory size */
211         unsigned long freeram;          /* Available memory size */
212         unsigned long sharedram;        /* Amount of shared memory */
213         unsigned long bufferram;        /* Memory used by buffers */
214         unsigned long totalswap;        /* Total swap space size */
215         unsigned long freeswap;         /* swap space still available */
216         unsigned short procs;           /* Number of current processes */
217         unsigned short pad;                     /* Padding needed for m68k */
218         unsigned long totalhigh;        /* Total high memory size */
219         unsigned long freehigh;         /* Available high memory size */
220         unsigned int mem_unit;          /* Memory unit size in bytes */
221         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
222 };
223 extern int sysinfo(struct sysinfo* info);
224
225
226 /* Size-saving "small" ints (arch-dependent) */
227 #if defined(i386) || defined (__mips__)
228 /* add other arches which benefit from this... */
229 typedef signed char smallint;
230 typedef unsigned char smalluint;
231 #else
232 /* for arches where byte accesses generate larger code: */
233 typedef int smallint;
234 typedef unsigned smalluint;
235 #endif
236
237
238 extern void chomp(char *s);
239 extern void trim(char *s);
240 extern char *skip_whitespace(const char *);
241 extern char *skip_non_whitespace(const char *);
242
243 extern const char *bb_mode_string(int mode);
244 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
245 extern int remove_file(const char *path, int flags);
246 extern int copy_file(const char *source, const char *dest, int flags);
247 extern int recursive_action(const char *fileName, int recurse,
248         int followLinks, int depthFirst,
249         int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
250         int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData, int depth),
251         void* userData, int depth);
252 extern int device_open(const char *device, int mode);
253 extern int get_console_fd(void);
254 extern char *find_block_device(char *path);
255 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
256 extern off_t bb_copyfd_eof(int fd1, int fd2);
257 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size);
258 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size);
259 /* "short" copy can be detected by return value < size */
260 /* this helper yells "short read!" if param is not -1 */
261 extern void complain_copyfd_and_die(off_t sz) ATTRIBUTE_NORETURN;
262 extern char bb_process_escape_sequence(const char **ptr);
263 extern char *bb_get_last_path_component(char *path);
264 extern int ndelay_on(int fd);
265 extern int ndelay_off(int fd);
266
267
268 extern DIR *xopendir(const char *path);
269 extern DIR *warn_opendir(const char *path);
270
271 char *xgetcwd(char *cwd);
272 char *xreadlink(const char *path);
273 char *xmalloc_realpath(const char *path);
274 extern void xstat(char *filename, struct stat *buf);
275 extern pid_t spawn(char **argv);
276 extern pid_t xspawn(char **argv);
277 extern int wait4pid(int pid);
278 extern void xsetgid(gid_t gid);
279 extern void xsetuid(uid_t uid);
280 extern void xdaemon(int nochdir, int noclose);
281 extern void xchdir(const char *path);
282 extern void xsetenv(const char *key, const char *value);
283 extern int xopen(const char *pathname, int flags);
284 extern int xopen3(const char *pathname, int flags, int mode);
285 extern off_t xlseek(int fd, off_t offset, int whence);
286 extern off_t fdlength(int fd);
287
288
289 extern int xsocket(int domain, int type, int protocol);
290 extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
291 extern void xlisten(int s, int backlog);
292 extern void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen);
293 extern int xconnect_tcp_v4(struct sockaddr_in *s_addr);
294 extern struct hostent *xgethostbyname(const char *name);
295 extern struct hostent *xgethostbyname2(const char *name, int af);
296 extern int setsockopt_reuseaddr(int fd);
297 extern int setsockopt_broadcast(int fd);
298
299 /* "new" (ipv4+ipv6) API */
300 typedef struct len_and_sockaddr {
301         int len;
302         union {
303                 struct sockaddr sa;
304                 struct sockaddr_in sin;
305 #if ENABLE_FEATURE_IPV6
306                 struct sockaddr_in6 sin6;
307 #endif
308         };
309 } len_and_sockaddr;
310 /* Create stream socket, and allocated suitable lsa
311  * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6)) */
312 int xsocket_stream(len_and_sockaddr **lsap);
313 /* Create server TCP socket bound to bindaddr:port. bindaddr can be NULL,
314  * numeric IP ("N.N.N.N") or numeric IPv6 address,
315  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
316  * If there is no suffix, port argument is used */
317 extern int create_and_bind_stream_or_die(const char *bindaddr, int port);
318 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
319  * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
320  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
321  * If there is no suffix, port argument is used */
322 extern int create_and_connect_stream_or_die(const char *peer, int port);
323 /* Connect to peer identified by lsa */
324 extern int xconnect_stream(const len_and_sockaddr *lsa);
325 /* Return malloc'ed len_and_sockaddr with socket address of host:port
326  * Currently will return IPv4 or IPv6 sockaddrs only
327  * (depending on host), but in theory nothing prevents e.g.
328  * UNIX socket address being returned, IPX sockaddr etc... */
329 extern len_and_sockaddr* host2sockaddr(const char *host, int port);
330 /* Assign sin[6]_port member if the socket is of corresponding type,
331  * otherwise noop. Useful for ftp.
332  * NB: does NOT do htons() internally, just direct assignment. */
333 extern void set_nport(len_and_sockaddr *lsa, unsigned port);
334 /* Retrieve sin[6]_port or return -1 for non-inet lsa's */
335 extern int get_nport(len_and_sockaddr *lsa);
336 extern char* xmalloc_sockaddr2host(const struct sockaddr *sa, socklen_t salen);
337 extern char* xmalloc_sockaddr2dotted(const struct sockaddr *sa, socklen_t salen);
338
339
340 extern char *xstrdup(const char *s);
341 extern char *xstrndup(const char *s, int n);
342 extern char *safe_strncpy(char *dst, const char *src, size_t size);
343 extern char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
344 // gcc-4.1.1 still isn't good enough at optimizing it
345 // (+200 bytes compared to macro)
346 //static ATTRIBUTE_ALWAYS_INLINE
347 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
348 //static ATTRIBUTE_ALWAYS_INLINE
349 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
350 #define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
351 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
352 #define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
353 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
354
355 /* dmalloc will redefine these to it's own implementation. It is safe
356  * to have the prototypes here unconditionally.  */
357 extern void *xmalloc(size_t size);
358 extern void *xrealloc(void *old, size_t size);
359 extern void *xzalloc(size_t size);
360
361 extern ssize_t safe_read(int fd, void *buf, size_t count);
362 extern ssize_t full_read(int fd, void *buf, size_t count);
363 extern void xread(int fd, void *buf, size_t count);
364 extern unsigned char xread_char(int fd);
365 extern char *reads(int fd, char *buf, size_t count);
366 extern ssize_t read_close(int fd, void *buf, size_t count);
367 extern ssize_t open_read_close(const char *filename, void *buf, size_t count);
368 extern void *xmalloc_open_read_close(const char *filename, size_t *sizep);
369
370 extern ssize_t safe_write(int fd, const void *buf, size_t count);
371 extern ssize_t full_write(int fd, const void *buf, size_t count);
372 extern void xwrite(int fd, const void *buf, size_t count);
373
374 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
375 extern void xprint_and_close_file(FILE *file);
376 extern char *xmalloc_fgets(FILE *file);
377 /* Read up to (and including) TERMINATING_STRING: */
378 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string);
379 /* Chops off '\n' from the end, unlike fgets: */
380 extern char *xmalloc_getline(FILE *file);
381 extern char *bb_get_chunk_from_file(FILE *file, int *end);
382 extern void die_if_ferror(FILE *file, const char *msg);
383 extern void die_if_ferror_stdout(void);
384 extern void xfflush_stdout(void);
385 extern void fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
386 extern int fclose_if_not_stdin(FILE *file);
387 extern FILE *xfopen(const char *filename, const char *mode);
388 /* Prints warning to stderr and returns NULL on failure: */
389 extern FILE *fopen_or_warn(const char *filename, const char *mode);
390 /* "Opens" stdin if filename is special, else just opens file: */
391 extern FILE *fopen_or_warn_stdin(const char *filename);
392
393
394 extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
395 extern char *utoa(unsigned n);
396 extern void itoa_to_buf(int n, char *buf, unsigned buflen);
397 extern char *itoa(int n);
398 extern void smart_ulltoa5(unsigned long long ul, char buf[5]);
399 /* Put a string of hex bytes (ala "1b"), return advanced pointer */
400 extern char *bin2hex(char *buf, const char *cp, int count);
401
402 struct suffix_mult {
403         const char *suffix;
404         unsigned mult;
405 };
406 #include "xatonum.h"
407 /* Specialized: */
408 /* Using xatoi() instead of naive atoi() is not always convenient -
409  * in many places people want *non-negative* values, but store them
410  * in signed int. Therefore we need this one:
411  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
412 int xatoi_u(const char *numstr);
413 /* Useful for reading port numbers */
414 uint16_t xatou16(const char *numstr);
415
416
417 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
418  * for BusyBox since we want to avoid using the glibc NSS stuff, which
419  * increases target size and is often not needed on embedded systems.  */
420 extern long xuname2uid(const char *name);
421 extern long xgroup2gid(const char *name);
422 /* wrapper: allows string to contain numeric uid or gid */
423 extern unsigned long get_ug_id(const char *s, long (*xname2id)(const char *));
424 /* from chpst. Does not die, returns 0 on failure */
425 struct bb_uidgid_t {
426         uid_t uid;
427         gid_t gid;
428 };
429 extern int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok);
430 /* what is this? */
431 /*extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);*/
432 extern char *bb_getpwuid(char *name, long uid, int bufsize);
433 extern char *bb_getgrgid(char *group, long gid, int bufsize);
434
435
436 enum { BB_GETOPT_ERROR = 0x80000000 };
437 extern const char *opt_complementary;
438 #if ENABLE_GETOPT_LONG
439 extern const struct option *applet_long_options;
440 #endif
441 extern uint32_t option_mask32;
442 extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
443
444
445 typedef struct llist_s {
446         char *data;
447         struct llist_s *link;
448 } llist_t;
449 extern void llist_add_to(llist_t **old_head, void *data);
450 extern void llist_add_to_end(llist_t **list_head, void *data);
451 extern void *llist_pop(llist_t **elm);
452 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
453 extern llist_t* rev_llist(llist_t *list);
454
455 enum {
456         LOGMODE_NONE = 0,
457         LOGMODE_STDIO = 1<<0,
458         LOGMODE_SYSLOG = 1<<1,
459         LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
460 };
461 extern const char *msg_eol;
462 extern int logmode;
463 extern int die_sleep;
464 extern int xfunc_error_retval;
465 extern void sleep_and_die(void) ATTRIBUTE_NORETURN;
466 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
467 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
468 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
469 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
470 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
471 extern void bb_vherror_msg(const char *s, va_list p);
472 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
473 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
474 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
475 extern void bb_perror_nomsg(void);
476 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
477 /* These are used internally -- you shouldn't need to use them */
478 extern void bb_verror_msg(const char *s, va_list p, const char *strerr);
479 extern void bb_vperror_msg(const char *s, va_list p);
480 extern void bb_vinfo_msg(const char *s, va_list p);
481
482
483 /* applets which are useful from another applets */
484 extern int bb_cat(char** argv);
485 extern int bb_echo(char** argv);
486 extern int bb_test(int argc, char** argv);
487
488
489 /* Networking */
490 int create_icmp_socket(void);
491 int create_icmp6_socket(void);
492 /* interface.c */
493 struct aftype;
494 struct hwtype;
495 extern int interface_opt_a;
496 int display_interfaces(char *ifname);
497 struct aftype *get_aftype(const char *name);
498 const struct hwtype *get_hwtype(const char *name);
499 const struct hwtype *get_hwntype(int type);
500
501
502 #ifndef BUILD_INDIVIDUAL
503 extern struct BB_applet *find_applet_by_name(const char *name);
504 extern void run_applet_by_name(const char *name, int argc, char **argv);
505 #endif
506
507 extern struct mntent *find_mount_point(const char *name, const char *table);
508 extern void erase_mtab(const char * name);
509 extern unsigned int tty_baud_to_value(speed_t speed);
510 extern speed_t tty_value_to_baud(unsigned int value);
511 extern void bb_warn_ignoring_args(int n);
512
513 extern int get_linux_version_code(void);
514
515 extern char *query_loop(const char *device);
516 extern int del_loop(const char *device);
517 extern int set_loop(char **device, const char *file, unsigned long long offset);
518
519
520 const char *make_human_readable_str(unsigned long long size,
521                 unsigned long block_size, unsigned long display_unit);
522
523 char *bb_askpass(int timeout, const char * prompt);
524 int bb_ask_confirmation(void);
525 int klogctl(int type, char * b, int len);
526
527 extern int bb_parse_mode(const char* s, mode_t* theMode);
528
529 char *concat_path_file(const char *path, const char *filename);
530 char *concat_subpath_file(const char *path, const char *filename);
531 char *last_char_is(const char *s, int c);
532
533 int execable_file(const char *name);
534 char *find_execable(const char *filename);
535 int exists_execable(const char *filename);
536
537 USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
538 int inflate(int in, int out);
539
540
541 /* NB: returns port in host byte order */
542 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port);
543 void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
544
545 int bb_make_directory(char *path, long mode, int flags);
546
547 int get_signum(const char *name);
548 const char *get_signame(int number);
549
550 char *bb_simplify_path(const char *path);
551
552 #define FAIL_DELAY 3
553 extern void bb_do_delay(int seconds);
554 extern void change_identity(const struct passwd *pw);
555 extern const char *change_identity_e2str(const struct passwd *pw);
556 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
557 #if ENABLE_SELINUX
558 extern void renew_current_security_context(void);
559 extern void set_current_security_context(security_context_t sid);
560 #endif
561 extern int restricted_shell(const char *shell);
562 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
563 extern int correct_password(const struct passwd *pw);
564 extern char *pw_encrypt(const char *clear, const char *salt);
565 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
566 extern int index_in_str_array(const char * const string_array[], const char *key);
567 extern int index_in_substr_array(const char * const string_array[], const char *key);
568 extern void print_login_issue(const char *issue_file, const char *tty);
569 extern void print_login_prompt(void);
570 #ifdef BB_NOMMU
571 extern void vfork_daemon(int nochdir, int noclose);
572 extern void vfork_daemon_rexec(int nochdir, int noclose,
573                 int argc, char **argv, char *foreground_opt);
574 #endif
575 extern int get_terminal_width_height(int fd, int *width, int *height);
576
577 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
578 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
579 void reset_ino_dev_hashtable(void);
580 #ifdef __GLIBC__
581 /* At least glibc has horrendously large inline for this, so wrap it */
582 extern unsigned long long bb_makedev(unsigned int major, unsigned int minor);
583 #undef makedev
584 #define makedev(a,b) bb_makedev(a,b)
585 #endif
586
587
588 #ifndef COMM_LEN
589 #ifdef TASK_COMM_LEN
590 enum { COMM_LEN = TASK_COMM_LEN };
591 #else
592 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
593 enum { COMM_LEN = 16 };
594 #endif
595 #endif
596 typedef struct {
597         DIR *dir;
598 /* Fields are set to 0/NULL if failed to determine (or not requested) */
599         char *cmd;
600         unsigned long rss;
601         unsigned long stime, utime;
602         unsigned pid;
603         unsigned ppid;
604         unsigned pgid;
605         unsigned sid;
606         unsigned uid;
607         unsigned gid;
608         /* basename of executable file in call to exec(2), size from */
609         /* sizeof(task_struct.comm) in /usr/include/linux/sched.h */
610         char state[4];
611         char comm[COMM_LEN];
612 //      user/group? - use passwd/group parsing functions
613 } procps_status_t;
614 enum {
615         PSSCAN_PID      = 1 << 0,
616         PSSCAN_PPID     = 1 << 1,
617         PSSCAN_PGID     = 1 << 2,
618         PSSCAN_SID      = 1 << 3,
619         PSSCAN_UIDGID   = 1 << 4,
620         PSSCAN_COMM     = 1 << 5,
621         PSSCAN_CMD      = 1 << 6,
622         PSSCAN_STATE    = 1 << 7,
623         PSSCAN_RSS      = 1 << 8,
624         PSSCAN_STIME    = 1 << 9,
625         PSSCAN_UTIME    = 1 << 10,
626         /* These are all retrieved from proc/NN/stat in one go: */
627         PSSCAN_STAT     = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
628                         | PSSCAN_COMM | PSSCAN_STATE
629                         | PSSCAN_RSS | PSSCAN_STIME | PSSCAN_UTIME,
630 };
631 procps_status_t* alloc_procps_scan(int flags);
632 void free_procps_scan(procps_status_t* sp);
633 procps_status_t* procps_scan(procps_status_t* sp, int flags);
634 pid_t *find_pid_by_name(const char* procName);
635 pid_t *pidlist_reverse(pid_t *pidList);
636 void clear_username_cache(void);
637 const char* get_cached_username(uid_t uid);
638 const char* get_cached_groupname(gid_t gid);
639
640
641 extern const char bb_uuenc_tbl_base64[];
642 extern const char bb_uuenc_tbl_std[];
643 void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
644
645 typedef struct sha1_ctx_t {
646         uint32_t count[2];
647         uint32_t hash[5];
648         uint32_t wbuf[16];
649 } sha1_ctx_t;
650 void sha1_begin(sha1_ctx_t *ctx);
651 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
652 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
653
654 typedef struct md5_ctx_t {
655         uint32_t A;
656         uint32_t B;
657         uint32_t C;
658         uint32_t D;
659         uint64_t total;
660         uint32_t buflen;
661         char buffer[128];
662 } md5_ctx_t;
663 void md5_begin(md5_ctx_t *ctx);
664 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
665 void *md5_end(void *resbuf, md5_ctx_t *ctx);
666
667 uint32_t *crc32_filltable(int endian);
668
669
670 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
671         FILEUTILS_PRESERVE_STATUS = 1,
672         FILEUTILS_DEREFERENCE = 2,
673         FILEUTILS_RECUR = 4,
674         FILEUTILS_FORCE = 8,
675         FILEUTILS_INTERACTIVE = 0x10,
676         FILEUTILS_MAKE_HARDLINK = 0x20,
677         FILEUTILS_MAKE_SOFTLINK = 0x40,
678 };
679 #define FILEUTILS_CP_OPTSTR "pdRfils"
680
681 extern const char *applet_name;
682 extern const char BB_BANNER[];
683
684 extern const char bb_msg_full_version[];
685 extern const char bb_msg_memory_exhausted[];
686 extern const char bb_msg_invalid_date[];
687 extern const char bb_msg_read_error[];
688 extern const char bb_msg_write_error[];
689 extern const char bb_msg_unknown[];
690 extern const char bb_msg_can_not_create_raw_socket[];
691 extern const char bb_msg_perm_denied_are_you_root[];
692 extern const char bb_msg_requires_arg[];
693 extern const char bb_msg_invalid_arg[];
694 extern const char bb_msg_standard_input[];
695 extern const char bb_msg_standard_output[];
696
697 extern const char bb_str_default[];
698 /* NB: (bb_hexdigits_upcase[i] | 0x10) -> lowercase hex digit */
699 extern const char bb_hexdigits_upcase[];
700
701 extern const char bb_path_mtab_file[];
702 extern const char bb_path_nologin_file[];
703 extern const char bb_path_passwd_file[];
704 extern const char bb_path_shadow_file[];
705 extern const char bb_path_gshadow_file[];
706 extern const char bb_path_group_file[];
707 extern const char bb_path_securetty_file[];
708 extern const char bb_path_motd_file[];
709 extern const char bb_path_wtmp_file[];
710 extern const char bb_dev_null[];
711
712 #ifndef BUFSIZ
713 #define BUFSIZ 4096
714 #endif
715 extern char bb_common_bufsiz1[BUFSIZ+1];
716
717 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
718  * use bb_default_login_shell and following defines.
719  * If you change LIBBB_DEFAULT_LOGIN_SHELL,
720  * don't forget to change increment constant. */
721 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
722 extern const char bb_default_login_shell[];
723 /* "/bin/sh" */
724 #define DEFAULT_SHELL     (bb_default_login_shell+1)
725 /* "sh" */
726 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
727
728
729 #if ENABLE_FEATURE_DEVFS
730 # define CURRENT_VC "/dev/vc/0"
731 # define VC_1 "/dev/vc/1"
732 # define VC_2 "/dev/vc/2"
733 # define VC_3 "/dev/vc/3"
734 # define VC_4 "/dev/vc/4"
735 # define VC_5 "/dev/vc/5"
736 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
737 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
738    respective serial ports .. as such, we can't use the common device paths for
739    these. -- PFM */
740 #  define SC_0 "/dev/ttsc/0"
741 #  define SC_1 "/dev/ttsc/1"
742 #  define SC_FORMAT "/dev/ttsc/%d"
743 #else
744 #  define SC_0 "/dev/tts/0"
745 #  define SC_1 "/dev/tts/1"
746 #  define SC_FORMAT "/dev/tts/%d"
747 #endif
748 # define VC_FORMAT "/dev/vc/%d"
749 # define LOOP_FORMAT "/dev/loop/%d"
750 # define LOOP_NAME "/dev/loop/"
751 # define FB_0 "/dev/fb/0"
752 #else
753 # define CURRENT_VC "/dev/tty0"
754 # define VC_1 "/dev/tty1"
755 # define VC_2 "/dev/tty2"
756 # define VC_3 "/dev/tty3"
757 # define VC_4 "/dev/tty4"
758 # define VC_5 "/dev/tty5"
759 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
760 #  define SC_0 "/dev/ttySC0"
761 #  define SC_1 "/dev/ttySC1"
762 #  define SC_FORMAT "/dev/ttySC%d"
763 #else
764 #  define SC_0 "/dev/ttyS0"
765 #  define SC_1 "/dev/ttyS1"
766 #  define SC_FORMAT "/dev/ttyS%d"
767 #endif
768 # define VC_FORMAT "/dev/tty%d"
769 # define LOOP_FORMAT "/dev/loop%d"
770 # define LOOP_NAME "/dev/loop"
771 # define FB_0 "/dev/fb0"
772 #endif
773
774 /* The following devices are the same on devfs and non-devfs systems.  */
775 #define CURRENT_TTY "/dev/tty"
776 #define CONSOLE_DEV "/dev/console"
777
778
779 #ifndef RB_POWER_OFF
780 /* Stop system and switch power off if possible.  */
781 #define RB_POWER_OFF   0x4321fedc
782 #endif
783
784 /* Make sure we call functions instead of macros.  */
785 #undef isalnum
786 #undef isalpha
787 #undef isascii
788 #undef isblank
789 #undef iscntrl
790 #undef isgraph
791 #undef islower
792 #undef isprint
793 #undef ispunct
794 #undef isspace
795 #undef isupper
796 #undef isxdigit
797
798 /* This one is more efficient - we save ~400 bytes */
799 #undef isdigit
800 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
801
802
803 #ifdef DMALLOC
804 #include <dmalloc.h>
805 #endif
806
807 #endif /* __LIBBUSYBOX_H__ */