conf: single object containing list of IP addresses, list of routes

There are currently two places in the domain where this combination is
used, and there is about to be another. This patch puts them together
for brevity and uniformity.

As with the newly-renamed virNetDevIPAddr and virNetDevIPRoute
objects, the new virNetDevIPInfo object will need to be accessed by a
utility function that calls low level Netlink functions (so we don't
want it to be in the conf directory) and will be called from multiple
hypervisor drivers (so it can't be in any hypervisor directory); the
most appropriate place is thus once again the util directory.

The parse and format functions are in conf/domain_conf.c because only
the domain XML (i.e. *not* the network XML) has this exact combination
of IP addresses plus routes. Note that virDomainNetIPInfoFormat() will
end up being the only caller to virDomainNetRoutesFormat() and
virDomainNetIPsFormat(), so it will just subsume those functions in a
later patch, but we can't do that until they are no longer called.

(It would have been nice to include the interface name within the
virNetDevIPInfo object (with a slight name change), but that can't
be done cleanly, because in each case the interface name is provided
in a different place in the XML relative to the routes and IP
addresses, so putting it in this object would actually make the code
more confused rather than simpler).

docs/schemas/domaincommon.rng

@@ -2629,6 +2629,33 @@
       </optional>
     </interleave>
   </define>
+
+  <!--
+      All ip-related info for either the host or guest side of an interface
+  -->
+  <define name="interface-ip-info">
+    <zeroOrMore>
+      <element name="ip">
+        <attribute name="address">
+          <ref name="ipAddr"/>
+        </attribute>
+        <optional>
+          <attribute name="family">
+            <ref name="addr-family"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="prefix">
+            <ref name="ipPrefix"/>
+          </attribute>
+        </optional>
+        <empty/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="route"/>
+    </zeroOrMore>
+  </define>
   <!--
       An emulator description is just a path to the binary used for the task
     -->

src/conf/domain_conf.c

@@ -6186,6 +6186,53 @@ virDomainNetIPParseXML(xmlNodePtr node)
     return ret;
 }
 
+
+/* fill in a virNetDevIPInfoPtr from the <route> and <ip>
+ * elements found in the given XML context.
+ *
+ * return 0 on success (including none found) and -1 on failure.
+ */
+static int ATTRIBUTE_UNUSED
+virDomainNetIPInfoParseXML(const char *source,
+                           xmlXPathContextPtr ctxt,
+                           virNetDevIPInfoPtr def)
+{
+    xmlNodePtr *nodes = NULL;
+    virNetDevIPAddrPtr ip = NULL;
+    virNetDevIPRoutePtr route = NULL;
+    int nnodes;
+    int ret = -1;
+    size_t i;
+
+    if ((nnodes = virXPathNodeSet("./ip", ctxt, &nodes)) < 0)
+        goto cleanup;
+
+    for (i = 0; i < nnodes; i++) {
+        if (!(ip = virDomainNetIPParseXML(nodes[i])) ||
+            VIR_APPEND_ELEMENT(def->ips, def->nips, ip) < 0)
+            goto cleanup;
+    }
+    VIR_FREE(nodes);
+
+    if ((nnodes = virXPathNodeSet("./route", ctxt, &nodes)) < 0)
+        goto cleanup;
+
+    for (i = 0; i < nnodes; i++) {
+        if (!(route = virNetDevIPRouteParseXML(source, nodes[i], ctxt)) ||
+            VIR_APPEND_ELEMENT(def->routes, def->nroutes, route) < 0)
+            goto cleanup;
+    }
+
+    ret = 0;
+ cleanup:
+    if (ret < 0)
+        virNetDevIPInfoClear(def);
+    VIR_FREE(ip);
+    virNetDevIPRouteFree(route);
+    VIR_FREE(nodes);
+    return ret;
+}
+
 static int
 virDomainHostdevDefParseXMLCaps(xmlNodePtr node ATTRIBUTE_UNUSED,
                                 xmlXPathContextPtr ctxt,
@@ -20322,6 +20369,19 @@ virDomainNetRoutesFormat(virBufferPtr buf,
     return 0;
 }
 
+
+static int ATTRIBUTE_UNUSED
+virDomainNetIPInfoFormat(virBufferPtr buf,
+                         virNetDevIPInfoPtr def)
+{
+    if (virDomainNetIPsFormat(buf, def->ips, def->nips) < 0)
+        return -1;
+    if (virDomainNetRoutesFormat(buf, def->routes, def->nroutes) < 0)
+        return -1;
+    return 0;
+}
+
+
 static int
 virDomainHostdevDefFormatSubsys(virBufferPtr buf,
                                 virDomainHostdevDefPtr def,

src/libvirt_private.syms

@@ -1931,6 +1931,7 @@ virNetDevBridgeSetVlanFiltering;
 virNetDevIPAddrAdd;
 virNetDevIPAddrDel;
 virNetDevIPAddrGet;
+virNetDevIPInfoClear;
 virNetDevIPRouteAdd;
 virNetDevIPRouteFree;
 virNetDevIPRouteGetAddress;

src/util/virnetdevip.c

@@ -845,3 +845,19 @@ virNetDevIPRouteGetGateway(virNetDevIPRoutePtr def)
         return &def->gateway;
     return NULL;
 }
+
+/* manipulating the virNetDevIPInfo object */
+
+void
+virNetDevIPInfoClear(virNetDevIPInfoPtr ip)
+{
+    size_t i;
+
+    for (i = 0; i < ip->nips; i++)
+        VIR_FREE(ip->ips[i]);
+    VIR_FREE(ip->ips);
+
+    for (i = 0; i < ip->nroutes; i++)
+        virNetDevIPRouteFree(ip->routes[i]);
+    VIR_FREE(ip->routes);
+}

src/util/virnetdevip.h

@@ -47,6 +47,14 @@ typedef struct {
     virSocketAddr gateway;      /* gateway IP address for ip-route */
 } virNetDevIPRoute, *virNetDevIPRoutePtr;
 
+/* A full set of all IP config info for a network device */
+typedef struct {
+    size_t nips;
+    virNetDevIPAddrPtr *ips;
+    size_t nroutes;
+    virNetDevIPRoutePtr *routes;
+} virNetDevIPInfo, *virNetDevIPInfoPtr;
+
 /* manipulating/querying the netdev */
 int virNetDevIPAddrAdd(const char *ifname,
                        virSocketAddr *addr,
@@ -76,4 +84,7 @@ int virNetDevIPRouteGetPrefix(virNetDevIPRoutePtr def);
 unsigned int virNetDevIPRouteGetMetric(virNetDevIPRoutePtr def);
 virSocketAddrPtr virNetDevIPRouteGetGateway(virNetDevIPRoutePtr def);
 
+/* virNetDevIPInfo object */
+void virNetDevIPInfoClear(virNetDevIPInfoPtr ip);
+
 #endif /* __VIR_NETDEVIP_H__ */