TODO

   1 TODO list for libguestfs
   2 ======================================================================
   3
   4 This list contains random ideas and musings on features we could add
   5 to libguestfs in future.
   6
   7    - RWMJ
   8
   9 Python bindings
  10 ---------------
  11
  12 Ideas for the Python bindings:
  13 https://www.redhat.com/archives/fedora-virt/2009-April/msg00114.html
  14
  15 FTP server or FUSE?
  16 -------------------
  17
  18 Originally we had intended to implement an NFS server inside the
  19 appliance, which would allow the guest filesystems to be mounted on
  20 the host, and large changes to be made.  We eventually rejected the
  21 idea of using NFS, partly because it requires root to mount
  22 filesystems in the host, and partly because of problems handling UID
  23 mappings between host and guest filesystem.
  24
  25 Then we look at implementing an FTP server instead.  FTP clients are
  26 widely available for many languages, don't require root, and don't
  27 have any UID mapping problems.  However there is the problem of
  28 getting the TCP connection into the guest, and that FTP requires a
  29 secondary data connection either in or out of the guest (the NFS
  30 situation is even more dire).
  31
  32 Thirdly we looked at implementing a FUSE-based filesystem.  This is
  33 plausible - it could be implemented just by adding the additional FUSE
  34 operations to the standard guestfs(3) API, and then implementing a
  35 simple FUSE daemon.  (The FUSE website has some very helpful
  36 documentation and examples).  I [RWMJ] am not particularly convinced
  37 that a FUSE-based filesystem would really be useful to anyone, but am
  38 prepared to accept patches if someone does all the work.
  39
  40 See also the mountlo project:
  41 http://sourceforge.net/project/showfiles.php?group_id=121684&package_id=150116
  42
  43 BufferIn
  44 --------
  45
  46 BufferIn should turn into <char *, int> and simple strings in other
  47 languages that can handle 8 bit clean strings.
  48
  49 Limit on transfers would still be 2MB for these types.
  50  - then implement write-file properly
  51
  52 febootstrap / debootstrap inside appliance
  53 ------------------------------------------
  54
  55 This was originally proposed as a way to install new operating systems
  56 in the appliance.  However no one has come up with a workable
  57 solution.
  58
  59 Haskell bindings
  60 ----------------
  61
  62 Complete the Haskell bindings (see discussion on haskell-cafe).
  63
  64 Complete bind tests
  65 -------------------
  66
  67 Complete the bind tests - must test the return values and error cases.
  68
  69 virt-inspector - make libvirt XML
  70 ---------------------------------
  71
  72 It should be possible to generate libvirt XML from virt-inspector
  73 data, at least partially.  This would be just another output type so:
  74
  75  virt-inspector --libvirt guest.img
  76
  77 Note that recent versions of libvirt/virt-install allow guests to be
  78 imported, so this is not so useful any more.
  79
  80 "Standalone/local mode"
  81 -----------------------
  82
  83 Instead of running guestfsd (the daemon) inside qemu, there should be
  84 an option to just run guestfsd directly.
  85
  86 The architecture in this mode would look like:
  87
  88      +------------------+
  89      | main program     |
  90      |------------------|
  91      | libguestfs       |
  92      +--------^---------+
  93           |   | reply
  94       cmd |   |
  95      +----v-------------+
  96      | guestfsd         |
  97      +------------------+
  98
  99 Notes:
 100
 101 (1) This only makes sense if we are running as root.
 102
 103 (2) There is no console / kernel messages in this configuration, but
 104 we might consider capturing stderr from the daemon.
 105
 106 (3) guestfs_config and guestfs_add_drive become no-ops.
 107
 108 Obviously in this configuration, commands are run directly on the
 109 local machine's disks.  You could just run the commands themselves
 110 directly, but libguestfs provides a convenient API and language
 111 bindings.  Also deals with tricky stuff like parsing the output of the
 112 LVM commands.  Also we get to leverage other code such as
 113 virt-inspector.
 114
 115 This is mainly useful from live CDs, ie. virt-p2v.
 116
 117 Should we bother having the daemon at all and just link the guestfsd
 118 code directly into libguestfs?
 119
 120 PPC problems
 121 ------------
 122
 123 [This section should be filed as bugs, but no one seems to care for
 124 PPC hosts and the hardware is rapidly becoming obsolete]
 125
 126   ppc (32 bit) works with qemu from git, however there is no serial console
 127
 128   ppc64 requires extra parameters:
 129     -M mac99 -cpu ppc64
 130   however it still fails:
 131     invalid/unsupported opcode: 01 - 01 - 1a (06301e83) 00000000018c2738 1
 132     invalid bits: 00400000 for opcode: 0b - 19 - 15 (2d746572) 0000000000009230
 133
 134   no serial console in ppc or ppc64 because no one can tell us what
 135   console=ttyXX option to use
 136
 137 Supermin appliance to febootstrap
 138 ---------------------------------
 139
 140 Supermin appliance functionality should be moved into febootstrap.
 141
 142 Ideas for extra commands
 143 ------------------------
 144
 145   General glibc / core programs:
 146     chgrp
 147     dd (?)
 148     utime / utimes / futimes / futimens / l..
 149     more mk*temp calls
 150     trunc[ate??]
 151
 152   ext2 properties:
 153     chattr
 154     lsattr
 155     badblocks
 156     blkid
 157     debugfs
 158     dumpe2fs
 159     e2image
 160     e2undo
 161     filefrag
 162     findfs
 163     logsave
 164     mklost+found
 165
 166   SELinux:
 167     chcat
 168     restorecon
 169     ch???
 170
 171   Oddball:
 172     pivot_root
 173     fts(3) / ftw(3)
 174
 175 Other initrd-* commands
 176 -----------------------
 177
 178 Such as:
 179
 180 initrd-extract
 181 initrd-replace
 182
 183 Simple editing of configuration files
 184 -------------------------------------
 185
 186 Some easy non-Augeas methods to edit configuration files.
 187 I'm thinking:
 188
 189   replace /etc/file key value
 190
 191 which would look in /etc/file for any instances of
 192
 193   key=...
 194   key ...
 195   key:...
 196
 197 and replace them with
 198
 199   key=value
 200   key value
 201   key:value
 202
 203 That would solve about 50% of reconfiguration needs, and for the
 204 rest you'd use Augeas, 'download'+'upload' or 'edit'.
 205
 206 RWMJ: I had a go at implementing this, but it's quite error-prone to
 207 do this sort of editing inside the C-based daemon code.  It's far
 208 better to do it with Augeas, or else to use an external language like
 209 Perl.
 210
 211 Quick Perl scripts
 212 ------------------
 213
 214 Currently we can't do Perl "one-liners".  ie. The current syntax for
 215 any short Perl one-liner would be:
 216
 217   perl -MSys::Guestfs -e '$g = Sys::Guestfs->new(); $g->add_drive ("foo"); $g->launch; $g->wait_ready; $g->mount ("/dev/sda1", "/"); ....'
 218
 219 You can see we're well beyond a single line just getting to the point
 220 of adding drives and mounting.
 221
 222 First suggestion:
 223
 224  $h = create ($filename, \"/dev/sda1\" => \"/\");
 225
 226  $h = create ([$file1, $file2], \"/dev/sda1\" => \"/\");
 227
 228 To mount read-only, add C<ro =E<gt> 1> like this:
 229
 230  $h = create ($filename, \"/dev/sda1\" => \"/\", ro => 1);
 231
 232 which is equivalent to the following sequence of calls:
 233
 234  $h = Sys::Guestfs->new ();
 235  $h->set_autosync (1);
 236  $h->add_drive_ro ($filename);
 237  $h->launch ();
 238  $h->wait_ready ();
 239  $h->mount_ro (\"/dev/sda1\", \"/\");
 240
 241 Command-line form would be:
 242
 243  perl -MSys::Guestfs=:all -e '$_=create("guest.img", "/dev/sda1" => "/"); $_->cat ("/etc/fstab");'
 244
 245 That's not brief enough for one-liners, so we could have an extra
 246 autogenerated module which creates a Sys::Guestfs handle singleton
 247 (the handle is an implicit global variable as in guestfish), eg:
 248
 249  perl -MSys::Guestfs::One -e 'inspect("guest.img"); cat ("/etc/fstab");'
 250
 251 How would editing files work?
 252
 253 ntfsclone
 254 ---------
 255
 256 Useful imaging tool:
 257 http://man.linux-ntfs.org/ntfsclone.8.html