Merge pull request #204 from rojkov/nokerneldrv

qat: make users explicitly opt in to have kernel mode compiled in

Author: kad

.travis.yml

@@ -43,10 +43,10 @@ before_install:
 script:
   - make format
   - make lint
-  - make
+  - make BUILDTAGS=kerneldrv
   - make vet
   - make cyclomatic-check
-  - make test
+  - make test BUILDTAGS=kerneldrv
   - make images
   - make images BUILDER=buildah
   - make demos

Jenkinsfile

@@ -86,10 +86,10 @@ pipeline {
             }
           }
         }
-        stage("make test") {
+        stage("make test BUILDTAGS=kerneldrv") {
           steps {
             dir(path: "$REPO_DIR") {
-              sh "make test"
+              sh "make test BUILDTAGS=kerneldrv"
             }
           }
         }

Makefile

@@ -2,6 +2,8 @@ GO := go
 GOFMT := gofmt
 GOCYCLO := gocyclo
 
+BUILDTAGS ?= ""
+
 pkgs  = $(shell $(GO) list ./... | grep -v vendor)
 cmds = $(shell ls cmd)
 
@@ -18,10 +20,10 @@ cyclomatic-check:
 
 test:
 ifndef WHAT
-	@$(GO) test -race -coverprofile=coverage.txt -covermode=atomic $(pkgs)
+	@$(GO) test -tags $(BUILDTAGS) -race -coverprofile=coverage.txt -covermode=atomic $(pkgs)
 else
 	@cd $(WHAT) && \
-            $(GO) test -v -cover -coverprofile cover.out || rc=1; \
+            $(GO) test -tags $(BUILDTAGS) -v -cover -coverprofile cover.out || rc=1; \
             $(GO) tool cover -html=cover.out -o coverage.html; \
             rm cover.out; \
             echo "Coverage report: file://$$(realpath coverage.html)"; \
@@ -32,12 +34,12 @@ lint:
 	@rc=0 ; for f in $$(find -name \*.go | grep -v \.\/vendor) ; do golint -set_exit_status $$f || rc=1 ; done ; exit $$rc
 
 $(cmds):
-	cd cmd/$@; go build
+	cd cmd/$@; $(GO) build -tags $(BUILDTAGS)
 
 build: $(cmds)
 
 clean:
-	@for cmd in $(cmds) ; do pwd=$(shell pwd) ; cd cmd/$$cmd ; go clean ; cd $$pwd ; done
+	@for cmd in $(cmds) ; do pwd=$(shell pwd) ; cd cmd/$$cmd ; $(GO) clean ; cd $$pwd ; done
 
 TAG?=$(shell git rev-parse HEAD)
 

cmd/qat_plugin/README.md

@@ -61,12 +61,16 @@ Use the `kernel-vf-drivers flag` to specify the vf Device Driver for the particu
 
 `-dpdk-driver` is set to `vfio-pci` by default since it is more robust and secure driver compared with `igb_uio`. See [DPDK Linux Driver Guide](http://dpdk.org/doc/guides/linux_gsg/linux_drivers.html) for more information.
 
+`-mode` parameter can be set to `kerneldrv` to override the default  mode (`dpdkdrv`). With `-mode kerneldrv`, no other parameter documented above are valid, except `-debug` which is global for both modes. `kerneldrv` mode implements resource allocation based on system configured [logical instances](https://01.org/sites/default/files/downloads//336210-009qatswprogrammersguide.pdfhttps://01.org/sites/default/files/downloads//336210-009qatswprogrammersguide.pdf). The mode does not guarantee full device isolation between containers and therefore it's not recommended. Moreover, the mode will be deprecated and removed once `libqat` implements non-UIO based device access.
+
 ### Build QAT device plugin Docker image:
 ```
 $ cd $GOPATH/src/github.com/intel/intel-device-plugins-for-kubernetes
 $ make  intel-qat-plugin
 ```
 
+**Note**: `kerneldrv` mode is excluded from the build by default. Add `BUILDTAGS=kerneldrv` to `make` to get `kerneldrv` functionality added to the build.
+
 ### Deploy QAT device plugin as a DaemonSet:
 ```
 $ cd $GOPATH/src/github.com/intel/intel-device-plugins-for-kubernetes

cmd/qat_plugin/kerneldrv/kerneldrv.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build kerneldrv
+
 package kerneldrv
 
 import (

cmd/qat_plugin/kerneldrv/kerneldrv_test.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build kerneldrv
+
 package kerneldrv
 
 import (

cmd/qat_plugin/kerneldrv/stub.go

@@ -0,0 +1,32 @@
+// Copyright 2019 Intel Corporation. All Rights Reserved.
+//
+// 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.
+
+// +build !kerneldrv
+
+package kerneldrv
+
+import (
+	"fmt"
+	"os"
+
+	dpapi "github.com/intel/intel-device-plugins-for-kubernetes/pkg/deviceplugin"
+)
+
+// NewDevicePlugin creates a non-functional stub for kernel mode device plugins.
+func NewDevicePlugin() dpapi.Scanner {
+	fmt.Println("kernel mode is not supported in this build. Use 'kerneldrv' build tag to have this mode enabled. Exiting...")
+	os.Exit(1)
+
+	return nil
+}

cmd/qat_plugin/qat_plugin.go

@@ -53,7 +53,7 @@ func main() {
 	case "kernel":
 		plugin = kerneldrv.NewDevicePlugin()
 	default:
-		err = errors.Errorf("Uknown mode: %s", *mode)
+		err = errors.Errorf("Unknown mode: %s", *mode)
 	}
 	if err != nil {
 		fmt.Println(err.Error())