Gitiles
Code Review Sign In
gerrit.nordix.org / codeaurora / busybox / f6b713997102ee9371eb3615744f99b22d20e661 / . / include / busybox.h
blob: 69f45543576e0c28063ad9fdd671a333d3fd51fb [file] [log] [blame]
Eric Andersenf6b71392000-09-26 01:09:18 +0000[diff] [blame^]1/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
21 * Permission has been granted to redistribute this code under the GPL.
22 *
23 */
24#ifndef _BB_INTERNAL_H_
25#define _BB_INTERNAL_H_ 1
26
27#include "Config.h"
28
29#ifdef DMALLOC
30#include "dmalloc.h"
31#endif
32
33#include <stdlib.h>
34#include <stdarg.h>
35#include <string.h>
36#include <unistd.h>
37#include <errno.h>
38#include <sys/stat.h>
39#include <sys/param.h>
40#include <mntent.h>
41#include <regex.h>
42/* for the _syscall() macros */
43#include <sys/syscall.h>
44#include <linux/unistd.h>
45
46
47/* Some useful definitions */
48#define FALSE ((int) 1)
49#define TRUE ((int) 0)
50
51/* for mtab.c */
52#define MTAB_GETMOUNTPT '1'
53#define MTAB_GETDEVICE '2'
54
55#define BUF_SIZE 8192
56#define EXPAND_ALLOC 1024
57
58
59#define isBlank(ch) (((ch) == ' ') || ((ch) == '\t'))
60#define isDecimal(ch) (((ch) >= '0') && ((ch) <= '9'))
61#define isOctal(ch) (((ch) >= '0') && ((ch) <= '7'))
62#define isWildCard(ch) (((ch) == '*') || ((ch) == '?') || ((ch) == '['))
63
64/* Macros for min/max. */
65#ifndef MIN
66#define MIN(a,b) (((a)<(b))?(a):(b))
67#endif
68
69#ifndef MAX
70#define MAX(a,b) (((a)>(b))?(a):(b))
71#endif
72
73
74/* I don't like nested includes, but the string and io functions are used
75 * too often
76 */
77#include <stdio.h>
78#if !defined(NO_STRING_H) || defined(STDC_HEADERS)
79# include <string.h>
80# if !defined(STDC_HEADERS) && !defined(NO_MEMORY_H) && !defined(__GNUC__)
81# include <memory.h>
82# endif
83# define memzero(s, n) memset ((void *)(s), 0, (n))
84#else
85# include <strings.h>
86# define strchr index
87# define strrchr rindex
88# define memcpy(d, s, n) bcopy((s), (d), (n))
89# define memcmp(s1, s2, n) bcmp((s1), (s2), (n))
90# define memzero(s, n) bzero((s), (n))
91#endif
92
93
94enum Location {
95 _BB_DIR_ROOT = 0,
96 _BB_DIR_BIN,
97 _BB_DIR_SBIN,
98 _BB_DIR_USR_BIN,
99 _BB_DIR_USR_SBIN
100};
101
102struct BB_applet {
103 const char* name;
104 int (*main)(int argc, char** argv);
105 enum Location location;
106 const char* usage;
107};
108/* From busybox.c */
109extern const struct BB_applet applets[];
110
111extern int ar_main(int argc, char **argv);
112extern int basename_main(int argc, char **argv);
113extern int bogomips_main(int argc, char **argv);
114extern int busybox_main(int argc, char** argv);
115extern int cat_main(int argc, char** argv);
116extern int chmod_chown_chgrp_main(int argc, char** argv);
117extern int chroot_main(int argc, char** argv);
118extern int chvt_main(int argc, char** argv);
119extern int clear_main(int argc, char** argv);
120extern int cp_mv_main(int argc, char** argv);
121extern int cut_main(int argc, char** argv);
122extern int date_main(int argc, char** argv);
123extern int dc_main(int argc, char** argv);
124extern int dd_main(int argc, char** argv);
125extern int dirname_main(int argc, char** argv);
126extern int deallocvt_main(int argc, char** argv);
127extern int df_main(int argc, char** argv);
128extern int dmesg_main(int argc, char** argv);
129extern int dos2unix_main(int argc, char** argv);
130extern int du_main(int argc, char** argv);
131extern int dumpkmap_main(int argc, char** argv);
132extern int dutmp_main(int argc, char** argv);
133extern int echo_main(int argc, char** argv);
134extern int expr_main(int argc, char** argv);
135extern int false_main(int argc, char** argv);
136extern int fbset_main(int argc, char** argv);
137extern int fdisk_main(int argc, char** argv);
138extern int fdflush_main(int argc, char **argv);
139extern int fsck_minix_main(int argc, char **argv);
140extern int find_main(int argc, char** argv);
141extern int free_main(int argc, char** argv);
142extern int freeramdisk_main(int argc, char** argv);
143extern int getopt_main(int argc, char** argv);
144extern int grep_main(int argc, char** argv);
145extern int gunzip_main (int argc, char** argv);
146extern int gzip_main(int argc, char** argv);
147extern int halt_main(int argc, char** argv);
148extern int head_main(int argc, char** argv);
149extern int hostid_main(int argc, char** argv);
150extern int hostname_main(int argc, char** argv);
151extern int id_main(int argc, char** argv);
152extern int init_main(int argc, char** argv);
153extern int insmod_main(int argc, char** argv);
154extern int kill_main(int argc, char** argv);
155extern int length_main(int argc, char** argv);
156extern int ln_main(int argc, char** argv);
157extern int loadacm_main(int argc, char** argv);
158extern int loadfont_main(int argc, char** argv);
159extern int loadkmap_main(int argc, char** argv);
160extern int losetup_main(int argc, char** argv);
161extern int logger_main(int argc, char **argv);
162extern int logname_main(int argc, char **argv);
163extern int ls_main(int argc, char** argv);
164extern int lsmod_main(int argc, char** argv);
165extern int makedevs_main(int argc, char** argv);
166extern int md5sum_main(int argc, char** argv);
167extern int mkdir_main(int argc, char** argv);
168extern int mkfifo_main(int argc, char **argv);
169extern int mkfs_minix_main(int argc, char **argv);
170extern int mknod_main(int argc, char** argv);
171extern int mkswap_main(int argc, char** argv);
172extern int mktemp_main(int argc, char **argv);
173extern int nc_main(int argc, char** argv);
174extern int more_main(int argc, char** argv);
175extern int mount_main(int argc, char** argv);
176extern int mt_main(int argc, char** argv);
177extern int nslookup_main(int argc, char **argv);
178extern int ping_main(int argc, char **argv);
179extern int poweroff_main(int argc, char **argv);
180extern int printf_main(int argc, char** argv);
181extern int ps_main(int argc, char** argv);
182extern int pwd_main(int argc, char** argv);
183extern int rdate_main(int argc, char** argv);
184extern int reboot_main(int argc, char** argv);
185extern int renice_main(int argc, char** argv);
186extern int reset_main(int argc, char** argv);
187extern int rm_main(int argc, char** argv);
188extern int rmdir_main(int argc, char **argv);
189extern int rmmod_main(int argc, char** argv);
190extern int sed_main(int argc, char** argv);
191extern int sfdisk_main(int argc, char** argv);
192extern int setkeycodes_main(int argc, char** argv);
193extern int shell_main(int argc, char** argv);
194extern int sleep_main(int argc, char** argv);
195extern int sort_main(int argc, char** argv);
196extern int swap_on_off_main(int argc, char** argv);
197extern int sync_main(int argc, char** argv);
198extern int syslogd_main(int argc, char **argv);
199extern int tail_main(int argc, char** argv);
200extern int tar_main(int argc, char** argv);
201extern int tee_main(int argc, char** argv);
202extern int test_main(int argc, char** argv);
203extern int telnet_main(int argc, char** argv);
204extern int touch_main(int argc, char** argv);
205extern int tr_main(int argc, char** argv);
206extern int true_main(int argc, char** argv);
207extern int tput_main(int argc, char** argv);
208extern int tryopen_main(int argc, char** argv);
209extern int tty_main(int argc, char** argv);
210extern int umount_main(int argc, char** argv);
211extern int uname_main(int argc, char** argv);
212extern int uniq_main(int argc, char** argv);
213extern int unix2dos_main(int argc, char** argv);
214extern int unrpm_main(int argc, char** argv);
215extern int update_main(int argc, char** argv);
216extern int uptime_main(int argc, char** argv);
217extern int usleep_main(int argc, char** argv);
218extern int uuencode_main(int argc, char** argv);
219extern int uudecode_main(int argc, char** argv);
220extern int wc_main(int argc, char** argv);
221extern int wget_main(int argc, char** argv);
222extern int which_main(int argc, char** argv);
223extern int whoami_main(int argc, char** argv);
224extern int xargs_main(int argc, char** argv);
225extern int yes_main(int argc, char** argv);
226
227extern const char ar_usage[];
228extern const char basename_usage[];
229extern const char cat_usage[];
230extern const char chgrp_usage[];
231extern const char chmod_usage[];
232extern const char chown_usage[];
233extern const char chroot_usage[];
234extern const char chvt_usage[];
235extern const char clear_usage[];
236extern const char cp_usage[];
237extern const char cut_usage[];
238extern const char date_usage[];
239extern const char dc_usage[];
240extern const char dd_usage[];
241extern const char deallocvt_usage[];
242extern const char df_usage[];
243extern const char dirname_usage[];
244extern const char dmesg_usage[];
245extern const char dos2unix_usage[];
246extern const char du_usage[];
247extern const char dumpkmap_usage[];
248extern const char dutmp_usage[];
249extern const char echo_usage[];
250extern const char expr_usage[];
251extern const char false_usage[];
252extern const char fdflush_usage[];
253extern const char find_usage[];
254extern const char free_usage[];
255extern const char freeramdisk_usage[];
256extern const char fsck_minix_usage[];
257extern const char grep_usage[];
258extern const char gunzip_usage[];
259extern const char gzip_usage[];
260extern const char halt_usage[];
261extern const char head_usage[];
262extern const char hostid_usage[];
263extern const char hostname_usage[];
264extern const char id_usage[];
265extern const char insmod_usage[];
266extern const char kill_usage[];
267extern const char killall_usage[];
268extern const char length_usage[];
269extern const char ln_usage[];
270extern const char loadacm_usage[];
271extern const char loadfont_usage[];
272extern const char loadkmap_usage[];
273extern const char logger_usage[];
274extern const char logname_usage[];
275extern const char ls_usage[];
276extern const char lsmod_usage[];
277extern const char makedevs_usage[];
278extern const char md5sum_usage[];
279extern const char mkdir_usage[];
280extern const char mkfifo_usage[];
281extern const char mkfs_minix_usage[];
282extern const char mknod_usage[];
283extern const char mkswap_usage[];
284extern const char mktemp_usage[];
285extern const char more_usage[];
286extern const char mount_usage[];
287extern const char mt_usage[];
288extern const char mv_usage[];
289extern const char nc_usage[];
290extern const char nslookup_usage[];
291extern const char ping_usage[];
292extern const char poweroff_usage[];
293extern const char printf_usage[];
294extern const char ps_usage[];
295extern const char pwd_usage[];
296extern const char rdate_usage[];
297extern const char reboot_usage[];
298extern const char renice_usage[];
299extern const char reset_usage[];
300extern const char rm_usage[];
301extern const char rmdir_usage[];
302extern const char rmmod_usage[];
303extern const char sed_usage[];
304extern const char setkeycodes_usage[];
305extern const char shell_usage[];
306extern const char sleep_usage[];
307extern const char sort_usage[];
308extern const char swapoff_usage[];
309extern const char swapon_usage[];
310extern const char sync_usage[];
311extern const char syslogd_usage[];
312extern const char tail_usage[];
313extern const char tar_usage[];
314extern const char tee_usage[];
315extern const char telnet_usage[];
316extern const char test_usage[];
317extern const char touch_usage[];
318extern const char tr_usage[];
319extern const char true_usage[];
320extern const char tty_usage[];
321extern const char umount_usage[];
322extern const char uname_usage[];
323extern const char uniq_usage[];
324extern const char unix2dos_usage[];
325extern const char unrpm_usage[];
326extern const char update_usage[];
327extern const char uptime_usage[];
328extern const char usleep_usage[];
329extern const char uudecode_usage[];
330extern const char uuencode_usage[];
331extern const char wc_usage[];
332extern const char wget_usage[];
333extern const char which_usage[];
334extern const char whoami_usage[];
335extern const char xargs_usage[];
336extern const char yes_usage[];
337
338extern const char *applet_name;
339
340extern void usage(const char *usage) __attribute__ ((noreturn));
341extern void errorMsg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
342extern void fatalError(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
343
344const char *modeString(int mode);
345const char *timeString(time_t timeVal);
346int isDirectory(const char *name, const int followLinks, struct stat *statBuf);
347int isDevice(const char *name);
348
349typedef struct ino_dev_hash_bucket_struct {
350 struct ino_dev_hash_bucket_struct *next;
351 ino_t ino;
352 dev_t dev;
353 char name[1];
354} ino_dev_hashtable_bucket_t;
355int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
356void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
357void reset_ino_dev_hashtable(void);
358
359int copyFile(const char *srcName, const char *destName,
360 int setModes, int followLinks, int forceFlag);
361int copySubFile(int srcFd, int dstFd, size_t remaining);
362char *buildName(const char *dirName, const char *fileName);
363int makeString(int argc, const char **argv, char *buf, int bufLen);
364char *getChunk(int size);
365char *chunkstrdup(const char *str);
366void freeChunks(void);
367int fullWrite(int fd, const char *buf, int len);
368int fullRead(int fd, char *buf, int len);
369int recursiveAction(const char *fileName, int recurse, int followLinks, int depthFirst,
370 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
371 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
372 void* userData);
373
374extern int createPath (const char *name, int mode);
375extern int parse_mode( const char* s, mode_t* theMode);
376
377extern int get_kernel_revision(void);
378
379extern int get_console_fd(char* tty_name);
380extern struct mntent *findMountPoint(const char *name, const char *table);
381extern void write_mtab(char* blockDevice, char* directory,
382 char* filesystemType, long flags, char* string_flags);
383extern void erase_mtab(const char * name);
384extern void mtab_read(void);
385extern char *mtab_first(void **iter);
386extern char *mtab_next(void **iter);
387extern char *mtab_getinfo(const char *match, const char which);
388extern int check_wildcard_match(const char* text, const char* pattern);
389extern long getNum (const char *cp);
390extern pid_t* findPidByName( char* pidName);
391extern int find_real_root_device_name(char* name);
392extern char *get_line_from_file(FILE *file);
393extern void print_file(FILE *file);
394extern int print_file_by_name(char *filename);
395extern char process_escape_sequence(char **ptr);
396extern char *get_last_path_component(char *path);
397extern void xregcomp(regex_t *preg, const char *regex, int cflags);
398
399#ifndef DMALLOC
400extern void *xmalloc (size_t size);
401extern void *xrealloc(void *old, size_t size);
402extern void *xcalloc(size_t nmemb, size_t size);
403extern char *xstrdup (const char *s);
404#endif
405extern char *xstrndup (const char *s, int n);
406
407
408/* These parse entries in /etc/passwd and /etc/group. This is desirable
409 * for BusyBox since we want to avoid using the glibc NSS stuff, which
410 * increases target size and is often not needed embedded systems. */
411extern long my_getpwnam(char *name);
412extern long my_getgrnam(char *name);
413extern void my_getpwuid(char *name, long uid);
414extern void my_getgrgid(char *group, long gid);
415extern long my_getpwnamegid(char *name);
416
417extern int device_open(char *device, int mode);
418
419#if defined BB_FEATURE_MOUNT_LOOP
420extern int del_loop(const char *device);
421extern int set_loop(const char *device, const char *file, int offset, int *loopro);
422extern char *find_unused_loop_device (void);
423#endif
424
425
426#if (__GLIBC__ < 2) && (defined BB_SYSLOGD || defined BB_INIT)
427extern int vdprintf(int d, const char *format, va_list ap);
428#endif
429
430#if defined BB_NFSMOUNT
431int nfsmount(const char *spec, const char *node, int *flags,
432 char **extra_opts, char **mount_opts, int running_bg);
433#endif
434
435#ifndef RB_POWER_OFF
436/* Stop system and switch power off if possible. */
437#define RB_POWER_OFF 0x4321fedc
438#endif
439
440/* Include our own copy of struct sysinfo to avoid binary compatability
441 * problems with Linux 2.4, which changed things. Grumble, grumble. */
442struct sysinfo {
443 long uptime; /* Seconds since boot */
444 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
445 unsigned long totalram; /* Total usable main memory size */
446 unsigned long freeram; /* Available memory size */
447 unsigned long sharedram; /* Amount of shared memory */
448 unsigned long bufferram; /* Memory used by buffers */
449 unsigned long totalswap; /* Total swap space size */
450 unsigned long freeswap; /* swap space still available */
451 unsigned short procs; /* Number of current processes */
452 unsigned long totalhigh; /* Total high memory size */
453 unsigned long freehigh; /* Available high memory size */
454 unsigned int mem_unit; /* Memory unit size in bytes */
455 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
456};
457extern int sysinfo (struct sysinfo* info);
458
459/* Bit map related macros -- libc5 doens't provide these... sigh. */
460#ifndef setbit
461#define NBBY CHAR_BIT
462#define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
463#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
464#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
465#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
466#endif
467
468#endif /* _BB_INTERNAL_H_ */