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     more mk*temp calls
 149
 150   ext2 properties:
 151     chattr
 152     lsattr
 153     badblocks
 154     blkid
 155     debugfs
 156     dumpe2fs
 157     e2image
 158     e2undo
 159     filefrag
 160     findfs
 161     logsave
 162     mklost+found
 163
 164   SELinux:
 165     chcat
 166     restorecon
 167     ch???
 168
 169   Oddball:
 170     pivot_root
 171     fts(3) / ftw(3)
 172
 173 Other initrd-* commands
 174 -----------------------
 175
 176 Such as:
 177
 178 initrd-extract
 179 initrd-replace
 180
 181 Simple editing of configuration files
 182 -------------------------------------
 183
 184 Some easy non-Augeas methods to edit configuration files.
 185 I'm thinking:
 186
 187   replace /etc/file key value
 188
 189 which would look in /etc/file for any instances of
 190
 191   key=...
 192   key ...
 193   key:...
 194
 195 and replace them with
 196
 197   key=value
 198   key value
 199   key:value
 200
 201 That would solve about 50% of reconfiguration needs, and for the
 202 rest you'd use Augeas, 'download'+'upload' or 'edit'.
 203
 204 RWMJ: I had a go at implementing this, but it's quite error-prone to
 205 do this sort of editing inside the C-based daemon code.  It's far
 206 better to do it with Augeas, or else to use an external language like
 207 Perl.
 208
 209 Quick Perl scripts
 210 ------------------
 211
 212 Currently we can't do Perl "one-liners".  ie. The current syntax for
 213 any short Perl one-liner would be:
 214
 215   perl -MSys::Guestfs -e '$g = Sys::Guestfs->new(); $g->add_drive ("foo"); $g->launch; $g->mount ("/dev/sda1", "/"); ....'
 216
 217 You can see we're well beyond a single line just getting to the point
 218 of adding drives and mounting.
 219
 220 First suggestion:
 221
 222  $h = create ($filename, \"/dev/sda1\" => \"/\");
 223
 224  $h = create ([$file1, $file2], \"/dev/sda1\" => \"/\");
 225
 226 To mount read-only, add C<ro =E<gt> 1> like this:
 227
 228  $h = create ($filename, \"/dev/sda1\" => \"/\", ro => 1);
 229
 230 which is equivalent to the following sequence of calls:
 231
 232  $h = Sys::Guestfs->new ();
 233  $h->set_autosync (1);
 234  $h->add_drive_ro ($filename);
 235  $h->launch ();
 236  $h->mount_ro (\"/dev/sda1\", \"/\");
 237
 238 Command-line form would be:
 239
 240  perl -MSys::Guestfs=:all -e '$_=create("guest.img", "/dev/sda1" => "/"); $_->cat ("/etc/fstab");'
 241
 242 That's not brief enough for one-liners, so we could have an extra
 243 autogenerated module which creates a Sys::Guestfs handle singleton
 244 (the handle is an implicit global variable as in guestfish), eg:
 245
 246  perl -MSys::Guestfs::One -e 'inspect("guest.img"); cat ("/etc/fstab");'
 247
 248 How would editing files work?
 249
 250 ntfsclone
 251 ---------
 252
 253 Useful imaging tool:
 254 http://man.linux-ntfs.org/ntfsclone.8.html
 255
 256 Standard images
 257 ---------------
 258
 259 Equip guestfish with some standard images that it can load
 260 quickly, eg:
 261
 262   load ext2
 263
 264 Maybe it's better to create these on the fly?
 265
 266 virt-rescue pty
 267 ---------------
 268
 269 See:
 270 http://search.cpan.org/~rgiersig/IO-Tty-1.08/Pty.pm
 271 http://www.perlmonks.org/index.pl?node_id=582185
 272
 273 Note that pty requires cooperation inside the C code too (there are
 274 two sides to a pty, and one has to be handled after the fork).
 275
 276 virt-rescue TERM
 277 ----------------
 278
 279 Pass TERM from the library, through the kernel command line, to the
 280 init script.