bhyve: support serial type 'tcp'

In addition to the nmdm consoles, bhyve also supports a tcp console.
It's configured with:

 .. -l com1,tcp=127.0.0.1:12345

Then a user could connect to the guest console port 0 by making a tcp
connection to the host's 127.0.0.1:12345.

In the domain XML this configuration is represented as:

  <serial type='tcp'>
    <source mode='bind' host='127.0.0.1' service='12345'/>
    <target type='serial' port='0'/>
  </serial>

Also, update domain capabilities to include the TCP console support.
Unfortunately, there's no way to detect that from the bhyve binary
before trying to start a VM, so there's no capability probing for this
feature.

Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

diff --git a/src/bhyve/bhyve_capabilities.c b/src/bhyve/bhyve_capabilities.c
index 59fc81d26cb476480a5f4d091f49de77d0507888..04a5a4cf29036a157fc72cc8533e412243f9b871 100644 (file)
--- a/src/bhyve/bhyve_capabilities.c
+++ b/src/bhyve/bhyve_capabilities.c
@@ -128,7 +128,8 @@ virBhyveDomainCapsFill(virDomainCaps *caps,
     caps->console.supported = VIR_TRISTATE_BOOL_YES;
     caps->console.type.report = true;
     VIR_DOMAIN_CAPS_ENUM_SET(caps->console.type,
-                             VIR_DOMAIN_CHR_TYPE_NMDM);
+                             VIR_DOMAIN_CHR_TYPE_NMDM,
+                             VIR_DOMAIN_CHR_TYPE_TCP);
 
     return 0;
 }

diff --git a/src/bhyve/bhyve_command.c b/src/bhyve/bhyve_command.c
index c82a07c2eb1d6a8e279d9b45ace5d1e235342b05..89648f76cb21ee62615ef80d807580c02ff8801d 100644 (file)
--- a/src/bhyve/bhyve_command.c
+++ b/src/bhyve/bhyve_command.c
@@ -159,29 +159,41 @@ bhyveBuildNetArgStr(const virDomainDef *def,
 static int
 bhyveBuildConsoleArgStr(const virDomainDef *def, virCommand *cmd)
 {
+    size_t i = 0;
     virDomainChrDef *chr = NULL;
 
     if (!def->nserials)
         return 0;
 
-    chr = def->serials[0];
+    for (i = 0; i < def->nserials; i++) {
+        chr = def->serials[i];
 
-    if (chr->source->type != VIR_DOMAIN_CHR_TYPE_NMDM) {
-        virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
-                       _("only nmdm console types are supported"));
-        return -1;
-    }
+        /* bhyve supports only two ports: com1 and com2 */
+        if (chr->target.port > 2) {
+            virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
+                           _("only two serial ports are supported"));
+            return -1;
+        }
 
-    /* bhyve supports only two ports: com1 and com2 */
-    if (chr->target.port > 2) {
-        virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
-                       _("only two serial ports are supported"));
-        return -1;
-    }
+        virCommandAddArg(cmd, "-l");
 
-    virCommandAddArg(cmd, "-l");
-    virCommandAddArgFormat(cmd, "com%d,%s",
-                           chr->target.port + 1, chr->source->data.file.path);
+        switch (chr->source->type) {
+        case VIR_DOMAIN_CHR_TYPE_NMDM:
+            virCommandAddArgFormat(cmd, "com%d,%s",
+                                   chr->target.port + 1, chr->source->data.file.path);
+            break;
+        case VIR_DOMAIN_CHR_TYPE_TCP:
+            virCommandAddArgFormat(cmd, "com%d,tcp=%s:%s",
+                                   chr->target.port + 1,
+                                   chr->source->data.tcp.host,
+                                   chr->source->data.tcp.service);
+            break;
+        default:
+            virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s",
+                           _("only nmdm and tcp console types are supported"));
+            return -1;
+        }
+    }
 
     return 0;
 }

diff --git a/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.args b/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.args
new file mode 100644 (file)
index 0000000..8e4072d
--- /dev/null
+++ b/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.args
@@ -0,0 +1,12 @@
+bhyve \
+-c 1 \
+-m 214 \
+-u \
+-H \
+-P \
+-s 0:0,hostbridge \
+-s 1:0,lpc \
+-s 2:0,ahci,hd:/tmp/freebsd.img \
+-s 3:0,virtio-net,faketapdev,mac=52:54:00:b1:42:eb \
+-l com1,tcp=127.0.0.1:12345 \
+bhyve

diff --git a/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.ldargs b/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.ldargs
new file mode 100644 (file)
index 0000000..5905f4b
--- /dev/null
+++ b/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.ldargs
@@ -0,0 +1,4 @@
+bhyveload \
+-m 214 \
+-d /tmp/freebsd.img \
+bhyve

diff --git a/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.xml b/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.xml
new file mode 100644 (file)
index 0000000..61c9440
--- /dev/null
+++ b/tests/bhyvexml2argvdata/bhyvexml2argv-serial-tcp.xml
@@ -0,0 +1,27 @@
+<domain type='bhyve'>
+  <name>bhyve</name>
+  <uuid>df3be7e7-a104-11e3-aeb0-50e5492bd3dc</uuid>
+  <memory>219136</memory>
+  <vcpu>1</vcpu>
+  <os>
+    <type>hvm</type>
+  </os>
+  <devices>
+    <disk type='file'>
+      <driver name='file' type='raw'/>
+      <source file='/tmp/freebsd.img'/>
+      <target dev='hda' bus='sata'/>
+      <address type='drive' controller='0' bus='0' target='2' unit='0'/>
+    </disk>
+    <interface type='bridge'>
+      <mac address='52:54:00:b1:42:eb'/>
+      <model type='virtio'/>
+      <source bridge="virbr0"/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
+    </interface>
+    <serial type='tcp'>
+      <source mode='connect' host='127.0.0.1' service='12345'/>
+      <protocol type="raw"/>
+    </serial>
+  </devices>
+</domain>

diff --git a/tests/bhyvexml2argvtest.c b/tests/bhyvexml2argvtest.c
index 58b404ca7d37230cded4f557c99cb17638e123ed..d1786ff1659859c0f4e4d056ab654b95e7b34dcf 100644 (file)
--- a/tests/bhyvexml2argvtest.c
+++ b/tests/bhyvexml2argvtest.c
@@ -254,6 +254,7 @@ mymain(void)
     DO_TEST_FAILURE("virtio-rnd-transitional");
     driver.bhyvecaps &= ~BHYVE_CAP_VIRTIO_RND;
     DO_TEST_FAILURE("virtio-rnd");
+    DO_TEST("serial-tcp");
 
     /* Address allocation tests */
     DO_TEST("addr-single-sata-disk");

diff --git a/tests/bhyvexml2xmloutdata/bhyvexml2xmlout-serial-tcp.xml b/tests/bhyvexml2xmloutdata/bhyvexml2xmlout-serial-tcp.xml
new file mode 100644 (file)
index 0000000..641efcd
--- /dev/null
+++ b/tests/bhyvexml2xmloutdata/bhyvexml2xmlout-serial-tcp.xml
@@ -0,0 +1,46 @@
+<domain type='bhyve'>
+  <name>bhyve</name>
+  <uuid>df3be7e7-a104-11e3-aeb0-50e5492bd3dc</uuid>
+  <memory unit='KiB'>219136</memory>
+  <currentMemory unit='KiB'>219136</currentMemory>
+  <vcpu placement='static'>1</vcpu>
+  <os>
+    <type arch='x86_64'>hvm</type>
+    <boot dev='hd'/>
+  </os>
+  <clock offset='utc'/>
+  <on_poweroff>destroy</on_poweroff>
+  <on_reboot>restart</on_reboot>
+  <on_crash>destroy</on_crash>
+  <devices>
+    <disk type='file' device='disk'>
+      <driver name='file' type='raw'/>
+      <source file='/tmp/freebsd.img'/>
+      <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='isa' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x0'/>
+    </controller>
+    <controller type='sata' index='0'>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/>
+    </controller>
+    <interface type='bridge'>
+      <mac address='52:54:00:b1:42:eb'/>
+      <source bridge='virbr0'/>
+      <model type='virtio'/>
+      <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
+    </interface>
+    <serial type='tcp'>
+      <source mode='connect' host='127.0.0.1' service='12345'/>
+      <protocol type='raw'/>
+      <target port='0'/>
+    </serial>
+    <console type='tcp'>
+      <source mode='connect' host='127.0.0.1' service='12345'/>
+      <protocol type='raw'/>
+      <target type='serial' port='0'/>
+    </console>
+  </devices>
+</domain>

diff --git a/tests/bhyvexml2xmltest.c b/tests/bhyvexml2xmltest.c
index 98006dac048177abe76411968c94af61c1ec7d94..0b858731a67b4dd5fc48ef621d936f53e7e441d0 100644 (file)
--- a/tests/bhyvexml2xmltest.c
+++ b/tests/bhyvexml2xmltest.c
@@ -115,6 +115,7 @@ mymain(void)
     DO_TEST_DIFFERENT("isa-controller");
     DO_TEST_DIFFERENT("fs-9p");
     DO_TEST_DIFFERENT("virtio-rnd");
+    DO_TEST_DIFFERENT("serial-tcp");
 
     /* Address allocation tests */
     DO_TEST_DIFFERENT("addr-single-sata-disk");

diff --git a/tests/domaincapsdata/bhyve_basic.x86_64.xml b/tests/domaincapsdata/bhyve_basic.x86_64.xml
index d1211a5b5e8663e5b8a9d39ed5756467cd2cee40..0c386c79d29bc2f2021f341e9460115edace0afd 100644 (file)
--- a/tests/domaincapsdata/bhyve_basic.x86_64.xml
+++ b/tests/domaincapsdata/bhyve_basic.x86_64.xml
@@ -29,6 +29,7 @@
     <hostdev supported='no'/>
     <console supported='yes'>
       <enum name='type'>
+        <value>tcp</value>
         <value>nmdm</value>
       </enum>
     </console>

diff --git a/tests/domaincapsdata/bhyve_fbuf.x86_64.xml b/tests/domaincapsdata/bhyve_fbuf.x86_64.xml
index 8d5e42dd82c28da9efb48d71d8b29c695889c141..29362818579c82f96a68b2a8610aca325db65bca 100644 (file)
--- a/tests/domaincapsdata/bhyve_fbuf.x86_64.xml
+++ b/tests/domaincapsdata/bhyve_fbuf.x86_64.xml
@@ -46,6 +46,7 @@
     <hostdev supported='no'/>
     <console supported='yes'>
       <enum name='type'>
+        <value>tcp</value>
         <value>nmdm</value>
       </enum>
     </console>

diff --git a/tests/domaincapsdata/bhyve_uefi.x86_64.xml b/tests/domaincapsdata/bhyve_uefi.x86_64.xml
index 3a6f178dd4d5392d7ceb62102b055a542f2a2662..fa87fd3640f8550428e05c3484b8d8baab1d754f 100644 (file)
--- a/tests/domaincapsdata/bhyve_uefi.x86_64.xml
+++ b/tests/domaincapsdata/bhyve_uefi.x86_64.xml
@@ -38,6 +38,7 @@
     <hostdev supported='no'/>
     <console supported='yes'>
       <enum name='type'>
+        <value>tcp</value>
         <value>nmdm</value>
       </enum>
     </console>