Merge pull request #3468 from fidencio/wip/bring-govmm-in

govmm: Bring the project in

src/runtime/pkg/govmm/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+on: ["pull_request"]
+name: Unit tests
+jobs:
+  test:
+    strategy:
+      matrix:
+        go-version: [1.15.x, 1.16.x]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: latest
+          args: -c .golangci.yml -v
+      - name: go test
+        run: go test ./...

src/runtime/pkg/govmm/.gitignore

@@ -0,0 +1 @@
+*~

src/runtime/pkg/govmm/.golangci.yml

@@ -0,0 +1,35 @@
+# Copyright (c) 2021 Intel Corporation
+#
+# SPDX-License-Identifier: Apache-2.0
+
+run:
+  concurrency: 4
+  deadline: 600s
+  skip-dirs:
+    - vendor
+# Ignore auto-generated protobuf code.
+  skip-files:
+    - ".*\\.pb\\.go$"
+
+linters:
+  disable-all: true
+  enable:
+    - deadcode
+    - gocyclo
+    - gofmt
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - staticcheck
+    - structcheck
+    - typecheck
+    - unconvert
+    - unused
+    - varcheck
+
+linters-settings:
+  gocyclo:
+    min_complexity: 15
+  unused:
+    check-exported: true

src/runtime/pkg/govmm/.travis.yml

@@ -0,0 +1,26 @@
+language: go
+
+go:
+    - "1.10"
+    - "1.11"
+    - tip
+arch:
+    - s390x
+
+go_import_path: github.com/kata-containers/govmm
+
+matrix:
+  allow_failures:
+  - go: tip
+
+before_install:
+  - go get github.com/alecthomas/gometalinter
+  - gometalinter --install
+  - go get github.com/mattn/goveralls
+
+script:
+   - go env
+   - gometalinter --tests --vendor --disable-all --enable=misspell --enable=vet --enable=ineffassign --enable=gofmt --enable=gocyclo --cyclo-over=15 --enable=golint --enable=errcheck --enable=deadcode --enable=staticcheck -enable=gas ./...
+
+after_success:
+   - $GOPATH/bin/goveralls -repotoken $COVERALLS_TOKEN -v -service=travis-ci

src/runtime/pkg/govmm/CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# Contributing to Virtual Machine Manager for Go
+
+Virtual Machine Manager for Go is an open source project licensed under the [Apache v2 License] (https://opensource.org/licenses/Apache-2.0)
+
+## Coding Style
+
+Virtual Machine Manager for Go follows the standard formatting recommendations and language idioms set out
+in [Effective Go](https://golang.org/doc/effective_go.html) and in the
+[Go Code Review Comments wiki](https://github.com/golang/go/wiki/CodeReviewComments).
+
+## Certificate of Origin
+
+In order to get a clear contribution chain of trust we use the [signed-off-by language] (https://01.org/community/signed-process)
+used by the Linux kernel project.
+
+## Patch format
+
+Beside the signed-off-by footer, we expect each patch to comply with the following format:
+
+```
+Change summary
+
+More detailed explanation of your changes: Why and how.
+Wrap it to 72 characters.
+See [here] (http://chris.beams.io/posts/git-commit/)
+for some more good advices.
+
+Fixes #NUMBER (or URL to the issue)
+
+Signed-off-by: <contributor@foo.com>
+```
+
+For example:
+
+```
+Fix poorly named identifiers
+  
+One identifier, fnname, in func.go was poorly named.  It has been renamed
+to fnName.  Another identifier retval was not needed and has been removed
+entirely.
+
+Fixes #1
+    
+Signed-off-by: Mark Ryan <mark.d.ryan@intel.com>
+```
+
+## New files
+
+Each Go source file in the Virtual Machine Manager for Go project must
+contain the following header:
+
+```
+/*
+// Copyright contributors to the Virtual Machine Manager for Go project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+```
+
+## Contributors File
+
+This CONTRIBUTORS.md file is a partial list of contributors to the
+Virtual Machine Manager for Go project. To see the full list of
+contributors, see the revision history in source control.
+
+Contributors who wish to be recognized in this file should add
+themselves (or their employer, as appropriate).
+
+## Pull requests
+
+We accept github pull requests.
+
+## Quality Controls
+
+We request you give quality assurance some consideration by:
+
+* Adding go unit tests for changes where it makes sense.
+* Enabling [Travis CI](https://travis-ci.org/kata-containers/govmm) on your github fork of Virtual Machine Manager for Go to get continuous integration feedback on your dev/test branches.
+
+## Issue tracking
+
+If you have a problem, please let us know.  If it's a bug not already documented, by all means please [open an
+issue in github](https://github.com/kata-containers/govmm/issues/new) so we all get visibility
+the problem and work toward resolution.
+
+Any security issues discovered with govmm should be reported by following the instructions on https://01.org/security.

src/runtime/pkg/govmm/COPYING

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

src/runtime/pkg/govmm/README.md

@@ -0,0 +1,21 @@
+# Virtual Machine Manager for Go
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/kata-containers/govmm)](https://goreportcard.com/report/github.com/kata-containers/govmm)
+[![Build Status](https://travis-ci.org/kata-containers/govmm.svg?branch=master)](https://travis-ci.org/kata-containers/govmm)
+[![GoDoc](https://godoc.org/github.com/kata-containers/govmm/qemu?status.svg)](https://godoc.org/github.com/kata-containers/govmm/qemu)
+[![Coverage Status](https://coveralls.io/repos/github/kata-containers/govmm/badge.svg?branch=master)](https://coveralls.io/github/kata-containers/govmm?branch=master)
+
+Virtual Machine Manager for Go (govmm) is a suite of packages that
+provide Go APIs for creating and managing virtual machines.  There's
+currently support for only one hypervisor, qemu/kvm (version 5.0 and
+later), support for which is provided by the
+github.com/kata-containers/govmm/qemu package.
+
+The qemu package provides APIs for launching qemu instances and for
+managing those instances via QMP, once launched.  VM instances can
+be stopped, have devices attached to them and monitored for events
+via the qemu APIs.
+
+The qemu package has no external dependencies apart from the Go
+standard library and so is nice and easy to vendor inside other
+projects.

src/runtime/pkg/govmm/go.mod

@@ -0,0 +1,3 @@
+module github.com/kata-containers/govmm
+
+go 1.16

src/runtime/pkg/govmm/qemu/examples_test.go

@@ -0,0 +1,85 @@
+/*
+// Copyright contributors to the Virtual Machine Manager for Go project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+
+package qemu_test
+
+import (
+	"time"
+
+	"context"
+
+	"github.com/kata-containers/govmm/qemu"
+)
+
+func Example() {
+	params := make([]string, 0, 32)
+
+	// Rootfs
+	params = append(params, "-drive", "file=/tmp/image.qcow2,if=virtio,aio=threads,format=qcow2")
+	// Network
+	params = append(params, "-net", "nic,model=virtio", "-net", "user")
+	// kvm
+	params = append(params, "-enable-kvm", "-cpu", "host")
+	// qmp socket
+	params = append(params, "-daemonize", "-qmp", "unix:/tmp/qmp-socket,server=on,wait=off")
+	// resources
+	params = append(params, "-m", "370", "-smp", "cpus=2")
+
+	// LaunchCustomQemu should return as soon as the instance has launched as we
+	// are using the --daemonize flag.  It will set up a unix domain socket
+	// called /tmp/qmp-socket that we can use to manage the instance.
+	_, err := qemu.LaunchCustomQemu(context.Background(), "", params, nil, nil, nil)
+	if err != nil {
+		panic(err)
+	}
+
+	// This channel will be closed when the instance dies.
+	disconnectedCh := make(chan struct{})
+
+	// Set up our options.  We don't want any logging or to receive any events.
+	cfg := qemu.QMPConfig{}
+
+	// Start monitoring the qemu instance.  This functon will block until we have
+	// connect to the QMP socket and received the welcome message.
+	q, _, err := qemu.QMPStart(context.Background(), "/tmp/qmp-socket", cfg, disconnectedCh)
+	if err != nil {
+		panic(err)
+	}
+
+	// This has to be the first command executed in a QMP session.
+	err = q.ExecuteQMPCapabilities(context.Background())
+	if err != nil {
+		panic(err)
+	}
+
+	// Let's try to shutdown the VM.  If it hasn't shutdown in 10 seconds we'll
+	// send a quit message.
+	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	err = q.ExecuteSystemPowerdown(ctx)
+	cancel()
+	if err != nil {
+		err = q.ExecuteQuit(context.Background())
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	q.Shutdown()
+
+	// disconnectedCh is closed when the VM exits. This line blocks until this
+	// event occurs.
+	<-disconnectedCh
+}

src/runtime/pkg/govmm/qemu/image.go

@@ -0,0 +1,77 @@
+/*
+// Copyright contributors to the Virtual Machine Manager for Go project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+
+package qemu
+
+import (
+	"context"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"os/exec"
+	"path"
+	"syscall"
+)
+
+// CreateCloudInitISO creates a cloud-init ConfigDrive ISO image.  This is
+// useful for configuring newly booted VMs. Before it can create the ISO
+// image it needs to create a file tree with the various files that will
+// make up the image.  This directory is created under scratchDir and is
+// deleted when when the function returns, successfully or otherwise.  ctx is
+// a context that can be used to timeout or cancel the image creation.
+// isoPath contains the desired path of the ISO image to be created.  The
+// userdata and metadata parameters are byte slices that contain the
+// ConfigDrive userdata and metadata that will be stored with the ISO image.
+// The attrs parameter can be used to control aspects of the newly created
+// qemu process, such as the user and group under which it runs.  It may be nil.
+func CreateCloudInitISO(ctx context.Context, scratchDir, isoPath string,
+	userData, metaData []byte, attr *syscall.SysProcAttr) error {
+	configDrivePath := path.Join(scratchDir, "clr-cloud-init")
+	dataDirPath := path.Join(configDrivePath, "openstack", "latest")
+	metaDataPath := path.Join(dataDirPath, "meta_data.json")
+	userDataPath := path.Join(dataDirPath, "user_data")
+
+	defer func() {
+		/* #nosec */
+		_ = os.RemoveAll(configDrivePath)
+	}()
+
+	err := os.MkdirAll(dataDirPath, 0750)
+	if err != nil {
+		return fmt.Errorf("unable to create config drive directory %s : %v",
+			dataDirPath, err)
+	}
+
+	err = ioutil.WriteFile(metaDataPath, metaData, 0644)
+	if err != nil {
+		return fmt.Errorf("unable to create %s : %v", metaDataPath, err)
+	}
+
+	err = ioutil.WriteFile(userDataPath, userData, 0644)
+	if err != nil {
+		return fmt.Errorf("unable to create %s : %v", userDataPath, err)
+	}
+
+	cmd := exec.CommandContext(ctx, "xorriso", "-as", "mkisofs", "-R", "-V", "config-2",
+		"-o", isoPath, configDrivePath)
+	cmd.SysProcAttr = attr
+	err = cmd.Run()
+	if err != nil {
+		return fmt.Errorf("unable to create cloudinit iso image %v", err)
+	}
+
+	return nil
+}

src/runtime/pkg/govmm/qemu/qemu_arch_base_test.go

@@ -0,0 +1,175 @@
+//go:build !s390x
+// +build !s390x
+
+/*
+// Copyright contributors to the Virtual Machine Manager for Go project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+
+package qemu
+
+import "testing"
+
+var (
+	deviceFSString                 = "-device virtio-9p-pci,disable-modern=true,fsdev=workload9p,mount_tag=rootfs,romfile=efi-virtio.rom -fsdev local,id=workload9p,path=/var/lib/docker/devicemapper/mnt/e31ebda2,security_model=none,multidevs=remap"
+	deviceNetworkString            = "-netdev tap,id=tap0,vhost=on,ifname=ceth0,downscript=no,script=no -device driver=virtio-net-pci,netdev=tap0,mac=01:02:de:ad:be:ef,disable-modern=true,romfile=efi-virtio.rom"
+	deviceNetworkStringMq          = "-netdev tap,id=tap0,vhost=on,fds=3:4 -device driver=virtio-net-pci,netdev=tap0,mac=01:02:de:ad:be:ef,disable-modern=true,mq=on,vectors=6,romfile=efi-virtio.rom"
+	deviceSerialString             = "-device virtio-serial-pci,disable-modern=true,id=serial0,romfile=efi-virtio.rom,max_ports=2"
+	deviceVhostUserNetString       = "-chardev socket,id=char1,path=/tmp/nonexistentsocket.socket -netdev type=vhost-user,id=net1,chardev=char1,vhostforce -device virtio-net-pci,netdev=net1,mac=00:11:22:33:44:55,romfile=efi-virtio.rom"
+	deviceVSOCKString              = "-device vhost-vsock-pci,disable-modern=true,id=vhost-vsock-pci0,guest-cid=4,romfile=efi-virtio.rom"
+	deviceVFIOString               = "-device vfio-pci,host=02:10.0,x-pci-vendor-id=0x1234,x-pci-device-id=0x5678,romfile=efi-virtio.rom"
+	devicePCIeRootPortSimpleString = "-device pcie-root-port,id=rp1,bus=pcie.0,chassis=0x00,slot=0x00,multifunction=off"
+	devicePCIeRootPortFullString   = "-device pcie-root-port,id=rp2,bus=pcie.0,chassis=0x0,slot=0x1,addr=0x2,multifunction=on,bus-reserve=0x3,pref64-reserve=16G,mem-reserve=1G,io-reserve=512M,romfile=efi-virtio.rom"
+	deviceVFIOPCIeSimpleString     = "-device vfio-pci,host=02:00.0,bus=rp0"
+	deviceVFIOPCIeFullString       = "-device vfio-pci,host=02:00.0,x-pci-vendor-id=0x10de,x-pci-device-id=0x15f8,romfile=efi-virtio.rom,bus=rp1"
+	deviceSCSIControllerStr        = "-device virtio-scsi-pci,id=foo,disable-modern=false,romfile=efi-virtio.rom"
+	deviceSCSIControllerBusAddrStr = "-device virtio-scsi-pci,id=foo,bus=pci.0,addr=00:04.0,disable-modern=true,iothread=iothread1,romfile=efi-virtio.rom"
+	deviceVhostUserSCSIString      = "-chardev socket,id=char1,path=/tmp/nonexistentsocket.socket -device vhost-user-scsi-pci,id=scsi1,chardev=char1,romfile=efi-virtio.rom"
+	deviceVhostUserBlkString       = "-chardev socket,id=char2,path=/tmp/nonexistentsocket.socket -device vhost-user-blk-pci,logical_block_size=4096,size=512M,chardev=char2,romfile=efi-virtio.rom"
+	deviceBlockString              = "-device virtio-blk-pci,disable-modern=true,drive=hd0,scsi=off,config-wce=off,romfile=efi-virtio.rom,share-rw=on,serial=hd0 -drive id=hd0,file=/var/lib/vm.img,aio=threads,format=qcow2,if=none,readonly=on"
+	devicePCIBridgeString          = "-device pci-bridge,bus=/pci-bus/pcie.0,id=mybridge,chassis_nr=5,shpc=on,addr=ff,romfile=efi-virtio.rom"
+	devicePCIBridgeStringReserved  = "-device pci-bridge,bus=/pci-bus/pcie.0,id=mybridge,chassis_nr=5,shpc=off,addr=ff,romfile=efi-virtio.rom,io-reserve=4k,mem-reserve=1m,pref64-reserve=1m"
+	devicePCIEBridgeString         = "-device pcie-pci-bridge,bus=/pci-bus/pcie.0,id=mybridge,addr=ff,romfile=efi-virtio.rom"
+	romfile                        = "efi-virtio.rom"
+)
+
+func TestAppendDeviceVhostUser(t *testing.T) {
+
+	vhostuserBlkDevice := VhostUserDevice{
+		SocketPath:    "/tmp/nonexistentsocket.socket",
+		CharDevID:     "char2",
+		TypeDevID:     "",
+		Address:       "",
+		VhostUserType: VhostUserBlk,
+		ROMFile:       romfile,
+	}
+	testAppend(vhostuserBlkDevice, deviceVhostUserBlkString, t)
+
+	vhostuserSCSIDevice := VhostUserDevice{
+		SocketPath:    "/tmp/nonexistentsocket.socket",
+		CharDevID:     "char1",
+		TypeDevID:     "scsi1",
+		Address:       "",
+		VhostUserType: VhostUserSCSI,
+		ROMFile:       romfile,
+	}
+	testAppend(vhostuserSCSIDevice, deviceVhostUserSCSIString, t)
+
+	vhostuserNetDevice := VhostUserDevice{
+		SocketPath:    "/tmp/nonexistentsocket.socket",
+		CharDevID:     "char1",
+		TypeDevID:     "net1",
+		Address:       "00:11:22:33:44:55",
+		VhostUserType: VhostUserNet,
+		ROMFile:       romfile,
+	}
+	testAppend(vhostuserNetDevice, deviceVhostUserNetString, t)
+}
+
+func TestAppendVirtioBalloon(t *testing.T) {
+	balloonDevice := BalloonDevice{
+		ID:      "balloon",
+		ROMFile: romfile,
+	}
+
+	var deviceString = "-device " + string(VirtioBalloon) + "-" + string(TransportPCI)
+	deviceString += ",id=" + balloonDevice.ID + ",romfile=" + balloonDevice.ROMFile
+
+	var OnDeflateOnOMM = ",deflate-on-oom=on"
+	var OffDeflateOnOMM = ",deflate-on-oom=off"
+
+	var OnDisableModern = ",disable-modern=true"
+	var OffDisableModern = ",disable-modern=false"
+
+	testAppend(balloonDevice, deviceString+OffDeflateOnOMM+OffDisableModern, t)
+
+	balloonDevice.DeflateOnOOM = true
+	testAppend(balloonDevice, deviceString+OnDeflateOnOMM+OffDisableModern, t)
+
+	balloonDevice.DisableModern = true
+	testAppend(balloonDevice, deviceString+OnDeflateOnOMM+OnDisableModern, t)
+
+}
+
+func TestAppendDevicePCIeRootPort(t *testing.T) {
+	var pcieRootPortID string
+
+	// test empty ID
+	pcieRootPortDevice := PCIeRootPortDevice{}
+	if pcieRootPortDevice.Valid() {
+		t.Fatalf("failed to validdate empty ID")
+	}
+
+	// test pref64_reserve and pre64_reserve
+	pcieRootPortID = "rp0"
+	pcieRootPortDevice = PCIeRootPortDevice{
+		ID:            pcieRootPortID,
+		Pref64Reserve: "16G",
+		Pref32Reserve: "256M",
+	}
+	if pcieRootPortDevice.Valid() {
+		t.Fatalf("failed to validate pref32-reserve and pref64-reserve for %v", pcieRootPortID)
+	}
+
+	// default test
+	pcieRootPortID = "rp1"
+	pcieRootPortDevice = PCIeRootPortDevice{
+		ID: pcieRootPortID,
+	}
+	if !pcieRootPortDevice.Valid() {
+		t.Fatalf("failed to validate for %v", pcieRootPortID)
+	}
+	testAppend(pcieRootPortDevice, devicePCIeRootPortSimpleString, t)
+
+	// full test
+	pcieRootPortID = "rp2"
+	pcieRootPortDevice = PCIeRootPortDevice{
+		ID:            pcieRootPortID,
+		Multifunction: true,
+		Bus:           "pcie.0",
+		Chassis:       "0x0",
+		Slot:          "0x1",
+		Addr:          "0x2",
+		Pref64Reserve: "16G",
+		IOReserve:     "512M",
+		MemReserve:    "1G",
+		BusReserve:    "0x3",
+		ROMFile:       romfile,
+	}
+	if !pcieRootPortDevice.Valid() {
+		t.Fatalf("failed to validate for %v", pcieRootPortID)
+	}
+	testAppend(pcieRootPortDevice, devicePCIeRootPortFullString, t)
+}
+
+func TestAppendDeviceVFIOPCIe(t *testing.T) {
+	// default test
+	pcieRootPortID := "rp0"
+	vfioDevice := VFIODevice{
+		BDF: "02:00.0",
+		Bus: pcieRootPortID,
+	}
+	testAppend(vfioDevice, deviceVFIOPCIeSimpleString, t)
+
+	// full test
+	pcieRootPortID = "rp1"
+	vfioDevice = VFIODevice{
+		BDF:      "02:00.0",
+		Bus:      pcieRootPortID,
+		ROMFile:  romfile,
+		VendorID: "0x10de",
+		DeviceID: "0x15f8",
+	}
+	testAppend(vfioDevice, deviceVFIOPCIeFullString, t)
+}

src/runtime/pkg/govmm/qemu/qemu_s390x_test.go

@@ -0,0 +1,108 @@
+// +build s390x
+
+/*
+// Copyright contributors to the Virtual Machine Manager for Go project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+
+package qemu
+
+import "testing"
+
+// -pci devices don't play well with Z hence replace them with corresponding -ccw devices
+// See https://wiki.qemu.org/Documentation/Platforms/S390X
+var (
+	deviceFSString                 = "-device virtio-9p-ccw,fsdev=workload9p,mount_tag=rootfs,devno=" + DevNo + " -fsdev local,id=workload9p,path=/var/lib/docker/devicemapper/mnt/e31ebda2,security_model=none,multidevs=remap"
+	deviceFSIOMMUString            = "-device virtio-9p-ccw,fsdev=workload9p,mount_tag=rootfs,iommu_platform=on,devno=" + DevNo + " -fsdev local,id=workload9p,path=/var/lib/docker/devicemapper/mnt/e31ebda2,security_model=none,multidevs=remap"
+	deviceNetworkString            = "-netdev tap,id=tap0,vhost=on,ifname=ceth0,downscript=no,script=no -device driver=virtio-net-ccw,netdev=tap0,mac=01:02:de:ad:be:ef,devno=" + DevNo
+	deviceNetworkStringMq          = "-netdev tap,id=tap0,vhost=on,fds=3:4 -device driver=virtio-net-ccw,netdev=tap0,mac=01:02:de:ad:be:ef,mq=on,devno=" + DevNo
+	deviceSerialString             = "-device virtio-serial-ccw,id=serial0,devno=" + DevNo
+	deviceVSOCKString              = "-device vhost-vsock-ccw,id=vhost-vsock-pci0,guest-cid=4,devno=" + DevNo
+	deviceVFIOString               = "-device vfio-ccw,host=02:10.0,devno=" + DevNo
+	deviceSCSIControllerStr        = "-device virtio-scsi-ccw,id=foo,devno=" + DevNo
+	deviceSCSIControllerBusAddrStr = "-device virtio-scsi-ccw,id=foo,bus=pci.0,addr=00:04.0,iothread=iothread1,devno=" + DevNo
+	deviceBlockString              = "-device virtio-blk-ccw,drive=hd0,scsi=off,config-wce=off,devno=" + DevNo + ",share-rw=on,serial=hd0 -drive id=hd0,file=/var/lib/vm.img,aio=threads,format=qcow2,if=none,readonly"
+	devicePCIBridgeString          = "-device pci-bridge,bus=/pci-bus/pcie.0,id=mybridge,chassis_nr=5,shpc=on,addr=ff"
+	devicePCIEBridgeString         = "-device pcie-pci-bridge,bus=/pci-bus/pcie.0,id=mybridge,addr=ff"
+	romfile                        = ""
+)
+
+func TestAppendVirtioBalloon(t *testing.T) {
+	balloonDevice := BalloonDevice{
+		ID: "balloon",
+	}
+
+	var deviceString = "-device " + string(VirtioBalloon) + "-" + string(TransportCCW)
+	deviceString += ",id=" + balloonDevice.ID
+	balloonDevice.DevNo = DevNo
+	devnoOptios := ",devno=" + DevNo
+
+	var OnDeflateOnOMM = ",deflate-on-oom=on"
+	var OffDeflateOnOMM = ",deflate-on-oom=off"
+	testAppend(balloonDevice, deviceString+devnoOptios+OffDeflateOnOMM, t)
+
+	balloonDevice.DeflateOnOOM = true
+	testAppend(balloonDevice, deviceString+devnoOptios+OnDeflateOnOMM, t)
+}
+
+func TestAppendDeviceFSCCW(t *testing.T) {
+	defaultKnobs := Knobs{
+		NoUserConfig: true,
+	}
+
+	fsdev := FSDevice{
+		Driver:        Virtio9P,
+		FSDriver:      Local,
+		ID:            "workload9p",
+		Path:          "/var/lib/docker/devicemapper/mnt/e31ebda2",
+		MountTag:      "rootfs",
+		SecurityModel: None,
+		DisableModern: true,
+		ROMFile:       "efi-virtio.rom",
+		Multidev:      Remap,
+		Transport:     TransportCCW,
+		DevNo:         DevNo,
+	}
+
+	var config Config
+	config.Knobs = defaultKnobs
+
+	testConfigAppend(&config, fsdev, deviceFSString, t)
+}
+
+func TestAppendDeviceFSCCWIOMMU(t *testing.T) {
+	defaultKnobs := Knobs{
+		NoUserConfig:  true,
+		IOMMUPlatform: true,
+	}
+
+	fsdev := FSDevice{
+		Driver:        Virtio9P,
+		FSDriver:      Local,
+		ID:            "workload9p",
+		Path:          "/var/lib/docker/devicemapper/mnt/e31ebda2",
+		MountTag:      "rootfs",
+		SecurityModel: None,
+		DisableModern: true,
+		ROMFile:       "efi-virtio.rom",
+		Multidev:      Remap,
+		Transport:     TransportCCW,
+		DevNo:         DevNo,
+	}
+
+	var config Config
+	config.Knobs = defaultKnobs
+
+	testConfigAppend(&config, fsdev, deviceFSIOMMUString, t)
+}