提交 f39faaa7 编写于 作者: D Daniel Veillard

* docs/*.html: repair the damages made by Amaya on the content

  of documentation following feedback from Simon Hernandez
Daniel
上级 3d6dbfea
Thu Mar 22 16:25:10 CET 2007 Daniel Veillard <veillard@redhat.com>
* docs/*.html: repair the damages made by Amaya on the content
of documentation following feedback from Simon Hernandez
Thu Mar 22 11:35:05 CET 2007 Daniel Veillard <veillard@redhat.com> Thu Mar 22 11:35:05 CET 2007 Daniel Veillard <veillard@redhat.com>
* src/virsh.c: applied patch from Masayuki Sunou to avoid a bug * src/virsh.c: applied patch from Masayuki Sunou to avoid a bug
......
...@@ -8,11 +8,22 @@ Releases ...@@ -8,11 +8,22 @@ Releases
0.2.1: Mar 16 2007: 0.2.1: Mar 16 2007:
- Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin) - Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)
- Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt - Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
config directory (Daniel Berrange and Mark McLoughlin), memory leak in qemud (Mark), various fixes on network support (Mark), avoid Xen domain zombies on device hotplug errors (Daniel Berrange), various fixes on qemud (Mark), config directory (Daniel Berrange and Mark McLoughlin), memory leak
argsparsing (Richard Jones), virsh -t argument (Saori Fukuta), avoid virsh in qemud (Mark), various fixes on network support (Mark), avoid Xen
crash on TAB key (Daniel Berrange), detect xend operation failures (Kazuki Mizushima), don't listen on null socket (Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900 (Nobuhiro Itou), assorted networking fixes domain zombies on device hotplug errors (Daniel Berrange), various
(Daniel Berrange), shutoff and shutdown mismatches (Kazuki Mizushima), unlimited memory handling (Atsushi SAKAI), python binding fixes (Tatsuro Enokura) fixes on qemud (Mark), args parsing (Richard Jones), virsh -t argument
- Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies and build (Daniel Berrange), fix xend port detection (Daniel Berrange), icompile time warnings (Mark), avoid const related compiler warnings (Daniel Berrange), automated builds (Daniel Berrange), pointer/int mismatch (Richard Jones), configure time selection of drivers, libvirt spec hacking (Daniel Berrange) (Saori Fukuta), avoid virsh crash on TAB key (Daniel Berrange), detect
xend operation failures (Kazuki Mizushima), don't listen on null socket
(Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900
(Nobuhiro Itou), assorted networking fixes (Daniel Berrange), shutoff and
shutdown mismatches (Kazuki Mizushima), unlimited memory handling
(Atsushi SAKAI), python binding fixes (Tatsuro Enokura)
- Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
and build (Daniel Berrange), fix xend port detection (Daniel
Berrange), icompile time warnings (Mark), avoid const related
compiler warnings (Daniel Berrange), automated builds (Daniel
Berrange), pointer/int mismatch (Richard Jones), configure time
selection of drivers, libvirt spec hacking (Daniel Berrange)
- Add support for network autostart and init scripts (Mark McLoughlin) - Add support for network autostart and init scripts (Mark McLoughlin)
- New API virConnectGetCapabilities() to detect the virtualization - New API virConnectGetCapabilities() to detect the virtualization
capabilities of a host (Richard Jones) capabilities of a host (Richard Jones)
...@@ -27,14 +38,14 @@ Releases ...@@ -27,14 +38,14 @@ Releases
0.2.0: Feb 14 2007: 0.2.0: Feb 14 2007:
- Various internal cleanups (Mark McLoughlin, Richard Jones,Daniel - Various internal cleanups (Mark McLoughlin, Richard Jones,
Berrange, Karel Zak) Daniel Berrange, Karel Zak)
- Bug fixes: avoid a crash in connect (Daniel Berrange), virsh - Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
argsparsing (Richard Jones) parsing (Richard Jones)
- Add support for QEmu and KVM virtualization (Daniel Berrange) - Add support for QEmu and KVM virtualization (Daniel Berrange)
- Add support for network configuration (Mark McLoughlin) - Add support for network configuration (Mark McLoughlin)
- Minor improvements: regression testing (Daniel Berrange),localization - Minor improvements: regression testing (Daniel Berrange),
string updates localization string updates
0.1.11: Jan 22 2007: 0.1.11: Jan 22 2007:
...@@ -46,18 +57,12 @@ Releases ...@@ -46,18 +57,12 @@ Releases
0.1.10: Dec 20 2006: 0.1.10: Dec 20 2006:
- more localizations - more localizations
- bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains - bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).
buffer overflow (Daniel Berrange), reference count bug when creating Xen - improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).
domains (Daniel Berrange).
- improvements: support graphic framebuffer for Xen paravirt (Daniel
Berrange), VNC listen IP range support (Daniel Berrange), support for
default Xen config files and inactive domains of 3.0.4 (Daniel
Berrange).
0.1.9: Nov 29 2006: 0.1.9: Nov 29 2006:
- python bindings: release interpeter lock when calling C (Daniel - python bindings: release interpeter lock when calling C (Daniel Berrange)
Berrange)
- don't raise HTTP error when looking informations for a domain - don't raise HTTP error when looking informations for a domain
- some refactoring to use the driver for all entry points - some refactoring to use the driver for all entry points
- better error reporting (Daniel Berrange) - better error reporting (Daniel Berrange)
...@@ -65,20 +70,15 @@ Releases ...@@ -65,20 +70,15 @@ Releases
- provide XML parsing errors - provide XML parsing errors
- extension of the test framework (Daniel Berrange) - extension of the test framework (Daniel Berrange)
- fix the reconnect regression test - fix the reconnect regression test
- python bindings: Domain instances now link to the Connect to avoid - python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect
garbage collection and disconnect - separate the notion of maximum memory and current use at the XML level
- separate the notion of maximum memory and current use at the XML
level
- Fix a memory leak (Daniel Berrange) - Fix a memory leak (Daniel Berrange)
- add support for shareable drives - add support for shareable drives
- add support for non-bridge style networking configs for guests(Daniel - add support for non-bridge style networking configs for guests(Daniel Berrange)
Berrange)
- python bindings: fix unsigned long marshalling (Daniel Berrange) - python bindings: fix unsigned long marshalling (Daniel Berrange)
- new config APIs virConfNew() and virConfSetValue() to build configs - new config APIs virConfNew() and virConfSetValue() to build configs from scratch
from scratch
- hot plug device support based on Michel Ponceau patch - hot plug device support based on Michel Ponceau patch
- added support for inactive domains, new APIs, various associated - added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)
cleanup (Daniel Berrange)
- special device model for HVM guests (Daniel Berrange) - special device model for HVM guests (Daniel Berrange)
- add API to dump core of domains (but requires a patched xend) - add API to dump core of domains (but requires a patched xend)
- pygrub bootloader informations take over <os> informations - pygrub bootloader informations take over <os> informations
...@@ -86,78 +86,72 @@ Releases ...@@ -86,78 +86,72 @@ Releases
0.1.8: Oct 16 2006: 0.1.8: Oct 16 2006:
- Bug for system with page size != 4k - Bug for system with page size != 4k
- vcpu number initialization (Philippe Berthault) - vcpu number initialization (Philippe Berthault)
- don't label crashed domains as shut off (Peter Vetere) - don't label crashed domains as shut off (Peter Vetere)
- fix virsh man page (Noriko Mizumoto) - fix virsh man page (Noriko Mizumoto)
- blktapdd support for alternate drivers like blktap (Daniel - blktapdd support for alternate drivers like blktap (Daniel Berrange)
Berrange) - memory leak fixes (xend interface and XML parsing) (Daniel Berrange)
- memory leak fixes (xend interface and XML parsing) (Daniel - compile fix
Berrange) - mlock/munlock size fixes (Daniel Berrange)
- compile fix - improve error reporting
- mlock/munlock size fixes (Daniel Berrange)
- improve error reporting
0.1.7: Sep 29 2006: 0.1.7: Sep 29 2006:
- fix a memory bug on getting vcpu informations from xend (Daniel - fix a memory bug on getting vcpu informations from xend (Daniel Berrange)
Berrange) - fix another problem in the hypercalls change in Xen changeset
- fix another problem in the hypercalls change in Xen 86d26e6ec89b when getting domain informations (Daniel Berrange)
changeset86d26e6ec89b when getting domain informations (Daniel
Berrange)
0.1.6: Sep 22 2006: 0.1.6: Sep 22 2006:
- Support for localization of strings using gettext (Daniel Berrange) - Support for localization of strings using gettext (Daniel Berrange)
- Support for new Xen-3.0.3 cdrom and disk configuration (Daniel - Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)
Berrange) - Support for setting VNC port when creating domains with new
- Support for setting VNC port when creating domains with newxend config xend config files (Daniel Berrange)
files (Daniel Berrange)
- Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig) - Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)
- Fix reconnection problem when talking directly to http xend - Fix reconnection problem when talking directly to http xend
0.1.5: Sep 5 2006: 0.1.5: Sep 5 2006:
- Support for new hypercalls change in Xen changeset 86d26e6ec89b - Support for new hypercalls change in Xen changeset 86d26e6ec89b
- bug fixes: virParseUUID() was wrong, netwoking for paravirt - bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
guestsi(Daniel Berrange), virsh on non-existent domains (Daniel (Daniel Berrange), virsh on non-existent domains (Daniel Berrange),
Berrange),string cast bug when handling error in python (Pete Vetere), string cast bug when handling error in python (Pete Vetere), HTTP
HTTP500 xend error code handling (Pete Vetere and Daniel Berrange) 500 xend error code handling (Pete Vetere and Daniel Berrange)
- improvements: test suite for SEXPR <-> XML format conversions - improvements: test suite for SEXPR <-> XML format conversions (Daniel
(DanielBerrange), virsh output regression suite (Daniel Berrange), new Berrange), virsh output regression suite (Daniel Berrange), new environ
environvariable VIRSH_DEFAULT_CONNECT_URI for the default URI when variable VIRSH_DEFAULT_CONNECT_URI for the default URI when connecting
connecting(Daniel Berrange), graphical console support for paravirt (Daniel Berrange), graphical console support for paravirt guests
guests(Jeremy Katz), parsing of simple Xen config files (with Daniel (Jeremy Katz), parsing of simple Xen config files (with Daniel Berrange),
Berrange),early work on defined (not running) domains (Daniel early work on defined (not running) domains (Daniel Berrange),
Berrange),virsh output improvement (Daniel Berrange virsh output improvement (Daniel Berrange
0.1.4: Aug 16 2006: 0.1.4: Aug 16 2006:
- bug fixes: spec file fix (Mark McLoughlin), error report problem - bug fixes: spec file fix (Mark McLoughlin), error report problem (with
(withHugh Brock), long integer in Python bindings (with Daniel Berrange), Hugh Brock), long integer in Python bindings (with Daniel Berrange), XML
XMLgeneration bug for CDRom (Daniel Berrange), bug whem using number() generation bug for CDRom (Daniel Berrange), bug whem using number() XPath
XPathfunction (Mark McLoughlin), fix python detection code, remove function (Mark McLoughlin), fix python detection code, remove duplicate
duplicateinitialization errors (Daniel Berrange) initialization errors (Daniel Berrange)
- improvements: UUID in XML description (Peter Vetere), proxy - improvements: UUID in XML description (Peter Vetere), proxy code
codecleanup, virtual CPU and affinity support + virsh support cleanup, virtual CPU and affinity support + virsh support (Michel
(MichelPonceau, Philippe Berthault, Daniel Berrange), port and tty Ponceau, Philippe Berthault, Daniel Berrange), port and tty informations
informationsfor console in XML (Daniel Berrange), added XML dump to for console in XML (Daniel Berrange), added XML dump to driver and proxy
driver and proxysupport (Daniel Berrange), extention of boot options with support (Daniel Berrange), extention of boot options with support for
support forfloppy and cdrom (Daniel Berrange), features block in XML to floppy and cdrom (Daniel Berrange), features block in XML to report/ask
report/askPAE, ACPI, APIC for HVM domains (Daniel Berrange), fail PAE, ACPI, APIC for HVM domains (Daniel Berrange), fail saide-effect
saide-effectoperations when using read-only connection, large operations when using read-only connection, large improvements to test
improvements to testdriver (Daniel Berrange) driver (Daniel Berrange)
- documentation: spelling (Daniel Berrange), test driver examples. - documentation: spelling (Daniel Berrange), test driver examples.
0.1.3: Jul 11 2006: 0.1.3: Jul 11 2006:
- bugfixes: build as non-root, fix xend access when root, handling - bugfixes: build as non-root, fix xend access when root, handling of
ofempty XML elements (Mark McLoughlin), XML serialization and parsing empty XML elements (Mark McLoughlin), XML serialization and parsing fixes
fixes(Mark McLoughlin), allow to create domains without disk (Mark McLoughlin), allow to create domains without disk (Mark
(MarkMcLoughlin), McLoughlin),
- improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel - improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
Berrange),support for fully virtualized guest (Jim Fehlig, DV, Mark support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)
McLoughlin)
- documentation: augmented to cover hvm domains - documentation: augmented to cover hvm domains
...@@ -167,57 +161,57 @@ Releases ...@@ -167,57 +161,57 @@ Releases
0.1.1: Jun 21 2006: 0.1.1: Jun 21 2006:
- building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel - building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
P.Berrange) Berrange)
- driver cleanups: new entry points, cleanup of libvirt.c (with Daniel - driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
P.Berrange) Berrange)
- Cope with API change introduced in Xen changeset 10277 - Cope with API change introduced in Xen changeset 10277
- new test driver for regression checks (Daniel P. Berrange) - new test driver for regression checks (Daniel P. Berrange)
- improvements: added UUID to XML serialization, buffer usage (KarelZak), - improvements: added UUID to XML serialization, buffer usage (Karel
--connect argument to virsh (Daniel P. Berrange), Zak), --connect argument to virsh (Daniel P. Berrange),
- bug fixes: uninitialized memory access in error reporting, - bug fixes: uninitialized memory access in error reporting, S-Expr
S-Exprparsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
TODO inxs_internal.c xs_internal.c
- documentation: Python examples (David Lutterkort), new Perl bindingURL, - documentation: Python examples (David Lutterkort), new Perl binding
man page update (Karel Zak) URL, man page update (Karel Zak)
0.1.0: Apr 10 2006: 0.1.0: Apr 10 2006:
- building fixes: --with-xen-distdir option (Ronald Aigner), out of - building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
treebuild and pkginfo cflag fix (Daniel Berrange) build and pkginfo cflag fix (Daniel Berrange)
- enhancement and fixes of the XML description format (David - enhancement and fixes of the XML description format (David Lutterkort
Lutterkortand Jim Fehlig) and Jim Fehlig)
- new APIs: for Node information and Reboot - new APIs: for Node information and Reboot
- internal code cleanup: refactoring internals into a driver model, - internal code cleanup: refactoring internals into a driver model, more
moreerror handling, structure sharing, thread safety and ref counting error handling, structure sharing, thread safety and ref counting
- bug fixes: error message (Jim Meyering), error allocation in virsh - bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
(JimMeyering), virDomainLookupByID (Jim Fehlig), Meyering), virDomainLookupByID (Jim Fehlig),
- documentation: updates on architecture, and format, typo fix - documentation: updates on architecture, and format, typo fix (Jim
(JimMeyering) Meyering)
- bindings: exception handling in examples (Jim Meyering), perl ones - bindings: exception handling in examples (Jim Meyering), perl ones out
outof tree (Daniel Berrange) of tree (Daniel Berrange)
- virsh: more options, create, nodeinfo (Karel Zak), renaming of - virsh: more options, create, nodeinfo (Karel Zak), renaming of some
someoptions (Karel Zak), use stderr only for errors (Karel Zak), man options (Karel Zak), use stderr only for errors (Karel Zak), man page
page(Andrew Puch) (Andrew Puch)
0.0.6: Feb 28 2006: 0.0.6: Feb 28 2006:
- add UUID lookup and extract API - add UUID lookup and extract API
- add error handling APIs both synchronous and asynchronous - add error handling APIs both synchronous and asynchronous
- added minimal hook for error handling at the python level, improved - added minimal hook for error handling at the python level, improved the
thepython bindings python bindings
- augment the documentation and tests to cover error handling - augment the documentation and tests to cover error handling
0.0.5: Feb 23 2006: 0.0.5: Feb 23 2006:
- Added XML description parsing, dependance to libxml2, implemented - Added XML description parsing, dependance to libxml2, implemented the
thecreation API virDomainCreateLinux() creation API virDomainCreateLinux()
- new APIs to lookup and name domain by UUID - new APIs to lookup and name domain by UUID
- fixed the XML dump when using the Xend access - fixed the XML dump when using the Xend access
- Fixed a few more problem related to the name change - Fixed a few more problem related to the name change
- Adding regression tests in python and examples in C - Adding regression tests in python and examples in C
- web site improvement, extended the documentation to cover the XMLformat - web site improvement, extended the documentation to cover the XML
and Python API format and Python API
- Added devhelp help for Gnome/Gtk programmers - Added devhelp help for Gnome/Gtk programmers
...@@ -233,8 +227,8 @@ Releases ...@@ -233,8 +227,8 @@ Releases
0.0.2: Jan 29 2006: 0.0.2: Jan 29 2006:
- Update of the documentation, web site redesign (Diana Fong) - Update of the documentation, web site redesign (Diana Fong)
- integration of HTTP xend RPC based on libxend by Anthony Liquori - integration of HTTP xend RPC based on libxend by Anthony Liquori for
formost operations most operations
- Adding Save and Restore APIs - Adding Save and Restore APIs
- extended the virsh command line tool (Karel Zak) - extended the virsh command line tool (Karel Zak)
- remove xenstore transactions (Anthony Liguori) - remove xenstore transactions (Anthony Liguori)
......
...@@ -5,49 +5,48 @@ ...@@ -5,49 +5,48 @@
<li><a href="FAQ.html#Compilatio">Compilation</a></li> <li><a href="FAQ.html#Compilatio">Compilation</a></li>
<li><a href="FAQ.html#Developer">Developer corner</a></li> <li><a href="FAQ.html#Developer">Developer corner</a></li>
</ul><h3><a name="License" id="License">License</a>(s)</h3><ol><li><em>Licensing Terms for libvirt</em> </ul><h3><a name="License" id="License">License</a>(s)</h3><ol><li><em>Licensing Terms for libvirt</em>
<p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
LesserGeneral Public License</a>, see the file COPYING.LIB in the General Public License</a>, see the file COPYING.LIB in the distribution
distributionfor the precise wording. The only library that libvirt for the precise wording. The only library that libvirt depends upon is
depends upon isthe Xen store access library which is also licenced under the Xen store access library which is also licenced under the LGPL.</p>
the LGPL.</p>
</li> </li>
<li><em>Can I embed libvirt in a proprietary application ?</em> <li><em>Can I embed libvirt in a proprietary application ?</em>
<p>Yes. The LGPL allows you to embed libvirt into a <p>Yes. The LGPL allows you to embed libvirt into a proprietary
proprietaryapplication. It would be graceful to send-back bug fixes and application. It would be graceful to send-back bug fixes and improvements
improvementsas patches for possible incorporation in the main development as patches for possible incorporation in the main development tree. It
tree. Itwill decrease your maintainance costs anyway if you do so.</p> will decrease your maintainance costs anyway if you do so.</p>
</li> </li>
</ol><h3><a name="Installati" id="Installati">Installation</a></h3><ol><li><em>Where can I get libvirt</em>? </ol><h3><a name="Installati" id="Installati">Installation</a></h3><ol><li><em>Where can I get libvirt</em> ?
<p>The original distribution comes from <a href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p> <p>The original distribution comes from <a href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p>
</li> </li>
<li><em>I can't install the libvirt/libvirt-devel RPM packages due tofailed <li><em>I can't install the libvirt/libvirt-devel RPM packages due to
dependencies</em> failed dependencies</em>
<p>The most generic solution is to re-fetch the latest src.rpm , <p>The most generic solution is to re-fetch the latest src.rpm , and
andrebuild it locally with</p> rebuild it locally with</p>
<p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p> <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
<p>If everything goes well it will generate two binary rpm packages <p>If everything goes well it will generate two binary rpm packages (one
(oneproviding the shared libs and virsh, and the other one, the providing the shared libs and virsh, and the other one, the -devel
-develpackage, providing includes, static libraries and scripts needed to package, providing includes, static libraries and scripts needed to build
buildapplications with libvirt that you can install locally.</p> applications with libvirt that you can install locally.</p>
<p>One can also rebuild the RPMs from a tarball:</p> <p>One can also rebuild the RPMs from a tarball:</p>
<p><code>rpmbuild -ta libdir-xxx.tar.gz</code></p> <p><code>rpmbuild -ta libdir-xxx.tar.gz</code></p>
<p>Or from a configured tree with:</p> <p>Or from a configured tree with:</p>
<p><code>make rpm</code></p> <p><code>make rpm</code></p>
</li> </li>
<li><em>Failure to use the API for non-root users</em> <li><em>Failure to use the API for non-root users</em>
<p>Large parts of the API may only be accessible with root <p>Large parts of the API may only be accessible with root priviledges,
priviledges,however the read only access to the xenstore data doesnot however the read only access to the xenstore data doesnot have to be
have to beforbidden to user, at least for monitoring purposes. If "virsh forbidden to user, at least for monitoring purposes. If "virsh dominfo"
dominfo"fails to run as an user, change the mode of the xenstore fails to run as an user, change the mode of the xenstore read-only socket
read-only socketwith:</p> with:</p>
<p><code>chmod 666 /var/run/xenstored/socket_ro</code></p> <p><code>chmod 666 /var/run/xenstored/socket_ro</code></p>
<p>and also make sure that the Xen Daemon is running correctly with <p>and also make sure that the Xen Daemon is running correctly with local
localHTTP server enabled, this is defined HTTP server enabled, this is defined in
in<code>/etc/xen/xend-config.sxp</code>which need the following line to <code>/etc/xen/xend-config.sxp</code> which need the following line to be
beenabled:</p> enabled:</p>
<p><code>(xend-http-server yes)</code></p> <p><code>(xend-http-server yes)</code></p>
<p>If needed restart the xend daemon after making the change with <p>If needed restart the xend daemon after making the change with the
thefollowing command run as root:</p> following command run as root:</p>
<p><code>service xend restart</code></p> <p><code>service xend restart</code></p>
</li> </li>
</ol><h3><a name="Compilatio" id="Compilatio">Compilation</a></h3><ol><li><em>What is the process to compile libvirt ?</em> </ol><h3><a name="Compilatio" id="Compilatio">Compilation</a></h3><ol><li><em>What is the process to compile libvirt ?</em>
...@@ -59,24 +58,23 @@ ...@@ -59,24 +58,23 @@
<p><code>./configure [possible options]</code></p> <p><code>./configure [possible options]</code></p>
<p><code>make</code></p> <p><code>make</code></p>
<p><code>make install</code></p> <p><code>make install</code></p>
<p>At that point you may have to rerun ldconfig or a similar utility <p>At that point you may have to rerun ldconfig or a similar utility to
toupdate your list of installed shared libs.</p> update your list of installed shared libs.</p>
</li> </li>
<li><em>What other libraries are needed to compile/install libvirt ?</em> <li><em>What other libraries are needed to compile/install libvirt ?</em>
<p>Libvirt requires libxenstore, which is usually provided by the <p>Libvirt requires libxenstore, which is usually provided by the xen
xenpackages as well as the public headers to compile against packages as well as the public headers to compile against libxenstore.</p>
libxenstore.</p>
</li> </li>
<li><em>I use the CVS version and there is no configure script</em> <li><em>I use the CVS version and there is no configure script</em>
<p>The configure script (and other Makefiles) are generated. Use <p>The configure script (and other Makefiles) are generated. Use the
theautogen.sh script to regenerate the configure script and autogen.sh script to regenerate the configure script and Makefiles,
Makefiles,like:</p> like:</p>
<p><code>./autogen.sh --prefix=/usr --disable-shared</code></p> <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
</li> </li>
</ol><h3><a name="Developer" id="Developer">Developer</a>corner</h3><ol><li><em>Troubles compiling or linking programs using libvirt</em> </ol><h3><a name="Developer" id="Developer">Developer</a> corner</h3><ol><li><em>Troubles compiling or linking programs using libvirt</em>
<p>To simplify the process of reusing the library, libvirt comes <p>To simplify the process of reusing the library, libvirt comes with
withpkgconfig support, which can be used directly from autoconf support pkgconfig support, which can be used directly from autoconf support or
orvia the pkg-config command line tool, like:</p> via the pkg-config command line tool, like:</p>
<p><code>pkg-config libvirt --libs</code></p> <p><code>pkg-config libvirt --libs</code></p>
</li> </li>
</ol></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> </ol></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>libvirt architecture</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">libvirt architecture</h1><p>Currently libvirt supports 2 kind of virtualization, and its <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>libvirt architecture</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">libvirt architecture</h1><p>Currently libvirt supports 2 kind of virtualization, and its
internalstructure is based on a driver model which simplifies adding new internal structure is based on a driver model which simplifies adding new
engines:</p><ul><li><a href="#Xen">Xen hypervisor</a></li> engines:</p><ul><li><a href="#Xen">Xen hypervisor</a></li>
<li><a href="#QEmu">QEmu and KVM based virtualization</a></li> <li><a href="#QEmu">QEmu and KVM based virtualization</a></li>
<li><a href="#drivers">the driver architecture</a></li> <li><a href="#drivers">the driver architecture</a></li>
</ul><h3><a name="Xen" id="Xen">Libvirt Xen support</a></h3><p>When running in a Xen environment, programs using libvirt have to </ul><h3><a name="Xen" id="Xen">Libvirt Xen support</a></h3><p>When running in a Xen environment, programs using libvirt have to execute
executein "Domain 0", which is the primary Linux OS loaded on the machine. in "Domain 0", which is the primary Linux OS loaded on the machine. That OS
That OSkernel provides most if not all of the actual drivers used by the set kernel provides most if not all of the actual drivers used by the set of
ofdomains. It also runs the Xen Store, a database of informations shared by domains. It also runs the Xen Store, a database of informations shared by the
thehypervisor, the kernels, the drivers and the xen daemon. Xend. The xen hypervisor, the kernels, the drivers and the xen daemon. Xend. The xen daemon
daemonsupervise the control and execution of the sets of domains. The supervise the control and execution of the sets of domains. The hypervisor,
hypervisor,drivers, kernels and daemons communicate though a shared system drivers, kernels and daemons communicate though a shared system bus
busimplemented in the hypervisor. The figure below tries to provide a view implemented in the hypervisor. The figure below tries to provide a view of
ofthis environment:</p><img src="architecture.gif" alt="The Xen architecture" /><p>The library can be initialized in 2 ways depending on the level this environment:</p><img src="architecture.gif" alt="The Xen architecture" /><p>The library can be initialized in 2 ways depending on the level of
ofpriviledge of the embedding program. If it runs with root priviledge of the embedding program. If it runs with root access,
access,virConnectOpen() can be used, it will use different ways to connect virConnectOpen() can be used, it will use three different ways to connect to
tothe Xen infrastructure:</p><ul><li>a connection to the Xen Daemon though an HTTP RPC layer</li> the Xen infrastructure:</p><ul><li>a connection to the Xen Daemon though an HTTP RPC layer</li>
<li>a read/write connection to the Xen Store</li> <li>a read/write connection to the Xen Store</li>
<li>use Xen Hypervisor calls</li> <li>use Xen Hypervisor calls</li>
<li>when used as non-root libvirt connect to a proxy daemon runningas root <li>when used as non-root libvirt connect to a proxy daemon running
and providing read-only support</li> as root and providing read-only support</li>
</ul><p>The library will usually interact with the Xen daemon for any </ul><p>The library will usually interact with the Xen daemon for any operation
operationchanging the state of the system, but for performance and accuracy changing the state of the system, but for performance and accuracy reasons
reasonsmay talk directly to the hypervisor when gathering state informations may talk directly to the hypervisor when gathering state informations at
atleast when possible (i.e. when the running program using libvirt has least when possible (i.e. when the running program using libvirt has root
rootpriviledge access).</p><p>If it runs without root access virConnectOpenReadOnly() should be used priviledge access).</p><p>If it runs without root access virConnectOpenReadOnly() should be used to
toconnect to initialize the library. It will then fork a libvirt_proxy connect to initialize the library. It will then fork a libvirt_proxy
programrunning as root and providing read_only access to the API, this is program running as root and providing read_only access to the API, this is
thenonly useful for reporting and monitoring.</p><h3><a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a></h3><p>The model for QEmu and KVM is completely similar, basically KVM isbased on then only useful for reporting and monitoring.</p><h3><a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a></h3><p>The model for QEmu and KVM is completely similar, basically KVM is based
QEmu for the process controlling a new domain, only small detailsdiffers on QEmu for the process controlling a new domain, only small details differs
between the two. In both case the libvirt API is providedby a controlling between the two. In both case the libvirt API is provided by a controlling
process forked by libvirt in the background andwhich launch and control the process forked by libvirt in the background and which launch and control the
QEmu or KVM process. That program calledlibvirt_qemud talks though a specific QEmu or KVM process. That program called libvirt_qemud talks though a specific
protocol to the library, andconnects to the console of the QEmu process in protocol to the library, and connects to the console of the QEmu process in
order to control andreport on its status. Libvirt tries to expose all the order to control and report on its status. Libvirt tries to expose all the
emulationsmodels of QEmu, the selection is done when creating the new emulations models of QEmu, the selection is done when creating the new
domain,by specifying the architecture and machine type targetted.</p><p>The code controlling the QEmu process is available in domain, by specifying the architecture and machine type targetted.</p><p>The code controlling the QEmu process is available in the
the<code>qemud/</code>subdirectory.</p><h3><a name="drivers" id="drivers">the driver based architecture</a></h3><p>As the previous section explains, libvirt can communicate using <code>qemud/</code> directory.</p><h3><a name="drivers" id="drivers">the driver based architecture</a></h3><p>As the previous section explains, libvirt can communicate using different
differentchannels with the Xen hypervisor, and is also able to use different channels with the current hypervisor, and should also be able to use
kindof hypervisor. To simplify the internal design, code, easemaintainance different kind of hypervisor. To simplify the internal design, code, ease
and simplify the support of other virtualization engine theinternals have maintainance and simplify the support of other virtualization engine the
been structured as one core component, the libvirt.c moduleacting as a internals have been structured as one core component, the libvirt.c module
front-end for the library API and a set of hypvisor driversdefining a common acting as a front-end for the library API and a set of hypvisor drivers
set of routines. That way the Xen Daemon accces, the XenStore one, the defining a common set of routines. That way the Xen Daemon accces, the Xen
Hypervisor hypercall are all isolated in separate C modulesimplementing at Store one, the Hypervisor hypercall are all isolated in separate C modules
least a subset of the common operations defined by thedrivers present in implementing at least a subset of the common operations defined by the
driver.h. The driver architecture is used to add supportfor other drivers present in driver.h:</p><ul><li>xend_internal: implements the driver functions though the Xen
virtualization engines and</p><ul><li>xend_internal: implements the driver functions though the Daemon</li>
XenDaemon.</li> <li>xs_internal: implements the subset of the driver availble though the
<li>xs_internal: implements the subset of the driver availble though theXen Xen Store</li>
Store.</li> <li>xen_internal: provide the implementation of the functions possible via
<li>xen_internal: provide the implementation of the functions possible direct hypervisor access</li>
viadirect Xen hypervisor access.</li> <li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
<li>proxy_internal: provide read-only Xen access via a proxy, the proxycode is in the <code>proxy/</code>directory.</li>
is in the <code>proxy/</code>sub directory.</li>
<li>xm_internal: provide support for Xen defined but not running <li>xm_internal: provide support for Xen defined but not running
domains.</li> domains.</li>
<li>qemu_internal: implement the driver functions for QEmu and <li>qemu_internal: implement the driver functions for QEmu and
KVMvirtualization engines. It also uses a qemud/ specific daemon KVM virtualization engines. It also uses a qemud/ specific daemon
whichinterracts with the QEmu process to implement libvirt API.</li> which interracts with the QEmu process to implement libvirt API.</li>
<li>test: this is a test driver useful for regression tests of thefront-end <li>test: this is a test driver useful for regression tests of the
part of libvirt.</li> front-end part of libvirt.</li>
</ul><p>Note that a given driver may only implement a subset of those </ul><p>Note that a given driver may only implement a subset of those functions,
functions,for example saving a Xen domain state to disk and restoring it is (for example saving a Xen domain state to disk and restoring it is only
only possiblethough the Xen Daemon, in that case the driver entry points are possible though the Xen Daemon), in that case the driver entry points for
initialized toNULL.</p><p></p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> unsupported functions are initialized to NULL.</p><p></p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reporting bugs and getting help</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reporting bugs and getting help</h1><p>There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a>for <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reporting bugs and getting help</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reporting bugs and getting help</h1><p>There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
libvirt,with an <a href="https://www.redhat.com/archives/libvir-list/">on-linearchive</a>. with an <a href="https://www.redhat.com/archives/libvir-list/">on-line
Please subscribe to this list before posting by visiting the <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated archive</a>. Please subscribe to this list before posting by visiting the <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
Web</a>page and follow the instructions. Patches with explanations and page and follow the instructions. Patches with explanations and provided as
provided asattachments are really appreciated and will be discussed on the attachments are really appreciated and will be discussed on the mailing list.
mailing list.If possible generate the patches by using cvs diff -u in a CVS If possible generate the patches by using cvs diff -u in a CVS checkout.</p><p>We use Red Hat Bugzilla to track bugs to libvirt. If you want to report a
checkout.</p><p>We use Red Hat Bugzilla to track bugs to libvirt. If you want to report bug, please check <a href="http://bugzilla.redhat.com/bugzilla/buglist.cgi?component=libvirt&amp;component=libvirt-devel&amp;component=libvirt-python&amp;bug_status=ASSIGNED&amp;bug_status=INVESTIGATE&amp;bug_status=NEW&amp;bug_status=REOPENED&amp;bug_status=VERIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr&amp;long_desc=&amp;Search=Search">the existing open bugs</a>, then if yours isn't a duplicate of
abug, please check <a href="http://bugzilla.redhat.com/bugzilla/buglist.cgi?component=libvirt&amp;component=libvirt-devel&amp;component=libvirt-python&amp;bug_status=ASSIGNED&amp;bug_status=INVESTIGATE&amp;bug_status=NEW&amp;bug_status=REOPENED&amp;bug_status=VERIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr&amp;long_desc=&amp;Search=Search">the an existing bug, <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora%20Core&amp;component=libvirt">log a new bug</a>. It may be good
existing open bugs</a>, then if yours isn't a duplicate ofan existing bug, <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora%20Core&amp;component=libvirt">log to post to the <a href="mailto:libvir-list@redhat.com">mailing-list</a>
a new bug</a>. It may be goodto post to the <a href="mailto:libvir-list@redhat.com">mailing-list</a>too if the issue looks too if the issue looks serious, thanks !</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
serious, thanks !</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Downloads</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Downloads</h1><p>The latest versions of libvirt can be found on the <a href="ftp://libvirt.org/libvirt/">libvirt.org</a>server ( <a href="http://libvirt.org/sources/">HTTP</a>, <a href="ftp://libvirt.org/libvirt/">FTP</a>). You will find there the <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Downloads</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Downloads</h1><p>The latest versions of libvirt can be found on the <a href="ftp://libvirt.org/libvirt/">libvirt.org</a> server ( <a href="http://libvirt.org/sources/">HTTP</a>, <a href="ftp://libvirt.org/libvirt/">FTP</a>). You will find there the released
releasedversions as well as <a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshottarballs</a>updated versions as well as <a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshot
from CVS head every hour</p><p>Anonymous <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a>is tarballs</a> updated from CVS head every hour</p><p>Anonymous <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a> is also
alsoavailable, first register onto the server:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login</code></p><p>it will request a password, enter <strong>anoncvs</strong>. Then you available, first register onto the server:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login</code></p><p>it will request a password, enter <strong>anoncvs</strong>. Then you can
cancheckout the development tree with:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs checkout the development tree with:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co
colibvirt</code></p><p>Use ./autogen.sh to configure the local checkout, then libvirt</code></p><p>Use ./autogen.sh to configure the local checkout, then <code>make</code>
<code>make</code>and <code>make install</code>, as usual. All normal cvs and <code>make install</code>, as usual. All normal cvs commands are now
commands are nowavailable except commiting to the base.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> available except commiting to the base.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
...@@ -3,65 +3,67 @@ ...@@ -3,65 +3,67 @@
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Handling of errors</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Handling of errors</h1><p>The main goals of libvirt when it comes to error handling are:</p><ul><li>provide as much detail as possible</li> <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Handling of errors</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Handling of errors</h1><p>The main goals of libvirt when it comes to error handling are:</p><ul><li>provide as much detail as possible</li>
<li>provide the informations as soon as possible</li> <li>provide the informations as soon as possible</li>
<li>dont force the library user into one style of error handling</li> <li>dont force the library user into one style of error handling</li>
</ul><p>As result the library provide both synchronous, callback based </ul><p>As result the library provide both synchronous, callback based and
andasynchronous error reporting. When an error happens in the library code asynchronous error reporting. When an error happens in the library code the
theerror is logged, allowing to retrieve it later and if the user registered error is logged, allowing to retrieve it later and if the user registered an
anerror callback it will be called synchronously. Once the call to libvirt error callback it will be called synchronously. Once the call to libvirt ends
endsthe error can be detected by the return value and the full information the error can be detected by the return value and the full information for
forthe last logged error can be retrieved.</p><p>To avoid as much as prossible troubles with a global variable in the last logged error can be retrieved.</p><p>To avoid as much as prossible troubles with a global variable in a
amultithreaded environment, libvirt will associate when possible the errors multithreaded environment, libvirt will associate when possible the errors to
tothe current connection they are related to, that way the error is stored in the current connection they are related to, that way the error is stored in a
adynamic structure which can be made thread specific. Error callback can dynamic structure which can be made thread specific. Error callback can be
beset specifically to a connection with</p><p>So error handling in the code is the following:</p><ol><li>if the error can be associated to a connection for example when set specifically to a connection with</p><p>So error handling in the code is the following:</p><ol><li>if the error can be associated to a connection for example when failing
failingto look up a domain to look up a domain
<ol><li>if there is a callback associated to the connection set with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,call <ol><li>if there is a callback associated to the connection set with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
it with the error informations</li> call it with the error informations</li>
<li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,call <li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
it with the error information</li> call it with the error information</li>
<li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>which <li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
is the default error function of the library issuing the erroron which is the default error function of the library issuing the error
stderr</li> on stderr</li>
<li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li> <li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li>
</ol></li> </ol></li>
<li>otherwise like when failing to create an hypervisor connection: <li>otherwise like when failing to create an hypervisor connection:
<ol><li>if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,call <ol><li>if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
it with the error information</li> call it with the error information</li>
<li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>which <li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
is the default error function of the library issuing the erroron which is the default error function of the library issuing the error
stderr</li> on stderr</li>
<li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li> <li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li>
</ol></li> </ol></li>
</ol><p>In all cases the error informations are provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a>pointer </ol><p>In all cases the error informations are provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
toread-only structure <a href="html/libvirt-virterror.html#virError">virError</a>containing read-only structure <a href="html/libvirt-virterror.html#virError">virError</a> containing the
thefollowing fields:</p><ul><li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>enum</li> following fields:</p><ul><li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
<li>domain: an enum indicating which part of libvirt raised the error see<a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li> enum</li>
<li>level: the error level, usually VIR_ERR_ERROR, though there is room <li>domain: an enum indicating which part of libvirt raised the error see
forwarnings like VIR_ERR_WARNING</li> <a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li>
<li>level: the error level, usually VIR_ERR_ERROR, though there is room for
warnings like VIR_ERR_WARNING</li>
<li>message: the full human-readable formatted string of the error</li> <li>message: the full human-readable formatted string of the error</li>
<li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>connection <li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
to the hypervisor where this happened</li> connection to the hypervisor where this happened</li>
<li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>domaintargetted <li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
in the operation</li> targetted in the operation</li>
</ul><p>and then extra raw informations about the error which may be initializedto </ul><p>and then extra raw informations about the error which may be initialized
0 or NULL if unused</p><ul><li>str1, str2, str3: string informations, usually str1 is the errormessage to 0 or NULL if unused</p><ul><li>str1, str2, str3: string informations, usually str1 is the error
format</li> message format</li>
<li>int1, int2: integer informations</li> <li>int1, int2: integer informations</li>
</ul><p>So usually, setting up specific error handling with libvirt consist </ul><p>So usually, setting up specific error handling with libvirt consist of
ofregistering an handler with with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>orwith registering an handler with with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a> or
<a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,chech with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
the value of the code value, take appropriate action, if needed letlibvirt chech the value of the code value, take appropriate action, if needed let
print the error on stderr by calling <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>.For libvirt print the error on stderr by calling <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>.
asynchronous error handing, set such a function doing nothing to avoidthe For asynchronous error handing, set such a function doing nothing to avoid
error being reported on stderr, and call virConnGetLastError the error being reported on stderr, and call virConnGetLastError or
orvirGetLastError when an API call returned an error value. It can be a virGetLastError when an API call returned an error value. It can be a good
goodidea to use <a href="html/libvirt-virterror.html#virResetLastError">virResetError</a>or <a href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>once idea to use <a href="html/libvirt-virterror.html#virResetLastError">virResetError</a> or <a href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>
an error has been processed fully.</p><p>At the python level, there only a global reporting callback function once an error has been processed fully.</p><p>At the python level, there only a global reporting callback function at
atthis point, see the error.py example about it:</p><pre>def handler(ctxt, err): this point, see the error.py example about it:</p><pre>def handler(ctxt, err):
global errno global errno
#print "handler(%s, %s)" % (ctxt, err) #print "handler(%s, %s)" % (ctxt, err)
errno = err errno = err
libvirt.registerErrorHandler(handler, 'context') </pre><p>the second argument to the registerErrorHandler function is passed as libvirt.registerErrorHandler(handler, 'context') </pre><p>the second argument to the registerErrorHandler function is passed as the
thefist argument of the callback like in the C version. The error is a fist argument of the callback like in the C version. The error is a tuple
tuplecontaining the same field as a virError in C, but cast to Python.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> containing the same field as a virError in C, but cast to Python.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>XML Formats</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">XML Formats</h1><p>This section describes the XML formats used mostly to represent domains, <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>XML Format</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">XML Format</h1><p>This section describes the XML format used to represent domains, there are
there are variations on the format based on the kind of domains run and the variations on the format based on the kind of domains run and the options
options used to launch them:</p><ul><li><a href="#Normal1">Normal paravirtualized Xen domains</a></li> used to launch them:</p><ul><li><a href="#Normal1">Normal paravirtualized Xen domains</a></li>
<li><a href="#Fully1">Fully virtualized Xen domains</a></li> <li><a href="#Fully1">Fully virtualized Xen domains</a></li>
<li><a href="#KVM1">KVM domains</a></li> <li><a href="#KVM1">KVM domains</a></li>
<li><a href="#Net1">Networking options for QEmu and KVM</a></li> <li><a href="#Net1">Networking options for QEmu and KVM</a></li>
<li><a href="#QEmu1">QEmu domains</a></li> <li><a href="#QEmu1">QEmu domains</a></li>
<li><a href="#Capa1">Discovering virtualization capabilities</a></li> <li><a href="#Capa1">Discovering virtualization capabilities</a></li>
</ul><p>The formats try as much as possible to follow the same structure and reuse </ul><p>The formats try as much as possible to follow the same structure and reuse
elements and attributes where it makes sense.</p><h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized elements and attributes where it makes sense.</p><h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
Xendomains</a>:</h3><p>The library use an XML format to describe domains, as input to <a href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>and guests</a>:</h3><p>The library use an XML format to describe domains, as input to <a href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
as the output of <a href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,the and as the output of <a href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,
following is an example of the format as returned by the shell the following is an example of the format as returned by the shell command
command<code>virsh xmldump fc4</code>, where fc4 was one of the running <code>virsh xmldump fc4</code> , where fc4 was one of the running domains:</p><pre>&lt;domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>&gt;
domains:</p><pre>&lt;domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>&gt;
&lt;name&gt;fc4&lt;/name&gt; &lt;name&gt;fc4&lt;/name&gt;
<span style="color: #00B200; background-color: #FFFFFF">&lt;os&gt; <span style="color: #00B200; background-color: #FFFFFF">&lt;os&gt;
&lt;type&gt;linux&lt;/type&gt; &lt;type&gt;linux&lt;/type&gt;
...@@ -37,72 +36,70 @@ domains:</p><pre>&lt;domain type='xen' <span style="color: #0071FF; background-c ...@@ -37,72 +36,70 @@ domains:</p><pre>&lt;domain type='xen' <span style="color: #0071FF; background-c
&lt;/interface&gt;</span> &lt;/interface&gt;</span>
<span style="color: #FF8000; background-color: #FFFFFF">&lt;console tty='/dev/pts/5'/&gt;</span> <span style="color: #FF8000; background-color: #FFFFFF">&lt;console tty='/dev/pts/5'/&gt;</span>
&lt;/devices&gt; &lt;/devices&gt;
&lt;/domain&gt;</pre><p>The root element must be called <code>domain</code>with no namespace, &lt;/domain&gt;</pre><p>The root element must be called <code>domain</code> with no namespace, the
the<code>type</code>attribute indicates the kind of hypervisor used, 'xen' <code>type</code> attribute indicates the kind of hypervisor used, 'xen' is
isthe default value. The <code>id</code>attribute gives the domain id the default value. The <code>id</code> attribute gives the domain id at
atruntime (not however that this may change, for example if the domain is runtime (not however that this may change, for example if the domain is saved
savedto disk and restored). The domain has a few children whose order is to disk and restored). The domain has a few children whose order is not
notsignificant:</p><ul><li>name: the domain name, preferably ASCII based</li> significant:</p><ul><li>name: the domain name, preferably ASCII based</li>
<li>memory: the maximum memory allocated to the domain in kilobytes</li> <li>memory: the maximum memory allocated to the domain in kilobytes</li>
<li>vcpu: the number of virtual cpu configured for the domain</li> <li>vcpu: the number of virtual cpu configured for the domain</li>
<li>os: a block describing the Operating System, its content will <li>os: a block describing the Operating System, its content will be
bedependant on the OS type dependant on the OS type
<ul><li>type: indicate the OS type, always linux at this point</li> <ul><li>type: indicate the OS type, always linux at this point</li>
<li>kernel: path to the kernel on the Domain 0 filesystem</li> <li>kernel: path to the kernel on the Domain 0 filesystem</li>
<li>initrd: an optional path for the init ramdisk on the Domain <li>initrd: an optional path for the init ramdisk on the Domain 0
0filesystem</li> filesystem</li>
<li>cmdline: optional command line to the kernel</li> <li>cmdline: optional command line to the kernel</li>
<li>root: the root filesystem from the guest viewpoint, it may bepassed <li>root: the root filesystem from the guest viewpoint, it may be
as part of the cmdline content too</li> passed as part of the cmdline content too</li>
</ul></li> </ul></li>
<li>devices: a list of <code>disk</code>, <li>devices: a list of <code>disk</code>, <code>interface</code> and
<code>interface</code>and<code>console</code>descriptions in no special <code>console</code> descriptions in no special order</li>
order</li> </ul><p>The format of the devices and their type may grow over time, but the
</ul><p>The format of the devices and their type may grow over time, but following should be sufficient for basic use:</p><p>A <code>disk</code> device indicates a block device, it can have two
thefollowing should be sufficient for basic use:</p><p>A <code>disk</code>device indicates a block device, it can have twovalues values for the type attribute either 'file' or 'block' corresponding to the 2
for the type attribute either 'file' or 'block' corresponding to the 2options options availble at the Xen layer. It has two mandatory children, and one
availble at the Xen layer. It has two mandatory children, and oneoptional one optional one in no specific order:</p><ul><li>source with a file attribute containing the path in Domain 0 to the
in no specific order:</p><ul><li>source with a file attribute containing the path in Domain 0 to thefile file or a dev attribute if using a block device, containing the device
or a dev attribute if using a block device, containing the devicename name ('hda5' or '/dev/hda5')</li>
('hda5' or '/dev/hda5')</li> <li>target indicates in a dev attribute the device where it is mapped in
<li>target indicates in a dev attribute the device where it is mapped inthe the guest</li>
guest</li> <li>readonly an optional empty element indicating the device is
<li>readonly an optional empty element indicating the device read-only</li>
isread-only</li> </ul><p>An <code>interface</code> element describes a network device mapped on the
</ul><p>An <code>interface</code>element describes a network device mapped on guest, it also has a type whose value is currently 'bridge', it also have a
theguest, it also has a type whose value is currently 'bridge', it also have number of children in no specific order:</p><ul><li>source: indicating the bridge name</li>
anumber of children in no specific order:</p><ul><li>source: indicating the bridge name</li>
<li>mac: the optional mac address provided in the address attribute</li> <li>mac: the optional mac address provided in the address attribute</li>
<li>ip: the optional IP address provided in the address attribute</li> <li>ip: the optional IP address provided in the address attribute</li>
<li>script: the script used to bridge the interfcae in the Domain 0</li> <li>script: the script used to bridge the interfcae in the Domain 0</li>
<li>target: and optional target indicating the device name.</li> <li>target: and optional target indicating the device name.</li>
</ul><p>A <code>console</code>element describes a serial console connection tothe </ul><p>A <code>console</code> element describes a serial console connection to
guest. It has no children, and a single attribute the guest. It has no children, and a single attribute <code>tty</code> which
<code>tty</code>whichprovides the path to the Pseudo TTY on which the guest provides the path to the Pseudo TTY on which the guest console can be
console can beaccessed</p><p>Life cycle actions for the domain can also be expressed in the XML accessed</p><p>Life cycle actions for the domain can also be expressed in the XML format,
format,they drive what should be happening if the domain crashes, is rebooted they drive what should be happening if the domain crashes, is rebooted or is
or ispoweroff. There is various actions possible when this happen:</p><ul><li>destroy: The domain is cleaned up (that's the default normal poweroff. There is various actions possible when this happen:</p><ul><li>destroy: The domain is cleaned up (that's the default normal processing
processingin Xen)</li> in Xen)</li>
<li>restart: A new domain is started in place of the old one with the <li>restart: A new domain is started in place of the old one with the same
sameconfiguration parameters</li> configuration parameters</li>
<li>preserve: The domain will remain in memory until it is <li>preserve: The domain will remain in memory until it is destroyed
destroyedmanually, it won't be running but allows for post-mortem manually, it won't be running but allows for post-mortem debugging</li>
debugging</li> <li>rename-restart: a variant of the previous one but where the old domain
<li>rename-restart: a variant of the previous one but where the old is renamed before being saved to allow a restart</li>
domainis renamed before being saved to allow a restart</li>
</ul><p>The following could be used for a Xen production system:</p><pre>&lt;domain&gt; </ul><p>The following could be used for a Xen production system:</p><pre>&lt;domain&gt;
... ...
&lt;on_reboot&gt;restart&lt;/on_reboot&gt; &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
&lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt; &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
&lt;on_crash&gt;rename-restart&lt;/on_crash&gt; &lt;on_crash&gt;rename-restart&lt;/on_crash&gt;
... ...
&lt;/domain&gt;</pre><p>While the format may be extended in various ways as support for &lt;/domain&gt;</pre><p>While the format may be extended in various ways as support for more
morehypervisor types and features are added, it is expected that this core hypervisor types and features are added, it is expected that this core subset
subsetwill remain functional in spite of the evolution of the library.</p><h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized will remain functional in spite of the evolution of the library.</p><h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a>
guests</a>(added in 0.1.3):</h3><p>Here is an example of a domain description used to start a (added in 0.1.3):</h3><p>Here is an example of a domain description used to start a fully
fullyvirtualized (a.k.a. HVM) Xen domain. This requires hardware virtualized (a.k.a. HVM) Xen domain. This requires hardware virtualization
virtualizationsupport at the processor level but allows to run unmodified support at the processor level but allows to run unmodified operating
operatingsystems:</p><pre>&lt;domain type='xen' id='3'&gt; systems:</p><pre>&lt;domain type='xen' id='3'&gt;
&lt;name&gt;fv0&lt;/name&gt; &lt;name&gt;fv0&lt;/name&gt;
&lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt; &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
&lt;os&gt; &lt;os&gt;
...@@ -142,49 +139,49 @@ operatingsystems:</p><pre>&lt;domain type='xen' id='3'&gt; ...@@ -142,49 +139,49 @@ operatingsystems:</p><pre>&lt;domain type='xen' id='3'&gt;
&lt;/disk&gt; &lt;/disk&gt;
<span style="color: #0000E5; background-color: #FFFFFF">&lt;graphics type='vnc' port='5904'/&gt;</span> <span style="color: #0000E5; background-color: #FFFFFF">&lt;graphics type='vnc' port='5904'/&gt;</span>
&lt;/devices&gt; &lt;/devices&gt;
&lt;/domain&gt;</pre><p>There is a few things to notice specifically for HVM domains:</p><ul><li>the optional <code>&lt;features&gt;</code>block is used to &lt;/domain&gt;</pre><p>There is a few things to notice specifically for HVM domains:</p><ul><li>the optional <code>&lt;features&gt;</code> block is used to enable
enablecertain guest CPU / system features. For HVM guests the certain guest CPU / system features. For HVM guests the following
followingfeatures are defined: features are defined:
<ul><li><code>pae</code>- enable PAE memory addressing</li> <ul><li><code>pae</code> - enable PAE memory addressing</li>
<li><code>apic</code>- enable IO APIC</li> <li><code>apic</code> - enable IO APIC</li>
<li><code>acpi</code>- enable ACPI bios</li> <li><code>acpi</code> - enable ACPI bios</li>
</ul></li> </ul></li>
<li>the <code>&lt;os&gt;</code>block description is very different, firstit <li>the <code>&lt;os&gt;</code> block description is very different, first
indicates that the type is 'hvm' for hardware virtualization, theninstead it indicates that the type is 'hvm' for hardware virtualization, then
of a kernel, boot and command line arguments, it points to an osboot instead of a kernel, boot and command line arguments, it points to an os
loader which will extract the boot informations from the boot boot loader which will extract the boot informations from the boot device
devicespecified in a separate boot element. The <code>dev</code>attribute specified in a separate boot element. The <code>dev</code> attribute on
onthe <code>boot</code>tag can be one of: the <code>boot</code> tag can be one of:
<ul><li><code>fd</code>- boot from first floppy device</li> <ul><li><code>fd</code> - boot from first floppy device</li>
<li><code>hd</code>- boot from first harddisk device</li> <li><code>hd</code> - boot from first harddisk device</li>
<li><code>cdrom</code>- boot from first cdrom device</li> <li><code>cdrom</code> - boot from first cdrom device</li>
</ul></li> </ul></li>
<li>the <code>&lt;devices&gt;</code>section includes an emulator <li>the <code>&lt;devices&gt;</code> section includes an emulator entry
entrypointing to an additional program in charge of emulating the pointing to an additional program in charge of emulating the devices</li>
devices</li> <li>the disk entry indicates in the dev target section that the emulation
<li>the disk entry indicates in the dev target section that the for the drive is the first IDE disk device hda. The list of device names
emulationfor the drive is the first IDE disk device hda. The list of supported is dependant on the Hypervisor, but for Xen it can be any IDE
device namessupported is dependant on the Hypervisor, but for Xen it can device <code>hda</code>-<code>hdd</code>, or a floppy device
be any IDEdevice <code>hda</code>-<code>hdd</code>, or a floppy <code>fda</code>, <code>fdb</code>. The <code>&lt;disk&gt;</code> element
device<code>fda</code>, <code>fdb</code>. The also supports a 'device' attribute to indicate what kinda of hardware to
<code>&lt;disk&gt;</code>elementalso supports a 'device' attribute to emulate. The following values are supported:
indicate what kinda of hardware toemulate. The following values are <ul><li><code>floppy</code> - a floppy disk controller</li>
supported: <li><code>disk</code> - a generic hard drive (the default it
<ul><li><code>floppy</code>- a floppy disk controller</li> omitted)</li>
<li><code>disk</code>- a generic hard drive (the default itomitted)</li> <li><code>cdrom</code> - a CDROM device</li>
<li><code>cdrom</code>- a CDROM device</li>
</ul> </ul>
For Xen 3.0.2 and earlier a CDROM device can only be emulated on For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
the<code>hdc</code>channel, while for 3.0.3 and later, it can be <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated
emulatedon any IDE channel.</li> on any IDE channel.</li>
<li>the <code>&lt;devices&gt;</code>section also include at least oneentry <li>the <code>&lt;devices&gt;</code> section also include at least one
for the graphic device used to render the os. Currently there isjust 2 entry for the graphic device used to render the os. Currently there is
types possible 'vnc' or 'sdl'. If the type is 'vnc', then anadditional just 2 types possible 'vnc' or 'sdl'. If the type is 'vnc', then an
<code>port</code>attribute will be present indicating the TCPport on additional <code>port</code> attribute will be present indicating the TCP
which the VNC server is accepting client connections.</li> port on which the VNC server is accepting client connections.</li>
</ul><p>It is likely that the HVM description gets additional optional elementsand </ul><p>It is likely that the HVM description gets additional optional elements
attributes as the support for fully virtualized domain expands,especially for and attributes as the support for fully virtualized domain expands,
the variety of devices emulated and the graphic supportoptions offered.</p><h3><a name="KVM1" id="KVM1">KVM domain (added in 0.2.0)</a></h3><p>Support for the <a href="http://kvm.qumranet.com/">KVM virtualization</a> especially for the variety of devices emulated and the graphic support
options offered.</p><h3><a name="KVM1" id="KVM1">KVM domain (added in 0.2.0)</a></h3><p>Support for the <a href="http://kvm.qumranet.com/">KVM virtualization</a>
is provided in recent Linux kernels (2.6.20 and onward). This requires is provided in recent Linux kernels (2.6.20 and onward). This requires
specific hardware with acceleration support and the availability of the specific hardware with acceleration support and the availability of the
special version of the <a href="http://fabrice.bellard.free.fr/qemu/">QEmu</a> binary. Since this special version of the <a href="http://fabrice.bellard.free.fr/qemu/">QEmu</a> binary. Since this
...@@ -415,4 +412,4 @@ Xen support, you will see the os_type of xen to indicate a paravirtual ...@@ -415,4 +412,4 @@ Xen support, you will see the os_type of xen to indicate a paravirtual
kernel, then architecture informations and potential features.</p><p>The third block (in green) gives similar informations but when running a kernel, then architecture informations and potential features.</p><p>The third block (in green) gives similar informations but when running a
32 bit OS fully virtualized with Xen using the hvm support.</p><p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the 32 bit OS fully virtualized with Xen using the hvm support.</p><p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
discussion</a> which led to the capabilities format in the mailing-list discussion</a> which led to the capabilities format in the mailing-list
archives.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> archives.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
...@@ -15,15 +15,16 @@ ...@@ -15,15 +15,16 @@
</div> </div>
<div id="content"> <div id="content">
<h3>what is <span class="style1">libvirt?</span></h3> <h3>what is <span class="style1">libvirt?</span></h3>
<p>Libvirt is a C toolkit to interact with the virtualization capabilitiesof <p>Libvirt is a C toolkit to interact with the virtualization capabilities
recent versions of Linux (and other OSes). It is free software availableunder of recent versions of Linux (and other OSes). It is free software available
the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNULesser under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
General Public License</a>. Virtualization of the Linux OperatingSystem means Lesser General Public License</a>. Virtualization of the Linux Operating
the ability to run multiple instances of Operating Systemsconcurently on a System means the ability to run multiple instances of Operating Systems
single hardware system where the basic resources are drivenby a Linux concurently on a single hardware system where the basic resources are driven
instance. The library aim at providing long term stable C APIinitially for by a Linux instance. The library aim at providing long term stable C API
the <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xenparavirtualization</a>but initially for the <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen
should be able to integrate other virtualizationmechanisms if needed.</p> paravirtualization</a> but should be able to integrate other
virtualization mechanisms, it currently also support <a href="http://fabrice.bellard.free.fr/qemu/">QEmu</a> and <a href="http://kvm.qumranet.com/">KVM</a>.</p>
</div> </div>
</div> </div>
<div class="linkList"> <div class="linkList">
...@@ -46,7 +47,7 @@ should be able to integrate other virtualizationmechanisms if needed.</p> ...@@ -46,7 +47,7 @@ should be able to integrate other virtualizationmechanisms if needed.</p>
<a href="downloads.html">Downloads</a> <a href="downloads.html">Downloads</a>
</li> </li>
<li> <li>
<a href="format.html">XML Formats</a> <a href="format.html">XML Format</a>
</li> </li>
<li> <li>
<a href="python.html">Binding for Python</a> <a href="python.html">Binding for Python</a>
......
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Introduction</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Introduction</h1><p>Libvirt is a C toolkit to interact with the virtualization capabilities <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Introduction</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Introduction</h1><p>Libvirt is a C toolkit to interact with the virtualization capabilities of
ofrecent versions of Linux (and other OSes), but libvirt won't try to recent versions of Linux (and other OSes), but libvirt won't try to provide
provideall possible interfaces for interacting with the virtualization all possible interfaces for interacting with the virtualization features.</p><p>To avoid ambiguity about the terms used here here are the definitions for
features.</p><p>To avoid ambiguity about the terms used here here are the definitions some of the specific concepts used in libvirt documentation:</p><ul><li>a <strong>node</strong> is a single physical machine</li>
forsome of the specific concepts used in libvirt documentation:</p><ul><li>a <strong>node</strong>is a single physical machine</li> <li>an <strong>hypervisor</strong> is a layer of software allowing to
<li>an <strong>hypervisor</strong>is a layer of software allowing virtualize a node in a set of virtual machines with possibly different
tovirtualize a node in a set of virtual machines with possibly configurations than the node itself</li>
differentconfigurations than the node itself</li> <li>a <strong>domain</strong> is an instance of an operating system running
<li>a <strong>domain</strong>is an instance of an operating system on a virtualized machine provided by the hypervisor</li>
runningon a virtualized machine provided by the hypervisor</li> </ul><p style="text-align: center"><img alt="Hypervisor and domains running on a node" src="node.gif" /></p><p>Now we can define the goal of libvirt: to provide the lowest possible
</ul><p style="text-align: center"><img alt="Hypervisor and domains running on a node" src="node.gif" /></p><p>Now we can define the goal of libvirt: to provide the lowest generic and stable layer to manage domains on a node.</p><p>This implies the following:</p><ul><li>the API should not be targetted to a single virtualization environment
possiblegeneric and stable layer to manage domains on a node.</p><p>This implies the following:</p><ul><li>the API is not targetted to a single virtualization environment, though Xen is the current default, which also means that some very
itcurrently supports Xen and QEmu/KVM. This also implies that some specific capabilities which are not generic enough may not be provided as
veryspecific capabilities which are not generic enough may not be libvirt APIs</li>
provided aslibvirt APIs</li> <li>the API should allow to do efficiently and cleanly all the operations
<li>the API should allow to do efficiently and cleanly all the needed to manage domains on a node</li>
operationsneeded to manage domains on a node</li> <li>the API will not try to provide hight level multi-nodes management
<li>the API will not try to provide hight level multi-nodes features like load balancing, though they could be implemented on top of
managementfeatures like load balancing, though they could be implemented libvirt</li>
on top oflibvirt</li> <li>stability of the API is a big concern, libvirt should isolate
<li>stability of the API is a big concern, libvirt should applications from the frequent changes expected at the lower level of the
isolateapplications from the frequent changes expected at the lower level virtualization framework</li>
of thevirtualization framework</li> </ul><p>So libvirt should be a building block for higher level management tools
</ul><p>So libvirt should be a building block for higher level management toolsand and for applications focusing on virtualization of a single node (the only
for applications focusing on virtualization of a single node (the exception being domain migration between node capabilities which may need to
onlyexception being domain migration between node capabilities which may need be added at the libvirt level). Where possible libvirt should be extendable
tobe added at the libvirt level). Where possible libvirt should be to be able to provide the same API for remote nodes, however this is not the
extendableto be able to provide the same API for remote nodes, however this case at the moment, the code currently handle only local node accesses
is not thecase at the moment, the code currently handle only local node (extension for remote access support is being worked on, see <a href="bugs.html">the mailing list</a> discussions about it).</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
accesses(extension for remote access support is being worked on, see<a href="bugs.html">the mailing list</a>discussions about it).</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<html> <html>
<head> <head>
<meta http-equiv="content-type" content=""> <meta http-equiv="Content-Type" content="">
<title>Libvirt the virtualization API</title> <title>Libvirt the virtualization API</title>
</head> </head>
<body bgcolor="#ffffff"> <body bgcolor="#ffffff">
<h1 align="center">Libvirt the virtualization API</h1> <h1 align="center">Libvirt the virtualization API</h1>
<h1>Note: this is the flat content of the <a <h1>Note: this is the flat content of the <a href="index.html">web
href="index.html">website</a></h1> site</a></h1>
<h1 style="text-align: center">libvirt</h1> <h1 style="text-align: center">libvirt</h1>
<h3>what is <span class="style1">libvirt?</span></h3> <h3>what is <span class="style1">libvirt?</span></h3>
<p>Libvirt is a C toolkit to interact with the virtualization capabilitiesof <p>Libvirt is a C toolkit to interact with the virtualization capabilities
recent versions of Linux (and other OSes). It is free software availableunder of recent versions of Linux (and other OSes). It is free software available
the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNULesser under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
General Public License</a>. Virtualization of the Linux OperatingSystem means Lesser General Public License</a>. Virtualization of the Linux Operating
the ability to run multiple instances of Operating Systemsconcurently on a System means the ability to run multiple instances of Operating Systems
single hardware system where the basic resources are drivenby a Linux concurently on a single hardware system where the basic resources are driven
instance. The library aim at providing long term stable C APIinitially for by a Linux instance. The library aim at providing long term stable C API
the <a initially for the <a
href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xenparavirtualization</a>but href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen
should be able to integrate other virtualizationmechanisms if needed.</p> paravirtualization</a> but should be able to integrate other
virtualization mechanisms, it currently also support <a
href="http://fabrice.bellard.free.fr/qemu/">QEmu</a> and <a
href="http://kvm.qumranet.com/">KVM</a>.</p>
<h2><a name="News">Releases</a></h2> <h2><a name="News">Releases</a></h2>
<p>Here is the list of official releases, however since it is early on in <p>Here is the list of official releases, however since it is early on in the
thedevelopment of libvirt, it is preferable when possible to just use the <a development of libvirt, it is preferable when possible to just use the <a
href="downloads.html">CVS version or snapshot</a>, contact the mailing href="downloads.html">CVS version or snapshot</a>, contact the mailing list
listand check the <a href="ChangeLog.html">ChangeLog</a>to gauge and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progresses.</p>
progresses.</p>
<h3>0.2.1: Mar 16 2007</h3> <h3>0.2.1: Mar 16 2007</h3>
<ul> <ul>
<li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li> <li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li>
<li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt <li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
config directory (Daniel Berrange and Mark McLoughlin), memory leak in qemud (Mark), various fixes on network support (Mark), avoid Xen domain zombies on device hotplug errors (Daniel Berrange), various fixes on qemud (Mark), config directory (Daniel Berrange and Mark McLoughlin), memory leak
argsparsing (Richard Jones), virsh -t argument (Saori Fukuta), avoid virsh in qemud (Mark), various fixes on network support (Mark), avoid Xen
crash on TAB key (Daniel Berrange), detect xend operation failures (Kazuki Mizushima), don't listen on null socket (Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900 (Nobuhiro Itou), assorted networking fixes domain zombies on device hotplug errors (Daniel Berrange), various
(Daniel Berrange), shutoff and shutdown mismatches (Kazuki Mizushima), unlimited memory handling (Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li> fixes on qemud (Mark), args parsing (Richard Jones), virsh -t argument
<li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies and build (Daniel Berrange), fix xend port detection (Daniel Berrange), icompile time warnings (Mark), avoid const related compiler warnings (Daniel Berrange), automated builds (Daniel Berrange), pointer/int mismatch (Richard Jones), configure time selection of drivers, libvirt spec hacking (Daniel Berrange)</li> (Saori Fukuta), avoid virsh crash on TAB key (Daniel Berrange), detect
xend operation failures (Kazuki Mizushima), don't listen on null socket
(Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900
(Nobuhiro Itou), assorted networking fixes (Daniel Berrange), shutoff and
shutdown mismatches (Kazuki Mizushima), unlimited memory handling
(Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li>
<li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
and build (Daniel Berrange), fix xend port detection (Daniel
Berrange), icompile time warnings (Mark), avoid const related
compiler warnings (Daniel Berrange), automated builds (Daniel
Berrange), pointer/int mismatch (Richard Jones), configure time
selection of drivers, libvirt spec hacking (Daniel Berrange)</li>
<li>Add support for network autostart and init scripts (Mark McLoughlin)</li> <li>Add support for network autostart and init scripts (Mark McLoughlin)</li>
<li>New API virConnectGetCapabilities() to detect the virtualization <li>New API virConnectGetCapabilities() to detect the virtualization
capabilities of a host (Richard Jones)</li> capabilities of a host (Richard Jones)</li>
...@@ -54,16 +67,17 @@ progresses.</p> ...@@ -54,16 +67,17 @@ progresses.</p>
Jones), python bindings for new functions (Daniel Berrange)</li> Jones), python bindings for new functions (Daniel Berrange)</li>
<li>Documentation updates especially on the XML formats</li> <li>Documentation updates especially on the XML formats</li>
</ul> </ul>
<h3>0.2.0: Feb 14 2007</h3> <h3>0.2.0: Feb 14 2007</h3>
<ul> <ul>
<li>Various internal cleanups (Mark McLoughlin, Richard Jones,Daniel <li>Various internal cleanups (Mark McLoughlin, Richard Jones,
Berrange, Karel Zak)</li> Daniel Berrange, Karel Zak)</li>
<li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh <li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
argsparsing (Richard Jones)</li> parsing (Richard Jones)</li>
<li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li> <li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li>
<li>Add support for network configuration (Mark McLoughlin)</li> <li>Add support for network configuration (Mark McLoughlin)</li>
<li>Minor improvements: regression testing (Daniel Berrange),localization <li>Minor improvements: regression testing (Daniel Berrange),
string updates</li> localization string updates</li>
</ul> </ul>
<h3>0.1.11: Jan 22 2007</h3> <h3>0.1.11: Jan 22 2007</h3>
...@@ -77,19 +91,13 @@ progresses.</p> ...@@ -77,19 +91,13 @@ progresses.</p>
<h3>0.1.10: Dec 20 2006</h3> <h3>0.1.10: Dec 20 2006</h3>
<ul> <ul>
<li>more localizations</li> <li>more localizations</li>
<li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains <li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).</li>
buffer overflow (Daniel Berrange), reference count bug when creating Xen <li>improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).</li>
domains (Daniel Berrange).</li>
<li>improvements: support graphic framebuffer for Xen paravirt (Daniel
Berrange), VNC listen IP range support (Daniel Berrange), support for
default Xen config files and inactive domains of 3.0.4 (Daniel
Berrange).</li>
</ul> </ul>
<h3>0.1.9: Nov 29 2006</h3> <h3>0.1.9: Nov 29 2006</h3>
<ul> <ul>
<li>python bindings: release interpeter lock when calling C (Daniel <li>python bindings: release interpeter lock when calling C (Daniel Berrange)</li>
Berrange)</li>
<li>don't raise HTTP error when looking informations for a domain</li> <li>don't raise HTTP error when looking informations for a domain</li>
<li>some refactoring to use the driver for all entry points</li> <li>some refactoring to use the driver for all entry points</li>
<li>better error reporting (Daniel Berrange)</li> <li>better error reporting (Daniel Berrange)</li>
...@@ -97,105 +105,90 @@ progresses.</p> ...@@ -97,105 +105,90 @@ progresses.</p>
<li>provide XML parsing errors</li> <li>provide XML parsing errors</li>
<li>extension of the test framework (Daniel Berrange)</li> <li>extension of the test framework (Daniel Berrange)</li>
<li>fix the reconnect regression test</li> <li>fix the reconnect regression test</li>
<li>python bindings: Domain instances now link to the Connect to avoid <li>python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect</li>
garbage collection and disconnect</li> <li>separate the notion of maximum memory and current use at the XML level</li>
<li>separate the notion of maximum memory and current use at the XML
level</li>
<li>Fix a memory leak (Daniel Berrange)</li> <li>Fix a memory leak (Daniel Berrange)</li>
<li>add support for shareable drives</li> <li>add support for shareable drives</li>
<li>add support for non-bridge style networking configs for guests(Daniel <li>add support for non-bridge style networking configs for guests(Daniel Berrange)</li>
Berrange)</li>
<li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li> <li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li>
<li>new config APIs virConfNew() and virConfSetValue() to build configs <li>new config APIs virConfNew() and virConfSetValue() to build configs from scratch</li>
from scratch</li>
<li>hot plug device support based on Michel Ponceau patch</li> <li>hot plug device support based on Michel Ponceau patch</li>
<li>added support for inactive domains, new APIs, various associated <li>added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)</li>
cleanup (Daniel Berrange)</li>
<li>special device model for HVM guests (Daniel Berrange)</li> <li>special device model for HVM guests (Daniel Berrange)</li>
<li>add API to dump core of domains (but requires a patched xend)</li> <li>add API to dump core of domains (but requires a patched xend)</li>
<li>pygrub bootloader informations take over &lt;os&gt; informations</li> <li>pygrub bootloader informations take over &lt;os&gt; informations</li>
<li>updated the localization strings</li> <li>updated the localization strings</li>
</ul> </ul>
<h3>0.1.8: Oct 16 2006</h3> <h3>0.1.8: Oct 16 2006</h3>
<ul> <ul>
<li>Bug for system with page size != 4k</li> <li> Bug for system with page size != 4k</li>
<li>vcpu number initialization (Philippe Berthault)</li> <li> vcpu number initialization (Philippe Berthault)</li>
<li>don't label crashed domains as shut off (Peter Vetere)</li> <li> don't label crashed domains as shut off (Peter Vetere)</li>
<li>fix virsh man page (Noriko Mizumoto)</li> <li> fix virsh man page (Noriko Mizumoto)</li>
<li>blktapdd support for alternate drivers like blktap (Daniel <li> blktapdd support for alternate drivers like blktap (Daniel Berrange)</li>
Berrange)</li> <li> memory leak fixes (xend interface and XML parsing) (Daniel Berrange)</li>
<li>memory leak fixes (xend interface and XML parsing) (Daniel <li> compile fix</li>
Berrange)</li> <li> mlock/munlock size fixes (Daniel Berrange)</li>
<li>compile fix</li> <li> improve error reporting</li>
<li>mlock/munlock size fixes (Daniel Berrange)</li>
<li>improve error reporting</li>
</ul> </ul>
<h3>0.1.7: Sep 29 2006</h3> <h3>0.1.7: Sep 29 2006</h3>
<ul> <ul>
<li>fix a memory bug on getting vcpu informations from xend (Daniel <li> fix a memory bug on getting vcpu informations from xend (Daniel Berrange)</li>
Berrange)</li> <li> fix another problem in the hypercalls change in Xen changeset
<li>fix another problem in the hypercalls change in Xen 86d26e6ec89b when getting domain informations (Daniel Berrange)</li>
changeset86d26e6ec89b when getting domain informations (Daniel
Berrange)</li>
</ul> </ul>
<h3>0.1.6: Sep 22 2006</h3> <h3>0.1.6: Sep 22 2006</h3>
<ul> <ul>
<li>Support for localization of strings using gettext (Daniel Berrange)</li> <li>Support for localization of strings using gettext (Daniel Berrange)</li>
<li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel <li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)</li>
Berrange)</li> <li>Support for setting VNC port when creating domains with new
<li>Support for setting VNC port when creating domains with newxend config xend config files (Daniel Berrange) </li>
files (Daniel Berrange)</li>
<li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li> <li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li>
<li>Fix reconnection problem when talking directly to http xend</li> <li>Fix reconnection problem when talking directly to http xend</li>
</ul> </ul>
<h3>0.1.5: Sep 5 2006</h3> <h3>0.1.5: Sep 5 2006</h3>
<ul> <ul>
<li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li> <li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li>
<li>bug fixes: virParseUUID() was wrong, netwoking for paravirt <li>bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
guestsi(Daniel Berrange), virsh on non-existent domains (Daniel (Daniel Berrange), virsh on non-existent domains (Daniel Berrange),
Berrange),string cast bug when handling error in python (Pete Vetere), string cast bug when handling error in python (Pete Vetere), HTTP
HTTP500 xend error code handling (Pete Vetere and Daniel Berrange)</li> 500 xend error code handling (Pete Vetere and Daniel Berrange)</li>
<li>improvements: test suite for SEXPR &lt;-&gt; XML format conversions <li>improvements: test suite for SEXPR &lt;-&gt; XML format conversions (Daniel
(DanielBerrange), virsh output regression suite (Daniel Berrange), new Berrange), virsh output regression suite (Daniel Berrange), new environ
environvariable VIRSH_DEFAULT_CONNECT_URI for the default URI when variable VIRSH_DEFAULT_CONNECT_URI for the default URI when connecting
connecting(Daniel Berrange), graphical console support for paravirt (Daniel Berrange), graphical console support for paravirt guests
guests(Jeremy Katz), parsing of simple Xen config files (with Daniel (Jeremy Katz), parsing of simple Xen config files (with Daniel Berrange),
Berrange),early work on defined (not running) domains (Daniel early work on defined (not running) domains (Daniel Berrange),
Berrange),virsh output improvement (Daniel Berrange</li> virsh output improvement (Daniel Berrange</li>
</ul> </ul>
<h3>0.1.4: Aug 16 2006</h3> <h3>0.1.4: Aug 16 2006</h3>
<ul> <ul>
<li>bug fixes: spec file fix (Mark McLoughlin), error report problem <li>bug fixes: spec file fix (Mark McLoughlin), error report problem (with
(withHugh Brock), long integer in Python bindings (with Daniel Berrange), Hugh Brock), long integer in Python bindings (with Daniel Berrange), XML
XMLgeneration bug for CDRom (Daniel Berrange), bug whem using number() generation bug for CDRom (Daniel Berrange), bug whem using number() XPath
XPathfunction (Mark McLoughlin), fix python detection code, remove function (Mark McLoughlin), fix python detection code, remove duplicate
duplicateinitialization errors (Daniel Berrange)</li> initialization errors (Daniel Berrange)</li>
<li>improvements: UUID in XML description (Peter Vetere), proxy <li>improvements: UUID in XML description (Peter Vetere), proxy code
codecleanup, virtual CPU and affinity support + virsh support cleanup, virtual CPU and affinity support + virsh support (Michel
(MichelPonceau, Philippe Berthault, Daniel Berrange), port and tty Ponceau, Philippe Berthault, Daniel Berrange), port and tty informations
informationsfor console in XML (Daniel Berrange), added XML dump to for console in XML (Daniel Berrange), added XML dump to driver and proxy
driver and proxysupport (Daniel Berrange), extention of boot options with support (Daniel Berrange), extention of boot options with support for
support forfloppy and cdrom (Daniel Berrange), features block in XML to floppy and cdrom (Daniel Berrange), features block in XML to report/ask
report/askPAE, ACPI, APIC for HVM domains (Daniel Berrange), fail PAE, ACPI, APIC for HVM domains (Daniel Berrange), fail saide-effect
saide-effectoperations when using read-only connection, large operations when using read-only connection, large improvements to test
improvements to testdriver (Daniel Berrange)</li> driver (Daniel Berrange) </li>
<li>documentation: spelling (Daniel Berrange), test driver examples.</li> <li>documentation: spelling (Daniel Berrange), test driver examples.</li>
</ul> </ul>
<h3>0.1.3: Jul 11 2006</h3> <h3>0.1.3: Jul 11 2006</h3>
<ul> <ul>
<li>bugfixes: build as non-root, fix xend access when root, handling <li>bugfixes: build as non-root, fix xend access when root, handling of
ofempty XML elements (Mark McLoughlin), XML serialization and parsing empty XML elements (Mark McLoughlin), XML serialization and parsing fixes
fixes(Mark McLoughlin), allow to create domains without disk (Mark McLoughlin), allow to create domains without disk (Mark
(MarkMcLoughlin),</li> McLoughlin),</li>
<li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel <li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
Berrange),support for fully virtualized guest (Jim Fehlig, DV, Mark support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)</li>
McLoughlin)</li>
<li>documentation: augmented to cover hvm domains</li> <li>documentation: augmented to cover hvm domains</li>
</ul> </ul>
...@@ -207,60 +200,60 @@ progresses.</p> ...@@ -207,60 +200,60 @@ progresses.</p>
<h3>0.1.1: Jun 21 2006</h3> <h3>0.1.1: Jun 21 2006</h3>
<ul> <ul>
<li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel <li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
P.Berrange)</li> Berrange)</li>
<li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel <li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
P.Berrange)</li> Berrange)</li>
<li>Cope with API change introduced in Xen changeset 10277</li> <li>Cope with API change introduced in Xen changeset 10277</li>
<li>new test driver for regression checks (Daniel P. Berrange)</li> <li>new test driver for regression checks (Daniel P. Berrange)</li>
<li>improvements: added UUID to XML serialization, buffer usage (KarelZak), <li>improvements: added UUID to XML serialization, buffer usage (Karel
--connect argument to virsh (Daniel P. Berrange),</li> Zak), --connect argument to virsh (Daniel P. Berrange),</li>
<li>bug fixes: uninitialized memory access in error reporting, <li>bug fixes: uninitialized memory access in error reporting, S-Expr
S-Exprparsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
TODO inxs_internal.c</li> xs_internal.c</li>
<li>documentation: Python examples (David Lutterkort), new Perl bindingURL, <li>documentation: Python examples (David Lutterkort), new Perl binding
man page update (Karel Zak)</li> URL, man page update (Karel Zak)</li>
</ul> </ul>
<h3>0.1.0: Apr 10 2006</h3> <h3>0.1.0: Apr 10 2006</h3>
<ul> <ul>
<li>building fixes: --with-xen-distdir option (Ronald Aigner), out of <li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
treebuild and pkginfo cflag fix (Daniel Berrange)</li> build and pkginfo cflag fix (Daniel Berrange)</li>
<li>enhancement and fixes of the XML description format (David <li>enhancement and fixes of the XML description format (David Lutterkort
Lutterkortand Jim Fehlig)</li> and Jim Fehlig)</li>
<li>new APIs: for Node information and Reboot</li> <li>new APIs: for Node information and Reboot</li>
<li>internal code cleanup: refactoring internals into a driver model, <li>internal code cleanup: refactoring internals into a driver model, more
moreerror handling, structure sharing, thread safety and ref counting</li> error handling, structure sharing, thread safety and ref counting</li>
<li>bug fixes: error message (Jim Meyering), error allocation in virsh <li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
(JimMeyering), virDomainLookupByID (Jim Fehlig),</li> Meyering), virDomainLookupByID (Jim Fehlig),</li>
<li>documentation: updates on architecture, and format, typo fix <li>documentation: updates on architecture, and format, typo fix (Jim
(JimMeyering)</li> Meyering)</li>
<li>bindings: exception handling in examples (Jim Meyering), perl ones <li>bindings: exception handling in examples (Jim Meyering), perl ones out
outof tree (Daniel Berrange)</li> of tree (Daniel Berrange)</li>
<li>virsh: more options, create, nodeinfo (Karel Zak), renaming of <li>virsh: more options, create, nodeinfo (Karel Zak), renaming of some
someoptions (Karel Zak), use stderr only for errors (Karel Zak), man options (Karel Zak), use stderr only for errors (Karel Zak), man page
page(Andrew Puch)</li> (Andrew Puch)</li>
</ul> </ul>
<h3>0.0.6: Feb 28 2006</h3> <h3>0.0.6: Feb 28 2006</h3>
<ul> <ul>
<li>add UUID lookup and extract API</li> <li>add UUID lookup and extract API</li>
<li>add error handling APIs both synchronous and asynchronous</li> <li>add error handling APIs both synchronous and asynchronous</li>
<li>added minimal hook for error handling at the python level, improved <li>added minimal hook for error handling at the python level, improved the
thepython bindings</li> python bindings</li>
<li>augment the documentation and tests to cover error handling</li> <li>augment the documentation and tests to cover error handling</li>
</ul> </ul>
<h3>0.0.5: Feb 23 2006</h3> <h3>0.0.5: Feb 23 2006</h3>
<ul> <ul>
<li>Added XML description parsing, dependance to libxml2, implemented <li>Added XML description parsing, dependance to libxml2, implemented the
thecreation API virDomainCreateLinux()</li> creation API virDomainCreateLinux()</li>
<li>new APIs to lookup and name domain by UUID</li> <li>new APIs to lookup and name domain by UUID</li>
<li>fixed the XML dump when using the Xend access</li> <li>fixed the XML dump when using the Xend access</li>
<li>Fixed a few more problem related to the name change</li> <li>Fixed a few more problem related to the name change</li>
<li>Adding regression tests in python and examples in C</li> <li>Adding regression tests in python and examples in C</li>
<li>web site improvement, extended the documentation to cover the XMLformat <li>web site improvement, extended the documentation to cover the XML
and Python API</li> format and Python API</li>
<li>Added devhelp help for Gnome/Gtk programmers</li> <li>Added devhelp help for Gnome/Gtk programmers</li>
</ul> </ul>
...@@ -279,8 +272,8 @@ progresses.</p> ...@@ -279,8 +272,8 @@ progresses.</p>
<h3>0.0.2: Jan 29 2006</h3> <h3>0.0.2: Jan 29 2006</h3>
<ul> <ul>
<li>Update of the documentation, web site redesign (Diana Fong)</li> <li>Update of the documentation, web site redesign (Diana Fong)</li>
<li>integration of HTTP xend RPC based on libxend by Anthony Liquori <li>integration of HTTP xend RPC based on libxend by Anthony Liquori for
formost operations</li> most operations</li>
<li>Adding Save and Restore APIs</li> <li>Adding Save and Restore APIs</li>
<li>extended the virsh command line tool (Karel Zak)</li> <li>extended the virsh command line tool (Karel Zak)</li>
<li>remove xenstore transactions (Anthony Liguori)</li> <li>remove xenstore transactions (Anthony Liguori)</li>
...@@ -296,58 +289,58 @@ progresses.</p> ...@@ -296,58 +289,58 @@ progresses.</p>
<h2><a name="Introducti">Introduction</a></h2> <h2><a name="Introducti">Introduction</a></h2>
<p>Libvirt is a C toolkit to interact with the virtualization capabilities <p>Libvirt is a C toolkit to interact with the virtualization capabilities of
ofrecent versions of Linux (and other OSes), but libvirt won't try to recent versions of Linux (and other OSes), but libvirt won't try to provide
provideall possible interfaces for interacting with the virtualization all possible interfaces for interacting with the virtualization features.</p>
features.</p>
<p>To avoid ambiguity about the terms used here here are the definitions <p>To avoid ambiguity about the terms used here here are the definitions for
forsome of the specific concepts used in libvirt documentation:</p> some of the specific concepts used in libvirt documentation:</p>
<ul> <ul>
<li>a <strong>node</strong>is a single physical machine</li> <li>a <strong>node</strong> is a single physical machine</li>
<li>an <strong>hypervisor</strong>is a layer of software allowing <li>an <strong>hypervisor</strong> is a layer of software allowing to
tovirtualize a node in a set of virtual machines with possibly virtualize a node in a set of virtual machines with possibly different
differentconfigurations than the node itself</li> configurations than the node itself</li>
<li>a <strong>domain</strong>is an instance of an operating system <li>a <strong>domain</strong> is an instance of an operating system running
runningon a virtualized machine provided by the hypervisor</li> on a virtualized machine provided by the hypervisor</li>
</ul> </ul>
<p style="text-align: center"><img <p style="text-align: center"><img
alt="Hypervisor and domains running on a node" src="node.gif"></p> alt="Hypervisor and domains running on a node" src="node.gif"></p>
<p>Now we can define the goal of libvirt: to provide the lowest <p>Now we can define the goal of libvirt: to provide the lowest possible
possiblegeneric and stable layer to manage domains on a node.</p> generic and stable layer to manage domains on a node.</p>
<p>This implies the following:</p> <p>This implies the following:</p>
<ul> <ul>
<li>the API is not targetted to a single virtualization environment, <li>the API should not be targetted to a single virtualization environment
itcurrently supports Xen and QEmu/KVM. This also implies that some though Xen is the current default, which also means that some very
veryspecific capabilities which are not generic enough may not be specific capabilities which are not generic enough may not be provided as
provided aslibvirt APIs</li> libvirt APIs</li>
<li>the API should allow to do efficiently and cleanly all the <li>the API should allow to do efficiently and cleanly all the operations
operationsneeded to manage domains on a node</li> needed to manage domains on a node</li>
<li>the API will not try to provide hight level multi-nodes <li>the API will not try to provide hight level multi-nodes management
managementfeatures like load balancing, though they could be implemented features like load balancing, though they could be implemented on top of
on top oflibvirt</li> libvirt</li>
<li>stability of the API is a big concern, libvirt should <li>stability of the API is a big concern, libvirt should isolate
isolateapplications from the frequent changes expected at the lower level applications from the frequent changes expected at the lower level of the
of thevirtualization framework</li> virtualization framework</li>
</ul> </ul>
<p>So libvirt should be a building block for higher level management toolsand <p>So libvirt should be a building block for higher level management tools
for applications focusing on virtualization of a single node (the and for applications focusing on virtualization of a single node (the only
onlyexception being domain migration between node capabilities which may need exception being domain migration between node capabilities which may need to
tobe added at the libvirt level). Where possible libvirt should be be added at the libvirt level). Where possible libvirt should be extendable
extendableto be able to provide the same API for remote nodes, however this to be able to provide the same API for remote nodes, however this is not the
is not thecase at the moment, the code currently handle only local node case at the moment, the code currently handle only local node accesses
accesses(extension for remote access support is being worked on, see<a (extension for remote access support is being worked on, see <a
href="bugs.html">the mailing list</a>discussions about it).</p> href="bugs.html">the mailing list</a> discussions about it).</p>
<h2><a name="architecture">libvirt architecture</a></h2> <h2><a name="architecture">libvirt architecture</a></h2>
<p>Currently libvirt supports 2 kind of virtualization, and its <p>Currently libvirt supports 2 kind of virtualization, and its
internalstructure is based on a driver model which simplifies adding new internal structure is based on a driver model which simplifies adding new
engines:</p> engines:</p>
<ul> <ul>
<li><a href="#Xen">Xen hypervisor</a></li> <li><a href="#Xen">Xen hypervisor</a></li>
<li><a href="#QEmu">QEmu and KVM based virtualization</a></li> <li><a href="#QEmu">QEmu and KVM based virtualization</a></li>
...@@ -356,123 +349,123 @@ engines:</p> ...@@ -356,123 +349,123 @@ engines:</p>
<h3><a name="Xen">Libvirt Xen support</a></h3> <h3><a name="Xen">Libvirt Xen support</a></h3>
<p>When running in a Xen environment, programs using libvirt have to <p>When running in a Xen environment, programs using libvirt have to execute
executein "Domain 0", which is the primary Linux OS loaded on the machine. in "Domain 0", which is the primary Linux OS loaded on the machine. That OS
That OSkernel provides most if not all of the actual drivers used by the set kernel provides most if not all of the actual drivers used by the set of
ofdomains. It also runs the Xen Store, a database of informations shared by domains. It also runs the Xen Store, a database of informations shared by the
thehypervisor, the kernels, the drivers and the xen daemon. Xend. The xen hypervisor, the kernels, the drivers and the xen daemon. Xend. The xen daemon
daemonsupervise the control and execution of the sets of domains. The supervise the control and execution of the sets of domains. The hypervisor,
hypervisor,drivers, kernels and daemons communicate though a shared system drivers, kernels and daemons communicate though a shared system bus
busimplemented in the hypervisor. The figure below tries to provide a view implemented in the hypervisor. The figure below tries to provide a view of
ofthis environment:</p> this environment:</p>
<img src="architecture.gif" alt="The Xen architecture"> <img src="architecture.gif" alt="The Xen architecture">
<p>The library can be initialized in 2 ways depending on the level <p>The library can be initialized in 2 ways depending on the level of
ofpriviledge of the embedding program. If it runs with root priviledge of the embedding program. If it runs with root access,
access,virConnectOpen() can be used, it will use different ways to connect virConnectOpen() can be used, it will use three different ways to connect to
tothe Xen infrastructure:</p> the Xen infrastructure:</p>
<ul> <ul>
<li>a connection to the Xen Daemon though an HTTP RPC layer</li> <li>a connection to the Xen Daemon though an HTTP RPC layer</li>
<li>a read/write connection to the Xen Store</li> <li>a read/write connection to the Xen Store</li>
<li>use Xen Hypervisor calls</li> <li>use Xen Hypervisor calls</li>
<li>when used as non-root libvirt connect to a proxy daemon runningas root <li>when used as non-root libvirt connect to a proxy daemon running
and providing read-only support</li> as root and providing read-only support</li>
</ul> </ul>
<p>The library will usually interact with the Xen daemon for any <p>The library will usually interact with the Xen daemon for any operation
operationchanging the state of the system, but for performance and accuracy changing the state of the system, but for performance and accuracy reasons
reasonsmay talk directly to the hypervisor when gathering state informations may talk directly to the hypervisor when gathering state informations at
atleast when possible (i.e. when the running program using libvirt has least when possible (i.e. when the running program using libvirt has root
rootpriviledge access).</p> priviledge access).</p>
<p>If it runs without root access virConnectOpenReadOnly() should be used <p>If it runs without root access virConnectOpenReadOnly() should be used to
toconnect to initialize the library. It will then fork a libvirt_proxy connect to initialize the library. It will then fork a libvirt_proxy
programrunning as root and providing read_only access to the API, this is program running as root and providing read_only access to the API, this is
thenonly useful for reporting and monitoring.</p> then only useful for reporting and monitoring.</p>
<h3><a name="QEmu">Libvirt QEmu and KVM support</a></h3> <h3><a name="QEmu">Libvirt QEmu and KVM support</a></h3>
<p>The model for QEmu and KVM is completely similar, basically KVM isbased on <p>The model for QEmu and KVM is completely similar, basically KVM is based
QEmu for the process controlling a new domain, only small detailsdiffers on QEmu for the process controlling a new domain, only small details differs
between the two. In both case the libvirt API is providedby a controlling between the two. In both case the libvirt API is provided by a controlling
process forked by libvirt in the background andwhich launch and control the process forked by libvirt in the background and which launch and control the
QEmu or KVM process. That program calledlibvirt_qemud talks though a specific QEmu or KVM process. That program called libvirt_qemud talks though a specific
protocol to the library, andconnects to the console of the QEmu process in protocol to the library, and connects to the console of the QEmu process in
order to control andreport on its status. Libvirt tries to expose all the order to control and report on its status. Libvirt tries to expose all the
emulationsmodels of QEmu, the selection is done when creating the new emulations models of QEmu, the selection is done when creating the new
domain,by specifying the architecture and machine type targetted.</p> domain, by specifying the architecture and machine type targetted.</p>
<p>The code controlling the QEmu process is available in <p>The code controlling the QEmu process is available in the
the<code>qemud/</code>subdirectory.</p> <code>qemud/</code> directory.</p>
<h3><a name="drivers">the driver based architecture</a></h3> <h3><a name="drivers">the driver based architecture</a></h3>
<p>As the previous section explains, libvirt can communicate using <p>As the previous section explains, libvirt can communicate using different
differentchannels with the Xen hypervisor, and is also able to use different channels with the current hypervisor, and should also be able to use
kindof hypervisor. To simplify the internal design, code, easemaintainance different kind of hypervisor. To simplify the internal design, code, ease
and simplify the support of other virtualization engine theinternals have maintainance and simplify the support of other virtualization engine the
been structured as one core component, the libvirt.c moduleacting as a internals have been structured as one core component, the libvirt.c module
front-end for the library API and a set of hypvisor driversdefining a common acting as a front-end for the library API and a set of hypvisor drivers
set of routines. That way the Xen Daemon accces, the XenStore one, the defining a common set of routines. That way the Xen Daemon accces, the Xen
Hypervisor hypercall are all isolated in separate C modulesimplementing at Store one, the Hypervisor hypercall are all isolated in separate C modules
least a subset of the common operations defined by thedrivers present in implementing at least a subset of the common operations defined by the
driver.h. The driver architecture is used to add supportfor other drivers present in driver.h:</p>
virtualization engines and</p>
<ul> <ul>
<li>xend_internal: implements the driver functions though the <li>xend_internal: implements the driver functions though the Xen
XenDaemon.</li> Daemon</li>
<li>xs_internal: implements the subset of the driver availble though theXen <li>xs_internal: implements the subset of the driver availble though the
Store.</li> Xen Store</li>
<li>xen_internal: provide the implementation of the functions possible <li>xen_internal: provide the implementation of the functions possible via
viadirect Xen hypervisor access.</li> direct hypervisor access</li>
<li>proxy_internal: provide read-only Xen access via a proxy, the proxycode <li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
is in the <code>proxy/</code>sub directory.</li> is in the <code>proxy/</code>directory.</li>
<li>xm_internal: provide support for Xen defined but not running <li>xm_internal: provide support for Xen defined but not running
domains.</li> domains.</li>
<li>qemu_internal: implement the driver functions for QEmu and <li>qemu_internal: implement the driver functions for QEmu and
KVMvirtualization engines. It also uses a qemud/ specific daemon KVM virtualization engines. It also uses a qemud/ specific daemon
whichinterracts with the QEmu process to implement libvirt API.</li> which interracts with the QEmu process to implement libvirt API.</li>
<li>test: this is a test driver useful for regression tests of thefront-end <li>test: this is a test driver useful for regression tests of the
part of libvirt.</li> front-end part of libvirt.</li>
</ul> </ul>
<p>Note that a given driver may only implement a subset of those <p>Note that a given driver may only implement a subset of those functions,
functions,for example saving a Xen domain state to disk and restoring it is (for example saving a Xen domain state to disk and restoring it is only
only possiblethough the Xen Daemon, in that case the driver entry points are possible though the Xen Daemon), in that case the driver entry points for
initialized toNULL.</p> unsupported functions are initialized to NULL.</p>
<p></p> <p></p>
<h2><a name="Downloads">Downloads</a></h2> <h2><a name="Downloads">Downloads</a></h2>
<p>The latest versions of libvirt can be found on the <a <p>The latest versions of libvirt can be found on the <a
href="ftp://libvirt.org/libvirt/">libvirt.org</a>server ( <a href="ftp://libvirt.org/libvirt/">libvirt.org</a> server ( <a
href="http://libvirt.org/sources/">HTTP</a>, <a href="http://libvirt.org/sources/">HTTP</a>, <a
href="ftp://libvirt.org/libvirt/">FTP</a>). You will find there the href="ftp://libvirt.org/libvirt/">FTP</a>). You will find there the released
releasedversions as well as <a versions as well as <a
href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshottarballs</a>updated href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshot
from CVS head every hour</p> tarballs</a> updated from CVS head every hour</p>
<p>Anonymous <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a>is <p>Anonymous <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a> is also
alsoavailable, first register onto the server:</p> available, first register onto the server:</p>
<p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login</code></p> <p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login</code></p>
<p>it will request a password, enter <strong>anoncvs</strong>. Then you <p>it will request a password, enter <strong>anoncvs</strong>. Then you can
cancheckout the development tree with:</p> checkout the development tree with:</p>
<p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co
libvirt</code></p>
<p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs <p>Use ./autogen.sh to configure the local checkout, then <code>make</code>
colibvirt</code></p> and <code>make install</code>, as usual. All normal cvs commands are now
available except commiting to the base.</p>
<p>Use ./autogen.sh to configure the local checkout, then <h2><a name="Format">XML Format</a></h2>
<code>make</code>and <code>make install</code>, as usual. All normal cvs
commands are nowavailable except commiting to the base.</p>
<h2><a name="Format">XML Formats</a></h2> <p>This section describes the XML format used to represent domains, there are
variations on the format based on the kind of domains run and the options
used to launch them:</p>
<p>This section describes the XML formats used mostly to represent domains,
there are variations on the format based on the kind of domains run and the
options used to launch them:</p>
<ul> <ul>
<li><a href="#Normal1">Normal paravirtualized Xen domains</a></li> <li><a href="#Normal1">Normal paravirtualized Xen domains</a></li>
<li><a href="#Fully1">Fully virtualized Xen domains</a></li> <li><a href="#Fully1">Fully virtualized Xen domains</a></li>
...@@ -485,16 +478,15 @@ options used to launch them:</p> ...@@ -485,16 +478,15 @@ options used to launch them:</p>
<p>The formats try as much as possible to follow the same structure and reuse <p>The formats try as much as possible to follow the same structure and reuse
elements and attributes where it makes sense.</p> elements and attributes where it makes sense.</p>
<h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized <h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
Xendomains</a>:</h3> guests</a>:</h3>
<p>The library use an XML format to describe domains, as input to <a <p>The library use an XML format to describe domains, as input to <a
href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>and href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
as the output of <a and as the output of <a
href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,the href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,
following is an example of the format as returned by the shell the following is an example of the format as returned by the shell command
command<code>virsh xmldump fc4</code>, where fc4 was one of the running <code>virsh xmldump fc4</code> , where fc4 was one of the running domains:</p>
domains:</p>
<pre>&lt;domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>&gt; <pre>&lt;domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>&gt;
&lt;name&gt;fc4&lt;/name&gt; &lt;name&gt;fc4&lt;/name&gt;
<span style="color: #00B200; background-color: #FFFFFF">&lt;os&gt; <span style="color: #00B200; background-color: #FFFFFF">&lt;os&gt;
...@@ -520,53 +512,52 @@ domains:</p> ...@@ -520,53 +512,52 @@ domains:</p>
&lt;/devices&gt; &lt;/devices&gt;
&lt;/domain&gt;</pre> &lt;/domain&gt;</pre>
<p>The root element must be called <code>domain</code>with no namespace, <p>The root element must be called <code>domain</code> with no namespace, the
the<code>type</code>attribute indicates the kind of hypervisor used, 'xen' <code>type</code> attribute indicates the kind of hypervisor used, 'xen' is
isthe default value. The <code>id</code>attribute gives the domain id the default value. The <code>id</code> attribute gives the domain id at
atruntime (not however that this may change, for example if the domain is runtime (not however that this may change, for example if the domain is saved
savedto disk and restored). The domain has a few children whose order is to disk and restored). The domain has a few children whose order is not
notsignificant:</p> significant:</p>
<ul> <ul>
<li>name: the domain name, preferably ASCII based</li> <li>name: the domain name, preferably ASCII based</li>
<li>memory: the maximum memory allocated to the domain in kilobytes</li> <li>memory: the maximum memory allocated to the domain in kilobytes</li>
<li>vcpu: the number of virtual cpu configured for the domain</li> <li>vcpu: the number of virtual cpu configured for the domain</li>
<li>os: a block describing the Operating System, its content will <li>os: a block describing the Operating System, its content will be
bedependant on the OS type dependant on the OS type
<ul> <ul>
<li>type: indicate the OS type, always linux at this point</li> <li>type: indicate the OS type, always linux at this point</li>
<li>kernel: path to the kernel on the Domain 0 filesystem</li> <li>kernel: path to the kernel on the Domain 0 filesystem</li>
<li>initrd: an optional path for the init ramdisk on the Domain <li>initrd: an optional path for the init ramdisk on the Domain 0
0filesystem</li> filesystem</li>
<li>cmdline: optional command line to the kernel</li> <li>cmdline: optional command line to the kernel</li>
<li>root: the root filesystem from the guest viewpoint, it may bepassed <li>root: the root filesystem from the guest viewpoint, it may be
as part of the cmdline content too</li> passed as part of the cmdline content too</li>
</ul> </ul>
</li> </li>
<li>devices: a list of <code>disk</code>, <li>devices: a list of <code>disk</code>, <code>interface</code> and
<code>interface</code>and<code>console</code>descriptions in no special <code>console</code> descriptions in no special order</li>
order</li>
</ul> </ul>
<p>The format of the devices and their type may grow over time, but <p>The format of the devices and their type may grow over time, but the
thefollowing should be sufficient for basic use:</p> following should be sufficient for basic use:</p>
<p>A <code>disk</code>device indicates a block device, it can have twovalues <p>A <code>disk</code> device indicates a block device, it can have two
for the type attribute either 'file' or 'block' corresponding to the 2options values for the type attribute either 'file' or 'block' corresponding to the 2
availble at the Xen layer. It has two mandatory children, and oneoptional one options availble at the Xen layer. It has two mandatory children, and one
in no specific order:</p> optional one in no specific order:</p>
<ul> <ul>
<li>source with a file attribute containing the path in Domain 0 to thefile <li>source with a file attribute containing the path in Domain 0 to the
or a dev attribute if using a block device, containing the devicename file or a dev attribute if using a block device, containing the device
('hda5' or '/dev/hda5')</li> name ('hda5' or '/dev/hda5')</li>
<li>target indicates in a dev attribute the device where it is mapped inthe <li>target indicates in a dev attribute the device where it is mapped in
guest</li> the guest</li>
<li>readonly an optional empty element indicating the device <li>readonly an optional empty element indicating the device is
isread-only</li> read-only</li>
</ul> </ul>
<p>An <code>interface</code>element describes a network device mapped on <p>An <code>interface</code> element describes a network device mapped on the
theguest, it also has a type whose value is currently 'bridge', it also have guest, it also has a type whose value is currently 'bridge', it also have a
anumber of children in no specific order:</p> number of children in no specific order:</p>
<ul> <ul>
<li>source: indicating the bridge name</li> <li>source: indicating the bridge name</li>
<li>mac: the optional mac address provided in the address attribute</li> <li>mac: the optional mac address provided in the address attribute</li>
...@@ -575,24 +566,23 @@ anumber of children in no specific order:</p> ...@@ -575,24 +566,23 @@ anumber of children in no specific order:</p>
<li>target: and optional target indicating the device name.</li> <li>target: and optional target indicating the device name.</li>
</ul> </ul>
<p>A <code>console</code>element describes a serial console connection tothe <p>A <code>console</code> element describes a serial console connection to
guest. It has no children, and a single attribute the guest. It has no children, and a single attribute <code>tty</code> which
<code>tty</code>whichprovides the path to the Pseudo TTY on which the guest provides the path to the Pseudo TTY on which the guest console can be
console can beaccessed</p> accessed</p>
<p>Life cycle actions for the domain can also be expressed in the XML <p>Life cycle actions for the domain can also be expressed in the XML format,
format,they drive what should be happening if the domain crashes, is rebooted they drive what should be happening if the domain crashes, is rebooted or is
or ispoweroff. There is various actions possible when this happen:</p> poweroff. There is various actions possible when this happen:</p>
<ul> <ul>
<li>destroy: The domain is cleaned up (that's the default normal <li>destroy: The domain is cleaned up (that's the default normal processing
processingin Xen)</li> in Xen)</li>
<li>restart: A new domain is started in place of the old one with the <li>restart: A new domain is started in place of the old one with the same
sameconfiguration parameters</li> configuration parameters</li>
<li>preserve: The domain will remain in memory until it is <li>preserve: The domain will remain in memory until it is destroyed
destroyedmanually, it won't be running but allows for post-mortem manually, it won't be running but allows for post-mortem debugging</li>
debugging</li> <li>rename-restart: a variant of the previous one but where the old domain
<li>rename-restart: a variant of the previous one but where the old is renamed before being saved to allow a restart</li>
domainis renamed before being saved to allow a restart</li>
</ul> </ul>
<p>The following could be used for a Xen production system:</p> <p>The following could be used for a Xen production system:</p>
...@@ -604,17 +594,17 @@ or ispoweroff. There is various actions possible when this happen:</p> ...@@ -604,17 +594,17 @@ or ispoweroff. There is various actions possible when this happen:</p>
... ...
&lt;/domain&gt;</pre> &lt;/domain&gt;</pre>
<p>While the format may be extended in various ways as support for <p>While the format may be extended in various ways as support for more
morehypervisor types and features are added, it is expected that this core hypervisor types and features are added, it is expected that this core subset
subsetwill remain functional in spite of the evolution of the library.</p> will remain functional in spite of the evolution of the library.</p>
<h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized <h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a>
guests</a>(added in 0.1.3):</h3> (added in 0.1.3):</h3>
<p>Here is an example of a domain description used to start a <p>Here is an example of a domain description used to start a fully
fullyvirtualized (a.k.a. HVM) Xen domain. This requires hardware virtualized (a.k.a. HVM) Xen domain. This requires hardware virtualization
virtualizationsupport at the processor level but allows to run unmodified support at the processor level but allows to run unmodified operating
operatingsystems:</p> systems:</p>
<pre>&lt;domain type='xen' id='3'&gt; <pre>&lt;domain type='xen' id='3'&gt;
&lt;name&gt;fv0&lt;/name&gt; &lt;name&gt;fv0&lt;/name&gt;
&lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt; &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
...@@ -659,56 +649,56 @@ operatingsystems:</p> ...@@ -659,56 +649,56 @@ operatingsystems:</p>
<p>There is a few things to notice specifically for HVM domains:</p> <p>There is a few things to notice specifically for HVM domains:</p>
<ul> <ul>
<li>the optional <code>&lt;features&gt;</code>block is used to <li>the optional <code>&lt;features&gt;</code> block is used to enable
enablecertain guest CPU / system features. For HVM guests the certain guest CPU / system features. For HVM guests the following
followingfeatures are defined: features are defined:
<ul> <ul>
<li><code>pae</code>- enable PAE memory addressing</li> <li><code>pae</code> - enable PAE memory addressing</li>
<li><code>apic</code>- enable IO APIC</li> <li><code>apic</code> - enable IO APIC</li>
<li><code>acpi</code>- enable ACPI bios</li> <li><code>acpi</code> - enable ACPI bios</li>
</ul> </ul>
</li> </li>
<li>the <code>&lt;os&gt;</code>block description is very different, firstit <li>the <code>&lt;os&gt;</code> block description is very different, first
indicates that the type is 'hvm' for hardware virtualization, theninstead it indicates that the type is 'hvm' for hardware virtualization, then
of a kernel, boot and command line arguments, it points to an osboot instead of a kernel, boot and command line arguments, it points to an os
loader which will extract the boot informations from the boot boot loader which will extract the boot informations from the boot device
devicespecified in a separate boot element. The <code>dev</code>attribute specified in a separate boot element. The <code>dev</code> attribute on
onthe <code>boot</code>tag can be one of: the <code>boot</code> tag can be one of:
<ul> <ul>
<li><code>fd</code>- boot from first floppy device</li> <li><code>fd</code> - boot from first floppy device</li>
<li><code>hd</code>- boot from first harddisk device</li> <li><code>hd</code> - boot from first harddisk device</li>
<li><code>cdrom</code>- boot from first cdrom device</li> <li><code>cdrom</code> - boot from first cdrom device</li>
</ul> </ul>
</li> </li>
<li>the <code>&lt;devices&gt;</code>section includes an emulator <li>the <code>&lt;devices&gt;</code> section includes an emulator entry
entrypointing to an additional program in charge of emulating the pointing to an additional program in charge of emulating the devices</li>
devices</li> <li>the disk entry indicates in the dev target section that the emulation
<li>the disk entry indicates in the dev target section that the for the drive is the first IDE disk device hda. The list of device names
emulationfor the drive is the first IDE disk device hda. The list of supported is dependant on the Hypervisor, but for Xen it can be any IDE
device namessupported is dependant on the Hypervisor, but for Xen it can device <code>hda</code>-<code>hdd</code>, or a floppy device
be any IDEdevice <code>hda</code>-<code>hdd</code>, or a floppy <code>fda</code>, <code>fdb</code>. The <code>&lt;disk&gt;</code> element
device<code>fda</code>, <code>fdb</code>. The also supports a 'device' attribute to indicate what kinda of hardware to
<code>&lt;disk&gt;</code>elementalso supports a 'device' attribute to emulate. The following values are supported:
indicate what kinda of hardware toemulate. The following values are
supported:
<ul> <ul>
<li><code>floppy</code>- a floppy disk controller</li> <li><code>floppy</code> - a floppy disk controller</li>
<li><code>disk</code>- a generic hard drive (the default itomitted)</li> <li><code>disk</code> - a generic hard drive (the default it
<li><code>cdrom</code>- a CDROM device</li> omitted)</li>
<li><code>cdrom</code> - a CDROM device</li>
</ul> </ul>
For Xen 3.0.2 and earlier a CDROM device can only be emulated on For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
the<code>hdc</code>channel, while for 3.0.3 and later, it can be <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated
emulatedon any IDE channel.</li> on any IDE channel.</li>
<li>the <code>&lt;devices&gt;</code>section also include at least oneentry <li>the <code>&lt;devices&gt;</code> section also include at least one
for the graphic device used to render the os. Currently there isjust 2 entry for the graphic device used to render the os. Currently there is
types possible 'vnc' or 'sdl'. If the type is 'vnc', then anadditional just 2 types possible 'vnc' or 'sdl'. If the type is 'vnc', then an
<code>port</code>attribute will be present indicating the TCPport on additional <code>port</code> attribute will be present indicating the TCP
which the VNC server is accepting client connections.</li> port on which the VNC server is accepting client connections.</li>
</ul> </ul>
<p>It is likely that the HVM description gets additional optional elementsand <p>It is likely that the HVM description gets additional optional elements
attributes as the support for fully virtualized domain expands,especially for and attributes as the support for fully virtualized domain expands,
the variety of devices emulated and the graphic supportoptions offered.</p> especially for the variety of devices emulated and the graphic support
options offered.</p>
<h3><a name="KVM1">KVM domain (added in 0.2.0)</a></h3> <h3><a name="KVM1">KVM domain (added in 0.2.0)</a></h3>
...@@ -990,27 +980,27 @@ archives.</p> ...@@ -990,27 +980,27 @@ archives.</p>
<h2><a name="Python" id="Python">Binding for Python</a></h2> <h2><a name="Python" id="Python">Binding for Python</a></h2>
<p>Libvirt comes with direct support for the Python language (just make <p>Libvirt comes with direct support for the Python language (just make sure
sureyou installed the libvirt-python package if not compiling from sources). you installed the libvirt-python package if not compiling from sources). Also
Alsonote that Daniel Berrange provides <a note that Daniel Berrange provides <a
href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">bindings for href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">bindings for Perl</a>
Perl</a>too.</p> too.</p>
<p>The Python binding should be complete and are mostly <p>The Python binding should be complete and are mostly automatically
automaticallygenerated from the formal description of the API in xml. The generated from the formal description of the API in xml. The bindings are
bindings arearticulated around 2 classes <code>virConnect</code>and virDomain articulated around 2 classes <code>virConnect</code> and virDomain mapping to
mapping tothe C types. Functions in the C API taking either type as argument the C types. Functions in the C API taking either type as argument then
thenbecomes methods for the classes, their name is just stripped from becomes methods for the classes, their name is just stripped from the
thevirConnect or virDomain(Get) prefix and the first letter gets converted virConnect or virDomain(Get) prefix and the first letter gets converted to
tolower case, for example the C functions:</p> lower case, for example the C functions:</p>
<p><code>int <a <p><code>int <a
href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>(virConnectPtr href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>
conn);</code></p> (virConnectPtr conn);</code></p>
<p><code>int <a <p><code>int <a
href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>(virDomainPtr href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>
domain, unsigned long memory);</code></p> (virDomainPtr domain, unsigned long memory);</code></p>
<p>become</p> <p>become</p>
...@@ -1018,18 +1008,18 @@ domain, unsigned long memory);</code></p> ...@@ -1018,18 +1008,18 @@ domain, unsigned long memory);</code></p>
<p><code>virDomain::setMaxMemory(self, memory)</code></p> <p><code>virDomain::setMaxMemory(self, memory)</code></p>
<p>This process is fully automated, you can get a summary of the conversionin <p>This process is fully automated, you can get a summary of the conversion
the file libvirtclass.txt present in the python dir or in the docs.Thereis a in the file libvirtclass.txt present in the python dir or in the docs.There
couple of function who don't map directly to their C counterparts due is a couple of function who don't map directly to their C counterparts due to
tospecificities in their argument conversions:</p> specificities in their argument conversions:</p>
<ul> <ul>
<li><code><a <li><code><a
href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>is href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>
replaced by <code>virDomain::listDomainsID(self)</code>which returnsa is replaced by <code>virDomain::listDomainsID(self)</code> which returns
list of the integer ID for the currently running domains</li> a list of the integer ID for the currently running domains</li>
<li><code><a <li><code><a
href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>is href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>
replaced by <code>virDomain::info()</code>which returns a list of is replaced by <code>virDomain::info()</code> which returns a list of
<ol> <ol>
<li>state: one of the state values (virDomainState)</li> <li>state: one of the state values (virDomainState)</li>
<li>maxMemory: the maximum memory used by the domain</li> <li>maxMemory: the maximum memory used by the domain</li>
...@@ -1040,9 +1030,8 @@ tospecificities in their argument conversions:</p> ...@@ -1040,9 +1030,8 @@ tospecificities in their argument conversions:</p>
</li> </li>
</ul> </ul>
<p>So let's look at a simple example inspired from the <p>So let's look at a simple example inspired from the <code>basic.py</code>
<code>basic.py</code>test found in <code>python/tests/</code>in the source test found in <code>python/tests/</code> in the source tree:</p>
tree:</p>
<pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span> <pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>
import sys import sys
...@@ -1060,20 +1049,20 @@ except: ...@@ -1060,20 +1049,20 @@ except:
print "Domain 0: id %d running %s" % (dom0.<span style="color: #FF0080; background-color: #FFFFFF">ID</span>(), dom0.<span style="color: #FF0080; background-color: #FFFFFF">OSType</span>()) print "Domain 0: id %d running %s" % (dom0.<span style="color: #FF0080; background-color: #FFFFFF">ID</span>(), dom0.<span style="color: #FF0080; background-color: #FFFFFF">OSType</span>())
print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre> print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre>
<p>There is not much to comment about it, it really is a straight mappingfrom <p>There is not much to comment about it, it really is a straight mapping
the C API, the only points to notice are:</p> from the C API, the only points to notice are:</p>
<ul> <ul>
<li>the import of the module called <code><span <li>the import of the module called <code><span
style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li> style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li>
<li>getting a connection to the hypervisor, in that case using <li>getting a connection to the hypervisor, in that case using the
theopenReadOnly function allows the code to execute as a normal user.</li> openReadOnly function allows the code to execute as a normal user.</li>
<li>getting an object representing the Domain 0 using <span <li>getting an object representing the Domain 0 using <span
style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li> style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li>
<li>if the domain is not found a libvirtError exception will be raised</li> <li>if the domain is not found a libvirtError exception will be raised</li>
<li>extracting and printing some informations about the domain usingvarious <li>extracting and printing some informations about the domain using
<span various <span
style="color: #E50073; background-color: #FFFFFF">methods</span>associated style="color: #E50073; background-color: #FFFFFF">methods</span>
to the virDomain class.</li> associated to the virDomain class.</li>
</ul> </ul>
<h2><a name="Errors" id="Errors">Handling of errors</a></h2> <h2><a name="Errors" id="Errors">Handling of errors</a></h2>
...@@ -1085,34 +1074,34 @@ the C API, the only points to notice are:</p> ...@@ -1085,34 +1074,34 @@ the C API, the only points to notice are:</p>
<li>dont force the library user into one style of error handling</li> <li>dont force the library user into one style of error handling</li>
</ul> </ul>
<p>As result the library provide both synchronous, callback based <p>As result the library provide both synchronous, callback based and
andasynchronous error reporting. When an error happens in the library code asynchronous error reporting. When an error happens in the library code the
theerror is logged, allowing to retrieve it later and if the user registered error is logged, allowing to retrieve it later and if the user registered an
anerror callback it will be called synchronously. Once the call to libvirt error callback it will be called synchronously. Once the call to libvirt ends
endsthe error can be detected by the return value and the full information the error can be detected by the return value and the full information for
forthe last logged error can be retrieved.</p> the last logged error can be retrieved.</p>
<p>To avoid as much as prossible troubles with a global variable in <p>To avoid as much as prossible troubles with a global variable in a
amultithreaded environment, libvirt will associate when possible the errors multithreaded environment, libvirt will associate when possible the errors to
tothe current connection they are related to, that way the error is stored in the current connection they are related to, that way the error is stored in a
adynamic structure which can be made thread specific. Error callback can dynamic structure which can be made thread specific. Error callback can be
beset specifically to a connection with</p> set specifically to a connection with</p>
<p>So error handling in the code is the following:</p> <p>So error handling in the code is the following:</p>
<ol> <ol>
<li>if the error can be associated to a connection for example when <li>if the error can be associated to a connection for example when failing
failingto look up a domain to look up a domain
<ol> <ol>
<li>if there is a callback associated to the connection set with <a <li>if there is a callback associated to the connection set with <a
href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,call href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
it with the error informations</li> call it with the error informations</li>
<li>otherwise if there is a global callback set with <a <li>otherwise if there is a global callback set with <a
href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,call href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
it with the error information</li> call it with the error information</li>
<li>otherwise call <a <li>otherwise call <a
href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>which href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
is the default error function of the library issuing the erroron which is the default error function of the library issuing the error
stderr</li> on stderr</li>
<li>save the error in the connection for later retrieval with <a <li>save the error in the connection for later retrieval with <a
href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li> href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li>
</ol> </ol>
...@@ -1120,12 +1109,12 @@ beset specifically to a connection with</p> ...@@ -1120,12 +1109,12 @@ beset specifically to a connection with</p>
<li>otherwise like when failing to create an hypervisor connection: <li>otherwise like when failing to create an hypervisor connection:
<ol> <ol>
<li>if there is a global callback set with <a <li>if there is a global callback set with <a
href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,call href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
it with the error information</li> call it with the error information</li>
<li>otherwise call <a <li>otherwise call <a
href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>which href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
is the default error function of the library issuing the erroron which is the default error function of the library issuing the error
stderr</li> on stderr</li>
<li>save the error in the connection for later retrieval with <a <li>save the error in the connection for later retrieval with <a
href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li> href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li>
</ol> </ol>
...@@ -1133,52 +1122,54 @@ beset specifically to a connection with</p> ...@@ -1133,52 +1122,54 @@ beset specifically to a connection with</p>
</ol> </ol>
<p>In all cases the error informations are provided as a <a <p>In all cases the error informations are provided as a <a
href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a>pointer href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
toread-only structure <a read-only structure <a
href="html/libvirt-virterror.html#virError">virError</a>containing href="html/libvirt-virterror.html#virError">virError</a> containing the
thefollowing fields:</p> following fields:</p>
<ul> <ul>
<li>code: an error number from the <a <li>code: an error number from the <a
href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>enum</li> href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
<li>domain: an enum indicating which part of libvirt raised the error see<a enum</li>
href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li> <li>domain: an enum indicating which part of libvirt raised the error see
<li>level: the error level, usually VIR_ERR_ERROR, though there is room <a
forwarnings like VIR_ERR_WARNING</li> href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li>
<li>level: the error level, usually VIR_ERR_ERROR, though there is room for
warnings like VIR_ERR_WARNING</li>
<li>message: the full human-readable formatted string of the error</li> <li>message: the full human-readable formatted string of the error</li>
<li>conn: if available a pointer to the <a <li>conn: if available a pointer to the <a
href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>connection href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
to the hypervisor where this happened</li> connection to the hypervisor where this happened</li>
<li>dom: if available a pointer to the <a <li>dom: if available a pointer to the <a
href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>domaintargetted href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
in the operation</li> targetted in the operation</li>
</ul> </ul>
<p>and then extra raw informations about the error which may be initializedto <p>and then extra raw informations about the error which may be initialized
0 or NULL if unused</p> to 0 or NULL if unused</p>
<ul> <ul>
<li>str1, str2, str3: string informations, usually str1 is the errormessage <li>str1, str2, str3: string informations, usually str1 is the error
format</li> message format</li>
<li>int1, int2: integer informations</li> <li>int1, int2: integer informations</li>
</ul> </ul>
<p>So usually, setting up specific error handling with libvirt consist <p>So usually, setting up specific error handling with libvirt consist of
ofregistering an handler with with <a registering an handler with with <a
href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>orwith href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a> or
<a with <a
href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,chech href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
the value of the code value, take appropriate action, if needed letlibvirt chech the value of the code value, take appropriate action, if needed let
print the error on stderr by calling <a libvirt print the error on stderr by calling <a
href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>.For href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>.
asynchronous error handing, set such a function doing nothing to avoidthe For asynchronous error handing, set such a function doing nothing to avoid
error being reported on stderr, and call virConnGetLastError the error being reported on stderr, and call virConnGetLastError or
orvirGetLastError when an API call returned an error value. It can be a virGetLastError when an API call returned an error value. It can be a good
goodidea to use <a idea to use <a
href="html/libvirt-virterror.html#virResetLastError">virResetError</a>or <a href="html/libvirt-virterror.html#virResetLastError">virResetError</a> or <a
href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>once href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>
an error has been processed fully.</p> once an error has been processed fully.</p>
<p>At the python level, there only a global reporting callback function <p>At the python level, there only a global reporting callback function at
atthis point, see the error.py example about it:</p> this point, see the error.py example about it:</p>
<pre>def handler(ctxt, err): <pre>def handler(ctxt, err):
global errno global errno
...@@ -1187,9 +1178,9 @@ atthis point, see the error.py example about it:</p> ...@@ -1187,9 +1178,9 @@ atthis point, see the error.py example about it:</p>
libvirt.registerErrorHandler(handler, 'context') </pre> libvirt.registerErrorHandler(handler, 'context') </pre>
<p>the second argument to the registerErrorHandler function is passed as <p>the second argument to the registerErrorHandler function is passed as the
thefist argument of the callback like in the C version. The error is a fist argument of the callback like in the C version. The error is a tuple
tuplecontaining the same field as a virError in C, but cast to Python.</p> containing the same field as a virError in C, but cast to Python.</p>
<h2><a name="FAQ" id="FAQ">FAQ</a></h2> <h2><a name="FAQ" id="FAQ">FAQ</a></h2>
...@@ -1205,54 +1196,53 @@ tuplecontaining the same field as a virError in C, but cast to Python.</p> ...@@ -1205,54 +1196,53 @@ tuplecontaining the same field as a virError in C, but cast to Python.</p>
<ol> <ol>
<li><em>Licensing Terms for libvirt</em> <li><em>Licensing Terms for libvirt</em>
<p>libvirt is released under the <a <p>libvirt is released under the <a
href="http://www.opensource.org/licenses/lgpl-license.html">GNU href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
LesserGeneral Public License</a>, see the file COPYING.LIB in the General Public License</a>, see the file COPYING.LIB in the distribution
distributionfor the precise wording. The only library that libvirt for the precise wording. The only library that libvirt depends upon is
depends upon isthe Xen store access library which is also licenced under the Xen store access library which is also licenced under the LGPL.</p>
the LGPL.</p>
</li> </li>
<li><em>Can I embed libvirt in a proprietary application ?</em> <li><em>Can I embed libvirt in a proprietary application ?</em>
<p>Yes. The LGPL allows you to embed libvirt into a <p>Yes. The LGPL allows you to embed libvirt into a proprietary
proprietaryapplication. It would be graceful to send-back bug fixes and application. It would be graceful to send-back bug fixes and improvements
improvementsas patches for possible incorporation in the main development as patches for possible incorporation in the main development tree. It
tree. Itwill decrease your maintainance costs anyway if you do so.</p> will decrease your maintainance costs anyway if you do so.</p>
</li> </li>
</ol> </ol>
<h3><a name="Installati">Installation</a></h3> <h3><a name="Installati">Installation</a></h3>
<ol> <ol>
<li><em>Where can I get libvirt</em>? <li><em>Where can I get libvirt</em> ?
<p>The original distribution comes from <a <p>The original distribution comes from <a
href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p> href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p>
</li> </li>
<li><em>I can't install the libvirt/libvirt-devel RPM packages due tofailed <li><em>I can't install the libvirt/libvirt-devel RPM packages due to
dependencies</em> failed dependencies</em>
<p>The most generic solution is to re-fetch the latest src.rpm , <p>The most generic solution is to re-fetch the latest src.rpm , and
andrebuild it locally with</p> rebuild it locally with</p>
<p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p> <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
<p>If everything goes well it will generate two binary rpm packages <p>If everything goes well it will generate two binary rpm packages (one
(oneproviding the shared libs and virsh, and the other one, the providing the shared libs and virsh, and the other one, the -devel
-develpackage, providing includes, static libraries and scripts needed to package, providing includes, static libraries and scripts needed to build
buildapplications with libvirt that you can install locally.</p> applications with libvirt that you can install locally.</p>
<p>One can also rebuild the RPMs from a tarball:</p> <p>One can also rebuild the RPMs from a tarball:</p>
<p><code>rpmbuild -ta libdir-xxx.tar.gz</code></p> <p><code>rpmbuild -ta libdir-xxx.tar.gz</code></p>
<p>Or from a configured tree with:</p> <p>Or from a configured tree with:</p>
<p><code>make rpm</code></p> <p><code>make rpm</code></p>
</li> </li>
<li><em>Failure to use the API for non-root users</em> <li><em>Failure to use the API for non-root users</em>
<p>Large parts of the API may only be accessible with root <p>Large parts of the API may only be accessible with root priviledges,
priviledges,however the read only access to the xenstore data doesnot however the read only access to the xenstore data doesnot have to be
have to beforbidden to user, at least for monitoring purposes. If "virsh forbidden to user, at least for monitoring purposes. If "virsh dominfo"
dominfo"fails to run as an user, change the mode of the xenstore fails to run as an user, change the mode of the xenstore read-only socket
read-only socketwith:</p> with:</p>
<p><code>chmod 666 /var/run/xenstored/socket_ro</code></p> <p><code>chmod 666 /var/run/xenstored/socket_ro</code></p>
<p>and also make sure that the Xen Daemon is running correctly with <p>and also make sure that the Xen Daemon is running correctly with local
localHTTP server enabled, this is defined HTTP server enabled, this is defined in
in<code>/etc/xen/xend-config.sxp</code>which need the following line to <code>/etc/xen/xend-config.sxp</code> which need the following line to be
beenabled:</p> enabled:</p>
<p><code>(xend-http-server yes)</code></p> <p><code>(xend-http-server yes)</code></p>
<p>If needed restart the xend daemon after making the change with <p>If needed restart the xend daemon after making the change with the
thefollowing command run as root:</p> following command run as root:</p>
<p><code>service xend restart</code></p> <p><code>service xend restart</code></p>
</li> </li>
</ol> </ol>
...@@ -1268,28 +1258,27 @@ tuplecontaining the same field as a virError in C, but cast to Python.</p> ...@@ -1268,28 +1258,27 @@ tuplecontaining the same field as a virError in C, but cast to Python.</p>
<p><code>./configure [possible options]</code></p> <p><code>./configure [possible options]</code></p>
<p><code>make</code></p> <p><code>make</code></p>
<p><code>make install</code></p> <p><code>make install</code></p>
<p>At that point you may have to rerun ldconfig or a similar utility <p>At that point you may have to rerun ldconfig or a similar utility to
toupdate your list of installed shared libs.</p> update your list of installed shared libs.</p>
</li> </li>
<li><em>What other libraries are needed to compile/install libvirt ?</em> <li><em>What other libraries are needed to compile/install libvirt ?</em>
<p>Libvirt requires libxenstore, which is usually provided by the <p>Libvirt requires libxenstore, which is usually provided by the xen
xenpackages as well as the public headers to compile against packages as well as the public headers to compile against libxenstore.</p>
libxenstore.</p>
</li> </li>
<li><em>I use the CVS version and there is no configure script</em> <li><em>I use the CVS version and there is no configure script</em>
<p>The configure script (and other Makefiles) are generated. Use <p>The configure script (and other Makefiles) are generated. Use the
theautogen.sh script to regenerate the configure script and autogen.sh script to regenerate the configure script and Makefiles,
Makefiles,like:</p> like:</p>
<p><code>./autogen.sh --prefix=/usr --disable-shared</code></p> <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
</li> </li>
</ol> </ol>
<h3><a name="Developer">Developer</a>corner</h3> <h3><a name="Developer">Developer</a> corner</h3>
<ol> <ol>
<li><em>Troubles compiling or linking programs using libvirt</em> <li><em>Troubles compiling or linking programs using libvirt</em>
<p>To simplify the process of reusing the library, libvirt comes <p>To simplify the process of reusing the library, libvirt comes with
withpkgconfig support, which can be used directly from autoconf support pkgconfig support, which can be used directly from autoconf support or
orvia the pkg-config command line tool, like:</p> via the pkg-config command line tool, like:</p>
<p><code>pkg-config libvirt --libs</code></p> <p><code>pkg-config libvirt --libs</code></p>
</li> </li>
</ol> </ol>
...@@ -1297,23 +1286,18 @@ tuplecontaining the same field as a virError in C, but cast to Python.</p> ...@@ -1297,23 +1286,18 @@ tuplecontaining the same field as a virError in C, but cast to Python.</p>
<h2><a name="Reporting">Reporting bugs and getting help</a></h2> <h2><a name="Reporting">Reporting bugs and getting help</a></h2>
<p>There is a mailing-list <a <p>There is a mailing-list <a
href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a>for href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
libvirt,with an <a with an <a href="https://www.redhat.com/archives/libvir-list/">on-line
href="https://www.redhat.com/archives/libvir-list/">on-linearchive</a>. archive</a>. Please subscribe to this list before posting by visiting the <a
Please subscribe to this list before posting by visiting the <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
href="https://www.redhat.com/mailman/listinfo/libvir-list">associated page and follow the instructions. Patches with explanations and provided as
Web</a>page and follow the instructions. Patches with explanations and attachments are really appreciated and will be discussed on the mailing list.
provided asattachments are really appreciated and will be discussed on the If possible generate the patches by using cvs diff -u in a CVS checkout.</p>
mailing list.If possible generate the patches by using cvs diff -u in a CVS
checkout.</p> <p>We use Red Hat Bugzilla to track bugs to libvirt. If you want to report a
bug, please check <a href="http://bugzilla.redhat.com/bugzilla/buglist.cgi?component=libvirt&amp;component=libvirt-devel&amp;component=libvirt-python&amp;bug_status=ASSIGNED&amp;bug_status=INVESTIGATE&amp;bug_status=NEW&amp;bug_status=REOPENED&amp;bug_status=VERIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr&amp;long_desc=&amp;Search=Search">the existing open bugs</a>, then if yours isn't a duplicate of
<p>We use Red Hat Bugzilla to track bugs to libvirt. If you want to report an existing bug, <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora%20Core&amp;component=libvirt">log a new bug</a>. It may be good
abug, please check <a to post to the <a href="mailto:libvir-list@redhat.com">mailing-list</a>
href="http://bugzilla.redhat.com/bugzilla/buglist.cgi?component=libvirt&amp;component=libvirt-devel&amp;component=libvirt-python&amp;bug_status=ASSIGNED&amp;bug_status=INVESTIGATE&amp;bug_status=NEW&amp;bug_status=REOPENED&amp;bug_status=VERIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr&amp;long_desc=&amp;Search=Search">the too if the issue looks serious, thanks !</p>
existing open bugs</a>, then if yours isn't a duplicate ofan existing bug, <a
href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora%20Core&amp;component=libvirt">log
a new bug</a>. It may be goodto post to the <a
href="mailto:libvir-list@redhat.com">mailing-list</a>too if the issue looks
serious, thanks !</p>
</body> </body>
</html> </html>
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Releases</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Releases</h1><p>Here is the list of official releases, however since it is early on in <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Releases</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Releases</h1><p>Here is the list of official releases, however since it is early on in the
thedevelopment of libvirt, it is preferable when possible to just use the <a href="downloads.html">CVS version or snapshot</a>, contact the mailing development of libvirt, it is preferable when possible to just use the <a href="downloads.html">CVS version or snapshot</a>, contact the mailing list
listand check the <a href="ChangeLog.html">ChangeLog</a>to gauge and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li>
progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)</li>
<li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt <li>Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
config directory (Daniel Berrange and Mark McLoughlin), memory leak in qemud (Mark), various fixes on network support (Mark), avoid Xen domain zombies on device hotplug errors (Daniel Berrange), various fixes on qemud (Mark), config directory (Daniel Berrange and Mark McLoughlin), memory leak
argsparsing (Richard Jones), virsh -t argument (Saori Fukuta), avoid virsh in qemud (Mark), various fixes on network support (Mark), avoid Xen
crash on TAB key (Daniel Berrange), detect xend operation failures (Kazuki Mizushima), don't listen on null socket (Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900 (Nobuhiro Itou), assorted networking fixes domain zombies on device hotplug errors (Daniel Berrange), various
(Daniel Berrange), shutoff and shutdown mismatches (Kazuki Mizushima), unlimited memory handling (Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li> fixes on qemud (Mark), args parsing (Richard Jones), virsh -t argument
<li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies and build (Daniel Berrange), fix xend port detection (Daniel Berrange), icompile time warnings (Mark), avoid const related compiler warnings (Daniel Berrange), automated builds (Daniel Berrange), pointer/int mismatch (Richard Jones), configure time selection of drivers, libvirt spec hacking (Daniel Berrange)</li> (Saori Fukuta), avoid virsh crash on TAB key (Daniel Berrange), detect
xend operation failures (Kazuki Mizushima), don't listen on null socket
(Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900
(Nobuhiro Itou), assorted networking fixes (Daniel Berrange), shutoff and
shutdown mismatches (Kazuki Mizushima), unlimited memory handling
(Atsushi SAKAI), python binding fixes (Tatsuro Enokura)</li>
<li>Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
and build (Daniel Berrange), fix xend port detection (Daniel
Berrange), icompile time warnings (Mark), avoid const related
compiler warnings (Daniel Berrange), automated builds (Daniel
Berrange), pointer/int mismatch (Richard Jones), configure time
selection of drivers, libvirt spec hacking (Daniel Berrange)</li>
<li>Add support for network autostart and init scripts (Mark McLoughlin)</li> <li>Add support for network autostart and init scripts (Mark McLoughlin)</li>
<li>New API virConnectGetCapabilities() to detect the virtualization <li>New API virConnectGetCapabilities() to detect the virtualization
capabilities of a host (Richard Jones)</li> capabilities of a host (Richard Jones)</li>
...@@ -21,28 +31,22 @@ progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Ric ...@@ -21,28 +31,22 @@ progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Ric
number of virtual CPU (Masayuki Sunou), virtsh --readonly option (Rich number of virtual CPU (Masayuki Sunou), virtsh --readonly option (Rich
Jones), python bindings for new functions (Daniel Berrange)</li> Jones), python bindings for new functions (Daniel Berrange)</li>
<li>Documentation updates especially on the XML formats</li> <li>Documentation updates especially on the XML formats</li>
</ul><h3>0.2.0: Feb 14 2007</h3><ul><li>Various internal cleanups (Mark McLoughlin, Richard Jones,Daniel </ul><h3>0.2.0: Feb 14 2007</h3><ul><li>Various internal cleanups (Mark McLoughlin, Richard Jones,
Berrange, Karel Zak)</li> Daniel Berrange, Karel Zak)</li>
<li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh <li>Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
argsparsing (Richard Jones)</li> parsing (Richard Jones)</li>
<li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li> <li>Add support for QEmu and KVM virtualization (Daniel Berrange)</li>
<li>Add support for network configuration (Mark McLoughlin)</li> <li>Add support for network configuration (Mark McLoughlin)</li>
<li>Minor improvements: regression testing (Daniel Berrange),localization <li>Minor improvements: regression testing (Daniel Berrange),
string updates</li> localization string updates</li>
</ul><h3>0.1.11: Jan 22 2007</h3><ul><li>Finish XML &lt;-&gt; XM config files support</li> </ul><h3>0.1.11: Jan 22 2007</h3><ul><li>Finish XML &lt;-&gt; XM config files support</li>
<li>Remove memory leak when freeing virConf objects</li> <li>Remove memory leak when freeing virConf objects</li>
<li>Finishing inactive domain support (Daniel Berrange)</li> <li>Finishing inactive domain support (Daniel Berrange)</li>
<li>Added a Relax-NG schemas to check XML instances</li> <li>Added a Relax-NG schemas to check XML instances</li>
</ul><h3>0.1.10: Dec 20 2006</h3><ul><li>more localizations</li> </ul><h3>0.1.10: Dec 20 2006</h3><ul><li>more localizations</li>
<li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains <li>bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).</li>
buffer overflow (Daniel Berrange), reference count bug when creating Xen <li>improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).</li>
domains (Daniel Berrange).</li> </ul><h3>0.1.9: Nov 29 2006</h3><ul><li>python bindings: release interpeter lock when calling C (Daniel Berrange)</li>
<li>improvements: support graphic framebuffer for Xen paravirt (Daniel
Berrange), VNC listen IP range support (Daniel Berrange), support for
default Xen config files and inactive domains of 3.0.4 (Daniel
Berrange).</li>
</ul><h3>0.1.9: Nov 29 2006</h3><ul><li>python bindings: release interpeter lock when calling C (Daniel
Berrange)</li>
<li>don't raise HTTP error when looking informations for a domain</li> <li>don't raise HTTP error when looking informations for a domain</li>
<li>some refactoring to use the driver for all entry points</li> <li>some refactoring to use the driver for all entry points</li>
<li>better error reporting (Daniel Berrange)</li> <li>better error reporting (Daniel Berrange)</li>
...@@ -50,134 +54,123 @@ progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Ric ...@@ -50,134 +54,123 @@ progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Ric
<li>provide XML parsing errors</li> <li>provide XML parsing errors</li>
<li>extension of the test framework (Daniel Berrange)</li> <li>extension of the test framework (Daniel Berrange)</li>
<li>fix the reconnect regression test</li> <li>fix the reconnect regression test</li>
<li>python bindings: Domain instances now link to the Connect to avoid <li>python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect</li>
garbage collection and disconnect</li> <li>separate the notion of maximum memory and current use at the XML level</li>
<li>separate the notion of maximum memory and current use at the XML
level</li>
<li>Fix a memory leak (Daniel Berrange)</li> <li>Fix a memory leak (Daniel Berrange)</li>
<li>add support for shareable drives</li> <li>add support for shareable drives</li>
<li>add support for non-bridge style networking configs for guests(Daniel <li>add support for non-bridge style networking configs for guests(Daniel Berrange)</li>
Berrange)</li>
<li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li> <li>python bindings: fix unsigned long marshalling (Daniel Berrange)</li>
<li>new config APIs virConfNew() and virConfSetValue() to build configs <li>new config APIs virConfNew() and virConfSetValue() to build configs from scratch</li>
from scratch</li>
<li>hot plug device support based on Michel Ponceau patch</li> <li>hot plug device support based on Michel Ponceau patch</li>
<li>added support for inactive domains, new APIs, various associated <li>added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)</li>
cleanup (Daniel Berrange)</li>
<li>special device model for HVM guests (Daniel Berrange)</li> <li>special device model for HVM guests (Daniel Berrange)</li>
<li>add API to dump core of domains (but requires a patched xend)</li> <li>add API to dump core of domains (but requires a patched xend)</li>
<li>pygrub bootloader informations take over &lt;os&gt; informations</li> <li>pygrub bootloader informations take over &lt;os&gt; informations</li>
<li>updated the localization strings</li> <li>updated the localization strings</li>
</ul><h3>0.1.8: Oct 16 2006</h3><ul><li>Bug for system with page size != 4k</li> </ul><h3>0.1.8: Oct 16 2006</h3><ul><li> Bug for system with page size != 4k</li>
<li>vcpu number initialization (Philippe Berthault)</li> <li> vcpu number initialization (Philippe Berthault)</li>
<li>don't label crashed domains as shut off (Peter Vetere)</li> <li> don't label crashed domains as shut off (Peter Vetere)</li>
<li>fix virsh man page (Noriko Mizumoto)</li> <li> fix virsh man page (Noriko Mizumoto)</li>
<li>blktapdd support for alternate drivers like blktap (Daniel <li> blktapdd support for alternate drivers like blktap (Daniel Berrange)</li>
Berrange)</li> <li> memory leak fixes (xend interface and XML parsing) (Daniel Berrange)</li>
<li>memory leak fixes (xend interface and XML parsing) (Daniel <li> compile fix</li>
Berrange)</li> <li> mlock/munlock size fixes (Daniel Berrange)</li>
<li>compile fix</li> <li> improve error reporting</li>
<li>mlock/munlock size fixes (Daniel Berrange)</li> </ul><h3>0.1.7: Sep 29 2006</h3><ul><li> fix a memory bug on getting vcpu informations from xend (Daniel Berrange)</li>
<li>improve error reporting</li> <li> fix another problem in the hypercalls change in Xen changeset
</ul><h3>0.1.7: Sep 29 2006</h3><ul><li>fix a memory bug on getting vcpu informations from xend (Daniel 86d26e6ec89b when getting domain informations (Daniel Berrange)</li>
Berrange)</li>
<li>fix another problem in the hypercalls change in Xen
changeset86d26e6ec89b when getting domain informations (Daniel
Berrange)</li>
</ul><h3>0.1.6: Sep 22 2006</h3><ul><li>Support for localization of strings using gettext (Daniel Berrange)</li> </ul><h3>0.1.6: Sep 22 2006</h3><ul><li>Support for localization of strings using gettext (Daniel Berrange)</li>
<li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel <li>Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)</li>
Berrange)</li> <li>Support for setting VNC port when creating domains with new
<li>Support for setting VNC port when creating domains with newxend config xend config files (Daniel Berrange) </li>
files (Daniel Berrange)</li>
<li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li> <li>Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)</li>
<li>Fix reconnection problem when talking directly to http xend</li> <li>Fix reconnection problem when talking directly to http xend</li>
</ul><h3>0.1.5: Sep 5 2006</h3><ul><li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li> </ul><h3>0.1.5: Sep 5 2006</h3><ul><li>Support for new hypercalls change in Xen changeset 86d26e6ec89b</li>
<li>bug fixes: virParseUUID() was wrong, netwoking for paravirt <li>bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
guestsi(Daniel Berrange), virsh on non-existent domains (Daniel (Daniel Berrange), virsh on non-existent domains (Daniel Berrange),
Berrange),string cast bug when handling error in python (Pete Vetere), string cast bug when handling error in python (Pete Vetere), HTTP
HTTP500 xend error code handling (Pete Vetere and Daniel Berrange)</li> 500 xend error code handling (Pete Vetere and Daniel Berrange)</li>
<li>improvements: test suite for SEXPR &lt;-&gt; XML format conversions <li>improvements: test suite for SEXPR &lt;-&gt; XML format conversions (Daniel
(DanielBerrange), virsh output regression suite (Daniel Berrange), new Berrange), virsh output regression suite (Daniel Berrange), new environ
environvariable VIRSH_DEFAULT_CONNECT_URI for the default URI when variable VIRSH_DEFAULT_CONNECT_URI for the default URI when connecting
connecting(Daniel Berrange), graphical console support for paravirt (Daniel Berrange), graphical console support for paravirt guests
guests(Jeremy Katz), parsing of simple Xen config files (with Daniel (Jeremy Katz), parsing of simple Xen config files (with Daniel Berrange),
Berrange),early work on defined (not running) domains (Daniel early work on defined (not running) domains (Daniel Berrange),
Berrange),virsh output improvement (Daniel Berrange</li> virsh output improvement (Daniel Berrange</li>
</ul><h3>0.1.4: Aug 16 2006</h3><ul><li>bug fixes: spec file fix (Mark McLoughlin), error report problem </ul><h3>0.1.4: Aug 16 2006</h3><ul><li>bug fixes: spec file fix (Mark McLoughlin), error report problem (with
(withHugh Brock), long integer in Python bindings (with Daniel Berrange), Hugh Brock), long integer in Python bindings (with Daniel Berrange), XML
XMLgeneration bug for CDRom (Daniel Berrange), bug whem using number() generation bug for CDRom (Daniel Berrange), bug whem using number() XPath
XPathfunction (Mark McLoughlin), fix python detection code, remove function (Mark McLoughlin), fix python detection code, remove duplicate
duplicateinitialization errors (Daniel Berrange)</li> initialization errors (Daniel Berrange)</li>
<li>improvements: UUID in XML description (Peter Vetere), proxy <li>improvements: UUID in XML description (Peter Vetere), proxy code
codecleanup, virtual CPU and affinity support + virsh support cleanup, virtual CPU and affinity support + virsh support (Michel
(MichelPonceau, Philippe Berthault, Daniel Berrange), port and tty Ponceau, Philippe Berthault, Daniel Berrange), port and tty informations
informationsfor console in XML (Daniel Berrange), added XML dump to for console in XML (Daniel Berrange), added XML dump to driver and proxy
driver and proxysupport (Daniel Berrange), extention of boot options with support (Daniel Berrange), extention of boot options with support for
support forfloppy and cdrom (Daniel Berrange), features block in XML to floppy and cdrom (Daniel Berrange), features block in XML to report/ask
report/askPAE, ACPI, APIC for HVM domains (Daniel Berrange), fail PAE, ACPI, APIC for HVM domains (Daniel Berrange), fail saide-effect
saide-effectoperations when using read-only connection, large operations when using read-only connection, large improvements to test
improvements to testdriver (Daniel Berrange)</li> driver (Daniel Berrange) </li>
<li>documentation: spelling (Daniel Berrange), test driver examples.</li> <li>documentation: spelling (Daniel Berrange), test driver examples.</li>
</ul><h3>0.1.3: Jul 11 2006</h3><ul><li>bugfixes: build as non-root, fix xend access when root, handling </ul><h3>0.1.3: Jul 11 2006</h3><ul><li>bugfixes: build as non-root, fix xend access when root, handling of
ofempty XML elements (Mark McLoughlin), XML serialization and parsing empty XML elements (Mark McLoughlin), XML serialization and parsing fixes
fixes(Mark McLoughlin), allow to create domains without disk (Mark McLoughlin), allow to create domains without disk (Mark
(MarkMcLoughlin),</li> McLoughlin),</li>
<li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel <li>improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
Berrange),support for fully virtualized guest (Jim Fehlig, DV, Mark support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)</li>
McLoughlin)</li>
<li>documentation: augmented to cover hvm domains</li> <li>documentation: augmented to cover hvm domains</li>
</ul><h3>0.1.2: Jul 3 2006</h3><ul><li>headers include paths fixup</li> </ul><h3>0.1.2: Jul 3 2006</h3><ul><li>headers include paths fixup</li>
<li>proxy mechanism for unpriviledged read-only access by httpu</li> <li>proxy mechanism for unpriviledged read-only access by httpu</li>
</ul><h3>0.1.1: Jun 21 2006</h3><ul><li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel </ul><h3>0.1.1: Jun 21 2006</h3><ul><li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
P.Berrange)</li> Berrange)</li>
<li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel <li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
P.Berrange)</li> Berrange)</li>
<li>Cope with API change introduced in Xen changeset 10277</li> <li>Cope with API change introduced in Xen changeset 10277</li>
<li>new test driver for regression checks (Daniel P. Berrange)</li> <li>new test driver for regression checks (Daniel P. Berrange)</li>
<li>improvements: added UUID to XML serialization, buffer usage (KarelZak), <li>improvements: added UUID to XML serialization, buffer usage (Karel
--connect argument to virsh (Daniel P. Berrange),</li> Zak), --connect argument to virsh (Daniel P. Berrange),</li>
<li>bug fixes: uninitialized memory access in error reporting, <li>bug fixes: uninitialized memory access in error reporting, S-Expr
S-Exprparsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
TODO inxs_internal.c</li> xs_internal.c</li>
<li>documentation: Python examples (David Lutterkort), new Perl bindingURL, <li>documentation: Python examples (David Lutterkort), new Perl binding
man page update (Karel Zak)</li> URL, man page update (Karel Zak)</li>
</ul><h3>0.1.0: Apr 10 2006</h3><ul><li>building fixes: --with-xen-distdir option (Ronald Aigner), out of </ul><h3>0.1.0: Apr 10 2006</h3><ul><li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
treebuild and pkginfo cflag fix (Daniel Berrange)</li> build and pkginfo cflag fix (Daniel Berrange)</li>
<li>enhancement and fixes of the XML description format (David <li>enhancement and fixes of the XML description format (David Lutterkort
Lutterkortand Jim Fehlig)</li> and Jim Fehlig)</li>
<li>new APIs: for Node information and Reboot</li> <li>new APIs: for Node information and Reboot</li>
<li>internal code cleanup: refactoring internals into a driver model, <li>internal code cleanup: refactoring internals into a driver model, more
moreerror handling, structure sharing, thread safety and ref counting</li> error handling, structure sharing, thread safety and ref counting</li>
<li>bug fixes: error message (Jim Meyering), error allocation in virsh <li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
(JimMeyering), virDomainLookupByID (Jim Fehlig),</li> Meyering), virDomainLookupByID (Jim Fehlig),</li>
<li>documentation: updates on architecture, and format, typo fix <li>documentation: updates on architecture, and format, typo fix (Jim
(JimMeyering)</li> Meyering)</li>
<li>bindings: exception handling in examples (Jim Meyering), perl ones <li>bindings: exception handling in examples (Jim Meyering), perl ones out
outof tree (Daniel Berrange)</li> of tree (Daniel Berrange)</li>
<li>virsh: more options, create, nodeinfo (Karel Zak), renaming of <li>virsh: more options, create, nodeinfo (Karel Zak), renaming of some
someoptions (Karel Zak), use stderr only for errors (Karel Zak), man options (Karel Zak), use stderr only for errors (Karel Zak), man page
page(Andrew Puch)</li> (Andrew Puch)</li>
</ul><h3>0.0.6: Feb 28 2006</h3><ul><li>add UUID lookup and extract API</li> </ul><h3>0.0.6: Feb 28 2006</h3><ul><li>add UUID lookup and extract API</li>
<li>add error handling APIs both synchronous and asynchronous</li> <li>add error handling APIs both synchronous and asynchronous</li>
<li>added minimal hook for error handling at the python level, improved <li>added minimal hook for error handling at the python level, improved the
thepython bindings</li> python bindings</li>
<li>augment the documentation and tests to cover error handling</li> <li>augment the documentation and tests to cover error handling</li>
</ul><h3>0.0.5: Feb 23 2006</h3><ul><li>Added XML description parsing, dependance to libxml2, implemented </ul><h3>0.0.5: Feb 23 2006</h3><ul><li>Added XML description parsing, dependance to libxml2, implemented the
thecreation API virDomainCreateLinux()</li> creation API virDomainCreateLinux()</li>
<li>new APIs to lookup and name domain by UUID</li> <li>new APIs to lookup and name domain by UUID</li>
<li>fixed the XML dump when using the Xend access</li> <li>fixed the XML dump when using the Xend access</li>
<li>Fixed a few more problem related to the name change</li> <li>Fixed a few more problem related to the name change</li>
<li>Adding regression tests in python and examples in C</li> <li>Adding regression tests in python and examples in C</li>
<li>web site improvement, extended the documentation to cover the XMLformat <li>web site improvement, extended the documentation to cover the XML
and Python API</li> format and Python API</li>
<li>Added devhelp help for Gnome/Gtk programmers</li> <li>Added devhelp help for Gnome/Gtk programmers</li>
</ul><h3>0.0.4: Feb 10 2006</h3><ul><li>Fix various bugs introduced in the name change</li> </ul><h3>0.0.4: Feb 10 2006</h3><ul><li>Fix various bugs introduced in the name change</li>
</ul><h3>0.0.3: Feb 9 2006</h3><ul><li>Switch name from from 'libvir' to libvirt</li> </ul><h3>0.0.3: Feb 9 2006</h3><ul><li>Switch name from from 'libvir' to libvirt</li>
<li>Starting infrastructure to add code examples</li> <li>Starting infrastructure to add code examples</li>
<li>Update of python bindings for completeness</li> <li>Update of python bindings for completeness</li>
</ul><h3>0.0.2: Jan 29 2006</h3><ul><li>Update of the documentation, web site redesign (Diana Fong)</li> </ul><h3>0.0.2: Jan 29 2006</h3><ul><li>Update of the documentation, web site redesign (Diana Fong)</li>
<li>integration of HTTP xend RPC based on libxend by Anthony Liquori <li>integration of HTTP xend RPC based on libxend by Anthony Liquori for
formost operations</li> most operations</li>
<li>Adding Save and Restore APIs</li> <li>Adding Save and Restore APIs</li>
<li>extended the virsh command line tool (Karel Zak)</li> <li>extended the virsh command line tool (Karel Zak)</li>
<li>remove xenstore transactions (Anthony Liguori)</li> <li>remove xenstore transactions (Anthony Liguori)</li>
...@@ -185,4 +178,4 @@ progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Ric ...@@ -185,4 +178,4 @@ progresses.</p><h3>0.2.1: Mar 16 2007</h3><ul><li>Various internal cleanups (Ric
</ul><h3>0.0.1: Dec 19 2005</h3><ul><li>First release</li> </ul><h3>0.0.1: Dec 19 2005</h3><ul><li>First release</li>
<li>Basic management of existing Xen domains</li> <li>Basic management of existing Xen domains</li>
<li>Minimal autogenerated Python bindings</li> <li>Minimal autogenerated Python bindings</li>
</ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> </ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Binding for Python</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Binding for Python</h1><p>Libvirt comes with direct support for the Python language (just make <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Binding for Python</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Binding for Python</h1><p>Libvirt comes with direct support for the Python language (just make sure
sureyou installed the libvirt-python package if not compiling from sources). you installed the libvirt-python package if not compiling from sources). Also
Alsonote that Daniel Berrange provides <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">bindings for note that Daniel Berrange provides <a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">bindings for Perl</a>
Perl</a>too.</p><p>The Python binding should be complete and are mostly too.</p><p>The Python binding should be complete and are mostly automatically
automaticallygenerated from the formal description of the API in xml. The generated from the formal description of the API in xml. The bindings are
bindings arearticulated around 2 classes <code>virConnect</code>and virDomain articulated around 2 classes <code>virConnect</code> and virDomain mapping to
mapping tothe C types. Functions in the C API taking either type as argument the C types. Functions in the C API taking either type as argument then
thenbecomes methods for the classes, their name is just stripped from becomes methods for the classes, their name is just stripped from the
thevirConnect or virDomain(Get) prefix and the first letter gets converted virConnect or virDomain(Get) prefix and the first letter gets converted to
tolower case, for example the C functions:</p><p><code>int <a href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>(virConnectPtr lower case, for example the C functions:</p><p><code>int <a href="html/libvirt-libvirt.html#virConnectNumOfDomains">virConnectNumOfDomains</a>
conn);</code></p><p><code>int <a href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>(virDomainPtr (virConnectPtr conn);</code></p><p><code>int <a href="html/libvirt-libvirt.html#virDomainSetMaxMemory">virDomainSetMaxMemory</a>
domain, unsigned long memory);</code></p><p>become</p><p><code>virConn::numOfDomains(self)</code></p><p><code>virDomain::setMaxMemory(self, memory)</code></p><p>This process is fully automated, you can get a summary of the conversionin (virDomainPtr domain, unsigned long memory);</code></p><p>become</p><p><code>virConn::numOfDomains(self)</code></p><p><code>virDomain::setMaxMemory(self, memory)</code></p><p>This process is fully automated, you can get a summary of the conversion
the file libvirtclass.txt present in the python dir or in the docs.Thereis a in the file libvirtclass.txt present in the python dir or in the docs.There
couple of function who don't map directly to their C counterparts due is a couple of function who don't map directly to their C counterparts due to
tospecificities in their argument conversions:</p><ul><li><code><a href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>is specificities in their argument conversions:</p><ul><li><code><a href="html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a></code>
replaced by <code>virDomain::listDomainsID(self)</code>which returnsa is replaced by <code>virDomain::listDomainsID(self)</code> which returns
list of the integer ID for the currently running domains</li> a list of the integer ID for the currently running domains</li>
<li><code><a href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>is <li><code><a href="html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a></code>
replaced by <code>virDomain::info()</code>which returns a list of is replaced by <code>virDomain::info()</code> which returns a list of
<ol><li>state: one of the state values (virDomainState)</li> <ol><li>state: one of the state values (virDomainState)</li>
<li>maxMemory: the maximum memory used by the domain</li> <li>maxMemory: the maximum memory used by the domain</li>
<li>memory: the current amount of memory used by the domain</li> <li>memory: the current amount of memory used by the domain</li>
<li>nbVirtCPU: the number of virtual CPU</li> <li>nbVirtCPU: the number of virtual CPU</li>
<li>cpuTime: the time used by the domain in nanoseconds</li> <li>cpuTime: the time used by the domain in nanoseconds</li>
</ol></li> </ol></li>
</ul><p>So let's look at a simple example inspired from the </ul><p>So let's look at a simple example inspired from the <code>basic.py</code>
<code>basic.py</code>test found in <code>python/tests/</code>in the source test found in <code>python/tests/</code> in the source tree:</p><pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>
tree:</p><pre>import <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>
import sys import sys
conn = <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>.openReadOnly(None) conn = <span style="color: #0071FF; background-color: #FFFFFF">libvirt</span>.openReadOnly(None)
...@@ -42,13 +41,13 @@ except: ...@@ -42,13 +41,13 @@ except:
sys.exit(1) sys.exit(1)
print "Domain 0: id %d running %s" % (dom0.<span style="color: #FF0080; background-color: #FFFFFF">ID</span>(), dom0.<span style="color: #FF0080; background-color: #FFFFFF">OSType</span>()) print "Domain 0: id %d running %s" % (dom0.<span style="color: #FF0080; background-color: #FFFFFF">ID</span>(), dom0.<span style="color: #FF0080; background-color: #FFFFFF">OSType</span>())
print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre><p>There is not much to comment about it, it really is a straight mappingfrom print dom0.<span style="color: #FF0080; background-color: #FFFFFF">info</span>()</pre><p>There is not much to comment about it, it really is a straight mapping
the C API, the only points to notice are:</p><ul><li>the import of the module called <code><span style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li> from the C API, the only points to notice are:</p><ul><li>the import of the module called <code><span style="color: #0071FF; background-color: #FFFFFF">libvirt</span></code></li>
<li>getting a connection to the hypervisor, in that case using <li>getting a connection to the hypervisor, in that case using the
theopenReadOnly function allows the code to execute as a normal user.</li> openReadOnly function allows the code to execute as a normal user.</li>
<li>getting an object representing the Domain 0 using <span style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li> <li>getting an object representing the Domain 0 using <span style="color: #007F00; background-color: #FFFFFF">lookupByName</span></li>
<li>if the domain is not found a libvirtError exception will be raised</li> <li>if the domain is not found a libvirtError exception will be raised</li>
<li>extracting and printing some informations about the domain usingvarious <li>extracting and printing some informations about the domain using
<span style="color: #E50073; background-color: #FFFFFF">methods</span>associated various <span style="color: #E50073; background-color: #FFFFFF">methods</span>
to the virDomain class.</li> associated to the virDomain class.</li>
</ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Formats</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> </ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册