The udhcp was deleted from busybox in 14634. Bolting an external project to
[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 extern void bb_xchdir(const char *path);
153
154 #define BB_GETOPT_ERROR 0x80000000UL
155 extern const char *bb_opt_complementally;
156 extern const struct option *bb_applet_long_options;
157 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
158
159 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
160                                            va_list arg) __attribute__ ((format (printf, 2, 0)));
161 extern int bb_vprintf(const char * __restrict format, va_list arg)
162         __attribute__ ((format (printf, 1, 0)));
163 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
164         __attribute__ ((format (printf, 2, 3)));
165 extern int bb_printf(const char * __restrict format, ...)
166         __attribute__ ((format (printf, 1, 2)));
167
168 //#warning rename to xferror_filename?
169 extern void bb_xferror(FILE *fp, const char *fn);
170 extern void bb_xferror_stdout(void);
171 extern void bb_xfflush_stdout(void);
172
173 extern void bb_warn_ignoring_args(int n);
174
175 extern void chomp(char *s);
176 extern void trim(char *s);
177 extern const char *bb_skip_whitespace(const char *);
178
179 extern struct BB_applet *find_applet_by_name(const char *name);
180 void run_applet_by_name(const char *name, int argc, char **argv);
181
182 /* dmalloc will redefine these to it's own implementation. It is safe
183  * to have the prototypes here unconditionally.  */
184 extern void *xmalloc(size_t size);
185 extern void *xrealloc(void *old, size_t size);
186 extern void *xcalloc(size_t nmemb, size_t size);
187
188 extern char *bb_xstrdup (const char *s);
189 extern char *bb_xstrndup (const char *s, int n);
190 extern char *safe_strncpy(char *dst, const char *src, size_t size);
191 extern int safe_strtoi(char *arg, int* value);
192 extern int safe_strtod(char *arg, double* value);
193 extern int safe_strtol(char *arg, long* value);
194 extern int safe_strtoul(char *arg, unsigned long* value);
195
196 struct suffix_mult {
197         const char *suffix;
198         unsigned int mult;
199 };
200
201 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
202                                                                                   unsigned long lower,
203                                                                                   unsigned long upper,
204                                                                                   const struct suffix_mult *suffixes);
205 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
206                                                                           unsigned long lower,
207                                                                           unsigned long upper);
208 extern unsigned long bb_xgetularg10_bnd(const char *arg,
209                                                                                 unsigned long lower,
210                                                                                 unsigned long upper);
211 extern unsigned long bb_xgetularg10(const char *arg);
212
213 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
214                                                                 long lower,
215                                                                 long upper,
216                                                                 const struct suffix_mult *suffixes);
217 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
218
219
220 //#warning pitchable now?
221 extern unsigned long bb_xparse_number(const char *numstr,
222                 const struct suffix_mult *suffixes);
223
224
225 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
226  * for BusyBox since we want to avoid using the glibc NSS stuff, which
227  * increases target size and is often not needed on embedded systems.  */
228 extern long bb_xgetpwnam(const char *name);
229 extern long bb_xgetgrnam(const char *name);
230 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
231 extern char * bb_getpwuid(char *name, long uid, int bufsize);
232 extern char * bb_getgrgid(char *group, long gid, int bufsize);
233 extern char *bb_askpass(int timeout, const char * prompt);
234
235 extern int device_open(const char *device, int mode);
236
237 extern char *query_loop(const char *device);
238 extern int del_loop(const char *device);
239 extern int set_loop(char **device, const char *file, int offset);
240
241 #if (__GLIBC__ < 2)
242 extern int vdprintf(int d, const char *format, va_list ap);
243 #endif
244
245 int nfsmount(const char *spec, const char *node, int *flags,
246              char **mount_opts, int running_bg);
247
248 /* Include our own copy of struct sysinfo to avoid binary compatibility
249  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
250 struct sysinfo {
251         long uptime;                    /* Seconds since boot */
252         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
253         unsigned long totalram;         /* Total usable main memory size */
254         unsigned long freeram;          /* Available memory size */
255         unsigned long sharedram;        /* Amount of shared memory */
256         unsigned long bufferram;        /* Memory used by buffers */
257         unsigned long totalswap;        /* Total swap space size */
258         unsigned long freeswap;         /* swap space still available */
259         unsigned short procs;           /* Number of current processes */
260         unsigned short pad;                     /* Padding needed for m68k */
261         unsigned long totalhigh;        /* Total high memory size */
262         unsigned long freehigh;         /* Available high memory size */
263         unsigned int mem_unit;          /* Memory unit size in bytes */
264         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
265 };
266 extern int sysinfo (struct sysinfo* info);
267
268 enum {
269         KILOBYTE = 1024,
270         MEGABYTE = (KILOBYTE*1024),
271         GIGABYTE = (MEGABYTE*1024)
272 };
273 const char *make_human_readable_str(unsigned long long size,
274                 unsigned long block_size, unsigned long display_unit);
275
276 int bb_ask_confirmation(void);
277 int klogctl(int type, char * b, int len);
278
279 char *xgetcwd(char *cwd);
280 char *xreadlink(const char *path);
281 char *concat_path_file(const char *path, const char *filename);
282 char *concat_subpath_file(const char *path, const char *filename);
283 char *last_char_is(const char *s, int c);
284
285 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
286 //#warning yuk!
287 char *fgets_str(FILE *file, const char *terminating_string);
288
289 extern int uncompress(int fd_in, int fd_out);
290 extern int inflate(int in, int out);
291
292 extern struct hostent *xgethostbyname(const char *name);
293 extern struct hostent *xgethostbyname2(const char *name, int af);
294 extern int create_icmp_socket(void);
295 extern int create_icmp6_socket(void);
296 extern int xconnect(struct sockaddr_in *s_addr);
297 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
298 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
299
300 //#warning wrap this?
301 char *dirname (char *path);
302
303 int bb_make_directory (char *path, long mode, int flags);
304
305 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
306 char *bb_simplify_path(const char *path);
307
308 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
309         FILEUTILS_PRESERVE_STATUS = 1,
310         FILEUTILS_DEREFERENCE = 2,
311         FILEUTILS_RECUR = 4,
312         FILEUTILS_FORCE = 8,
313         FILEUTILS_INTERACTIVE = 16
314 };
315
316 extern const char *bb_applet_name;
317
318 extern const char * const bb_msg_full_version;
319 extern const char * const bb_msg_memory_exhausted;
320 extern const char * const bb_msg_invalid_date;
321 extern const char * const bb_msg_io_error;
322 extern const char * const bb_msg_read_error;
323 extern const char * const bb_msg_write_error;
324 extern const char * const bb_msg_name_longer_than_foo;
325 extern const char * const bb_msg_unknown;
326 extern const char * const bb_msg_can_not_create_raw_socket;
327 extern const char * const bb_msg_perm_denied_are_you_root;
328 extern const char * const bb_msg_standard_input;
329 extern const char * const bb_msg_standard_output;
330
331 extern const char * const bb_path_nologin_file;
332 extern const char * const bb_path_passwd_file;
333 extern const char * const bb_path_shadow_file;
334 extern const char * const bb_path_gshadow_file;
335 extern const char * const bb_path_group_file;
336 extern const char * const bb_path_securetty_file;
337 extern const char * const bb_path_motd_file;
338 extern const char * const bb_dev_null;
339
340 #ifndef BUFSIZ
341 #define BUFSIZ 4096
342 #endif
343 extern char bb_common_bufsiz1[BUFSIZ+1];
344
345 /*
346  * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
347  * use bb_default_login_shell and next defines,
348  * if you LIBBB_DEFAULT_LOGIN_SHELL change,
349  * don`t lose change increment constant!
350  */
351 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
352
353 extern const char * const bb_default_login_shell;
354 /* "/bin/sh" */
355 #define DEFAULT_SHELL     (bb_default_login_shell+1)
356 /* "sh" */
357 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
358
359
360 extern const char bb_path_mtab_file[];
361
362 extern int bb_default_error_retval;
363
364 #ifdef CONFIG_FEATURE_DEVFS
365 # define CURRENT_VC "/dev/vc/0"
366 # define VC_1 "/dev/vc/1"
367 # define VC_2 "/dev/vc/2"
368 # define VC_3 "/dev/vc/3"
369 # define VC_4 "/dev/vc/4"
370 # define VC_5 "/dev/vc/5"
371 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
372 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
373    respective serial ports .. as such, we can't use the common device paths for
374    these. -- PFM */
375 #  define SC_0 "/dev/ttsc/0"
376 #  define SC_1 "/dev/ttsc/1"
377 #  define SC_FORMAT "/dev/ttsc/%d"
378 #else
379 #  define SC_0 "/dev/tts/0"
380 #  define SC_1 "/dev/tts/1"
381 #  define SC_FORMAT "/dev/tts/%d"
382 #endif
383 # define VC_FORMAT "/dev/vc/%d"
384 # define LOOP_FORMAT "/dev/loop/%d"
385 # define FB_0 "/dev/fb/0"
386 #else
387 # define CURRENT_VC "/dev/tty0"
388 # define VC_1 "/dev/tty1"
389 # define VC_2 "/dev/tty2"
390 # define VC_3 "/dev/tty3"
391 # define VC_4 "/dev/tty4"
392 # define VC_5 "/dev/tty5"
393 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
394 #  define SC_0 "/dev/ttySC0"
395 #  define SC_1 "/dev/ttySC1"
396 #  define SC_FORMAT "/dev/ttySC%d"
397 #else
398 #  define SC_0 "/dev/ttyS0"
399 #  define SC_1 "/dev/ttyS1"
400 #  define SC_FORMAT "/dev/ttyS%d"
401 #endif
402 # define VC_FORMAT "/dev/tty%d"
403 # define LOOP_FORMAT "/dev/loop%d"
404 # define FB_0 "/dev/fb0"
405 #endif
406
407 //#warning put these in .o files
408
409 /* The following devices are the same on devfs and non-devfs systems.  */
410 #define CURRENT_TTY "/dev/tty"
411 #define CONSOLE_DEV "/dev/console"
412
413 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
414 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
415 void reset_ino_dev_hashtable(void);
416
417 char *bb_xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
418
419 #define FAIL_DELAY    3
420 extern void bb_do_delay(int seconds);
421 extern void change_identity ( const struct passwd *pw );
422 extern const char *change_identity_e2str ( const struct passwd *pw );
423 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args);
424 #ifdef CONFIG_SELINUX
425 extern void renew_current_security_context(void);
426 extern void set_current_security_context(security_context_t sid);
427 #endif
428 extern int run_parts(char **args, const unsigned char test_mode, char **env);
429 extern int restricted_shell ( const char *shell );
430 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
431 extern int correct_password ( const struct passwd *pw );
432 extern char *pw_encrypt(const char *clear, const char *salt);
433 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
434 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
435
436 extern int bb_xopen(const char *pathname, int flags);
437 extern int bb_xopen3(const char *pathname, int flags, int mode);
438 extern ssize_t bb_xread(int fd, void *buf, size_t count);
439 extern void bb_xread_all(int fd, void *buf, size_t count);
440 extern unsigned char bb_xread_char(int fd);
441
442 #ifndef COMM_LEN
443 /*#include <sched.h> *//* Task command name length */
444 #ifdef TASK_COMM_LEN
445 #define COMM_LEN TASK_COMM_LEN
446 #else
447 #define COMM_LEN 16 /* synchronize with size of comm in struct task_struct
448                                                                   in /usr/include/linux/sched.h */
449 #endif
450 #endif
451 typedef struct {
452         int pid;
453         char user[9];
454         char state[4];
455         unsigned long rss;
456         int ppid;
457 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
458         unsigned pcpu;
459         unsigned pscpu;
460         unsigned long stime, utime;
461 #endif
462         char *cmd;
463
464         /* basename of executable file in call to exec(2),
465                 size from kernel headers */
466         char short_cmd[COMM_LEN];
467 } procps_status_t;
468
469 extern procps_status_t * procps_scan(int save_user_arg0);
470 extern int compare_string_array(const char * const string_array[], const char *key);
471
472 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
473
474 typedef struct llist_s {
475         char *data;
476         struct llist_s *link;
477 } llist_t;
478 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
479 extern llist_t *llist_add_to_end(llist_t *list_head, char *data);
480 extern llist_t *llist_free_one(llist_t *elm);
481 extern void llist_free(llist_t *elm);
482
483 extern void print_login_issue(const char *issue_file, const char *tty);
484 extern void print_login_prompt(void);
485
486 #if defined(__uClinux__)
487 extern void vfork_daemon_rexec(int nochdir, int noclose,
488                 int argc, char **argv, char *foreground_opt);
489 #endif
490
491 extern int get_terminal_width_height(int fd, int *width, int *height);
492 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
493
494 typedef struct _sha1_ctx_t_ {
495         uint32_t count[2];
496         uint32_t hash[5];
497         uint32_t wbuf[16];
498 } sha1_ctx_t;
499
500 void sha1_begin(sha1_ctx_t *ctx);
501 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
502 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
503
504 typedef struct _md5_ctx_t_ {
505         uint32_t A;
506         uint32_t B;
507         uint32_t C;
508         uint32_t D;
509         uint32_t total[2];
510         uint32_t buflen;
511         char buffer[128];
512 } md5_ctx_t;
513
514 void md5_begin(md5_ctx_t *ctx);
515 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
516 void *md5_end(void *resbuf, md5_ctx_t *ctx);
517
518 extern uint32_t *bb_crc32_filltable (int endian);
519
520 /* busybox.h will include dmalloc later for us, else include it here.  */
521 #if !defined _BB_INTERNAL_H_ && defined DMALLOC
522 #include <dmalloc.h>
523 #endif
524
525 #endif /* __LIBBUSYBOX_H__ */