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