config: Add configuration option for hypervisor block storage driver

Block devices can be passed using either virio-scsi or virtio-block. Fixes clearcontainers#1036 Signed-off-by: Archana Shinde <[email protected]>
jcvenegas · Feb 28, 2018 · 1768dd5 · 1768dd5
1 parent accaa9d
commit 1768dd5
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 3 deletions.
diff --git a/Makefile b/Makefile
@@ -207,6 +207,7 @@ DEFBRIDGES := 1
 DEFNETWORKMODEL := macvtap
 
 DEFDISABLEBLOCK := false
+DEFBLOCKSTORAGEDRIVER := virtio-scsi
 DEFENABLEMEMPREALLOC := false
 DEFENABLEHUGEPAGES := false
 DEFENABLESWAP := false
@@ -294,6 +295,7 @@ USER_VARS += DEFMEMSZ
 USER_VARS += DEFBRIDGES
 USER_VARS += DEFNETWORKMODEL
 USER_VARS += DEFDISABLEBLOCK
+USER_VARS += DEFBLOCKSTORAGEDRIVER
 USER_VARS += DEFENABLEMEMPREALLOC
 USER_VARS += DEFENABLEHUGEPAGES
 USER_VARS += DEFENABLESWAP
@@ -402,6 +404,7 @@ const defaultMemSize uint32 = $(DEFMEMSZ) // MiB
 const defaultBridgesCount uint32 = $(DEFBRIDGES)
 const defaultInterNetworkingModel = "$(DEFNETWORKMODEL)"
 const defaultDisableBlockDeviceUse bool = $(DEFDISABLEBLOCK)
+const defaultBlockDeviceDriver = "$(DEFBLOCKSTORAGEDRIVER)"
 const defaultEnableMemPrealloc bool = $(DEFENABLEMEMPREALLOC)
 const defaultEnableHugePages bool = $(DEFENABLEHUGEPAGES)
 const defaultEnableSwap bool = $(DEFENABLESWAP)
@@ -489,6 +492,7 @@ $(GENERATED_FILES): %: %.in Makefile VERSION
 		-e "s|@DEFBRIDGES@|$(DEFBRIDGES)|g" \
 		-e "s|@DEFNETWORKMODEL@|$(DEFNETWORKMODEL)|g" \
 		-e "s|@DEFDISABLEBLOCK@|$(DEFDISABLEBLOCK)|g" \
+		-e "s|@DEFBLOCKSTORAGEDRIVER@|$(DEFBLOCKSTORAGEDRIVER)|g" \
 		-e "s|@DEFENABLEMEMPREALLOC@|$(DEFENABLEMEMPREALLOC)|g" \
 		-e "s|@DEFENABLEHUGEPAGES@|$(DEFENABLEHUGEPAGES)|g" \
 		-e "s|@DEFENABLEMSWAP@|$(DEFENABLESWAP)|g" \

diff --git a/cc-env_test.go b/cc-env_test.go
@@ -68,6 +68,7 @@ func makeRuntimeConfig(prefixDir string) (configFile string, config oci.RuntimeC
 	shimPath := filepath.Join(prefixDir, "cc-shim")
 	proxyPath := filepath.Join(prefixDir, "cc-proxy")
 	disableBlock := true
+	blockStorageDriver := "virtio-scsi"
 
 	// override
 	defaultProxyPath = proxyPath
@@ -110,7 +111,8 @@ func makeRuntimeConfig(prefixDir string) (configFile string, config oci.RuntimeC
 		shimPath,
 		testProxyURL,
 		logPath,
-		disableBlock)
+		disableBlock,
+		blockStorageDriver)
 
 	configFile = path.Join(prefixDir, "runtime.toml")
 	err = createConfig(configFile, runtimeConfig)

diff --git a/config.go b/config.go
@@ -85,6 +85,7 @@ type hypervisor struct {
 	DefaultMemSz          uint32 `toml:"default_memory"`
 	DefaultBridges        uint32 `toml:"default_bridges"`
 	DisableBlockDeviceUse bool   `toml:"disable_block_device_use"`
+	BlockDeviceDriver     string `toml:"block_device_driver"`
 	MemPrealloc           bool   `toml:"enable_mem_prealloc"`
 	HugePages             bool   `toml:"enable_hugepages"`
 	Swap                  bool   `toml:"enable_swap"`
@@ -218,6 +219,18 @@ func (h hypervisor) defaultBridges() uint32 {
 	return h.DefaultBridges
 }
 
+func (h hypervisor) blockDeviceDriver() (string, error) {
+	if h.BlockDeviceDriver == "" {
+		return defaultBlockDeviceDriver, nil
+	}
+
+	if h.BlockDeviceDriver != vc.VirtioSCSI && h.BlockDeviceDriver != vc.VirtioBlock {
+		return "", fmt.Errorf("Invalid value %s provided for hypervisor block storage driver, can be either %s or %s", h.BlockDeviceDriver, vc.VirtioSCSI, vc.VirtioBlock)
+	}
+
+	return h.BlockDeviceDriver, nil
+}
+
 func (p proxy) path() string {
 	if p.Path == "" {
 		return defaultProxyPath
@@ -269,6 +282,11 @@ func newQemuHypervisorConfig(h hypervisor) (vc.HypervisorConfig, error) {
 	kernelParams := h.kernelParams()
 	machineType := h.machineType()
 
+	blockDriver, err := h.blockDeviceDriver()
+	if err != nil {
+		return vc.HypervisorConfig{}, err
+	}
+
 	return vc.HypervisorConfig{
 		HypervisorPath:        hypervisor,
 		KernelPath:            kernel,
@@ -286,6 +304,7 @@ func newQemuHypervisorConfig(h hypervisor) (vc.HypervisorConfig, error) {
 		Mlock:                 !h.Swap,
 		Debug:                 h.Debug,
 		DisableNestingChecks:  h.DisableNestingChecks,
+		BlockDeviceDriver:     blockDriver,
 	}, nil
 }
 
@@ -387,6 +406,7 @@ func loadConfiguration(configPath string, ignoreLogging bool) (resolvedConfigPat
 		Mlock:                 !defaultEnableSwap,
 		Debug:                 defaultEnableDebug,
 		DisableNestingChecks:  defaultDisableNestingChecks,
+		BlockDeviceDriver:     defaultBlockDeviceDriver,
 	}
 
 	err = config.InterNetworkModel.SetModel(defaultInterNetworkingModel)

diff --git a/config/configuration.toml.in b/config/configuration.toml.in
@@ -64,6 +64,11 @@ default_bridges = @DEFBRIDGES@
 # 9pfs is used instead to pass the rootfs.
 disable_block_device_use = @DEFDISABLEBLOCK@
 
+# Block storage driver to be used for the hypervisor in case the container
+# rootfs is backed by a block device. This is either virtio-scsi or 
+# virtio-blk.
+block_device_driver = "@DEFBLOCKSTORAGEDRIVER@"
+
 # Enable pre allocation of VM RAM, default false
 # Enabling this will result in lower container density
 # as all of the memory will be allocated and locked

diff --git a/config_test.go b/config_test.go
@@ -41,13 +41,14 @@ type testRuntimeConfig struct {
 	LogPath           string
 }
 
-func makeRuntimeConfigFileData(hypervisor, hypervisorPath, kernelPath, imagePath, kernelParams, machineType, shimPath, proxyPath, logPath string, disableBlock bool) string {
+func makeRuntimeConfigFileData(hypervisor, hypervisorPath, kernelPath, imagePath, kernelParams, machineType, shimPath, proxyPath, logPath string, disableBlock bool, blockDeviceDriver string) string {
 	return `
 	# Clear Containers runtime configuration file
 
 	[hypervisor.` + hypervisor + `]
 	path = "` + hypervisorPath + `"
 	kernel = "` + kernelPath + `"
+	block_device_driver =  "` + blockDeviceDriver + `"
 	kernel_params = "` + kernelParams + `"
 	image = "` + imagePath + `"
 	machine_type = "` + machineType + `"
@@ -99,8 +100,9 @@ func createAllRuntimeConfigFiles(dir, hypervisor string) (config testRuntimeConf
 	logPath := path.Join(logDir, "runtime.log")
 	machineType := "machineType"
 	disableBlockDevice := true
+	blockDeviceDriver := "virtio-scsi"
 
-	runtimeConfigFileData := makeRuntimeConfigFileData(hypervisor, hypervisorPath, kernelPath, imagePath, kernelParams, machineType, shimPath, proxyPath, logPath, disableBlockDevice)
+	runtimeConfigFileData := makeRuntimeConfigFileData(hypervisor, hypervisorPath, kernelPath, imagePath, kernelParams, machineType, shimPath, proxyPath, logPath, disableBlockDevice, blockDeviceDriver)
 
 	configPath := path.Join(dir, "runtime.toml")
 	err = createConfig(configPath, runtimeConfigFileData)
@@ -135,6 +137,7 @@ func createAllRuntimeConfigFiles(dir, hypervisor string) (config testRuntimeConf
 		DefaultVCPUs:          defaultVCPUCount,
 		DefaultMemSz:          defaultMemSize,
 		DisableBlockDeviceUse: disableBlockDevice,
+		BlockDeviceDriver:     defaultBlockDeviceDriver,
 		DefaultBridges:        defaultBridgesCount,
 		Mlock:                 !defaultEnableSwap,
 	}
@@ -518,6 +521,7 @@ func TestMinimalRuntimeConfig(t *testing.T) {
 		DisableBlockDeviceUse: defaultDisableBlockDeviceUse,
 		DefaultBridges:        defaultBridgesCount,
 		Mlock:                 !defaultEnableSwap,
+		BlockDeviceDriver:     defaultBlockDeviceDriver,
 	}
 
 	expectedAgentConfig := vc.HyperConfig{}