guestfs.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 guestfs - Library for accessing and modifying virtual machine images
   6
   7 =head1 SYNOPSIS
   8
   9  #include <guestfs.h>
  10
  11  guestfs_h *handle = guestfs_create ();
  12  guestfs_add_drive (handle, "guest.img");
  13  guestfs_launch (handle);
  14  guestfs_wait_ready (handle);
  15  guestfs_mount (handle, "/dev/sda1", "/");
  16  guestfs_touch (handle, "/hello");
  17  guestfs_sync (handle);
  18  guestfs_close (handle);
  19
  20 =head1 DESCRIPTION
  21
  22 Libguestfs is a library for accessing and modifying guest disk images.
  23 Amongst the things this is good for: making batch configuration
  24 changes to guests, getting disk used/free statistics (see also:
  25 virt-df), migrating between virtualization systems (see also:
  26 virt-p2v), performing partial backups, performing partial guest
  27 clones, cloning guests and changing registry/UUID/hostname info, and
  28 much else besides.
  29
  30 Libguestfs uses Linux kernel and qemu code, and can access any type of
  31 guest filesystem that Linux and qemu can, including but not limited
  32 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
  33 schemes, qcow, qcow2, vmdk.
  34
  35 Libguestfs provides ways to enumerate guest storage (eg. partitions,
  36 LVs, what filesystem is in each LV, etc.).  It can also run commands
  37 in the context of the guest.  Also you can mount guest filesystems on
  38 the host (requires root privs and NFS).
  39
  40 Libguestfs is a library that can be linked with C and C++ management
  41 programs (or management programs written in other languages, if people
  42 contribute the language bindings).  You can also use it from shell
  43 scripts or the command line.
  44
  45 You don't need to be root to use libguestfs, although obviously you do
  46 need enough permissions to access the disk images.
  47
  48 =head1 CONNECTION MANAGEMENT
  49
  50 If you are using the high-level API, then you should call the
  51 functions in the following order:
  52
  53  guestfs_h *handle = guestfs_create ();
  54
  55  guestfs_add_drive (handle, "guest.img");
  56  /* call guestfs_add_drive additional times if the guest has
  57   * multiple disks
  58   */
  59
  60  guestfs_launch (handle);
  61  guestfs_wait_ready (handle);
  62
  63  /* now you can examine what partitions, LVs etc are available
  64   * you have to mount / at least
  65   */
  66  guestfs_mount (handle, "/dev/sda1", "/");
  67
  68  /* now you can perform actions on the guest disk image */
  69  guestfs_touch (handle, "/hello");
  70
  71  /* you only need to call guestfs_sync if you have made
  72   * changes to the guest image
  73   */
  74  guestfs_sync (handle);
  75
  76  guestfs_close (handle);
  77
  78 C<guestfs_wait_ready> and all of the actions including C<guestfs_sync>
  79 are blocking calls.  You can use the low-level event API to do
  80 non-blocking operations instead.
  81
  82 All functions that return integers, return C<-1> on error.  See
  83 section ERROR HANDLING below for how to handle errors.
  84
  85 =head2 guestfs_h *
  86
  87 C<guestfs_h> is the opaque type representing a connection handle.
  88 Create a handle by calling C<guestfs_create>.  Call C<guestfs_close>
  89 to free the handle and release all resources used.
  90
  91 Handles and operations on handles are not thread safe.  However you
  92 can use a separate handle for each thread (but not on the same disk
  93 image).
  94
  95 =head2 guestfs_create
  96
  97  guestfs_h *guestfs_create (void);
  98
  99 Create a connection handle.
 100
 101 You have to call C<guestfs_add_drive> on the handle at least once.
 102 See CONFIGURATION MANAGEMENT section below.
 103
 104 This function returns a non-NULL pointer to a handle on success or
 105 NULL on error.
 106
 107 After configuring the handle, you have to call C<guestfs_launch> and
 108 C<guestfs_wait_ready>.
 109
 110 You may also want to configure error handling for the handle.  See
 111 ERROR HANDLING section below.
 112
 113 =head2 guestfs_close
 114
 115  void guestfs_close (guestfs_h *handle);
 116
 117 This closes the connection handle and frees up all resources used.
 118
 119 =head2 guestfs_launch, guestfs_wait_ready
 120
 121  int guestfs_launch (guestfs_h *handle);
 122  int guestfs_wait_ready (guestfs_h *handle);
 123
 124 Internally libguestfs is implemented by running a virtual machine
 125 using L<qemu(1)>.  These calls are necessary in order to boot the
 126 virtual machine.  More discussion of this is available in the section
 127 STATE MACHINE AND LOW-LEVEL EVENT API below.
 128
 129 You should call these two functions after configuring the handle
 130 (eg. adding drives) but before performing any actions.
 131
 132 =head2 guestfs_kill_subprocess
 133
 134  int guestfs_kill_subprocess (guestfs_h *handle);
 135
 136 This kills the qemu subprocess.  You should never need to call this.
 137
 138 =head1 CONFIGURATION MANAGEMENT
 139
 140 The configuration functions allow you to configure which drive images
 141 will be examined or modified, and set other aspects of the L<qemu(1)>
 142 virtual machine that we will be running.  You need to call only
 143 C<guestfs_add_drive> at least once for each guest image that you want
 144 to examine.
 145
 146 =head2 guestfs_add_drive
 147
 148  int guestfs_add_drive (guestfs_h *handle, const char *filename);
 149
 150 This function adds a virtual machine disk image C<filename> to the
 151 guest.  The first time you call this function, the disk appears as IDE
 152 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
 153 so on.
 154
 155 You don't necessarily need to be root when using libguestfs.  However
 156 you obviously do need sufficient permissions to access the filename
 157 for whatever operations you want to perform (ie. read access if you
 158 just want to read the image or write access if you want to modify the
 159 image).
 160
 161 This is equivalent to the qemu parameter C<-drive file=filename>.
 162
 163 =head2 guestfs_add_cdrom
 164
 165  int guestfs_add_cdrom (guestfs_h *handle, const char *filename);
 166
 167 This function adds a virtual CD-ROM disk image to the guest.
 168
 169 This is equivalent to the qemu parameter C<-cdrom filename>.
 170
 171 =head2 guestfs_config
 172
 173  int guestfs_config (guestfs_h *handle,
 174                      const char *qemu_param, const char *qemu_value);
 175
 176 This can be used to add arbitrary qemu command line parameters
 177 of the form C<-param value>.  Actually it's not quite arbitrary - we
 178 prevent you from setting some parameters which would interfere with
 179 parameters that we use.
 180
 181 The first character of C<qemu_param> string must be a C<-> (dash).
 182
 183 C<qemu_value> can be NULL.
 184
 185 =head1 ERROR HANDLING
 186
 187 The convention in all functions that return C<int> is that they return
 188 C<-1> to indicate an error.  You can get additional information on
 189 errors by calling C<guestfs_set_error_handler>.  The default error
 190 handler prints the information string to C<stderr>.
 191
 192 Out of memory errors are handled differently.  The default action is
 193 to call L<abort(3)>.  If this is undesirable, then you can set a
 194 handler using C<guestfs_set_out_of_memory_handler>.
 195
 196 =head2 guestfs_set_error_handler
 197
 198  typedef void (*guestfs_error_handler_cb) (guestfs_h *handle,
 199                                            void *data,
 200                                            const char *msg);
 201  void guestfs_set_error_handler (guestfs_h *handle,
 202                                  guestfs_error_handler_cb cb,
 203                                  void *data);
 204
 205 The callback C<cb> will be called if there is an error.  The
 206 parameters passed to the callback are an opaque data pointer and the
 207 error message string.
 208
 209 The default handler prints messages on C<stderr>.
 210
 211 If you set C<cb> to C<NULL> then I<no> handler is called and the error
 212 message is completely discarded.
 213
 214 =head2 guestfs_get_error_handler
 215
 216  guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *handle,
 217                                                      void **data_rtn);
 218
 219 Returns the current error handler callback.
 220
 221 =head2 guestfs_set_out_of_memory_handler
 222
 223  typedef void (*guestfs_abort_cb) (void);
 224  int guestfs_set_out_of_memory_handler (guestfs_h *handle,
 225                                         guestfs_abort_cb);
 226
 227 The callback C<cb> will be called if there is an out of memory
 228 situation.  I<Note this callback must not return>.
 229
 230 The default is to call L<abort(3)>.
 231
 232 You cannot set C<cb> to C<NULL>.  You can't ignore out of memory
 233 situations.
 234
 235 =head2 guestfs_get_out_of_memory_handler
 236
 237  guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *handle);
 238
 239 This returns the current out of memory handler.
 240
 241 =head1 VERBOSE MESSAGES
 242
 243 =head2 guestfs_set_verbose
 244
 245  void guestfs_set_verbose (guestfs_h *handle, int verbose);
 246
 247 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
 248
 249 Verbose messages are disabled unless the environment variable
 250 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
 251
 252 =head2 guestfs_get_verbose
 253
 254  int guestfs_get_verbose (guestfs_h *handle);
 255
 256 This returns the verbose messages flag.
 257
 258 =head1 HIGH-LEVEL API ACTIONS
 259
 260 =head2 guestfs_sync
 261
 262  int guestfs_sync (guestfs_h *handle);
 263
 264 This syncs the disk, so that any writes are flushed through to the
 265 underlying disk image.
 266
 267 You should always call this if you have modified a disk image, before
 268 calling C<guestfs_close>.
 269
 270 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 271
 272 Documentation will be auto-generated from here, including for
 273 guestfs_sync.
 274
 275 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 276
 277  do_[action] ([parameters])
 278  {
 279    guestfs_set_reply_callback (handle, [action]_cb, data);
 280    guestfs_nb_[action] (handle, [parameters ...]);
 281
 282    guestfs_main_loop_run (); /* --> blocks, then calls my_cb */
 283  }
 284
 285  [action]_cb (guestfs_h *handle, void *data)
 286  {
 287    retval = guestfs_nb_[action]_r (handle);
 288    /* ... */
 289    guestfs_main_loop_quit ();
 290    return retval;
 291  }
 292
 293 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 294
 295
 296
 297
 298
 299
 300
 301
 302 =head1 STATE MACHINE AND LOW-LEVEL EVENT API
 303
 304 Internally, libguestfs is implemented by running a virtual machine
 305 using L<qemu(1)>.  QEmu runs as a child process of the main program,
 306 and most of this discussion won't make sense unless you understand
 307 that the complexity is dealing with the (asynchronous) actions of the
 308 child process.
 309
 310                             child process
 311   ___________________       _________________________
 312  /                   \     /                         \
 313  | main program      |     | qemu +-----------------+|
 314  |                   |     |      | Linux kernel    ||
 315  +-------------------+     |      +-----------------+|
 316  | libguestfs     <-------------->| guestfsd        ||
 317  |                   |     |      +-----------------+|
 318  \___________________/     \_________________________/
 319
 320 The diagram above shows libguestfs communicating with the guestfsd
 321 daemon running inside the qemu child process.  There are several
 322 points of failure here: qemu can fail to start, the virtual machine
 323 inside qemu can fail to boot, guestfsd can fail to start or not
 324 establish communication, any component can start successfully but fail
 325 asynchronously later, and so on.
 326
 327 =head2 STATE MACHINE
 328
 329 libguestfs uses a state machine to model the child process:
 330
 331                          |
 332                     guestfs_create
 333                          |
 334                          |
 335                      ____V_____
 336                     /          \
 337                     |  CONFIG  |
 338                     \__________/
 339                      ^ ^   ^  \
 340                     /  |    \  \ guestfs_launch
 341                    /   |    _\__V______
 342                   /    |   /           \
 343                  /     |   | LAUNCHING |
 344                 /      |   \___________/
 345                /       |       /
 346               /        |  guestfs_wait_ready
 347              /         |     /
 348     ______  /        __|____V
 349    /      \ ------> /        \
 350    | BUSY |         | READY  |
 351    \______/ <------ \________/
 352
 353 The normal transitions are (1) CONFIG (when the handle is created, but
 354 there is no child process), (2) LAUNCHING (when the child process is
 355 booting up), (3) alternating between READY and BUSY as commands are
 356 issued to, and carried out by, the child process.
 357
 358 The guest may be killed by C<guestfs_kill_subprocess>, or may die
 359 asynchronously at any time (eg. due to some internal error), and that
 360 causes the state to transition back to CONFIG.
 361
 362 Configuration commands for qemu such as C<guestfs_add_drive> can only
 363 be issued when in the CONFIG state.
 364
 365 The high-level API offers two calls that go from CONFIG through
 366 LAUNCHING to READY.  C<guestfs_launch> is a non-blocking call that
 367 starts up the child process, immediately moving from CONFIG to
 368 LAUNCHING.  C<guestfs_wait_ready> blocks until the child process is
 369 READY to accept commands (or until some failure or timeout).  The
 370 low-level event API described below provides a non-blocking way to
 371 replace C<guestfs_wait_ready>.
 372
 373 High-level API actions such as C<guestfs_mount> can only be issued
 374 when in the READY state.  These high-level API calls block waiting for
 375 the command to be carried out (ie. the state to transition to BUSY and
 376 then back to READY).  But using the low-level event API, you get
 377 non-blocking versions.  (But you can still only carry out one
 378 operation per handle at a time - that is a limitation of the
 379 communications protocol we use).
 380
 381 Finally, the child process sends asynchronous messages back to the
 382 main program, such as kernel log messages.  Mostly these are ignored
 383 by the high-level API, but using the low-level event API you can
 384 register to receive these messages.
 385
 386 =head2 SETTING CALLBACKS TO HANDLE EVENTS
 387
 388 The child process generates events in some situations.  Current events
 389 include: receiving a reply message after some action, receiving a log
 390 message, the child process exits, &c.
 391
 392 Use the C<guestfs_set_*_callback> functions to set a callback for
 393 different types of events.
 394
 395 Only I<one callback of each type> can be registered for each handle.
 396 Calling C<guestfs_set_*_callback> again overwrites the previous
 397 callback of that type.  Cancel all callbacks of this type by calling
 398 this function with C<cb> set to C<NULL>.
 399
 400 =head2 NON-BLOCKING ACTIONS
 401
 402 C<guestfs_set_reply_callback> is the most interesting callback to
 403 play with, since it allows you to perform actions without blocking.
 404
 405 For example:
 406
 407  do_it ()
 408  {
 409    start_call ();
 410    guestfs_main_loop_run (); /* --> blocks, then calls my_cb */
 411  }
 412
 413  start_call ()
 414  {
 415    guestfs_set_reply_callback (handle, my_cb, data);
 416    guestfs_nb_[action] (handle, [other parameters ...]);
 417    /* returns immediately */
 418  }
 419
 420  my_cb (guestfs_h *handle, void *data)
 421  {
 422    retval = guestfs_nb_[action]_r (handle);
 423    /* ... */
 424  }
 425
 426 There are C<guestfs_nb_*> and C<guestfs_nb_*_r> functions
 427 corresponding to (very nearly) every C<guestfs_*> action in the
 428 high-level API.
 429
 430 =head2 guestfs_set_reply_callback
 431
 432  void guestfs_set_reply_callback (guestfs_h *handle,
 433                                   guestfs_reply_cb cb,
 434                                   void *opaque);
 435
 436 The callback function C<cb> will be called whenever a reply is
 437 received from the child process.  (This corresponds to a transition
 438 from the BUSY state to the READY state).
 439
 440 =head2 guestfs_set_log_message_callback
 441
 442  void guestfs_set_log_message_callback (guestfs_h *handle,
 443                                         guestfs_log_message_cb cb,
 444                                         void *opaque);
 445
 446 The callback function C<cb> will be called whenever qemu or the guest
 447 writes anything to the console.
 448
 449 Use this function to capture kernel messages and similar.
 450
 451 Normally there is no log message handler, and log messages are just
 452 discarded.
 453
 454 =head2 guestfs_set_subprocess_quit_callback
 455
 456  void guestfs_set_subprocess_quit_callback (guestfs_h *handle,
 457                                             guestfs_subprocess_quit_cb cb,
 458                                             void *opaque);
 459
 460 The callback function C<cb> will be called when the child process
 461 quits, either asynchronously or if killed by
 462 C<guestfs_kill_subprocess>.  (This corresponds to a transition from
 463 any state to the CONFIG state).
 464
 465 =head2 guestfs_set_launch_done_callback
 466
 467  void guestfs_set_launch_done_callback (guestfs_h *handle,
 468                                         guestfs_ready_cb cb,
 469                                         void *opaque);
 470
 471 The callback function C<cb> will be called when the child process
 472 becomes ready first time after it has been launched.  (This
 473 corresponds to a transition from LAUNCHING to the READY state).
 474
 475 You can use this instead of C<guestfs_wait_ready> to implement a
 476 non-blocking wait for the child process to finish booting up.
 477
 478 =head2 EVENT MAIN LOOP
 479
 480 To use the low-level event API, you have to provide an event "main
 481 loop".  You can write your own, but if you don't want to write one,
 482 two are provided for you:
 483
 484 =over 4
 485
 486 =item libguestfs-select
 487
 488 A simple main loop that is implemented using L<select(2)>.
 489
 490 This is the default main loop unless you call C<guestfs_set_main_loop>
 491 or C<guestfs_glib_set_main_loop>.
 492
 493 =item libguestfs-glib
 494
 495 An implementation which can be used with GLib and GTK+ programs.  You
 496 can use this to write graphical (GTK+) programs which use libguestfs
 497 without hanging during long or slow operations.
 498
 499 =back
 500
 501 =head2 guestfs_set_main_loop
 502
 503  void guestfs_set_main_loop (guestfs_main_loop *);
 504
 505 This call sets the current main loop to the list of callbacks
 506 contained in the C<guestfs_main_loop> structure.
 507
 508 Only one main loop implementation can be used by libguestfs, so
 509 calling this replaces the previous one.  (So this is something that
 510 has to be done by the main program, but only the main program "knows"
 511 that it is a GTK+ program or whatever).
 512
 513 You should call this early in the main program, certainly before
 514 calling C<guestfs_create>.
 515
 516 =head2 guestfs_glib_set_main_loop
 517
 518  void guestfs_glib_set_main_loop (GMainLoop *);
 519
 520 This helper calls C<guestfs_set_main_loop> with the correct callbacks
 521 for integrating with the GLib main loop.
 522
 523 The libguestfs-glib main loop is contained in a separate library, so
 524 that libguestfs doesn't depend on the whole of GLib:
 525
 526  #include <glib.h>
 527  #include <guestfs-glib.h>
 528
 529  main ()
 530  {
 531    GMainLoop *loop =
 532      g_main_loop_new (g_main_context_default (), 1);
 533    ...
 534    guestfs_glib_set_main_loop (loop);
 535    ...
 536    g_main_loop_run (loop);
 537  }
 538
 539 To use this main loop you must link with C<-lguestfs-glib>.  (See also
 540 the GLib and GTK+ documentation).
 541
 542 =head2 guestfs_main_loop_run
 543
 544  void guestfs_main_loop_run (void);
 545
 546 This calls the main loop.
 547
 548 For some types of main loop you may want or prefer to call another
 549 function, eg. C<g_main_loop_run>, or the main loop may already be
 550 invoked by another part of your program.  In those cases, ignore this
 551 call.
 552
 553 =head2 guestfs_main_loop_quit
 554
 555  void guestfs_main_loop_quit (void);
 556
 557 This instructs the main loop to quit.  In other words,
 558 C<guestfs_main_loop_run> will return.
 559
 560 For some types of main loop you may want or prefer to call another
 561 function, eg. C<g_main_loop_quit>.  In those cases, ignore this call.
 562
 563 =head2 WRITING A CUSTOM MAIN LOOP
 564
 565 This isn't documented.  Please see the libguestfs-select and
 566 libguestfs-glib implementations.
 567
 568 =head1 SEE ALSO
 569
 570 L<qemu(1)>
 571
 572
 573
 574
 575
 576 =head1 AUTHORS
 577
 578 Richard W.M. Jones (C<rjones at redhat dot com>)
 579
 580 =head1 COPYRIGHT
 581
 582 Copyright (C) 2009 Red Hat Inc.
 583 L<http://et.redhat.com/~rjones/libguestfs>
 584
 585 This library is free software; you can redistribute it and/or
 586 modify it under the terms of the GNU Lesser General Public
 587 License as published by the Free Software Foundation; either
 588 version 2 of the License, or (at your option) any later version.
 589
 590 This library is distributed in the hope that it will be useful,
 591 but WITHOUT ANY WARRANTY; without even the implied warranty of
 592 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 593 Lesser General Public License for more details.
 594
 595 You should have received a copy of the GNU Lesser General Public
 596 License along with this library; if not, write to the Free Software
 597 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA