TODO

   1 Busybox TODO
   2
   3 Harvest patches from
   4 http://git.openembedded.org/cgit.cgi/openembedded/tree/recipes/busybox/
   5 https://dev.openwrt.org/browser/trunk/package/busybox/patches/
   6
   7
   8 Stuff that needs to be done.  This is organized by who plans to get around to
   9 doing it eventually, but that doesn't mean they "own" the item.  If you want to
  10 do one of these bounce an email off the person it's listed under to see if they
  11 have any suggestions how they plan to go about it, and to minimize conflicts
  12 between your work and theirs.  But otherwise, all of these are fair game.
  13
  14 Rob Landley suggested this:
  15   Implement bb_realpath() that can handle NULL on non-glibc.
  16
  17   sh
  18     The command shell situation is a mess.  We have two different
  19     shells that don't really share any code, and the "standalone shell" doesn't
  20     work all that well (especially not in a chroot environment), due to apps not
  21     being reentrant.
  22
  23   Do a SUSv3 audit
  24     Look at the full Single Unix Specification version 3 (available online at
  25     "http://www.opengroup.org/onlinepubs/009695399/nfindex.html") and
  26     figure out which of our apps are compliant, and what we're missing that
  27     we might actually care about.
  28
  29     Even better would be some kind of automated compliance test harness that
  30     exercises each command line option and the various corner cases.
  31
  32   Internationalization
  33     How much internationalization should we do?
  34
  35     The low hanging fruit is UTF-8 character set support.  We should do this.
  36     See TODO_unicode file.
  37
  38     We also have lots of hardwired english text messages.  Consolidating this
  39     into some kind of message table not only makes translation easier, but
  40     also allows us to consolidate redundant (or close) strings.
  41
  42     We probably don't want to be bloated with locale support.  (Not unless we
  43     can cleanly export it from our underlying C library without having to
  44     concern ourselves with it directly.  Perhaps a few specific things like a
  45     config option for "date" are low hanging fruit here?)
  46
  47     What level should things happen at?  How much do we care about
  48     internationalizing the text console when X11 and xterms are so much better
  49     at it?  (There's some infrastructure here we don't implement: The
  50     "unicode_start" and "unicode_stop" shell scripts need "vt-is-UTF8" and a
  51     --unicode option to loadkeys.  That implies a real loadkeys/dumpkeys
  52     implementation to replace loadkmap/dumpkmap.  Plus messing with console font
  53     loading.  Is it worth it, or do we just say "use X"?)
  54
  55   Individual compilation of applets.
  56     It would be nice if busybox had the option to compile to individual applets,
  57     for people who want an alternate implementation less bloated than the gnu
  58     utils (or simply with less political baggage), but without it being one big
  59     executable.
  60
  61     Turning libbb into a real dll is another possibility, especially if libbb
  62     could export some of the other library interfaces we've already more or less
  63     got the code for (like zlib).
  64
  65   buildroot - Make a "dogfood" option
  66     Busybox 1.1 will be capable of replacing most gnu packages for real world
  67     use, such as developing software or in a live CD.  It needs wider testing.
  68
  69     Busybox should now be able to replace bzip2, coreutils, e2fsprogs, file,
  70     findutils, gawk, grep, inetutils, less, modutils, net-tools, patch, procps,
  71     sed, shadow, sysklogd, sysvinit, tar, util-linux, and vim.  The resulting
  72     system should be self-hosting (I.E. able to rebuild itself from source
  73     code).  This means it would need (at least) binutils, gcc, and make, or
  74     equivalents.
  75
  76     It would be a good "eating our own dogfood" test if buildroot had the option
  77     of using a "make allyesconfig" busybox instead of the all of the above
  78     packages.  Anything that's wrong with the resulting system, we can fix.  (It
  79     would be nice to be able to upgrade busybox to be able to replace bash and
  80     diffutils as well, but we're not there yet.)
  81
  82     One example of an existing system that does this already is Firmware Linux:
  83       http://www.landley.net/code/firmware
  84
  85   initramfs
  86     Busybox should have a sample initramfs build script.  This depends on
  87     shell, mdev, and switch_root.
  88
  89   mkdep
  90     Write a mkdep that doesn't segfault if there's a directory it doesn't
  91     have permission to read, isn't based on manually editing the output of
  92     lexx and yacc, doesn't make such a mess under include/config, etc.
  93
  94   Group globals into unions of structures.
  95     Go through and turn all the global and static variables into structures,
  96     and have all those structures be in a big union shared between processes,
  97     so busybox uses less bss.  (This is a big win on nommu machines.)  See
  98     sed.c and mdev.c for examples.
  99
 100   Go through bugs.busybox.net and close out all of that somehow.
 101     This one's open to everybody, but I'll wind up doing it...
 102
 103 Bernhard Reutner-Fischer <busybox@busybox.net> suggests to look at these:
 104   New debug options:
 105     -Wlarger-than-127
 106     Cleanup any big users
 107   Collate BUFSIZ IOBUF_SIZE MY_BUF_SIZE PIPE_PROGRESS_SIZE BUFSIZE PIPESIZE
 108     make bb_common_bufsiz1 configurable, size wise.
 109     make pipesize configurable, size wise.
 110     Use bb_common_bufsiz1 throughout applets!
 111
 112 As yet unclaimed:
 113
 114 ----
 115 diff
 116   Make sure we handle empty files properly:
 117     From the patch man page:
 118
 119     you can remove a file by sending out a context diff that compares
 120     the file to be deleted with an empty file dated the Epoch.  The
 121     file will be removed unless patch is conforming to POSIX and the
 122     -E or --remove-empty-files option is not given.
 123 ---
 124 patch
 125   Should have simple fuzz factor support to apply patches at an offset which
 126   shouldn't take up too much space.
 127
 128   And while we're at it, a new patch filename quoting format is apparently
 129   coming soon:  http://marc.theaimsgroup.com/?l=git&m=112927316408690&w=2
 130 ---
 131 tail
 132   ./busybox tail -f foo.c~ TODO
 133   should not print fmt=header_fmt for subsequent date >> TODO; i.e. only
 134   fmt+ if another (not the current) file did change
 135
 136 Architectural issues:
 137
 138 bb_close() with fsync()
 139   We should have a bb_close() in place of normal close, with a CONFIG_ option
 140   to not just check the return value of close() for an error, but fsync().
 141   Close can't reliably report anything useful because if write() accepted the
 142   data then it either went out to the network or it's in cache or a pipe
 143   buffer.  Either way, there's no guarantee it'll make it to its final
 144   destination before close() gets called, so there's no guarantee that any
 145   error will be reported.
 146
 147   You need to call fsync() if you care about errors that occur after write(),
 148   but that can have a big performance impact.  So make it a config option.
 149 ---
 150 Unify archivers
 151   Lots of archivers have the same general infrastructure.  The directory
 152   traversal code should be factored out, and the guts of each archiver could
 153   be some setup code and a series of callbacks for "add this file",
 154   "add this directory", "add this symlink" and so on.
 155
 156   This could clean up tar and zip, and make it cheaper to add cpio and ar
 157   write support, and possibly even cheaply add things like mkisofs or
 158   mksquashfs someday, if they become relevant.
 159 ---
 160 Text buffer support.
 161   Several existing applets (sort, vi, less...) read
 162   a whole file into memory and act on it.  Use open_read_close().
 163 ---
 164 Memory Allocation
 165   We have a CONFIG_BUFFER mechanism that lets us select whether to do memory
 166   allocation on the stack or the heap.  Unfortunately, we're not using it much.
 167   We need to audit our memory allocations and turn a lot of malloc/free calls
 168   into RESERVE_CONFIG_BUFFER/RELEASE_CONFIG_BUFFER.
 169   For a start, see e.g. make EXTRA_CFLAGS=-Wlarger-than-64
 170
 171   And while we're at it, many of the CONFIG_FEATURE_CLEAN_UP #ifdefs will be
 172   optimized out by the compiler in the stack allocation case (since there's no
 173   free for an alloca()), and this means that various cleanup loops that just
 174   call free might also be optimized out by the compiler if written right, so
 175   we can yank those #ifdefs too, and generally clean up the code.
 176 ---
 177 FEATURE_CLEAN_UP
 178   This is more an unresolved issue than a to-do item.  More thought is needed.
 179
 180   Normally we rely on exit() to free memory, close files and unmap segments
 181   for us.  This makes most calls to free(), close(), and unmap() optional in
 182   busybox applets that don't intend to run for very long, and optional stuff
 183   can be omitted to save size.
 184
 185   The idea was raised that we could simulate fork/exit with setjmp/longjmp
 186   for _really_ brainless embedded systems, or speed up the standalone shell
 187   by not forking.  Doing so would require a reliable FEATURE_CLEAN_UP.
 188   Unfortunately, this isn't as easy as it sounds.
 189
 190   The problem is, lots of things exit(), sometimes unexpectedly (xmalloc())
 191   and sometimes reliably (bb_perror_msg_and_die() or show_usage()).  This
 192   jumps out of the normal flow control and bypasses any cleanup code we
 193   put at the end of our applets.
 194
 195   It's possible to add hooks to libbb functions like xmalloc() and xopen()
 196   to add their entries to a linked list, which could be traversed and
 197   freed/closed automatically.  (This would need to be able to free just the
 198   entries after a checkpoint to be usable for a forkless standalone shell.
 199   You don't want to free the shell's own resources.)
 200
 201   Right now, FEATURE_CLEAN_UP is more or less a debugging aid, to make things
 202   like valgrind happy.  It's also documentation of _what_ we're trusting
 203   exit() to clean up for us.  But new infrastructure to auto-free stuff would
 204   render the existing FEATURE_CLEAN_UP code redundant.
 205
 206   For right now, exit() handles it just fine.
 207
 208
 209 Minor stuff:
 210   watchdog.c could autodetect the timer duration via:
 211     if(!ioctl (fd, WDIOC_GETTIMEOUT, &tmo)) timer_duration = 1 + (tmo / 2);
 212   Unfortunately, that needs linux/watchdog.h and that contains unfiltered
 213   kernel types on some distros, which breaks the build.
 214 ---
 215   use bb_error_msg where appropriate: See
 216   egrep "(printf.*\([[:space:]]*(stderr|2)|[^_]write.*\([[:space:]]*(stderr|2))"
 217 ---
 218   use bb_perror_msg where appropriate: See
 219   egrep "[^_]perror"
 220 ---
 221   possible code duplication ingroup() and is_a_group_member()
 222 ---
 223   Move __get_hz() to a better place and (re)use it in route.c, ash.c
 224 ---
 225   See grep -r strtod
 226   Alot of duplication that wants cleanup.
 227 ---
 228   unify progress_meter. wget, flash_eraseall, pipe_progress, fbsplash, setfiles.
 229 ---
 230   support start-stop-daemon -d <chdir-path>
 231 ---
 232 vdprintf() -> similar sized functionality
 233 ---
 234
 235 (TODO list after discussion 11.05.2009)
 236
 237 * shrink tc/brctl/ip
 238   tc/brctl seem like fairly large things to try and tackle in your timeframe,
 239   and i think people have posted attempts in the past. Adding additional
 240   options to ip though seems reasonable.
 241
 242 * add tests for some applets
 243
 244 * implement POSIX utilities and audit them for POSIX conformance. then
 245   audit them for GNU conformance. then document all your findings in a new
 246   doc/conformance.txt file while perhaps implementing some of the missing
 247   features.
 248   you can find the latest POSIX documentation (1003.1-2008) here:
 249   http://www.opengroup.org/onlinepubs/9699919799/
 250   and the complete list of all utilities that POSIX covers:
 251   http://www.opengroup.org/onlinepubs/9699919799/idx/utilities.html
 252   The first step would to generate a file/matrix what is already archived
 253   (also IPV6)
 254
 255 * implement 'at'
 256
 257 * rpcbind (former portmap) or equivalent
 258   so that we don't have to use -o nolock on nfs mounts
 259
 260 * check IPV6 compliance
 261
 262 * generate a mini example using kernel+busybox only (+libc) for example
 263
 264 * more support for advanced linux 2.6.x features, see: iotop
 265   most likely there is more
 266
 267 * even more support for statistics: mpstat, iostat, powertop....