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