Added generic domain XML APIs

ChangeLog

@@ -1,3 +1,16 @@
+Fri Jul 11 15:49:59 BST 2008 Daniel P. Berrange <berrange@redhat.com>
+
+	Generic APIs for domain XML configuration
+	* include/libvirt/virterror.h, src/virterror.c: Added new
+	scope VIR_FROM_DOMAIN
+	* src/Makefile.am, po/POTFILES.in: Added domain_conf.{c,h}
+	* src/xml.c, src/xml.h: Added virXPath{Int,UInt} and
+	virXMLPropString functions
+	* src/network_conf.c, src/network_conf.h: Added generic
+	APIs for domain XML configuration
+	* src/util.h: Re-write verify() hook for enums, to allow
+	multiple enum declarations per file.
+
 Fri Jul 11 13:08:13 CEST 2008 Daniel Veillard <veillard@redhat.com>
 
 	* src/openvz_driver.c: fix from Evgeniy Sokolov to the probe function

include/libvirt/virterror.h

@@ -57,6 +57,7 @@ typedef enum {
     VIR_FROM_LXC,   /* Error from Linux Container driver */
     VIR_FROM_STORAGE,   /* Error from storage driver */
     VIR_FROM_NETWORK,   /* Error from network config */
+    VIR_FROM_DOMAIN,    /* Error from domain config */
 } virErrorDomain;
 
 

po/POTFILES.in

@@ -3,6 +3,7 @@ qemud/qemud.c
 qemud/remote.c
 src/conf.c
 src/console.c
+src/domain_conf.c
 src/hash.c
 src/iptables.c
 src/libvirt.c

src/Makefile.am

@@ -39,6 +39,7 @@ CLIENT_SOURCES =						\
 		test.c test.h                                   \
                 buf.c buf.h					\
 		qparams.c qparams.h				\
+                domain_conf.c domain_conf.h                     \
                 capabilities.c capabilities.h			\
 		xml.c xml.h					\
 		event.c event.h					\

src/domain_conf.h

@@ -0,0 +1,489 @@
+/*
+ * domain_conf.h: domain XML processing
+ *
+ * Copyright (C) 2006-2008 Red Hat, Inc.
+ * Copyright (C) 2006-2008 Daniel P. Berrange
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
+ *
+ * Author: Daniel P. Berrange <berrange@redhat.com>
+ */
+
+#ifndef __DOMAIN_CONF_H
+#define __DOMAIN_CONF_H
+
+#include <config.h>
+
+#include "internal.h"
+#include "capabilities.h"
+#include "util.h"
+
+/* Different types of hypervisor */
+/* NB: Keep in sync with virDomainVirtTypeToString impl */
+enum virDomainVirtType {
+    VIR_DOMAIN_VIRT_QEMU,
+    VIR_DOMAIN_VIRT_KQEMU,
+    VIR_DOMAIN_VIRT_KVM,
+    VIR_DOMAIN_VIRT_XEN,
+    VIR_DOMAIN_VIRT_LXC,
+    VIR_DOMAIN_VIRT_UML,
+    VIR_DOMAIN_VIRT_OPENVZ,
+    VIR_DOMAIN_VIRT_VSERVER,
+    VIR_DOMAIN_VIRT_LDOM,
+    VIR_DOMAIN_VIRT_TEST,
+    VIR_DOMAIN_VIRT_VMWARE,
+    VIR_DOMAIN_VIRT_HYPERV,
+
+    VIR_DOMAIN_VIRT_LAST,
+};
+
+/* Two types of disk backends */
+enum virDomainDiskType {
+    VIR_DOMAIN_DISK_TYPE_BLOCK,
+    VIR_DOMAIN_DISK_TYPE_FILE,
+
+    VIR_DOMAIN_DISK_TYPE_LAST
+};
+
+/* Three types of disk frontend */
+enum virDomainDiskDevice {
+    VIR_DOMAIN_DISK_DEVICE_DISK,
+    VIR_DOMAIN_DISK_DEVICE_CDROM,
+    VIR_DOMAIN_DISK_DEVICE_FLOPPY,
+
+    VIR_DOMAIN_DISK_DEVICE_LAST
+};
+
+enum virDomainDiskBus {
+    VIR_DOMAIN_DISK_BUS_IDE,
+    VIR_DOMAIN_DISK_BUS_FDC,
+    VIR_DOMAIN_DISK_BUS_SCSI,
+    VIR_DOMAIN_DISK_BUS_VIRTIO,
+    VIR_DOMAIN_DISK_BUS_XEN,
+
+    VIR_DOMAIN_DISK_BUS_LAST
+};
+
+/* Stores the virtual disk configuration */
+typedef struct _virDomainDiskDef virDomainDiskDef;
+typedef virDomainDiskDef *virDomainDiskDefPtr;
+struct _virDomainDiskDef {
+    int type;
+    int device;
+    int bus;
+    char *src;
+    char *dst;
+    char *driverName;
+    char *driverType;
+    unsigned int readonly : 1;
+    unsigned int shared : 1;
+
+    virDomainDiskDefPtr next;
+};
+
+
+/* 5 different types of networking config */
+enum virDomainNetType {
+    VIR_DOMAIN_NET_TYPE_USER,
+    VIR_DOMAIN_NET_TYPE_ETHERNET,
+    VIR_DOMAIN_NET_TYPE_SERVER,
+    VIR_DOMAIN_NET_TYPE_CLIENT,
+    VIR_DOMAIN_NET_TYPE_MCAST,
+    VIR_DOMAIN_NET_TYPE_NETWORK,
+    VIR_DOMAIN_NET_TYPE_BRIDGE,
+
+    VIR_DOMAIN_NET_TYPE_LAST,
+};
+
+
+#define VIR_DOMAIN_NET_MAC_SIZE 6
+
+/* Stores the virtual network interface configuration */
+typedef struct _virDomainNetDef virDomainNetDef;
+typedef virDomainNetDef *virDomainNetDefPtr;
+struct _virDomainNetDef {
+    int type;
+    unsigned char mac[VIR_DOMAIN_NET_MAC_SIZE];
+    char *model;
+    union {
+        struct {
+            char *dev;
+            char *script;
+            char *ipaddr;
+        } ethernet;
+        struct {
+            char *address;
+            int port;
+        } socket; /* any of NET_CLIENT or NET_SERVER or NET_MCAST */
+        struct {
+            char *name;
+        } network;
+        struct {
+            char *brname;
+        } bridge;
+    } data;
+    char *ifname;
+
+    virDomainNetDefPtr next;
+};
+
+enum virDomainChrSrcType {
+    VIR_DOMAIN_CHR_TYPE_NULL,
+    VIR_DOMAIN_CHR_TYPE_VC,
+    VIR_DOMAIN_CHR_TYPE_PTY,
+    VIR_DOMAIN_CHR_TYPE_DEV,
+    VIR_DOMAIN_CHR_TYPE_FILE,
+    VIR_DOMAIN_CHR_TYPE_PIPE,
+    VIR_DOMAIN_CHR_TYPE_STDIO,
+    VIR_DOMAIN_CHR_TYPE_UDP,
+    VIR_DOMAIN_CHR_TYPE_TCP,
+    VIR_DOMAIN_CHR_TYPE_UNIX,
+
+    VIR_DOMAIN_CHR_TYPE_LAST,
+};
+
+enum virDomainChrTcpProtocol {
+    VIR_DOMAIN_CHR_TCP_PROTOCOL_RAW,
+    VIR_DOMAIN_CHR_TCP_PROTOCOL_TELNET,
+
+    VIR_DOMAIN_CHR_TCP_PROTOCOL_LAST,
+};
+
+typedef struct _virDomainChrDef virDomainChrDef;
+typedef virDomainChrDef *virDomainChrDefPtr;
+struct _virDomainChrDef {
+    int dstPort;
+
+    int type;
+    union {
+        struct {
+            char *path;
+        } file; /* pty, file, pipe, or device */
+        struct {
+            char *host;
+            char *service;
+            int listen;
+            int protocol;
+        } tcp;
+        struct {
+            char *bindHost;
+            char *bindService;
+            char *connectHost;
+            char *connectService;
+        } udp;
+        struct {
+            char *path;
+            int listen;
+        } nix;
+    } data;
+
+    virDomainChrDefPtr next;
+};
+
+enum virDomainInputType {
+    VIR_DOMAIN_INPUT_TYPE_MOUSE,
+    VIR_DOMAIN_INPUT_TYPE_TABLET,
+
+    VIR_DOMAIN_INPUT_TYPE_LAST,
+};
+
+enum virDomainInputBus {
+    VIR_DOMAIN_INPUT_BUS_PS2,
+    VIR_DOMAIN_INPUT_BUS_USB,
+    VIR_DOMAIN_INPUT_BUS_XEN,
+
+    VIR_DOMAIN_INPUT_BUS_LAST
+};
+
+typedef struct _virDomainInputDef virDomainInputDef;
+typedef virDomainInputDef *virDomainInputDefPtr;
+struct _virDomainInputDef {
+    int type;
+    int bus;
+    virDomainInputDefPtr next;
+};
+
+enum virDomainSoundModel {
+    VIR_DOMAIN_SOUND_MODEL_SB16,
+    VIR_DOMAIN_SOUND_MODEL_ES1370,
+    VIR_DOMAIN_SOUND_MODEL_PCSPK,
+
+    VIR_DOMAIN_SOUND_MODEL_LAST
+};
+
+typedef struct _virDomainSoundDef virDomainSoundDef;
+typedef virDomainSoundDef *virDomainSoundDefPtr;
+struct _virDomainSoundDef {
+    int model;
+    virDomainSoundDefPtr next;
+};
+
+/* 3 possible graphics console modes */
+enum virDomainGraphicsType {
+    VIR_DOMAIN_GRAPHICS_TYPE_SDL,
+    VIR_DOMAIN_GRAPHICS_TYPE_VNC,
+
+    VIR_DOMAIN_GRAPHICS_TYPE_LAST,
+};
+
+typedef struct _virDomainGraphicsDef virDomainGraphicsDef;
+typedef virDomainGraphicsDef *virDomainGraphicsDefPtr;
+struct _virDomainGraphicsDef {
+    int type;
+    union {
+        struct {
+            int port;
+            int autoport : 1;
+            char *listenAddr;
+            char *keymap;
+            char *passwd;
+        } vnc;
+        struct {
+            char *display;
+            char *xauth;
+        } sdl;
+    } data;
+};
+
+
+
+/* Flags for the 'type' field in next struct */
+enum virDomainDeviceType {
+    VIR_DOMAIN_DEVICE_DISK,
+    VIR_DOMAIN_DEVICE_NET,
+    VIR_DOMAIN_DEVICE_INPUT,
+    VIR_DOMAIN_DEVICE_SOUND,
+};
+
+typedef struct _virDomainDeviceDef virDomainDeviceDef;
+typedef virDomainDeviceDef *virDomainDeviceDefPtr;
+struct _virDomainDeviceDef {
+    int type;
+    union {
+        virDomainDiskDefPtr disk;
+        virDomainNetDefPtr net;
+        virDomainInputDefPtr input;
+        virDomainSoundDefPtr sound;
+    } data;
+};
+
+
+#define VIR_DOMAIN_MAX_BOOT_DEVS 4
+
+/* 3 possible boot devices */
+enum virDomainBootOrder {
+    VIR_DOMAIN_BOOT_FLOPPY,
+    VIR_DOMAIN_BOOT_CDROM,
+    VIR_DOMAIN_BOOT_DISK,
+    VIR_DOMAIN_BOOT_NET,
+
+    VIR_DOMAIN_BOOT_LAST,
+};
+
+enum virDomainFeature {
+    VIR_DOMAIN_FEATURE_ACPI,
+    VIR_DOMAIN_FEATURE_APIC,
+    VIR_DOMAIN_FEATURE_PAE,
+
+    VIR_DOMAIN_FEATURE_LAST
+};
+
+enum virDomainLifecycleAction {
+    VIR_DOMAIN_LIFECYCLE_DESTROY,
+    VIR_DOMAIN_LIFECYCLE_RESTART,
+    VIR_DOMAIN_LIFECYCLE_RESTART_RENAME,
+    VIR_DOMAIN_LIFECYCLE_PRESERVE,
+
+    VIR_DOMAIN_LIFECYCLE_LAST
+};
+
+/* Operating system configuration data & machine / arch */
+typedef struct _virDomainOSDef virDomainOSDef;
+typedef virDomainOSDef *virDomainOSDefPtr;
+struct _virDomainOSDef {
+    char *type;
+    char *arch;
+    char *machine;
+    int nBootDevs;
+    int bootDevs[VIR_DOMAIN_BOOT_LAST];
+    char *kernel;
+    char *initrd;
+    char *cmdline;
+    char *root;
+    char *loader;
+    char *bootloader;
+    char *bootloaderArgs;
+};
+
+#define VIR_DOMAIN_CPUMASK_LEN 1024
+
+/* Guest VM main configuration */
+typedef struct _virDomainDef virDomainDef;
+typedef virDomainDef *virDomainDefPtr;
+struct _virDomainDef {
+    int virtType;
+    int id;
+    unsigned char uuid[VIR_UUID_BUFLEN];
+    char *name;
+
+    unsigned long memory;
+    unsigned long maxmem;
+    unsigned long vcpus;
+    int cpumasklen;
+    char *cpumask;
+
+    /* These 3 are based on virDomainLifeCycleAction enum flags */
+    int onReboot;
+    int onPoweroff;
+    int onCrash;
+
+    virDomainOSDef os;
+    char *emulator;
+    int features;
+
+    int localtime;
+
+    virDomainGraphicsDefPtr graphics;
+    virDomainDiskDefPtr disks;
+    virDomainNetDefPtr nets;
+    virDomainInputDefPtr inputs;
+    virDomainSoundDefPtr sounds;
+    virDomainChrDefPtr serials;
+    virDomainChrDefPtr parallels;
+    virDomainChrDefPtr console;
+};
+
+/* Guest VM runtime state */
+typedef struct _virDomainObj virDomainObj;
+typedef virDomainObj *virDomainObjPtr;
+struct _virDomainObj {
+    int stdin;
+    int stdout;
+    int stderr;
+    int monitor;
+    int logfile;
+    int pid;
+    int state;
+
+    int nvcpupids;
+    int *vcpupids;
+
+    unsigned int autostart : 1;
+    unsigned int persistent : 1;
+
+    char *configFile;
+    char *autostartLink;
+
+    virDomainDefPtr def; /* The current definition */
+    virDomainDefPtr newDef; /* New definition to activate at shutdown */
+
+    virDomainObjPtr next;
+};
+
+
+static inline int
+virDomainIsActive(virDomainObjPtr dom)
+{
+    return dom->def->id != -1;
+}
+
+
+virDomainObjPtr virDomainFindByID(const virDomainObjPtr doms,
+                                  int id);
+virDomainObjPtr virDomainFindByUUID(const virDomainObjPtr doms,
+                                    const unsigned char *uuid);
+virDomainObjPtr virDomainFindByName(const virDomainObjPtr doms,
+                                    const char *name);
+
+
+void virDomainGraphicsDefFree(virDomainGraphicsDefPtr def);
+void virDomainInputDefFree(virDomainInputDefPtr def);
+void virDomainDiskDefFree(virDomainDiskDefPtr def);
+void virDomainNetDefFree(virDomainNetDefPtr def);
+void virDomainChrDefFree(virDomainChrDefPtr def);
+void virDomainSoundDefFree(virDomainSoundDefPtr def);
+void virDomainDeviceDefFree(virDomainDeviceDefPtr def);
+void virDomainDefFree(virDomainDefPtr vm);
+void virDomainObjFree(virDomainObjPtr vm);
+
+virDomainObjPtr virDomainAssignDef(virConnectPtr conn,
+                                   virDomainObjPtr *doms,
+                                   const virDomainDefPtr def);
+void virDomainRemoveInactive(virDomainObjPtr *doms,
+                             virDomainObjPtr dom);
+
+virDomainDeviceDefPtr virDomainDeviceDefParse(virConnectPtr conn,
+                                              const virDomainDefPtr def,
+                                              const char *xmlStr);
+virDomainDefPtr virDomainDefParseString(virConnectPtr conn,
+                                        virCapsPtr caps,
+                                        const char *xmlStr);
+virDomainDefPtr virDomainDefParseFile(virConnectPtr conn,
+                                      virCapsPtr caps,
+                                      const char *filename);
+virDomainDefPtr virDomainDefParseNode(virConnectPtr conn,
+                                      virCapsPtr caps,
+                                      xmlDocPtr doc,
+                                      xmlNodePtr root);
+char *virDomainDefFormat(virConnectPtr conn,
+                         virDomainDefPtr def,
+                         int flags);
+
+int virDomainCpuSetParse(virConnectPtr conn,
+                         const char **str,
+                         char sep,
+                         char *cpuset,
+                         int maxcpu);
+char *virDomainCpuSetFormat(virConnectPtr conn,
+                            char *cpuset,
+                            int maxcpu);
+
+
+int virDomainSaveConfig(virConnectPtr conn,
+                        const char *configDir,
+                        const char *autostartDir,
+                        virDomainObjPtr dom);
+
+virDomainObjPtr virDomainLoadConfig(virConnectPtr conn,
+                                    virCapsPtr caps,
+                                    virDomainObjPtr *doms,
+                                    const char *configDir,
+                                    const char *autostartDir,
+                                    const char *file);
+
+int virDomainLoadAllConfigs(virConnectPtr conn,
+                            virCapsPtr caps,
+                            virDomainObjPtr *doms,
+                            const char *configDir,
+                            const char *autostartDir);
+
+int virDomainDeleteConfig(virConnectPtr conn,
+                          virDomainObjPtr dom);
+
+VIR_ENUM_DECL(virDomainVirt)
+VIR_ENUM_DECL(virDomainBoot)
+VIR_ENUM_DECL(virDomainFeature)
+VIR_ENUM_DECL(virDomainLifecycle)
+VIR_ENUM_DECL(virDomainDisk)
+VIR_ENUM_DECL(virDomainDiskDevice)
+VIR_ENUM_DECL(virDomainDiskBus)
+VIR_ENUM_DECL(virDomainNet)
+VIR_ENUM_DECL(virDomainChr)
+VIR_ENUM_DECL(virDomainSoundModel)
+VIR_ENUM_DECL(virDomainInput)
+VIR_ENUM_DECL(virDomainInputBus)
+VIR_ENUM_DECL(virDomainGraphics)
+
+#endif /* __DOMAIN_CONF_H */

src/util.h

@@ -100,7 +100,7 @@ const char *virEnumToString(const char *const*types,
 
 #define VIR_ENUM_IMPL(name, lastVal, ...)                               \
     static const char const *name ## TypeList[] = { __VA_ARGS__ };      \
-    verify(ARRAY_CARDINALITY(name ## TypeList) == lastVal);             \
+    extern int (* name ## Verify (void)) [verify_true (ARRAY_CARDINALITY(name ## TypeList) == lastVal)]; \
     const char *name ## TypeToString(int type) {                        \
         return virEnumToString(name ## TypeList,                        \
                                ARRAY_CARDINALITY(name ## TypeList),     \

src/virterror.c

@@ -307,6 +307,9 @@ virDefaultErrorFunc(virErrorPtr err)
         case VIR_FROM_NETWORK:
             dom = "Network Config ";
             break;
+        case VIR_FROM_DOMAIN:
+            dom = "Domain Config ";
+            break;
 
     }
     if ((err->dom != NULL) && (err->code != VIR_ERR_INVALID_DOMAIN)) {

src/xml.c

@@ -551,6 +551,13 @@ virXPathULong(const char *xpath, xmlXPathContextPtr ctxt, unsigned long *value)
     return (ret);
 }
 
+char *
+virXMLPropString(xmlNodePtr node,
+                 const char *name)
+{
+    return (char *)xmlGetProp(node, BAD_CAST name);
+}
+
 /**
  * virXPathBoolean:
  * @xpath: the XPath string to evaluate
@@ -648,20 +655,21 @@ virXPathNodeSet(const char *xpath, xmlXPathContextPtr ctxt,
                     _("Invalid parameter to virXPathNodeSet()"), 0);
         return (-1);
     }
+
+    if (list != NULL)
+        *list = NULL;
+
     relnode = ctxt->node;
     obj = xmlXPathEval(BAD_CAST xpath, ctxt);
     if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
-        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr <= 0) ||
+        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr < 0)) {
-        (obj->nodesetval->nodeTab == NULL)) {
         xmlXPathFreeObject(obj);
-        if (list != NULL)
-            *list = NULL;
         ctxt->node = relnode;
         return (-1);
     }
 
     ret = obj->nodesetval->nodeNr;
-    if (list != NULL) {
+    if (list != NULL && ret) {
         if (VIR_ALLOC_N(*list, ret) < 0) {
             virXMLError(NULL, VIR_ERR_NO_MEMORY,
                         _("allocate string array"),

src/xml.h

@@ -23,6 +23,12 @@ char *		virXPathString	(const char *xpath,
 int		virXPathNumber	(const char *xpath,
                                  xmlXPathContextPtr ctxt,
                                  double *value);
+int		virXPathInt	(const char *xpath,
+                                 xmlXPathContextPtr ctxt,
+                                 int *value);
+int		virXPathUInt	(const char *xpath,
+                                 xmlXPathContextPtr ctxt,
+                                 unsigned int *value);
 int		virXPathLong	(const char *xpath,
                                  xmlXPathContextPtr ctxt,
                                  long *value);
@@ -35,6 +41,10 @@ int		virXPathNodeSet	(const char *xpath,
                                  xmlXPathContextPtr ctxt,
                                  xmlNodePtr **list);
 
+char *          virXMLPropString(xmlNodePtr node,
+                                 const char *name);
+
+
 #if WITH_XEN || WITH_QEMU
 int		virParseCpuSet	(virConnectPtr conn,
                                  const char **str,