add metadata support and generated files

Signed-off-by: Yuval Kohavi <[email protected]>

Author: yuval-k

HACKING.md

@@ -13,17 +13,18 @@ You need some external resources in order to run the tests, as described below:
 1. A firecracker binary (tested with 0.10.1), but any recent version should
    work.  Must either be installed as `./firecracker` or the path must be
    specified through the `FC_TEST_BIN` environment variable.
-2. Access to hardware virtualization via `/dev/kvm` (ensure you have mode
+2. Access to hardware virtualization via `/dev/kvm` and `/dev/vhost-vsock` (ensure you have mode
    `+rw`!)
 3. An uncompressed Linux kernel binary that can boot in Firecracker VM (Must be
-   installed as `./vmlinux`)
+   installed as `./testdata/vmlinux`)
 4. A tap device owned by your userid (Must be either named `fc-test-tap0` or
    have the name specified with the `FC_TEST_TAP` environment variable; try
    `sudo ip tuntap add fc-test-tap0 mode tap user $UID` to create `fc-test-tap0`
    if you need to create one)
-5. A root filesystem image installed (Must be named `root-drive.img`; can be
+5. A root filesystem image installed (Must be named `testdata/root-drive.img`)
+6. A secondary device image (Must be named `testdata/drive-2.img`; can be
    empty, create it something like
-   `dd if=/dev/zero of=drive-2.img bs=1k count=102400`)
+   `dd if=/dev/zero of=testdata/drive-2.img bs=1k count=102400`)
 
 With all of those set up, `make test EXTRAGOARGS=-v` should create a Firecracker
 process and run the Linux kernel in a MicroVM.

Makefile

@@ -18,10 +18,10 @@ EXTRAGOARGS:=
 
 all: build
 
-build clean test:
+generate build clean test:
 	go $@ $(EXTRAGOARGS)
 	for d in $(SUBDIRS); do \
 		cd $$d && go $@ $(EXTRAGOARGS); \
 	done
 
-.PHONY: all clean build test
+.PHONY: all generate clean build test

client/models/error.go

@@ -257,8 +257,10 @@ paths:
           schema:
             type: object
       responses:
+        201:
+          description: MMDS data store created
         204:
-          description: MMDS data store created/updated.
+          description: MMDS data store updated.
         400:
           description: MMDS data store cannot be created due to bad input.
           schema:
@@ -393,7 +395,7 @@ definitions:
 
   Error:
     properties:
-      faultMessage:
+      fault_message:
         type: string
         description: A description of the error condition
 

client/operations/operations_client.go

@@ -15,6 +15,7 @@ package main
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"os"
@@ -107,6 +108,7 @@ func main() {
 		FcCPUCount         int64    `long:"ncpus" short:"c" description:"Number of CPUs" default:"1"`
 		FcCPUTemplate      string   `long:"cpu-template" description:"Firecracker CPU Template (C3 or T2)"`
 		FcMemSz            int64    `long:"memory" short:"m" description:"VM memory, in MiB" default:"512"`
+		FcMetadata         string   `long:"metadata" description:"Firecracker Meatadata for MMDS (json)"`
 		Debug              bool     `long:"debug" short:"d" description:"Enable debug output"`
 		Help               bool     `long:"help" short:"h" description:"Show usage"`
 	}
@@ -131,6 +133,13 @@ func main() {
 		logger.SetLevel(log.DebugLevel)
 	}
 
+	var metadata interface{}
+	if opts.FcMetadata != "" {
+		if err := json.Unmarshal([]byte(opts.FcMetadata), &metadata); err != nil {
+			log.Fatalf("Unable to parse metadata as json: %s", err)
+		}
+	}
+
 	var NICs []firecracker.NetworkInterface
 
 	if len(opts.FcNicConfig) > 0 {
@@ -139,10 +148,12 @@ func main() {
 			log.Fatalf("Unable to parse NIC config: %s", err)
 		} else {
 			log.Printf("Adding tap device %s", tapDev)
+			allowMDDS := metadata != nil
 			NICs = []firecracker.NetworkInterface{
 				firecracker.NetworkInterface{
 					MacAddress:  tapMacAddr,
 					HostDevName: tapDev,
+					AllowMDDS:   allowMDDS,
 				},
 			}
 		}
@@ -192,8 +203,17 @@ func main() {
 	errchan, err := m.Init(ctx)
 	if err != nil {
 		log.Fatalf("Firecracker Init returned error %s", err)
-	} else {
-		m.StartInstance(vmmCtx)
+	}
+
+	if metadata != nil {
+		err := m.SetMetadata(vmmCtx, metadata)
+		if err != nil {
+			log.Fatalf("Firecracker SetMetadata returned error %s", err)
+		}
+	}
+	err = m.StartInstance(vmmCtx)
+	if err != nil {
+		log.Fatalf("Firecracker StartInstance returned error %s", err)
 	}
 
 	// wait for the VMM to exit

client/operations/put_mmds_responses.go

@@ -132,6 +132,14 @@ func (f *FirecrackerClient) CreateSyncAction(ctx context.Context, info *models.I
 	return f.client.Operations.CreateSyncAction(params)
 }
 
+func (f *FirecrackerClient) PutMmds(ctx context.Context, metadata interface{}) (*ops.PutMmdsCreated, *ops.PutMmdsNoContent, error) {
+	params := ops.NewPutMmdsParams()
+	params.SetContext(ctx)
+	params.SetBody(metadata)
+
+	return f.client.Operations.PutMmds(params)
+}
+
 func (f *FirecrackerClient) GetMachineConfig() (*ops.GetMachineConfigOK, error) {
 	p := ops.NewGetMachineConfigParams()
 	p.SetTimeout(firecrackerRequestTimeout)

client/swagger.yaml

@@ -58,6 +58,7 @@ type Firecracker interface {
 	PutGuestDriveByID(ctx context.Context, driveID string, drive *models.Drive) (*ops.PutGuestDriveByIDNoContent, error)
 	PutGuestVsockByID(ctx context.Context, vsockID string, vsock *models.Vsock) (*ops.PutGuestVsockByIDCreated, *ops.PutGuestVsockByIDNoContent, error)
 	CreateSyncAction(ctx context.Context, info *models.InstanceActionInfo) (*ops.CreateSyncActionNoContent, error)
+	PutMmds(ctx context.Context, metadata interface{}) (*ops.PutMmdsCreated, *ops.PutMmdsNoContent, error)
 	GetMachineConfig() (*ops.GetMachineConfigOK, error)
 }
 
@@ -129,6 +130,7 @@ func (m *Machine) Logger() *log.Entry {
 type NetworkInterface struct {
 	MacAddress  string
 	HostDevName string
+	AllowMDDS   bool
 }
 
 // BlockDevice represents a host block device mapped to the firecracker VM.
@@ -433,10 +435,11 @@ func (m *Machine) createNetworkInterface(ctx context.Context, iface NetworkInter
 	m.logger.Printf("Attaching NIC %s (hwaddr %s) at index %s", iface.HostDevName, iface.MacAddress, ifaceID)
 
 	ifaceCfg := models.NetworkInterface{
-		IfaceID:     &ifaceID,
-		GuestMac:    iface.MacAddress,
-		HostDevName: iface.HostDevName,
-		State:       models.DeviceStateAttached,
+		IfaceID:           &ifaceID,
+		GuestMac:          iface.MacAddress,
+		HostDevName:       iface.HostDevName,
+		State:             models.DeviceStateAttached,
+		AllowMmdsRequests: iface.AllowMDDS,
 	}
 
 	resp, err := m.client.PutGuestNetworkInterfaceByID(ctx, ifaceID, &ifaceCfg)
@@ -518,14 +521,30 @@ func (m *Machine) startInstance(ctx context.Context) error {
 		ActionType: models.InstanceActionInfoActionTypeInstanceStart,
 	}
 
-	ctx, cancel := context.WithCancel(ctx)
-	defer cancel()
-
 	resp, err := m.client.CreateSyncAction(ctx, &info)
 	if err == nil {
 		m.logger.Printf("startInstance successful: %s", resp.Error())
 	} else {
-		m.logger.Printf("Error starting instance: %s", err)
+		m.logger.Errorf("Starting instance: %s", err)
+	}
+	return err
+}
+
+// SetMetadata sets the machine's metadata for MDDS
+func (m *Machine) SetMetadata(ctx context.Context, metadata interface{}) error {
+	respcreated, respnocontent, err := m.client.PutMmds(ctx, metadata)
+
+	if err == nil {
+		var message string
+		if respcreated != nil {
+			message = respcreated.Error()
+		}
+		if respnocontent != nil {
+			message = respnocontent.Error()
+		}
+		m.logger.Printf("SetMetadata successful: %s", message)
+	} else {
+		m.logger.Errorf("Setting metadata: %s", err)
 	}
 	return err
 }