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