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