- patch from Denis Vlasenko to add bb_xbind() and bb_xlisten()
[oweals/busybox.git] / include / libbb.h
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Busybox main internal header file
4  *
5  * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
6  *
7  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
8  * Permission has been granted to redistribute this code under the GPL.
9  *
10  */
11 #ifndef __LIBBUSYBOX_H__
12 #define __LIBBUSYBOX_H__    1
13
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <stdarg.h>
17 #include <sys/types.h>
18 #include <sys/stat.h>
19 #include <termios.h>
20 #include <dirent.h>
21 #include <stdint.h>
22
23 #include <netinet/in.h>
24 #include <netdb.h>
25
26 #include <features.h>
27
28 #include "platform.h"
29 #include "bb_config.h"
30 #ifdef CONFIG_SELINUX
31 #include <selinux/selinux.h>
32 #endif
33
34 #include "pwd_.h"
35 #include "grp_.h"
36 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
37 #include "shadow_.h"
38 #endif
39 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
40 # include "sha1.h"
41 #endif
42
43 /* Some useful definitions */
44 #define FALSE   ((int) 0)
45 #define TRUE    ((int) 1)
46 #define SKIP    ((int) 2)
47
48 /* for mtab.c */
49 #define MTAB_GETMOUNTPT '1'
50 #define MTAB_GETDEVICE  '2'
51
52 #define BUF_SIZE        8192
53 #define EXPAND_ALLOC    1024
54
55 /* Macros for min/max.  */
56 #ifndef MIN
57 #define MIN(a,b) (((a)<(b))?(a):(b))
58 #endif
59
60 #ifndef MAX
61 #define MAX(a,b) (((a)>(b))?(a):(b))
62 #endif
63
64 /* buffer allocation schemes */
65 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
66 #define RESERVE_CONFIG_BUFFER(buffer,len)           char buffer[len]
67 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
68 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
69 #else
70 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
71 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
72 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
73 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
74 #else
75 #define RESERVE_CONFIG_BUFFER(buffer,len)           char *buffer=xmalloc(len)
76 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
77 #define RELEASE_CONFIG_BUFFER(buffer)      free (buffer)
78 #endif
79 #endif
80
81
82 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
83 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
84 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
85 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
86 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
87 extern void bb_vherror_msg(const char *s, va_list p);
88 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
89 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
90
91 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
92 extern void bb_perror_nomsg(void);
93
94 /* These two are used internally -- you shouldn't need to use them */
95 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
96 extern void bb_vperror_msg(const char *s, va_list p)  __attribute__ ((format (printf, 1, 0)));
97
98 extern int bb_echo(int argc, char** argv);
99
100 extern const char *bb_mode_string(int mode);
101 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
102 extern DIR *bb_opendir(const char *path);
103 extern DIR *bb_xopendir(const char *path);
104
105 extern int remove_file(const char *path, int flags);
106 extern int copy_file(const char *source, const char *dest, int flags);
107 extern ssize_t safe_read(int fd, void *buf, size_t count);
108 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
109 extern ssize_t safe_write(int fd, const void *buf, size_t count);
110 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
111 extern int recursive_action(const char *fileName, int recurse,
112           int followLinks, int depthFirst,
113           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
114           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
115           void* userData);
116
117 extern int bb_parse_mode( const char* s, mode_t* theMode);
118 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
119
120 extern unsigned long bb_baud_to_value(speed_t speed);
121 extern speed_t bb_value_to_baud(unsigned long value);
122
123 extern int get_kernel_revision(void);
124
125 extern int get_console_fd(void);
126 extern struct mntent *find_mount_point(const char *name, const char *table);
127 extern void erase_mtab(const char * name);
128 extern long *find_pid_by_name( const char* pidName);
129 extern long *pidlist_reverse(long *pidList);
130 extern char *find_block_device(char *path);
131 extern char *bb_get_line_from_file(FILE *file);
132 extern char *bb_get_chomped_line_from_file(FILE *file);
133 extern char *bb_get_chunk_from_file(FILE *file, int *end);
134 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
135 extern int bb_copyfd_eof(int fd1, int fd2);
136 extern void  bb_xprint_and_close_file(FILE *file);
137 extern int   bb_xprint_file_by_name(const char *filename);
138 extern char  bb_process_escape_sequence(const char **ptr);
139 extern char *bb_get_last_path_component(char *path);
140 extern FILE *bb_wfopen(const char *path, const char *mode);
141 extern FILE *bb_wfopen_input(const char *filename);
142 extern FILE *bb_xfopen(const char *path, const char *mode);
143
144 extern int   bb_fclose_nonstdin(FILE *f);
145 extern void  bb_fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
146
147 extern void xstat(const char *filename, struct stat *buf);
148 extern int  bb_xsocket(int domain, int type, int protocol);
149 extern void bb_xdaemon(int nochdir, int noclose);
150 extern void bb_xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
151 extern void bb_xlisten(int s, int backlog);
152
153 #define BB_GETOPT_ERROR 0x80000000UL
154 extern const char *bb_opt_complementally;
155 extern const struct option *bb_applet_long_options;
156 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
157
158 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
159                                            va_list arg) __attribute__ ((format (printf, 2, 0)));
160 extern int bb_vprintf(const char * __restrict format, va_list arg)
161         __attribute__ ((format (printf, 1, 0)));
162 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
163         __attribute__ ((format (printf, 2, 3)));
164 extern int bb_printf(const char * __restrict format, ...)
165         __attribute__ ((format (printf, 1, 2)));
166
167 //#warning rename to xferror_filename?
168 extern void bb_xferror(FILE *fp, const char *fn);
169 extern void bb_xferror_stdout(void);
170 extern void bb_xfflush_stdout(void);
171
172 extern void bb_warn_ignoring_args(int n);
173
174 extern void chomp(char *s);
175 extern void trim(char *s);
176 extern const char *bb_skip_whitespace(const char *);
177
178 extern struct BB_applet *find_applet_by_name(const char *name);
179 void run_applet_by_name(const char *name, int argc, char **argv);
180
181 /* dmalloc will redefine these to it's own implementation. It is safe
182  * to have the prototypes here unconditionally.  */
183 extern void *xmalloc(size_t size);
184 extern void *xrealloc(void *old, size_t size);
185 extern void *xcalloc(size_t nmemb, size_t size);
186
187 extern char *bb_xstrdup (const char *s);
188 extern char *bb_xstrndup (const char *s, int n);
189 extern char *safe_strncpy(char *dst, const char *src, size_t size);
190 extern int safe_strtoi(char *arg, int* value);
191 extern int safe_strtod(char *arg, double* value);
192 extern int safe_strtol(char *arg, long* value);
193 extern int safe_strtoul(char *arg, unsigned long* value);
194
195 struct suffix_mult {
196         const char *suffix;
197         unsigned int mult;
198 };
199
200 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
201                                                                                   unsigned long lower,
202                                                                                   unsigned long upper,
203                                                                                   const struct suffix_mult *suffixes);
204 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
205                                                                           unsigned long lower,
206                                                                           unsigned long upper);
207 extern unsigned long bb_xgetularg10_bnd(const char *arg,
208                                                                                 unsigned long lower,
209                                                                                 unsigned long upper);
210 extern unsigned long bb_xgetularg10(const char *arg);
211
212 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
213                                                                 long lower,
214                                                                 long upper,
215                                                                 const struct suffix_mult *suffixes);
216 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
217
218
219 //#warning pitchable now?
220 extern unsigned long bb_xparse_number(const char *numstr,
221                 const struct suffix_mult *suffixes);
222
223
224 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
225  * for BusyBox since we want to avoid using the glibc NSS stuff, which
226  * increases target size and is often not needed on embedded systems.  */
227 extern long bb_xgetpwnam(const char *name);
228 extern long bb_xgetgrnam(const char *name);
229 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
230 extern char * bb_getpwuid(char *name, long uid, int bufsize);
231 extern char * bb_getgrgid(char *group, long gid, int bufsize);
232 extern char *bb_askpass(int timeout, const char * prompt);
233
234 extern int device_open(const char *device, int mode);
235
236 extern char *query_loop(const char *device);
237 extern int del_loop(const char *device);
238 extern int set_loop(char **device, const char *file, int offset);
239
240 #if (__GLIBC__ < 2)
241 extern int vdprintf(int d, const char *format, va_list ap);
242 #endif
243
244 int nfsmount(const char *spec, const char *node, int *flags,
245              char **mount_opts, int running_bg);
246
247 /* Include our own copy of struct sysinfo to avoid binary compatibility
248  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
249 struct sysinfo {
250         long uptime;                    /* Seconds since boot */
251         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
252         unsigned long totalram;         /* Total usable main memory size */
253         unsigned long freeram;          /* Available memory size */
254         unsigned long sharedram;        /* Amount of shared memory */
255         unsigned long bufferram;        /* Memory used by buffers */
256         unsigned long totalswap;        /* Total swap space size */
257         unsigned long freeswap;         /* swap space still available */
258         unsigned short procs;           /* Number of current processes */
259         unsigned short pad;                     /* Padding needed for m68k */
260         unsigned long totalhigh;        /* Total high memory size */
261         unsigned long freehigh;         /* Available high memory size */
262         unsigned int mem_unit;          /* Memory unit size in bytes */
263         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
264 };
265 extern int sysinfo (struct sysinfo* info);
266
267 enum {
268         KILOBYTE = 1024,
269         MEGABYTE = (KILOBYTE*1024),
270         GIGABYTE = (MEGABYTE*1024)
271 };
272 const char *make_human_readable_str(unsigned long long size,
273                 unsigned long block_size, unsigned long display_unit);
274
275 int bb_ask_confirmation(void);
276 int klogctl(int type, char * b, int len);
277
278 char *xgetcwd(char *cwd);
279 char *xreadlink(const char *path);
280 char *concat_path_file(const char *path, const char *filename);
281 char *concat_subpath_file(const char *path, const char *filename);
282 char *last_char_is(const char *s, int c);
283
284 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
285 //#warning yuk!
286 char *fgets_str(FILE *file, const char *terminating_string);
287
288 extern int uncompress(int fd_in, int fd_out);
289 extern int inflate(int in, int out);
290
291 extern struct hostent *xgethostbyname(const char *name);
292 extern struct hostent *xgethostbyname2(const char *name, int af);
293 extern int create_icmp_socket(void);
294 extern int create_icmp6_socket(void);
295 extern int xconnect(struct sockaddr_in *s_addr);
296 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
297 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
298
299 //#warning wrap this?
300 char *dirname (char *path);
301
302 int bb_make_directory (char *path, long mode, int flags);
303
304 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
305 char *bb_simplify_path(const char *path);
306
307 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
308         FILEUTILS_PRESERVE_STATUS = 1,
309         FILEUTILS_DEREFERENCE = 2,
310         FILEUTILS_RECUR = 4,
311         FILEUTILS_FORCE = 8,
312         FILEUTILS_INTERACTIVE = 16
313 };
314
315 extern const char *bb_applet_name;
316
317 extern const char * const bb_msg_full_version;
318 extern const char * const bb_msg_memory_exhausted;
319 extern const char * const bb_msg_invalid_date;
320 extern const char * const bb_msg_io_error;
321 extern const char * const bb_msg_read_error;
322 extern const char * const bb_msg_write_error;
323 extern const char * const bb_msg_name_longer_than_foo;
324 extern const char * const bb_msg_unknown;
325 extern const char * const bb_msg_can_not_create_raw_socket;
326 extern const char * const bb_msg_perm_denied_are_you_root;
327 extern const char * const bb_msg_standard_input;
328 extern const char * const bb_msg_standard_output;
329
330 extern const char * const bb_path_nologin_file;
331 extern const char * const bb_path_passwd_file;
332 extern const char * const bb_path_shadow_file;
333 extern const char * const bb_path_gshadow_file;
334 extern const char * const bb_path_group_file;
335 extern const char * const bb_path_securetty_file;
336 extern const char * const bb_path_motd_file;
337 extern const char * const bb_dev_null;
338
339 #ifndef BUFSIZ
340 #define BUFSIZ 4096
341 #endif
342 extern char bb_common_bufsiz1[BUFSIZ+1];
343
344 /*
345  * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
346  * use bb_default_login_shell and next defines,
347  * if you LIBBB_DEFAULT_LOGIN_SHELL change,
348  * don`t lose change increment constant!
349  */
350 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
351
352 extern const char * const bb_default_login_shell;
353 /* "/bin/sh" */
354 #define DEFAULT_SHELL     (bb_default_login_shell+1)
355 /* "sh" */
356 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
357
358
359 extern const char bb_path_mtab_file[];
360
361 extern int bb_default_error_retval;
362
363 #ifdef CONFIG_FEATURE_DEVFS
364 # define CURRENT_VC "/dev/vc/0"
365 # define VC_1 "/dev/vc/1"
366 # define VC_2 "/dev/vc/2"
367 # define VC_3 "/dev/vc/3"
368 # define VC_4 "/dev/vc/4"
369 # define VC_5 "/dev/vc/5"
370 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
371 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
372    respective serial ports .. as such, we can't use the common device paths for
373    these. -- PFM */
374 #  define SC_0 "/dev/ttsc/0"
375 #  define SC_1 "/dev/ttsc/1"
376 #  define SC_FORMAT "/dev/ttsc/%d"
377 #else
378 #  define SC_0 "/dev/tts/0"
379 #  define SC_1 "/dev/tts/1"
380 #  define SC_FORMAT "/dev/tts/%d"
381 #endif
382 # define VC_FORMAT "/dev/vc/%d"
383 # define LOOP_FORMAT "/dev/loop/%d"
384 # define FB_0 "/dev/fb/0"
385 #else
386 # define CURRENT_VC "/dev/tty0"
387 # define VC_1 "/dev/tty1"
388 # define VC_2 "/dev/tty2"
389 # define VC_3 "/dev/tty3"
390 # define VC_4 "/dev/tty4"
391 # define VC_5 "/dev/tty5"
392 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
393 #  define SC_0 "/dev/ttySC0"
394 #  define SC_1 "/dev/ttySC1"
395 #  define SC_FORMAT "/dev/ttySC%d"
396 #else
397 #  define SC_0 "/dev/ttyS0"
398 #  define SC_1 "/dev/ttyS1"
399 #  define SC_FORMAT "/dev/ttyS%d"
400 #endif
401 # define VC_FORMAT "/dev/tty%d"
402 # define LOOP_FORMAT "/dev/loop%d"
403 # define FB_0 "/dev/fb0"
404 #endif
405
406 //#warning put these in .o files
407
408 /* The following devices are the same on devfs and non-devfs systems.  */
409 #define CURRENT_TTY "/dev/tty"
410 #define CONSOLE_DEV "/dev/console"
411
412 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
413 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
414 void reset_ino_dev_hashtable(void);
415
416 /* Stupid gcc always includes its own builtin strlen()... */
417 extern size_t bb_strlen(const char *string);
418 #ifndef BB_STRLEN_IMPLEMENTATION
419 #define strlen(x)   bb_strlen(x)
420 #endif
421
422 char *bb_xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
423
424 #define FAIL_DELAY    3
425 extern void bb_do_delay(int seconds);
426 extern void change_identity ( const struct passwd *pw );
427 extern const char *change_identity_e2str ( const struct passwd *pw );
428 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args);
429 #ifdef CONFIG_SELINUX
430 extern void renew_current_security_context(void);
431 extern void set_current_security_context(security_context_t sid);
432 #endif
433 extern int run_parts(char **args, const unsigned char test_mode, char **env);
434 extern int restricted_shell ( const char *shell );
435 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
436 extern int correct_password ( const struct passwd *pw );
437 extern char *pw_encrypt(const char *clear, const char *salt);
438 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
439 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
440
441 extern int bb_xopen(const char *pathname, int flags);
442 extern ssize_t bb_xread(int fd, void *buf, size_t count);
443 extern void bb_xread_all(int fd, void *buf, size_t count);
444 extern unsigned char bb_xread_char(int fd);
445
446 #ifndef COMM_LEN
447 /*#include <sched.h> *//* Task command name length */
448 #ifdef TASK_COMM_LEN
449 #define COMM_LEN TASK_COMM_LEN
450 #else
451 #define COMM_LEN 16 /* synchronize with size of comm in struct task_struct
452                                                                   in /usr/include/linux/sched.h */
453 #endif
454 #endif
455 typedef struct {
456         int pid;
457         char user[9];
458         char state[4];
459         unsigned long rss;
460         int ppid;
461 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
462         unsigned pcpu;
463         unsigned pscpu;
464         unsigned long stime, utime;
465 #endif
466         char *cmd;
467
468         /* basename of executable file in call to exec(2),
469                 size from kernel headers */
470         char short_cmd[COMM_LEN];
471 } procps_status_t;
472
473 extern procps_status_t * procps_scan(int save_user_arg0);
474 extern int compare_string_array(const char * const string_array[], const char *key);
475
476 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
477
478 typedef struct llist_s {
479         char *data;
480         struct llist_s *link;
481 } llist_t;
482 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
483 extern llist_t *llist_add_to_end(llist_t *list_head, char *data);
484 extern llist_t *llist_free_one(llist_t *elm);
485 extern void llist_free(llist_t *elm);
486
487 extern void print_login_issue(const char *issue_file, const char *tty);
488 extern void print_login_prompt(void);
489
490 #if defined(__uClinux__)
491 extern void vfork_daemon_rexec(int nochdir, int noclose,
492                 int argc, char **argv, char *foreground_opt);
493 #endif
494
495 extern int get_terminal_width_height(int fd, int *width, int *height);
496 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
497
498 typedef struct _sha1_ctx_t_ {
499         uint32_t count[2];
500         uint32_t hash[5];
501         uint32_t wbuf[16];
502 } sha1_ctx_t;
503
504 void sha1_begin(sha1_ctx_t *ctx);
505 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
506 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
507
508 typedef struct _md5_ctx_t_ {
509         uint32_t A;
510         uint32_t B;
511         uint32_t C;
512         uint32_t D;
513         uint32_t total[2];
514         uint32_t buflen;
515         char buffer[128];
516 } md5_ctx_t;
517
518 void md5_begin(md5_ctx_t *ctx);
519 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
520 void *md5_end(void *resbuf, md5_ctx_t *ctx);
521
522 extern uint32_t *bb_crc32_filltable (int endian);
523
524 /* busybox.h will include dmalloc later for us, else include it here.  */
525 #if !defined _BB_INTERNAL_H_ && defined DMALLOC
526 #include <dmalloc.h>
527 #endif
528
529 #endif /* __LIBBUSYBOX_H__ */