Generated code for 'glob-expand'.
[libguestfs.git] / 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 OCaml, Perl, Python, Ruby, Java
41 or Haskell).  You can also use it from shell scripts or the command line.
42
43 You don't need to be root to use libguestfs, although obviously you do
44 need enough permissions to access the disk images.
45
46 =head1 CONNECTION MANAGEMENT
47
48 If you are using the high-level API, then you should call the
49 functions in the following order:
50
51  guestfs_h *handle = guestfs_create ();
52  
53  guestfs_add_drive (handle, "guest.img");
54  /* call guestfs_add_drive additional times if the guest has
55   * multiple disks
56   */
57  
58  guestfs_launch (handle);
59  guestfs_wait_ready (handle);
60
61  /* now you can examine what partitions, LVs etc are available
62   * you have to mount / at least
63   */ 
64  guestfs_mount (handle, "/dev/sda1", "/");
65
66  /* now you can perform actions on the guest disk image */
67  guestfs_touch (handle, "/hello");
68  
69  /* you only need to call guestfs_sync if you have made
70   * changes to the guest image
71   */
72  guestfs_sync (handle);
73  
74  guestfs_close (handle);
75
76 C<guestfs_wait_ready> and all of the actions including C<guestfs_sync>
77 are blocking calls.  You can use the low-level event API to do
78 non-blocking operations instead.
79
80 All functions that return integers, return C<-1> on error.  See
81 section ERROR HANDLING below for how to handle errors.
82
83 =head2 guestfs_h *
84
85 C<guestfs_h> is the opaque type representing a connection handle.
86 Create a handle by calling C<guestfs_create>.  Call C<guestfs_close>
87 to free the handle and release all resources used.
88
89 For information on using multiple handles and threads, see the section
90 MULTIPLE HANDLES AND MULTIPLE THREADS below.
91
92 =head2 guestfs_create
93
94  guestfs_h *guestfs_create (void);
95
96 Create a connection handle.
97
98 You have to call C<guestfs_add_drive> on the handle at least once.
99
100 This function returns a non-NULL pointer to a handle on success or
101 NULL on error.
102
103 After configuring the handle, you have to call C<guestfs_launch> and
104 C<guestfs_wait_ready>.
105
106 You may also want to configure error handling for the handle.  See
107 ERROR HANDLING section below.
108
109 =head2 guestfs_close
110
111  void guestfs_close (guestfs_h *handle);
112
113 This closes the connection handle and frees up all resources used.
114
115 =head1 ERROR HANDLING
116
117 The convention in all functions that return C<int> is that they return
118 C<-1> to indicate an error.  You can get additional information on
119 errors by calling C<guestfs_last_error> and/or by setting up an error
120 handler with C<guestfs_set_error_handler>.
121
122 The default error handler prints the information string to C<stderr>.
123
124 Out of memory errors are handled differently.  The default action is
125 to call L<abort(3)>.  If this is undesirable, then you can set a
126 handler using C<guestfs_set_out_of_memory_handler>.
127
128 =head2 guestfs_last_error
129
130  const char *guestfs_last_error (guestfs_h *handle);
131
132 This returns the last error message that happened on C<handle>.  If
133 there has not been an error since the handle was created, then this
134 returns C<NULL>.
135
136 The lifetime of the returned string is until the next error occurs, or
137 C<guestfs_close> is called.
138
139 The error string is not localized (ie. is always in English), because
140 this makes searching for error messages in search engines give the
141 largest number of results.
142
143 =head2 guestfs_set_error_handler
144
145  typedef void (*guestfs_error_handler_cb) (guestfs_h *handle,
146                                            void *data,
147                                            const char *msg);
148  void guestfs_set_error_handler (guestfs_h *handle,
149                                  guestfs_error_handler_cb cb,
150                                  void *data);
151
152 The callback C<cb> will be called if there is an error.  The
153 parameters passed to the callback are an opaque data pointer and the
154 error message string.
155
156 Note that the message string C<msg> is freed as soon as the callback
157 function returns, so if you want to stash it somewhere you must make
158 your own copy.
159
160 The default handler prints messages on C<stderr>.
161
162 If you set C<cb> to C<NULL> then I<no> handler is called.
163
164 =head2 guestfs_get_error_handler
165
166  guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *handle,
167                                                      void **data_rtn);
168
169 Returns the current error handler callback.
170
171 =head2 guestfs_set_out_of_memory_handler 
172
173  typedef void (*guestfs_abort_cb) (void);
174  int guestfs_set_out_of_memory_handler (guestfs_h *handle,
175                                         guestfs_abort_cb);
176
177 The callback C<cb> will be called if there is an out of memory
178 situation.  I<Note this callback must not return>.
179
180 The default is to call L<abort(3)>.
181
182 You cannot set C<cb> to C<NULL>.  You can't ignore out of memory
183 situations.
184
185 =head2 guestfs_get_out_of_memory_handler
186
187  guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *handle);
188
189 This returns the current out of memory handler.
190
191 =head1 PATH
192
193 Libguestfs needs a kernel and initrd.img, which it finds by looking
194 along an internal path.
195
196 By default it looks for these in the directory C<$libdir/guestfs>
197 (eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>).
198
199 Use C<guestfs_set_path> or set the environment variable
200 C<LIBGUESTFS_PATH> to change the directories that libguestfs will
201 search in.  The value is a colon-separated list of paths.  The current
202 directory is I<not> searched unless the path contains an empty element
203 or C<.>.  For example C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would
204 search the current directory and then C</usr/lib/guestfs>.
205
206 =head1 HIGH-LEVEL API ACTIONS
207
208 @ACTIONS@
209
210 =head1 STRUCTURES
211
212 @STRUCTS@
213
214 =head1 STATE MACHINE AND LOW-LEVEL EVENT API
215
216 Internally, libguestfs is implemented by running a virtual machine
217 using L<qemu(1)>.  QEmu runs as a child process of the main program,
218 and most of this discussion won't make sense unless you understand
219 that the complexity is dealing with the (asynchronous) actions of the
220 child process.
221
222                             child process
223   ___________________       _________________________
224  /                   \     /                         \
225  | main program      |     | qemu +-----------------+|
226  |                   |     |      | Linux kernel    ||
227  +-------------------+     |      +-----------------+|
228  | libguestfs     <-------------->| guestfsd        ||
229  |                   |     |      +-----------------+|
230  \___________________/     \_________________________/
231
232 The diagram above shows libguestfs communicating with the guestfsd
233 daemon running inside the qemu child process.  There are several
234 points of failure here: qemu can fail to start, the virtual machine
235 inside qemu can fail to boot, guestfsd can fail to start or not
236 establish communication, any component can start successfully but fail
237 asynchronously later, and so on.
238
239 =head2 STATE MACHINE
240
241 libguestfs uses a state machine to model the child process:
242
243                          |
244                     guestfs_create
245                          |
246                          |
247                      ____V_____
248                     /          \
249                     |  CONFIG  |
250                     \__________/
251                      ^ ^   ^  \
252                     /  |    \  \ guestfs_launch
253                    /   |    _\__V______
254                   /    |   /           \
255                  /     |   | LAUNCHING |
256                 /      |   \___________/
257                /       |       /
258               /        |  guestfs_wait_ready
259              /         |     /
260     ______  /        __|____V
261    /      \ ------> /        \
262    | BUSY |         | READY  |
263    \______/ <------ \________/
264
265 The normal transitions are (1) CONFIG (when the handle is created, but
266 there is no child process), (2) LAUNCHING (when the child process is
267 booting up), (3) alternating between READY and BUSY as commands are
268 issued to, and carried out by, the child process.
269
270 The guest may be killed by C<guestfs_kill_subprocess>, or may die
271 asynchronously at any time (eg. due to some internal error), and that
272 causes the state to transition back to CONFIG.
273
274 Configuration commands for qemu such as C<guestfs_add_drive> can only
275 be issued when in the CONFIG state.
276
277 The high-level API offers two calls that go from CONFIG through
278 LAUNCHING to READY.  C<guestfs_launch> is a non-blocking call that
279 starts up the child process, immediately moving from CONFIG to
280 LAUNCHING.  C<guestfs_wait_ready> blocks until the child process is
281 READY to accept commands (or until some failure or timeout).  The
282 low-level event API described below provides a non-blocking way to
283 replace C<guestfs_wait_ready>.
284
285 High-level API actions such as C<guestfs_mount> can only be issued
286 when in the READY state.  These high-level API calls block waiting for
287 the command to be carried out (ie. the state to transition to BUSY and
288 then back to READY).  But using the low-level event API, you get
289 non-blocking versions.  (But you can still only carry out one
290 operation per handle at a time - that is a limitation of the
291 communications protocol we use).
292
293 Finally, the child process sends asynchronous messages back to the
294 main program, such as kernel log messages.  Mostly these are ignored
295 by the high-level API, but using the low-level event API you can
296 register to receive these messages.
297
298 =head2 SETTING CALLBACKS TO HANDLE EVENTS
299
300 The child process generates events in some situations.  Current events
301 include: receiving a reply message after some action, receiving a log
302 message, the child process exits, &c.
303
304 Use the C<guestfs_set_*_callback> functions to set a callback for
305 different types of events.
306
307 Only I<one callback of each type> can be registered for each handle.
308 Calling C<guestfs_set_*_callback> again overwrites the previous
309 callback of that type.  Cancel all callbacks of this type by calling
310 this function with C<cb> set to C<NULL>.
311
312 =head2 NON-BLOCKING ACTIONS
313
314 XXX This section was documented in previous versions but never
315 implemented in a way which matched the documentation.  For now I have
316 removed the documentation, pending a working implementation.  See also
317 C<src/guestfs-actions.c> in the source.
318
319
320 =head2 guestfs_set_send_callback
321
322  typedef void (*guestfs_send_cb) (guestfs_h *g, void *opaque);
323  void guestfs_set_send_callback (guestfs_h *handle,
324                                  guestfs_send_cb cb,
325                                  void *opaque);
326
327 The callback function C<cb> will be called whenever a message
328 which is queued for sending, has been sent.
329
330 =head2 guestfs_set_reply_callback
331
332  typedef void (*guestfs_reply_cb) (guestfs_h *g, void *opaque, XDR *xdr);
333  void guestfs_set_reply_callback (guestfs_h *handle,
334                                   guestfs_reply_cb cb,
335                                   void *opaque);
336
337 The callback function C<cb> will be called whenever a reply is
338 received from the child process.  (This corresponds to a transition
339 from the BUSY state to the READY state).
340
341 Note that the C<xdr> that you get in the callback is in C<XDR_DECODE>
342 mode, and you need to consume it before you return from the callback
343 function (since it gets destroyed after).
344
345 =head2 guestfs_set_log_message_callback
346
347  typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,
348                                          char *buf, int len);
349  void guestfs_set_log_message_callback (guestfs_h *handle,
350                                         guestfs_log_message_cb cb,
351                                         void *opaque);
352
353 The callback function C<cb> will be called whenever qemu or the guest
354 writes anything to the console.
355
356 Use this function to capture kernel messages and similar.
357
358 Normally there is no log message handler, and log messages are just
359 discarded.
360
361 =head2 guestfs_set_subprocess_quit_callback
362
363  typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);
364  void guestfs_set_subprocess_quit_callback (guestfs_h *handle,
365                                             guestfs_subprocess_quit_cb cb,
366                                             void *opaque);
367
368 The callback function C<cb> will be called when the child process
369 quits, either asynchronously or if killed by
370 C<guestfs_kill_subprocess>.  (This corresponds to a transition from
371 any state to the CONFIG state).
372
373 =head2 guestfs_set_launch_done_callback
374
375  typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);
376  void guestfs_set_launch_done_callback (guestfs_h *handle,
377                                         guestfs_ready_cb cb,
378                                         void *opaque);
379
380 The callback function C<cb> will be called when the child process
381 becomes ready first time after it has been launched.  (This
382 corresponds to a transition from LAUNCHING to the READY state).
383
384 You can use this instead of C<guestfs_wait_ready> to implement a
385 non-blocking wait for the child process to finish booting up.
386
387 =head2 EVENT MAIN LOOP
388
389 To use the low-level event API and/or to use handles from multiple
390 threads, you have to provide an event "main loop".  You can write your
391 own, but if you don't want to write one, two types are provided for
392 you:
393
394 =over 4
395
396 =item libguestfs-select
397
398 A simple main loop that is implemented using L<select(2)>.
399
400 This is the default main loop for new guestfs handles, unless you
401 call C<guestfs_set_main_loop> after a handle is created.
402
403 =item libguestfs-glib
404
405 An implementation which can be used with GLib and GTK+ programs.  You
406 can use this to write graphical (GTK+) programs which use libguestfs
407 without hanging during long or slow operations.
408
409 =back
410
411 =head2 MULTIPLE HANDLES AND MULTIPLE THREADS
412
413 The support for multiple handles and multiple threads is modelled
414 after glib (although doesn't require glib, if you use the select-based
415 main loop).
416
417 L<http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html>
418
419 You will need to create one main loop for each thread that wants to
420 use libguestfs.  Each guestfs handle should be confined to one thread.
421 If you try to pass guestfs handles between threads, you will get
422 undefined results.
423
424 If you only want to use guestfs handles from one thread in your
425 program, but your program has other threads doing other things, then
426 you don't need to do anything special.
427
428 =head2 SINGLE THREAD CASE
429
430 In the single thread case, there is a single select-based main loop
431 created for you.  All guestfs handles will use this main loop to
432 execute high level API actions.
433
434 =head2 MULTIPLE THREADS CASE
435
436 In the multiple threads case, you will need to create a main loop for
437 each thread that wants to use libguestfs.
438
439 To create main loops for other threads, use
440 C<guestfs_create_main_loop> or C<guestfs_glib_create_main_loop>.
441
442 Then you will need to attach each handle to the thread-specific main
443 loop by calling:
444
445  handle = guestfs_create ();
446  guestfs_set_main_loop (handle, main_loop_of_current_thread);
447
448 =head2 guestfs_set_main_loop
449
450  void guestfs_set_main_loop (guestfs_h *handle,
451                              guestfs_main_loop *main_loop);
452
453 Sets the main loop used by high level API actions for this handle.  By
454 default, the select-based main loop is used (see
455 C<guestfs_get_default_main_loop>).
456
457 You only need to use this in multi-threaded programs, where multiple
458 threads want to use libguestfs.  Create a main loop for each thread,
459 then call this function.
460
461 You cannot pass guestfs handles between threads.
462
463 =head2 guestfs_get_main_loop
464
465  guestfs_main_loop *guestfs_get_main_loop (guestfs_h *handle);
466
467 Return the main loop used by C<handle>.
468
469 =head2 guestfs_get_default_main_loop
470
471  guestfs_main_loop *guestfs_get_default_main_loop (void);
472
473 Return the default select-based main loop.
474
475 =head2 guestfs_create_main_loop
476
477  guestfs_main_loop *guestfs_create_main_loop (void);
478
479 This creates a select-based main loop.  You should create one main
480 loop for each additional thread that needs to use libguestfs.
481
482 =head2 guestfs_free_main_loop
483
484  void guestfs_free_main_loop (guestfs_main_loop *);
485
486 Free the select-based main loop which was previously allocated with
487 C<guestfs_create_main_loop>.
488
489 =head2 WRITING A CUSTOM MAIN LOOP
490
491 This isn't documented.  Please see the libguestfs-select and
492 libguestfs-glib implementations.
493
494 =head1 BLOCK DEVICE NAMING
495
496 In the kernel there is now quite a profusion of schemata for naming
497 block devices (in this context, by I<block device> I mean a physical
498 or virtual hard drive).  The original Linux IDE driver used names
499 starting with C</dev/hd*>.  SCSI devices have historically used a
500 different naming scheme, C</dev/sd*>.  When the Linux kernel I<libata>
501 driver became a popular replacement for the old IDE driver
502 (particularly for SATA devices) those devices also used the
503 C</dev/sd*> scheme.  Additionally we now have virtual machines with
504 paravirtualized drivers.  This has created several different naming
505 systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen
506 PV disks.
507
508 As discussed above, libguestfs uses a qemu appliance running an
509 embedded Linux kernel to access block devices.  We can run a variety
510 of appliances based on a variety of Linux kernels.
511
512 This causes a problem for libguestfs because many API calls use device
513 or partition names.  Working scripts and the recipe (example) scripts
514 that we make available over the internet could fail if the naming
515 scheme changes.
516
517 Therefore libguestfs defines C</dev/sd*> as the I<standard naming
518 scheme>.  Internally C</dev/sd*> names are translated, if necessary,
519 to other names as required.  For example, under RHEL 5 which uses the
520 C</dev/hd*> scheme, any device parameter C</dev/sda2> is translated to
521 C</dev/hda2> transparently.
522
523 Note that this I<only> applies to parameters.  The
524 C<guestfs_list_devices>, C<guestfs_list_partitions> and similar calls
525 return the true names of the devices and partitions as known to the
526 appliance.
527
528 =head2 ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION
529
530 Usually this translation is transparent.  However in some (very rare)
531 cases you may need to know the exact algorithm.  Such cases include
532 where you use C<guestfs_config> to add a mixture of virtio and IDE
533 devices to the qemu-based appliance, so have a mixture of C</dev/sd*>
534 and C</dev/vd*> devices.
535
536 The algorithm is applied only to I<parameters> which are known to be
537 either device or partition names.  Return values from functions such
538 as C<guestfs_list_devices> are never changed.
539
540 =over 4
541
542 =item *
543
544 Is the string a parameter which is a device or partition name?
545
546 =item *
547
548 Does the string begin with C</dev/sd>?
549
550 =item *
551
552 Does the named device exist?  If so, we use that device.
553 However if I<not> then we continue with this algorithm.
554
555 =item *
556
557 Replace initial C</dev/sd> string with C</dev/hd>.
558
559 For example, change C</dev/sda2> to C</dev/hda2>.
560
561 If that named device exists, use it.  If not, continue.
562
563 =item *
564
565 Replace initial C</dev/sd> string with C</dev/vd>.
566
567 If that named device exists, use it.  If not, return an error.
568
569 =back
570
571 =head2 PORTABILITY CONCERNS
572
573 Although the standard naming scheme and automatic translation is
574 useful for simple programs and guestfish scripts, for larger programs
575 it is best not to rely on this mechanism.
576
577 Where possible for maximum future portability programs using
578 libguestfs should use these future-proof techniques:
579
580 =over 4
581
582 =item *
583
584 Use C<guestfs_list_devices> or C<guestfs_list_partitions> to list
585 actual device names, and then use those names directly.
586
587 Since those device names exist by definition, they will never be
588 translated.
589
590 =item *
591
592 Use higher level ways to identify filesystems, such as LVM names,
593 UUIDs and filesystem labels.
594
595 =back
596
597 =head1 INTERNALS
598
599 =head2 COMMUNICATION PROTOCOL
600
601 Don't rely on using this protocol directly.  This section documents
602 how it currently works, but it may change at any time.
603
604 The protocol used to talk between the library and the daemon running
605 inside the qemu virtual machine is a simple RPC mechanism built on top
606 of XDR (RFC 1014, RFC 1832, RFC 4506).
607
608 The detailed format of structures is in C<src/guestfs_protocol.x>
609 (note: this file is automatically generated).
610
611 There are two broad cases, ordinary functions that don't have any
612 C<FileIn> and C<FileOut> parameters, which are handled with very
613 simple request/reply messages.  Then there are functions that have any
614 C<FileIn> or C<FileOut> parameters, which use the same request and
615 reply messages, but they may also be followed by files sent using a
616 chunked encoding.
617
618 =head3 ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)
619
620 For ordinary functions, the request message is:
621
622  total length (header + arguments,
623       but not including the length word itself)
624  struct guestfs_message_header (encoded as XDR)
625  struct guestfs_<foo>_args (encoded as XDR)
626
627 The total length field allows the daemon to allocate a fixed size
628 buffer into which it slurps the rest of the message.  As a result, the
629 total length is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently
630 4MB), which means the effective size of any request is limited to
631 somewhere under this size.
632
633 Note also that many functions don't take any arguments, in which case
634 the C<guestfs_I<foo>_args> is completely omitted.
635
636 The header contains the procedure number (C<guestfs_proc>) which is
637 how the receiver knows what type of args structure to expect, or none
638 at all.
639
640 The reply message for ordinary functions is:
641
642  total length (header + ret,
643       but not including the length word itself)
644  struct guestfs_message_header (encoded as XDR)
645  struct guestfs_<foo>_ret (encoded as XDR)
646
647 As above the C<guestfs_I<foo>_ret> structure may be completely omitted
648 for functions that return no formal return values.
649
650 As above the total length of the reply is limited to
651 C<GUESTFS_MESSAGE_MAX>.
652
653 In the case of an error, a flag is set in the header, and the reply
654 message is slightly changed:
655
656  total length (header + error,
657       but not including the length word itself)
658  struct guestfs_message_header (encoded as XDR)
659  struct guestfs_message_error (encoded as XDR)
660
661 The C<guestfs_message_error> structure contains the error message as a
662 string.
663
664 =head3 FUNCTIONS THAT HAVE FILEIN PARAMETERS
665
666 A C<FileIn> parameter indicates that we transfer a file I<into> the
667 guest.  The normal request message is sent (see above).  However this
668 is followed by a sequence of file chunks.
669
670  total length (header + arguments,
671       but not including the length word itself,
672       and not including the chunks)
673  struct guestfs_message_header (encoded as XDR)
674  struct guestfs_<foo>_args (encoded as XDR)
675  sequence of chunks for FileIn param #0
676  sequence of chunks for FileIn param #1 etc.
677
678 The "sequence of chunks" is:
679
680  length of chunk (not including length word itself)
681  struct guestfs_chunk (encoded as XDR)
682  length of chunk
683  struct guestfs_chunk (encoded as XDR)
684    ...
685  length of chunk
686  struct guestfs_chunk (with data.data_len == 0)
687
688 The final chunk has the C<data_len> field set to zero.  Additionally a
689 flag is set in the final chunk to indicate either successful
690 completion or early cancellation.
691
692 At time of writing there are no functions that have more than one
693 FileIn parameter.  However this is (theoretically) supported, by
694 sending the sequence of chunks for each FileIn parameter one after
695 another (from left to right).
696
697 Both the library (sender) I<and> the daemon (receiver) may cancel the
698 transfer.  The library does this by sending a chunk with a special
699 flag set to indicate cancellation.  When the daemon sees this, it
700 cancels the whole RPC, does I<not> send any reply, and goes back to
701 reading the next request.
702
703 The daemon may also cancel.  It does this by writing a special word
704 C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this
705 during the transfer, and if it gets it, it will cancel the transfer
706 (it sends a cancel chunk).  The special word is chosen so that even if
707 cancellation happens right at the end of the transfer (after the
708 library has finished writing and has started listening for the reply),
709 the "spurious" cancel flag will not be confused with the reply
710 message.
711
712 This protocol allows the transfer of arbitrary sized files (no 32 bit
713 limit), and also files where the size is not known in advance
714 (eg. from pipes or sockets).  However the chunks are rather small
715 (C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the
716 daemon need to keep much in memory.
717
718 =head3 FUNCTIONS THAT HAVE FILEOUT PARAMETERS
719
720 The protocol for FileOut parameters is exactly the same as for FileIn
721 parameters, but with the roles of daemon and library reversed.
722
723  total length (header + ret,
724       but not including the length word itself,
725       and not including the chunks)
726  struct guestfs_message_header (encoded as XDR)
727  struct guestfs_<foo>_ret (encoded as XDR)
728  sequence of chunks for FileOut param #0
729  sequence of chunks for FileOut param #1 etc.
730
731 =head3 INITIAL MESSAGE
732
733 Because the underlying channel (QEmu -net channel) doesn't have any
734 sort of connection control, when the daemon launches it sends an
735 initial word (C<GUESTFS_LAUNCH_FLAG>) which indicates that the guest
736 and daemon is alive.  This is what C<guestfs_wait_ready> waits for.
737
738 =head1 QEMU WRAPPERS
739
740 If you want to compile your own qemu, run qemu from a non-standard
741 location, or pass extra arguments to qemu, then you can write a
742 shell-script wrapper around qemu.
743
744 There is one important rule to remember: you I<must C<exec qemu>> as
745 the last command in the shell script (so that qemu replaces the shell
746 and becomes the direct child of the libguestfs-using program).  If you
747 don't do this, then the qemu process won't be cleaned up correctly.
748
749 Here is an example of a wrapper, where I have built my own copy of
750 qemu from source:
751
752  #!/bin/sh -
753  qemudir=/home/rjones/d/qemu
754  exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "$@"
755
756 Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>,
757 and then use it by setting the LIBGUESTFS_QEMU environment variable.
758 For example:
759
760  LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish
761
762 =head1 ENVIRONMENT VARIABLES
763
764 =over 4
765
766 =item LIBGUESTFS_DEBUG
767
768 Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This
769 has the same effect as calling C<guestfs_set_verbose (handle, 1)>.
770
771 =item LIBGUESTFS_PATH
772
773 Set the path that libguestfs uses to search for kernel and initrd.img.
774 See the discussion of paths in section PATH above.
775
776 =item LIBGUESTFS_QEMU
777
778 Set the default qemu binary that libguestfs uses.  If not set, then
779 the qemu which was found at compile time by the configure script is
780 used.
781
782 See also L<QEMU WRAPPERS> above.
783
784 =item LIBGUESTFS_APPEND
785
786 Pass additional options to the guest kernel.
787
788 =back
789
790 =head1 SEE ALSO
791
792 L<guestfish(1)>,
793 L<qemu(1)>,
794 L<febootstrap(1)>,
795 L<http://libguestfs.org/>.
796
797 =head1 BUGS
798
799 To get a list of bugs against libguestfs use this link:
800
801 L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>
802
803 To report a new bug against libguestfs use this link:
804
805 L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>
806
807 When reporting a bug, please check:
808
809 =over 4
810
811 =item *
812
813 That the bug hasn't been reported already.
814
815 =item *
816
817 That you are testing a recent version.
818
819 =item *
820
821 Describe the bug accurately, and give a way to reproduce it.
822
823 =back
824
825 =head1 AUTHORS
826
827 Richard W.M. Jones (C<rjones at redhat dot com>)
828
829 =head1 COPYRIGHT
830
831 Copyright (C) 2009 Red Hat Inc.
832 L<http://libguestfs.org/>
833
834 This library is free software; you can redistribute it and/or
835 modify it under the terms of the GNU Lesser General Public
836 License as published by the Free Software Foundation; either
837 version 2 of the License, or (at your option) any later version.
838
839 This library is distributed in the hope that it will be useful,
840 but WITHOUT ANY WARRANTY; without even the implied warranty of
841 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
842 Lesser General Public License for more details.
843
844 You should have received a copy of the GNU Lesser General Public
845 License along with this library; if not, write to the Free Software
846 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA