bhyve: add virBhyveDriverCreateXMLConf

Add virBhyveDriverCreateXMLConf, a simple wrapper around
virDomainXMLOptionNew that makes it easier to pass bhyveConnPtr
as a private data for parser. It will be used later for device
address allocation at parsing time.

Update consumers to use it instead of direct calls to
virDomainXMLOptionNew.

As we now have proper callbacks connected for the tests, update
test files accordingly to include the automatically generated
PCI root controller.

src/bhyve/bhyve_domain.c

@@ -83,6 +83,15 @@ bhyveDomainDeviceDefPostParse(virDomainDeviceDefPtr dev ATTRIBUTE_UNUSED,
     return 0;
 }
 
+virDomainXMLOptionPtr
+virBhyveDriverCreateXMLConf(bhyveConnPtr driver)
+{
+    virBhyveDriverDomainDefParserConfig.priv = driver;
+    return virDomainXMLOptionNew(&virBhyveDriverDomainDefParserConfig,
+                                 &virBhyveDriverPrivateDataCallbacks,
+                                 NULL);
+}
+
 virDomainDefParserConfig virBhyveDriverDomainDefParserConfig = {
     .devicesPostParseCallback = bhyveDomainDeviceDefPostParse,
     .domainPostParseCallback = bhyveDomainDefPostParse,

src/bhyve/bhyve_domain.h

@@ -37,6 +37,8 @@ struct _bhyveDomainObjPrivate {
     bhyveMonitorPtr mon;
 };
 
+virDomainXMLOptionPtr virBhyveDriverCreateXMLConf(bhyveConnPtr);
+
 extern virDomainXMLPrivateDataCallbacks virBhyveDriverPrivateDataCallbacks;
 extern virDomainDefParserConfig virBhyveDriverDomainDefParserConfig;
 

src/bhyve/bhyve_driver.c

@@ -1246,9 +1246,7 @@ bhyveStateInitialize(bool privileged,
     if (virBhyveProbeGrubCaps(&bhyve_driver->grubcaps) < 0)
         goto cleanup;
 
-    if (!(bhyve_driver->xmlopt = virDomainXMLOptionNew(&virBhyveDriverDomainDefParserConfig,
+    if (!(bhyve_driver->xmlopt = virBhyveDriverCreateXMLConf(bhyve_driver)))
-                                                       &virBhyveDriverPrivateDataCallbacks,
-                                                       NULL)))
         goto cleanup;
 
     if (!(bhyve_driver->domains = virDomainObjListNew()))

tests/bhyvexml2argvtest.c

@@ -7,6 +7,7 @@
 # include "datatypes.h"
 
 # include "bhyve/bhyve_capabilities.h"
+# include "bhyve/bhyve_domain.h"
 # include "bhyve/bhyve_utils.h"
 # include "bhyve/bhyve_command.h"
 
@@ -131,7 +132,7 @@ mymain(void)
     if ((driver.caps = virBhyveCapsBuild()) == NULL)
         return EXIT_FAILURE;
 
-    if ((driver.xmlopt = virDomainXMLOptionNew(NULL, NULL, NULL)) == NULL)
+    if ((driver.xmlopt = virBhyveDriverCreateXMLConf(&driver)) == NULL)
         return EXIT_FAILURE;
 
 # define DO_TEST_FULL(name, flags)                             \

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-acpiapic.xml

@@ -23,6 +23,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:81:c4:b1'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-base.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:b9:94:02'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-bhyveload-bootorder.xml

@@ -26,6 +26,7 @@
       <readonly/>
       <address type='drive' controller='0' bus='0' target='4' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:8d:10:e1'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-bhyveload-bootorder1.xml

@@ -26,6 +26,7 @@
       <readonly/>
       <address type='drive' controller='0' bus='0' target='4' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:92:68:0e'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-bhyveload-bootorder2.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:1e:63:25'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-bhyveload-bootorder3.xml

@@ -26,6 +26,7 @@
       <boot order='1'/>
       <address type='drive' controller='0' bus='0' target='4' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:7a:f5:a4'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-bhyveload-bootorder4.xml

@@ -27,6 +27,7 @@
       <boot order='1'/>
       <address type='drive' controller='0' bus='0' target='4' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:fe:97:82'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-bhyveload-explicitargs.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:11:bd:26'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-console.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:b1:42:eb'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-custom-loader.xml

@@ -20,6 +20,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:35:99:c2'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-disk-cdrom-grub.xml

@@ -20,6 +20,7 @@
       <readonly/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:6f:6a:53'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-disk-cdrom.xml

@@ -20,6 +20,7 @@
       <readonly/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:e3:ec:9b'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-disk-virtio.xml

@@ -19,6 +19,7 @@
       <target dev='vda' bus='virtio'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <interface type='bridge'>
       <mac address='52:54:00:bc:85:fe'/>
       <source bridge='virbr0'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-grub-bootorder.xml

@@ -32,6 +32,7 @@
       <boot order='1'/>
       <address type='drive' controller='0' bus='0' target='6' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:f4:6c:be'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-grub-bootorder2.xml

@@ -34,6 +34,7 @@
       <boot order='3'/>
       <address type='drive' controller='0' bus='0' target='6' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:0e:d2:6f'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-grub-defaults.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:ee:f5:79'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-localtime.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:82:ca:a3'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-macaddr.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:22:ee:11'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-metadata.xml

@@ -23,6 +23,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='0' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:ad:55:51'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-serial-grub-nocons.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:a7:cd:5b'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-serial-grub.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:f0:72:11'/>

tests/bhyvexml2xmloutdata/bhyvexml2xmlout-serial.xml

@@ -19,6 +19,7 @@
       <target dev='hda' bus='sata'/>
       <address type='drive' controller='0' bus='0' target='2' unit='0'/>
     </disk>
+    <controller type='pci' index='0' model='pci-root'/>
     <controller type='sata' index='0'/>
     <interface type='bridge'>
       <mac address='52:54:00:4f:f3:5b'/>

tests/bhyvexml2xmltest.c

@@ -5,6 +5,7 @@
 #ifdef WITH_BHYVE
 
 # include "bhyve/bhyve_capabilities.h"
+# include "bhyve/bhyve_domain.h"
 # include "bhyve/bhyve_utils.h"
 
 # define VIR_FROM_THIS VIR_FROM_NONE
@@ -49,7 +50,7 @@ mymain(void)
     if ((driver.caps = virBhyveCapsBuild()) == NULL)
         return EXIT_FAILURE;
 
-    if ((driver.xmlopt = virDomainXMLOptionNew(NULL, NULL, NULL)) == NULL)
+    if ((driver.xmlopt = virBhyveDriverCreateXMLConf(&driver)) == NULL)
         return EXIT_FAILURE;
 
 # define DO_TEST_FULL(name, is_different)                        \