3778898f97
BusyBox has support for embedded shell scripts. Two types can be distinguished: custom scripts and scripts implementing applets. Custom scripts should be placed in the 'embed' directory at build time. They are given a default applet configuration and appear as applets to the user but no further configuration is possible. Applet scripts are integrated with the BusyBox build system and are intended to be used to ship standard applets that just happen to be implemented as scripts. They can be configured at build time and appear just like native applets. Such scripts should be placed in the 'applets_sh' directory. A stub C program should be written to provide the usual applet configuration details and placed in a suitable subsystem directory. It may be helpful to have a configuration option to enable any dependencies the script requires: see the 'nologin' applet for an example. function old new delta scripted_main - 41 +41 applet_names 2773 2781 +8 applet_main 1600 1604 +4 i2cdetect_main 672 674 +2 applet_suid 100 101 +1 applet_install_loc 200 201 +1 applet_flags 100 101 +1 packed_usage 33180 33179 -1 tryexec 159 152 -7 evalcommand 1661 1653 -8 script_names 9 - -9 packed_scripts 123 114 -9 complete_cmd_dir_file 826 811 -15 shellexec 271 254 -17 find_command 1007 990 -17 busybox_main 642 624 -18 run_applet_and_exit 100 78 -22 find_script_by_name 51 - -51 ------------------------------------------------------------------------------ (add/remove: 1/2 grow/shrink: 6/9 up/down: 58/-174) Total: -116 bytes text data bss dec hex filename 950034 477 7296 957807 e9d6f busybox_old 949918 477 7296 957691 e9cfb busybox_unstripped Signed-off-by: Ron Yorston <rmy@pobox.com> Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
108 lines
4.5 KiB
C
108 lines
4.5 KiB
C
/* vi: set sw=4 ts=4: */
|
|
/*
|
|
* applets.h - a listing of all busybox applets.
|
|
*
|
|
* If you write a new applet, you need to add an entry to this list to make
|
|
* busybox aware of it.
|
|
*/
|
|
|
|
/*
|
|
name - applet name as it is typed on command line
|
|
help - applet name, converted to C (ether-wake: help = ether_wake)
|
|
main - corresponding <applet>_main to call (bzcat: main = bunzip2)
|
|
l - location to install link to: [/usr]/[s]bin
|
|
s - suid type:
|
|
BB_SUID_REQUIRE: will complain if busybox isn't suid
|
|
and is run by non-root (applet_main() will not be called at all)
|
|
BB_SUID_DROP: will drop suid prior to applet_main()
|
|
BB_SUID_MAYBE: neither of the above
|
|
(every instance of BB_SUID_REQUIRE and BB_SUID_MAYBE
|
|
needs to be justified in comment)
|
|
NB: please update FEATURE_SUID help text whenever you add/remove
|
|
BB_SUID_REQUIRE or BB_SUID_MAYBE applet.
|
|
*/
|
|
|
|
#define NOUSAGE_STR "\b"
|
|
|
|
#define dummy_trivial_usage NOUSAGE_STR \
|
|
|
|
#define dummy_full_usage "" \
|
|
|
|
#if defined(PROTOTYPES)
|
|
# define APPLET(name,l,s) int name##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
|
|
# define APPLET_ODDNAME(name,main,l,s,help) int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
|
|
# define APPLET_NOEXEC(name,main,l,s,help) int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
|
|
# define APPLET_NOFORK(name,main,l,s,help) int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
|
|
# define APPLET_SCRIPTED(name,main,l,s,help)
|
|
|
|
#elif defined(NAME_MAIN)
|
|
# define APPLET(name,l,s) name name##_main
|
|
# define APPLET_ODDNAME(name,main,l,s,help) name main##_main
|
|
# define APPLET_NOEXEC(name,main,l,s,help) name main##_main
|
|
# define APPLET_NOFORK(name,main,l,s,help) name main##_main
|
|
# define APPLET_SCRIPTED(name,main,l,s,help) name scripted_main
|
|
|
|
#elif defined(MAKE_USAGE) && ENABLE_FEATURE_VERBOSE_USAGE
|
|
# define APPLET(name,l,s) MAKE_USAGE(#name, name##_trivial_usage name##_full_usage)
|
|
# define APPLET_ODDNAME(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
|
|
# define APPLET_NOEXEC(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
|
|
# define APPLET_NOFORK(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
|
|
# define APPLET_SCRIPTED(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
|
|
|
|
#elif defined(MAKE_USAGE) && !ENABLE_FEATURE_VERBOSE_USAGE
|
|
# define APPLET(name,l,s) MAKE_USAGE(#name, name##_trivial_usage)
|
|
# define APPLET_ODDNAME(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage)
|
|
# define APPLET_NOEXEC(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage)
|
|
# define APPLET_NOFORK(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage)
|
|
# define APPLET_SCRIPTED(name,main,l,s,help) MAKE_USAGE(#name, help##_trivial_usage)
|
|
|
|
#elif defined(MAKE_LINKS)
|
|
# define APPLET(name,l,c) LINK l name
|
|
# define APPLET_ODDNAME(name,main,l,s,help) LINK l name
|
|
# define APPLET_NOEXEC(name,main,l,s,help) LINK l name
|
|
# define APPLET_NOFORK(name,main,l,s,help) LINK l name
|
|
# define APPLET_SCRIPTED(name,main,l,s,help) LINK l name
|
|
|
|
#elif defined(MAKE_SUID)
|
|
# define APPLET(name,l,s) SUID s l name
|
|
# define APPLET_ODDNAME(name,main,l,s,help) SUID s l name
|
|
# define APPLET_NOEXEC(name,main,l,s,help) SUID s l name
|
|
# define APPLET_NOFORK(name,main,l,s,help) SUID s l name
|
|
# define APPLET_SCRIPTED(name,main,l,s,help) SUID s l name
|
|
|
|
#elif defined(MAKE_SCRIPTS)
|
|
# define APPLET(name,l,s)
|
|
# define APPLET_ODDNAME(name,main,l,s,help)
|
|
# define APPLET_NOEXEC(name,main,l,s,help)
|
|
# define APPLET_NOFORK(name,main,l,s,help)
|
|
# define APPLET_SCRIPTED(name,main,l,s,help) SCRIPT name
|
|
|
|
#else
|
|
static struct bb_applet applets[] = { /* name, main, location, need_suid */
|
|
# define APPLET(name,l,s) { #name, #name, l, s },
|
|
# define APPLET_ODDNAME(name,main,l,s,help) { #name, #main, l, s },
|
|
# define APPLET_NOEXEC(name,main,l,s,help) { #name, #main, l, s, 1 },
|
|
# define APPLET_NOFORK(name,main,l,s,help) { #name, #main, l, s, 1, 1 },
|
|
# define APPLET_SCRIPTED(name,main,l,s,help) { #name, #main, l, s },
|
|
#endif
|
|
|
|
#if ENABLE_INSTALL_NO_USR
|
|
# define BB_DIR_USR_BIN BB_DIR_BIN
|
|
# define BB_DIR_USR_SBIN BB_DIR_SBIN
|
|
#endif
|
|
|
|
|
|
INSERT
|
|
|
|
|
|
#if !defined(PROTOTYPES) && !defined(NAME_MAIN) && !defined(MAKE_USAGE) \
|
|
&& !defined(MAKE_LINKS) && !defined(MAKE_SUID)
|
|
};
|
|
#endif
|
|
|
|
#undef APPLET
|
|
#undef APPLET_ODDNAME
|
|
#undef APPLET_NOEXEC
|
|
#undef APPLET_NOFORK
|
|
#undef APPLET_SCRIPTED
|