TODO

   1 Busybox TODO
   2
   3 Stuff that needs to be done.  All of this is fair game for 1.2.
   4
   5 build system
   6   make -j is broken, -j1 is forced atm
   7   Make sure that the flags get pinned in e.g. Rules.mak so when expanding them
   8   later on you get the cached result without the need to re-evaluate them.
   9 ----
  10 find
  11   doesn't understand (), lots of susv3 stuff.
  12 ----
  13 sh
  14   The command shell situation is a big mess.  We have three or four different
  15   shells that don't really share any code, and the "standalone shell" doesn't
  16   work all that well (especially not in a chroot environment), due to apps not
  17   being reentrant.  Unifying the various shells and figuring out a configurable
  18   way of adding the minimal set of bash features a given script uses is a big
  19   job, but it would be a big improvement.
  20
  21   Note: Rob Landley (rob@landley.net) is working on a new unified shell called
  22   bbsh, but it's a low priority...
  23 ---
  24 diff
  25   We should have a diff -u command.  We have patch, we should have diff
  26   (we only need to support unified diffs though).
  27
  28   Also, make sure we handle empty files properly:
  29     From the patch man page:
  30
  31    you can remove a file by sending out a context diff that compares
  32    the file to be deleted with an empty file dated the Epoch.  The
  33    file will be removed unless patch is conforming to POSIX and the
  34    -E or --remove-empty-files option is not given.
  35 ---
  36 patch
  37   Should have simple fuzz factor support to apply patches at an offset which
  38   shouldn't take up too much space.
  39
  40   And while we're at it, a new patch filename quoting format is apparently
  41   coming soon:  http://marc.theaimsgroup.com/?l=git&m=112927316408690&w=2
  42 ---
  43 man
  44   It would be nice to have a man command.  Not one that handles troff or
  45   anything, just one that can handle preformatted ascii man pages, possibly
  46   compressed.  This could probably be a script in the extras directory that
  47   calls cat/zcat/bzcat | less
  48
  49   (How doclifter might work into this is anybody's guess.)
  50 ---
  51 bzip2
  52   Compression-side support.
  53 ---
  54 init
  55   General cleanup.
  56 ---
  57 ar
  58   Write support?
  59 ---
  60 mdev
  61   Micro-udev.
  62
  63 Architectural issues:
  64
  65 bb_close() with fsync()
  66   We should have a bb_close() in place of normal close, with a CONFIG_ option
  67   to not just check the return value of close() for an error, but fsync().
  68   Close can't reliably report anything useful because if write() accepted the
  69   data then it either went out to the network or it's in cache or a pipe
  70   buffer.  Either way, there's no guarantee it'll make it to its final
  71   destination before close() gets called, so there's no guarantee that any
  72   error will be reported.
  73
  74   You need to call fsync() if you care about errors that occur after write(),
  75   but that can have a big performance impact.  So make it a config option.
  76 ---
  77 Unify base64 handling.
  78   There's base64 encoding and decoding going on in:
  79     networking/wget.c:base64enc()
  80     coreutils/uudecode.c:read_base64()
  81     coreutils/uuencode.c:tbl_base64[]
  82     networking/httpd.c:decodeBase64()
  83   And probably elsewhere.  That needs to be unified into libbb functions.
  84 ---
  85 Do a SUSv3 audit
  86   Look at the full Single Unix Specification version 3 (available online at
  87   "http://www.opengroup.org/onlinepubs/009695399/nfindex.html") and
  88   figure out which of our apps are compliant, and what we're missing that
  89   we might actually care about.
  90
  91   Even better would be some kind of automated compliance test harness that
  92   exercises each command line option and the various corner cases.
  93 ---
  94 Internationalization
  95   How much internationalization should we do?
  96
  97   The low hanging fruit is UTF-8 character set support.  We should do this.
  98   (Vodz pointed out the shell's cmdedit as needing work here.  What else?)
  99
 100   We also have lots of hardwired english text messages.  Consolidating this
 101   into some kind of message table not only makes translation easier, but
 102   also allows us to consolidate redundant (or close) strings.
 103
 104   We probably don't want to be bloated with locale support.  (Not unless we can
 105   cleanly export it from our underlying C library without having to concern
 106   ourselves with it directly.  Perhaps a few specific things like a config
 107   option for "date" are low hanging fruit here?)
 108
 109   What level should things happen at?  How much do we care about
 110   internationalizing the text console when X11 and xterms are so much better
 111   at it?  (There's some infrastructure here we don't implement: The
 112   "unicode_start" and "unicode_stop" shell scripts need "vt-is-UTF8" and a
 113   --unicode option to loadkeys.  That implies a real loadkeys/dumpkeys
 114   implementation to replace loadkmap/dumpkmap.  Plus messing with console font
 115   loading.  Is it worth it, or do we just say "use X"?)
 116 ---
 117 Unify archivers
 118   Lots of archivers have the same general infrastructure.  The directory
 119   traversal code should be factored out, and the guts of each archiver could
 120   be some setup code and a series of callbacks for "add this file",
 121   "add this directory", "add this symlink" and so on.
 122
 123   This could clean up tar and zip, and make it cheaper to add cpio and ar
 124   write support, and possibly even cheaply add things like mkisofs or
 125   mksquashfs someday, if they become relevant.
 126 ---
 127 Text buffer support.
 128   Several existing applets (sort, vi, less...) read
 129   a whole file into memory and act on it.  There might be an opportunity
 130   for shared code in there that could be moved into libbb...
 131 ---
 132 Individual compilation of applets.
 133   It would be nice if busybox had the option to compile to individual applets,
 134   for people who want an alternate implementation less bloated than the gnu
 135   utils (or simply with less political baggage), but without it being one big
 136   executable.
 137
 138   Turning libbb into a real dll is another possibility, especially if libbb
 139   could export some of the other library interfaces we've already more or less
 140   got the code for (like zlib).
 141 ---
 142 buildroot - Make a "dogfood" option
 143   Busybox 1.1 will be capable of replacing most gnu packages for real world use,
 144   such as developing software or in a live CD.  It needs wider testing.
 145
 146   Busybox should now be able to replace bzip2, coreutils, e2fsprogs, file,
 147   findutils, gawk, grep, inetutils, less, modutils, net-tools, patch, procps,
 148   sed, shadow, sysklogd, sysvinit, tar, util-linux, and vim.  The resulting
 149   system should be self-hosting (I.E. able to rebuild itself from source code).
 150   This means it would need (at least) binutils, gcc, and make, or equivalents.
 151
 152   It would be a good "eating our own dogfood" test if buildroot had the option
 153   of using a "make allyesconfig" busybox instead of the all of the above
 154   packages.  Anything that's wrong with the resulting system, we can fix.  (It
 155   would be nice to be able to upgrade busybox to be able to replace bash and
 156   diffutils as well, but we're not there yet.)
 157
 158   One example of an existing system that does this already is Firmware Linux:
 159     http://www.landley.net/code/firmware
 160 ---
 161 initramfs
 162   Busybox should have a sample initramfs build script.  This depends on
 163   bbsh, mdev, and switch_root.
 164 ---
 165 Memory Allocation
 166   We have a CONFIG_BUFFER mechanism that lets us select whether to do memory
 167   allocation on the stack or the heap.  Unfortunately, we're not using it much.
 168   We need to audit our memory allocations and turn a lot of malloc/free calls
 169   into RESERVE_CONFIG_BUFFER/RELEASE_CONFIG_BUFFER.
 170   For a start, see e.g. make CFLAGS_EXTRA=-Wlarger-than-64
 171
 172   And while we're at it, many of the CONFIG_FEATURE_CLEAN_UP #ifdefs will be
 173   optimized out by the compiler in the stack allocation case (since there's no
 174   free for an alloca()), and this means that various cleanup loops that just
 175   call free might also be optimized out by the compiler if written right, so
 176   we can yank those #ifdefs too, and generally clean up the code.
 177 ---
 178 Switch CONFIG_SYMBOLS to ENABLE_SYMBOLS
 179
 180   In busybox 1.0 and earlier, configuration was done by CONFIG_SYMBOLS
 181   that were either defined or undefined to indicate whether the symbol was
 182   selected in the .config file.  They were used with #ifdefs, ala:
 183
 184     #ifdef CONFIG_SYMBOL
 185       if (other_test) {
 186         do_code();
 187       }
 188     #endif
 189
 190   In 1.1, we have new ENABLE_SYMBOLS which are always defined (as 0 or 1),
 191   meaning you can still use them for preprocessor tests by replacing
 192   "#ifdef CONFIG_SYMBOL" with "#if ENABLE_SYMBOL".  But more importantly, we
 193   can use them as a true or false test in normal C code:
 194
 195     if (ENABLE_SYMBOL && other_test) {
 196       do_code();
 197     }
 198
 199   (Optimizing away if() statements that resolve to a constant value
 200   is known as "dead code elimination", an optimization so old and simple that
 201   Turbo Pascal for DOS did it twenty years ago.  Even modern mini-compilers
 202   like the Tiny C Compiler (tcc) and the Small Device C Compiler (SDCC)
 203   perform dead code elimination.)
 204
 205   Right now, busybox.h is #including both "config.h" (defining the
 206   CONFIG_SYMBOLS) and "bb_config.h" (defining the ENABLE_SYMBOLS).  At some
 207   point in the future, it would be nice to wean ourselves off of the
 208   CONFIG versions.  (Among other things, some defective build environments
 209   leak the Linux kernel's CONFIG_SYMBOLS into the system's standard #include
 210   files.  We've experienced collisions before.)
 211 ---
 212 FEATURE_CLEAN_UP
 213   This is more an unresolved issue than a to-do item.  More thought is needed.
 214
 215   Normally we rely on exit() to free memory, close files, and unmap segments
 216   for us.  This makes most calls to free(), close(), and unmap() optional in
 217   busybox applets that don't intend to run for very long, and optional stuff
 218   can be omitted to save size.
 219
 220   The idea was raised that we could simulate fork/exit with setjmp/longjmp
 221   for _really_ brainless embedded systems, or speed up the standalone shell
 222   by not forking.  Doing so would require a reliable FEATURE_CLEAN_UP.
 223   Unfortunately, this isn't as easy as it sounds.
 224
 225   The problem is, lots of things exit(), sometimes unexpectedly (xmalloc())
 226   and sometimes reliably (bb_perror_msg_and_die() or show_usage()).  This
 227   jumps out of the normal flow control and bypasses any cleanup code we
 228   put at the end of our applets.
 229
 230   It's possible to add hooks to libbb functions like xmalloc() and bb_xopen()
 231   to add their entries to a linked list, which could be traversed and
 232   freed/closed automatically.  (This would need to be able to free just the
 233   entries after a checkpoint to be usable for a forkless standalone shell.
 234   You don't want to free the shell's own resources.)
 235
 236   Right now, FEATURE_CLEAN_UP is more or less a debugging aid, to make things
 237   like valgrind happy.  It's also documentation of _what_ we're trusting
 238   exit() to clean up for us.  But new infrastructure to auto-free stuff would
 239   render the existing FEATURE_CLEAN_UP code redundant.
 240
 241   For right now, exit() handles it just fine.
 242
 243
 244
 245 Minor stuff:
 246   watchdog.c could autodetect the timer duration via:
 247     if(!ioctl (fd, WDIOC_GETTIMEOUT, &tmo)) timer_duration = 1 + (tmo / 2);
 248   Unfortunately, that needs linux/watchdog.h and that contains unfiltered
 249   kernel types on some distros, which breaks the build.
 250
 251
 252 Code cleanup:
 253
 254 Replace deprecated functions.
 255
 256 bzero() -> memset()
 257 ---
 258 sigblock(), siggetmask(), sigsetmask(), sigmask() -> sigprocmask et al
 259 ---
 260