hypervisor: add bios option in configuration file

This patch adds a new option in configuration file
this will allow users specify the path to a specific
firmware, if a path is not specified qemu uses the default firmware
(bios-256k.bin)

Fixes clearcontainers#686

Signed-off-by: Julio Montes <julio.montes@intel.com>

Makefile

@@ -79,6 +79,7 @@ PKGLIBEXECDIR := $(LIBEXECDIR)/$(CCDIR)
 
 KERNELPATH := $(PKGDATADIR)/vmlinuz.container
 IMAGEPATH := $(PKGDATADIR)/clear-containers.img
+FIRMWAREPATH :=
 
 KERNELPARAMS :=
 
@@ -156,6 +157,7 @@ USER_VARS += DESTTARGET
 USER_VARS += IMAGEPATH
 USER_VARS += MACHINETYPE
 USER_VARS += KERNELPATH
+USER_VARS += FIRMWAREPATH
 USER_VARS += KERNELPARAMS
 USER_VARS += LIBEXECDIR
 USER_VARS += LOCALSTATEDIR
@@ -215,6 +217,7 @@ var version = "$(VERSION)"
 var defaultHypervisorPath = "$(QEMUPATH)"
 var defaultImagePath = "$(IMAGEPATH)"
 var defaultKernelPath = "$(KERNELPATH)"
+var defaultFirmwarePath = "$(FIRMWAREPATH)"
 var defaultShimPath = "$(SHIMPATH)"
 
 const defaultKernelParams = "$(KERNELPARAMS)"
@@ -285,6 +288,7 @@ $(GENERATED_FILES): %: %.in Makefile VERSION
 		-e "s|@CONFIG_IN@|$(CONFIG_IN)|g" \
 		-e "s|@IMAGEPATH@|$(IMAGEPATH)|g" \
 		-e "s|@KERNELPATH@|$(KERNELPATH)|g" \
+		-e "s|@FIRMWAREPATH@|$(FIRMWAREPATH)|g" \
 		-e "s|@KERNELPARAMS@|$(KERNELPARAMS)|g" \
 		-e "s|@LOCALSTATEDIR@|$(LOCALSTATEDIR)|g" \
 		-e "s|@PKGLIBEXECDIR@|$(PKGLIBEXECDIR)|g" \

config.go

@@ -76,6 +76,7 @@ type hypervisor struct {
 	Path                  string `toml:"path"`
 	Kernel                string `toml:"kernel"`
 	Image                 string `toml:"image"`
+	Firmware              string `toml:"firmware"`
 	KernelParams          string `toml:"kernel_params"`
 	MachineType           string `toml:"machine_type"`
 	DefaultVCPUs          int32  `toml:"default_vcpus"`
@@ -134,6 +135,19 @@ func (h hypervisor) image() (string, error) {
 	return resolvePath(p)
 }
 
+func (h hypervisor) firmware() (string, error) {
+	p := h.Firmware
+
+	if p == "" {
+		if defaultFirmwarePath == "" {
+			return "", nil
+		}
+		p = defaultFirmwarePath
+	}
+
+	return resolvePath(p)
+}
+
 func (h hypervisor) kernelParams() string {
 	if h.KernelParams == "" {
 		return defaultKernelParams
@@ -210,13 +224,19 @@ func newQemuHypervisorConfig(h hypervisor) (vc.HypervisorConfig, error) {
 		return vc.HypervisorConfig{}, err
 	}
 
+	firmware, err := h.firmware()
+	if err != nil {
+		return vc.HypervisorConfig{}, err
+	}
+
 	kernelParams := h.kernelParams()
 	machineType := h.machineType()
 
 	return vc.HypervisorConfig{
 		HypervisorPath:        hypervisor,
 		KernelPath:            kernel,
 		ImagePath:             image,
+		FirmwarePath:          firmware,
 		KernelParams:          vc.DeserializeParams(strings.Fields(kernelParams)),
 		HypervisorMachineType: machineType,
 		DefaultVCPUs:          h.defaultVCPUs(),
@@ -320,6 +340,7 @@ func loadConfiguration(configPath string, ignoreLogging bool) (resolvedConfigPat
 		HypervisorPath:        defaultHypervisorPath,
 		KernelPath:            defaultKernelPath,
 		ImagePath:             defaultImagePath,
+		FirmwarePath:          defaultFirmwarePath,
 		HypervisorMachineType: defaultMachineType,
 		DefaultVCPUs:          defaultVCPUCount,
 		DefaultMemSz:          defaultMemSize,

config/configuration.toml.in

@@ -10,6 +10,10 @@ machine_type = "@MACHINETYPE@"
 # trouble running pre-2.15 glibc
 kernel_params = "@KERNELPARAMS@"
 
+# Path to the firmware.
+# If you want that qemu uses the default firmware leave this option empty
+firmware = "@FIRMWAREPATH@"
+
 # Default number of vCPUs per POD/VM:
 # unspecified or 0 --> will be set to @DEFVCPUS@
 # < 0              --> will be set to the actual number of physical cores

config_test.go

@@ -899,3 +899,23 @@ func TestGetDefaultConfigFile(t *testing.T) {
 	_, err = getDefaultConfigFile()
 	assert.Error(err)
 }
+
+func TestDefaultFirmware(t *testing.T) {
+	assert := assert.New(t)
+
+	f, err := ioutil.TempFile(os.TempDir(), "qboot.bin")
+	assert.NoError(err)
+	assert.NoError(f.Close())
+	defer os.RemoveAll(f.Name())
+
+	h := hypervisor{}
+	defaultFirmwarePath = ""
+	p, err := h.firmware()
+	assert.NoError(err)
+	assert.Empty(p)
+
+	defaultFirmwarePath = f.Name()
+	p, err = h.firmware()
+	assert.NoError(err)
+	assert.NotEmpty(p)
+}