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