diff --git a/ChangeLog b/ChangeLog index 1863fbd554..daddac3db0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +Mon Aug 7 18:33:45 EDT 2006 Daniel Berrange + + * src/xend_internal.c: Added details of serial console TTY to XML + representation of domain. Fetch VNC port from xenstore if it is + available (only in xen 3.0.3 or later). + * src/xs_internal.c, src/xs_internal.h: Added APIs for retrieving + the serial console TTY and VNC server port from xenstore. + * docs/libvir.html: Document 'port' attribute for VNC graphics, + and '' element for serial console. + Mon Aug 7 21:57:41 CEST 2006 Daniel Veillard * TODO: updated with new items diff --git a/docs/format.html b/docs/format.html index c211813845..2749deaf95 100644 --- a/docs/format.html +++ b/docs/format.html @@ -28,6 +28,7 @@ the following is an example of the format as returned by the shell command <mac address='aa:00:00:00:00:11'/> <script path='/etc/xen/scripts/vif-bridge'/> </interface> + <console tty='/dev/pts/5'/> </devices> </domain>

The root element must be called domain with no namespace, the type attribute indicates the kind of hypervisor used, 'xen' is @@ -47,10 +48,10 @@ significant:

  • name: the domain name, preferably ASCII based
  • root: the root filesystem from the guest viewpoint, it may be passed as part of the cmdline content too
-
  • devices: a list of disk and interface - descriptions in no special order
    • +
  • devices: a list of disk, interface + and console descriptions in no special order

    • The format of the devices and their type may grow over time, but the -following should be sufficient for basic use:

    A disk device indicates a block device, it can have two values for the +following should be sufficient for basic use:

    A disk device indicates a block device, it can have two values for the type attribute either 'file' or 'block' corresponding to the 2 options availble at the Xen layer. It has two mandatory children, and one optional one in no specific order:

    • source with a file attribute containing the path in Domain 0 to the @@ -60,14 +61,17 @@ one in no specific order:

      • source with a file attribute containing the the guest
      • readonly an optional empty element indicating the device is read-only
        • -

      An interface element describes a network device mapped on the guest, it +

    An interface element describes a network device mapped on the guest, it also has a type whose value is currently 'bridge', it also have a number of children in no specific order:

    • source: indicating the bridge name
    • mac: the optional mac address provided in the address attribute
    • ip: the optional IP address provided in the address attribute
    • script: the script used to bridge the interfcae in the Domain 0
    • target: and optional target indicating the device name.
      • -

    Life cycle actions for the domain can also be expressed in the XML format, +

    A console element describes a serial console connection to the +guest. It has no children, and a single attribute tty which provides +the path to the Pseudo TTY on which the guest console can be accessed +

    Life cycle actions for the domain can also be expressed in the XML format, they drive what should be happening if the domain crashes, is rebooted or is poweroff. There is various actions possible when this happen:

    • destroy: The domain is cleaned up (that's the default normal processing in Xen)
      • @@ -113,7 +117,7 @@ systems:

      <domain type='xen' id='3'>
       <source file='/root/fv0'/>
       <target dev='ioemu:hda'/>
     </disk>
-    <graphics type='vnc'/>
+    <graphics type='vnc' port='5904'/>
   </devices>
 </domain>

      There is a few things to notice specifically for HVM domains:

      • the <os> block description is very different, first it indicates that the type is 'hvm' for hardware virtualization, then instead of a diff --git a/docs/libvir.html b/docs/libvir.html index 5b5716697c..f2534ff063 100644 --- a/docs/libvir.html +++ b/docs/libvir.html @@ -320,6 +320,7 @@ the following is an example of the format as returned by the shell command <mac address='aa:00:00:00:00:11'/> <script path='/etc/xen/scripts/vif-bridge'/> </interface> + <console tty='/dev/pts/5'/> </devices> </domain> @@ -345,14 +346,14 @@ significant:

        passed as part of the cmdline content too
      -
    • devices: a list of disk and interface - descriptions in no special order
      • +
    • devices: a list of disk, interface + and console descriptions in no special order

    The format of the devices and their type may grow over time, but the following should be sufficient for basic use:

    -

    A disk device indicates a block device, it can have two values for the +

    A disk device indicates a block device, it can have two values for the type attribute either 'file' or 'block' corresponding to the 2 options availble at the Xen layer. It has two mandatory children, and one optional one in no specific order:

    @@ -366,7 +367,7 @@ one in no specific order:

    read-only -

    An interface element describes a network device mapped on the guest, it +

    An interface element describes a network device mapped on the guest, it also has a type whose value is currently 'bridge', it also have a number of children in no specific order:

      @@ -377,6 +378,11 @@ children in no specific order:

    • target: and optional target indicating the device name.
    +

    A console element describes a serial console connection to the +guest. It has no children, and a single attribute tty which provides +the path to the Pseudo TTY on which the guest console can be accessed +

    +

    Life cycle actions for the domain can also be expressed in the XML format, they drive what should be happening if the domain crashes, is rebooted or is poweroff. There is various actions possible when this happen:

    @@ -435,7 +441,7 @@ systems:

    <source file='/root/fv0'/> <target dev='ioemu:hda'/> </disk> - <graphics type='vnc'/> + <graphics type='vnc' port='5904'/> </devices> </domain> diff --git a/src/xend_internal.c b/src/xend_internal.c index 64c332139d..ed9f2f3e5b 100644 --- a/src/xend_internal.c +++ b/src/xend_internal.c @@ -35,6 +35,7 @@ #include "xml.h" #include "xend_internal.h" #include "xen_internal.h" /* for DOM0_INTERFACE_VERSION */ +#include "xs_internal.h" /* To extract VNC port & Serial console TTY */ #ifndef PROXY static const char * xenDaemonGetType(virConnectPtr conn); @@ -1434,6 +1435,7 @@ xend_parse_sexp_desc_os(struct sexpr *node, virBufferPtr buf, int hvm) /** * xend_parse_sexp_desc: + * @domain: the domain associated with the XML * @root: the root of the parsed S-Expression * * Parse the xend sexp description and turn it into the XML format similar @@ -1443,11 +1445,12 @@ xend_parse_sexp_desc_os(struct sexpr *node, virBufferPtr buf, int hvm) * the caller must free() the returned value. */ static char * -xend_parse_sexp_desc(struct sexpr *root) +xend_parse_sexp_desc(virDomainPtr domain, struct sexpr *root) { char *ret; struct sexpr *cur, *node; const char *tmp; + char *tty; virBuffer buf; int hvm = 0; @@ -1599,11 +1602,13 @@ xend_parse_sexp_desc(struct sexpr *root) if (hvm) { /* Graphics device */ tmp = sexpr_node(root, "domain/image/hvm/vnc"); - /* XXX extract VNC port from XenStore if its available */ if (tmp != NULL) { - if (tmp[0] == '1') - virBufferVSprintf(&buf, " \n", - 5900 + sexpr_int(root, "domain/domid")); + if (tmp[0] == '1') { + int port = xenStoreDomainGetVNCPort(domain); + if (port == -1) + port = 5900 + sexpr_int(root, "domain/domid"); + virBufferVSprintf(&buf, " \n", port); + } } tmp = sexpr_node(root, "domain/image/hvm/sdl"); @@ -1618,6 +1623,12 @@ xend_parse_sexp_desc(struct sexpr *root) */ } + tty = xenStoreDomainGetConsolePath(domain); + if (tty) { + virBufferVSprintf(&buf, " \n", tty); + free(tty); + } + virBufferAdd(&buf, " \n", 13); virBufferAdd(&buf, "\n", 10); @@ -2145,7 +2156,7 @@ xenDaemonDomainDumpXML(virDomainPtr domain) if (root == NULL) return (NULL); - ret = xend_parse_sexp_desc(root); + ret = xend_parse_sexp_desc(domain, root); sexpr_free(root); return (ret); diff --git a/src/xs_internal.c b/src/xs_internal.c index 1ed72a7a50..f53812a71d 100644 --- a/src/xs_internal.c +++ b/src/xs_internal.c @@ -627,3 +627,41 @@ xenStoreDomainReboot(virDomainPtr domain, unsigned int flags ATTRIBUTE_UNUSED) return(virDomainDoStoreWrite(domain, "control/shutdown", "reboot")); } +/** + * xenStoreDomainGetVNCPort: + * @domain: pointer to the domain block + * + * Return the port number on which the domain is listening for VNC + * connections. + * + * Returns the port number, -1 in case of error + */ +int xenStoreDomainGetVNCPort(virDomainPtr domain) { + char *tmp; + int ret = -1; + + tmp = virDomainDoStoreQuery(domain, "console/vnc-port"); + if (tmp != NULL) { + char *end; + ret = strtol(tmp, &end, 10); + if (ret == 0 && end == tmp) + ret = -1; + free(tmp); + } + return(ret); +} + +/** + * xenStoreDomainGetConsolePath: + * @domain: pointer to the domain block + * + * Return the path to the psuedo TTY on which the guest domain's + * serial console is attached. + * + * Returns the path to the serial console. It is the callers + * responsibilty to free() the return string. Returns NULL + * on error + */ +char * xenStoreDomainGetConsolePath(virDomainPtr domain) { + return virDomainDoStoreQuery(domain, "console/tty"); +} diff --git a/src/xs_internal.h b/src/xs_internal.h index dcdb4e125c..2e4f4a4802 100644 --- a/src/xs_internal.h +++ b/src/xs_internal.h @@ -35,6 +35,9 @@ unsigned long xenStoreDomainGetMaxMemory(virDomainPtr domain); int xenStoreDomainShutdown (virDomainPtr domain); int xenStoreDomainReboot (virDomainPtr domain, unsigned int flags); +int xenStoreDomainGetVNCPort(virDomainPtr domain); +char * xenStoreDomainGetConsolePath(virDomainPtr domain); + #ifdef __cplusplus } #endif