TODO

   1 Busybox TODO
   2
   3 Stuff that needs to be done
   4
   5 find
   6   doesn't understand (), lots of susv3 stuff.
   7 ----
   8 sh
   9   The command shell situation is a big mess.  We have three or four different
  10   shells that don't really share any code, and the "standalone shell" doesn't
  11   work all that well (especially not in a chroot environment), due to apps not
  12   being reentrant.  Unifying the various shells and figuring out a configurable
  13   way of adding the minimal set of bash features a given script uses is a big
  14   job, but it be a big improvement.
  15
  16   Note: Rob Landley (rob@landley.net) is working on this one, but very slowly...
  17
  18   Support unicode for cmdedit.
  19 ---
  20 diff
  21   We should have a diff -u command.  We have patch, we should have diff
  22   (we only need to support unified diffs though).
  23 ---
  24 fuser
  25   Would be nice.  The basic susv3 options, plus fuser -k.
  26 ---
  27 patch
  28   Should have simple fuzz factor support to apply patches at an offset which
  29   shouldn't take up too much space.
  30
  31   And while we're at it, a new patch filename quoting format is apparently
  32   coming soon:  http://marc.theaimsgroup.com/?l=git&m=112927316408690&w=2
  33 ---
  34 man
  35   It would be nice to have a man command.  Not one that handles troff or
  36   anything, just one that can handle preformatted ascii man pages, possibly
  37   compressed.  This could probably be a script in the extras directory that
  38   calls cat/zcat/bzcat | less
  39 ---
  40 bzip2
  41   Compression-side support.
  42
  43
  44 Architectural issues:
  45
  46 Do a SUSv3 audit
  47   Look at the full Single Unix Specification version 3 (available online at
  48   "http://www.opengroup.org/onlinepubs/009695399/nfindex.html") and
  49   figure out which of our apps are compliant, and what we're missing that
  50   we might actually care about.
  51
  52   Even better would be some kind of automated compliance test harness that
  53   exercises each command line option and the various corner cases.
  54 --
  55 Unify archivers
  56   Lots of archivers have the same general infrastructure.  The directory
  57   traversal code should be factored out, and the guts of each archiver could
  58   be some setup code and a series of callbacks for "add this file",
  59   "add this directory", "add this symlink" and so on.
  60
  61   This could clean up tar and zip, and make it cheaper to add cpio and ar
  62   write support, and possibly even cheaply add things like mkisofs someday,
  63   if it becomes relevant.
  64 ---
  65 Text buffer support.
  66   Several existing applets (sort, vi, less...) read
  67   a whole file into memory and act on it.  There might be an opportunity
  68   for shared code in there that could be moved into libbb...
  69 ---
  70 Individual compilation of applets.
  71   It would be nice if busybox had the option to compile to individual applets,
  72   for people who want an alternate implementation less bloated than the gnu
  73   utils (or simply with less political baggage), but without it being one big
  74   executable.
  75
  76   Turning libbb into a real dll is another possibility, especially if libbb
  77   could export some of the other library interfaces we've already more or less
  78   got the code for (like zlib).
  79 ---
  80 buildroot - Make a "dogfood" option
  81   Busybox 1.1 will be capable of replacing most gnu packages for real world use,
  82   such as developing software or in a live CD.  It needs wider testing.
  83
  84   Busybox should now be able to replace bzip2, coreutils, e2fsprogs, file,
  85   findutils, gawk, grep, inetutils, less, modutils, net-tools, patch, procps,
  86   sed, shadow, sysklogd, sysvinit, tar, util-linux, and vim.  The resulting
  87   system should be self-hosting (I.E. able to rebuild itself from source code).
  88   This means it would need (at least) binutils, gcc, and make, or equivalents.
  89
  90   It would be a good "eating our own dogfood" test if buildroot had the option
  91   of using a "make allyesconfig" busybox instead of the all of the above
  92   packages.  Anything that's wrong with the resulting system, we can fix.  (It
  93   would be nice to be able to upgrade busybox to be able to replace bash and
  94   diffutils as well, but we're not there yet.)
  95
  96   One example of an existing system that does this already is Firmware Linux:
  97     http://www.landley.net/code/firmware
  98 ---
  99 Memory Allocation
 100   We have a CONFIG_BUFFER mechanism that lets us select whether to do memory
 101   allocation on the stack or the heap.  Unfortunately, we're not using it much.
 102   We need to audit our memory allocations and turn a lot of malloc/free calls
 103   into RESERVE_CONFIG_BUFFER/RELEASE_CONFIG_BUFFER.
 104
 105   And while we're at it, many of the CONFIG_FEATURE_CLEAN_UP #ifdefs will be
 106   optimized out by the compiler in the stack allocation case (since there's no
 107   free for an alloca()), and this means that various cleanup loops that just
 108   call free might also be optimized out by the compiler if written right, so
 109   we can yank those #ifdefs too, and generally clean up the code.
 110 ---
 111 Switch CONFIG_SYMBOLS to ENABLE_SYMBOLS
 112
 113   In busybox 1.0 and earlier, configuration was done by CONFIG_SYMBOLS
 114   that were either defined or undefined to indicate whether the symbol was
 115   selected in the .config file.  They were used with #ifdefs, ala:
 116
 117     #ifdef CONFIG_SYMBOL
 118       if (other_test) {
 119         do_code();
 120       }
 121     #endif
 122
 123   In 1.1, we have new ENABLE_SYMBOLS which are always defined (as 0 or 1),
 124   meaning you can still use them for preprocessor tests by replacing
 125   "#ifdef CONFIG_SYMBOL" with "#if ENABLE_SYMBOL".  But more importantly, we
 126   can use them as a true or false test in normal C code:
 127
 128     if (ENABLE_SYMBOL && other_test) {
 129       do_code();
 130     }
 131
 132   (Optimizing away if() statements that resolve to a constant value
 133   is known as "dead code elimination", an optimization so old and simple that
 134   Turbo Pascal for DOS did it twenty years ago.  Even modern mini-compilers
 135   like the Tiny C Compiler (tcc) and the Small Device C Compiler (SDCC)
 136   perform dead code elimination.)
 137
 138   Right now, busybox.h is #including both "config.h" (defining the
 139   CONFIG_SYMBOLS) and "bb_config.h" (defining the ENABLE_SYMBOLS).  At some
 140   point in the future, it would be nice to wean ourselves off of the
 141   CONFIG versions.  (Among other things, some defective build environments
 142   leak the Linux kernel's CONFIG_SYMBOLS into the system's standard #include
 143   files.  We've experienced collisions before.)
 144 ---
 145 FEATURE_CLEAN_UP
 146   This is more an unresolved issue than a to-do item.  More thought is needed.
 147
 148   Normally we rely on exit() to free memory, close files, and unmap segments
 149   for us.  This makes most calls to free(), close(), and unmap() optional in
 150   busybox applets that don't intend to run for very long, and optional stuff
 151   can be omitted to save size.
 152
 153   The idea was raised that we could simulate fork/exit with setjmp/longjmp
 154   for _really_ brainless embedded systems, or speed up the standalone shell
 155   by not forking.  Doing so would require a reliable FEATURE_CLEAN_UP.
 156   Unfortunately, this isn't as easy as it sounds.
 157
 158   The problem is, lots of things exit(), sometimes unexpectedly (xmalloc())
 159   and sometimes reliably (bb_perror_msg_and_die() or show_usage()).  This
 160   jumps out of the normal flow control and bypasses any cleanup code we
 161   put at the end of our applets.
 162
 163   It's possible to add hooks to libbb functions like xmalloc() and bb_xopen()
 164   to add their entries to a linked list, which could be traversed and
 165   freed/closed automatically.  (This would need to be able to free just the
 166   entries after a checkpoint to be usable for a forkless standalone shell.
 167   You don't want to free the shell's own resources.)
 168
 169   Right now, FEATURE_CLEAN_UP is more or less a debugging aid, to make things
 170   like valgrind happy.  It's also documentation of _what_ we're trusting
 171   exit() to clean up for us.  But new infrastructure to auto-free stuff would
 172   render the existing FEATURE_CLEAN_UP code redundant.
 173
 174   For right now, exit() handles it just fine.