Merge pull request #129 from superfly/0.18

support 0.18's new vsock API

Author: sipsma

.buildkite/pipeline.yml

@@ -47,8 +47,8 @@ steps:
     commands:
       - 'ln -s /var/lib/fc-ci/vmlinux.bin testdata/vmlinux'
       - 'ln -s /var/lib/fc-ci/rootfs.ext4 testdata/root-drive.img'
-      - 'ln -s /usr/local/bin/firecracker-v0.17.0 testdata/firecracker'
-      - 'ln -s /usr/local/bin/jailer-v0.17.0 testdata/jailer'
+      - 'ln -s /usr/local/bin/firecracker-v0.18.0 testdata/firecracker'
+      - 'ln -s /usr/local/bin/jailer-v0.18.0 testdata/jailer'
       - "DISABLE_ROOT_TESTS=true FC_TEST_TAP=fc-test-tap${BUILDKITE_BUILD_NUMBER} make test EXTRAGOARGS='-v -count=1'"
     agents:
       queue: "${BUILDKITE_AGENT_META_DATA_QUEUE:-default}"
@@ -57,8 +57,8 @@ steps:
     commands:
       - 'ln -s /var/lib/fc-ci/vmlinux.bin testdata/vmlinux'
       - 'ln -s /var/lib/fc-ci/rootfs.ext4 testdata/root-drive.img'
-      - 'cp /usr/local/bin/firecracker-v0.17.0 testdata/firecracker'
-      - 'cp /usr/local/bin/jailer-v0.17.0 testdata/jailer'
+      - 'cp /usr/local/bin/firecracker-v0.18.0 testdata/firecracker'
+      - 'cp /usr/local/bin/jailer-v0.18.0 testdata/jailer'
       - 'make -C cni install CNI_BIN_ROOT=$(pwd)/testdata/bin'
       - "sudo FC_TEST_TAP=fc-root-tap${BUILDKITE_BUILD_NUMBER} make test EXTRAGOARGS='-v -count=1'"
     agents:

client/models/vsock.go

@@ -2,9 +2,10 @@ swagger: "2.0"
 info:
   title: Firecracker API
   description: RESTful public-facing API.
-               The API is accessible through HTTP calls on specific URLs carrying JSON modeled data.
+               The API is accessible through HTTP calls on specific URLs
+               carrying JSON modeled data.
                The transport medium is a Unix Domain Socket.
-  version: 0.17.0
+  version: 0.18.0
   termsOfService: ""
   contact:
     email: "[email protected]"
@@ -86,39 +87,6 @@ paths:
           schema:
             $ref: "#/definitions/Error"
 
-  /vsocks/{id}:
-    put:
-      summary: Creates new vsock with ID specified by the id parameter.
-      description:
-        If the vsock device with the specified ID already exists, its body will
-        be updated based on the new input. May fail if update is not possible.
-      operationId: putGuestVsockByID
-      parameters:
-      - name: id
-        in: path
-        description: The id of the vsock device
-        required: true
-        type: string
-      - name: body
-        in: body
-        description: Guest vsock properties
-        required: true
-        schema:
-          $ref: "#/definitions/Vsock"
-      responses:
-        201:
-          description: Vsock created
-        204:
-          description: Vsock updated
-        400:
-          description: Vsock cannot be created due to bad input
-          schema:
-            $ref: "#/definitions/Error"
-        default:
-          description: Internal server error
-          schema:
-            $ref: "#/definitions/Error"
-
   /drives/{drive_id}:
     put:
       summary: Creates or updates a drive.
@@ -385,6 +353,37 @@ paths:
           schema:
             $ref: "#/definitions/Error"
 
+  /vsocks/{id}:
+    put:
+      summary: Creates new vsock with ID specified by the id parameter.
+      description:
+        If the vsock device with the specified ID already exists, its body will
+        be updated based on the new input. May fail if update is not possible.
+      operationId: putGuestVsockByID
+      parameters:
+      - name: id
+        in: path
+        description: The id of the vsock device
+        required: true
+        type: string
+      - name: body
+        in: body
+        description: Guest vsock properties
+        required: true
+        schema:
+          $ref: "#/definitions/Vsock"
+      responses:
+        204:
+          description: Vsock created/updated
+        400:
+          description: Vsock cannot be created due to bad input
+          schema:
+            $ref: "#/definitions/Error"
+        default:
+          description: Internal server error
+          schema:
+            $ref: "#/definitions/Error"
+
 definitions:
   BootSource:
     type: object
@@ -644,14 +643,30 @@ definitions:
         format: int64
         description: The amount of milliseconds it takes for the bucket to refill.
         minimum: 0
+
   Vsock:
     type: object
+    description:
+      Defines a vsock device, backed by a set of Unix Domain Sockets, on the host side.
+      For host-initiated connections, Firecracker will be listening on the Unix socket
+      identified by the path `uds_path`. Firecracker will create this socket, bind and
+      listen on it. Host-initiated connections will be performed by connection to this
+      socket and issuing a connection forwarding request to the desired guest-side vsock
+      port (i.e. `CONNECT 52\n`, to connect to port 52).
+      For guest-initiated connections, Firecracker will expect host software to be
+      bound and listening on Unix sockets at `uds_path_<PORT>`.
+      E.g. "/path/to/host_vsock.sock_52" for port number 52.
     required:
-      - id
+      - vsock_id
+      - guest_cid
+      - uds_path
     properties:
-      id:
+      vsock_id:
         type: string
       guest_cid:
         type: integer
         minimum: 3
         description: Guest Vsock CID
+      uds_path:
+        type: string
+        description: Path to UNIX domain socket, used to proxy vsock connections.

client/operations/operations_client.go

@@ -189,10 +189,10 @@ type PutGuestVsockByIDOpt func(*ops.PutGuestVsockByIDParams)
 
 // PutGuestVsockByID is a wrapper for the swagger generated client to make
 // calling of the API easier.
-func (f *Client) PutGuestVsockByID(ctx context.Context, vsockID string, vsock *models.Vsock, opts ...PutGuestVsockByIDOpt) (*ops.PutGuestVsockByIDCreated, *ops.PutGuestVsockByIDNoContent, error) {
+func (f *Client) PutGuestVsockByID(ctx context.Context, vsock *models.Vsock, opts ...PutGuestVsockByIDOpt) (*ops.PutGuestVsockByIDNoContent, error) {
 	params := ops.NewPutGuestVsockByIDParams()
 	params.SetContext(ctx)
-	params.SetID(vsockID)
+	params.SetID(StringValue(vsock.VsockID))
 	params.SetBody(vsock)
 	for _, opt := range opts {
 		opt(params)

client/operations/put_guest_vsock_by_id_responses.go

@@ -592,9 +592,9 @@ func TestHandlers(t *testing.T) {
 		{
 			Handler: AddVsocksHandler,
 			Client: fctesting.MockClient{
-				PutGuestVsockByIDFn: func(params *ops.PutGuestVsockByIDParams) (*ops.PutGuestVsockByIDCreated, *ops.PutGuestVsockByIDNoContent, error) {
+				PutGuestVsockByIDFn: func(params *ops.PutGuestVsockByIDParams) (*ops.PutGuestVsockByIDNoContent, error) {
 					called = AddVsocksHandler.Name
-					return &ops.PutGuestVsockByIDCreated{}, &ops.PutGuestVsockByIDNoContent{}, nil
+					return &ops.PutGuestVsockByIDNoContent{}, nil
 				},
 			},
 			Config: Config{

client/swagger.yaml

@@ -222,6 +222,8 @@ type RateLimiterSet struct {
 // VsockDevice represents a vsock connection between the host and the guest
 // microVM.
 type VsockDevice struct {
+	// ID defines the vsock's device ID for firecracker.
+	ID string
 	// Path defines the filesystem path of the vsock device on the host.
 	Path string
 	// CID defines the 32-bit Context Identifier for the vsock device.  See
@@ -731,11 +733,12 @@ func (m *Machine) attachDrive(ctx context.Context, dev models.Drive) error {
 // addVsock adds a vsock to the instance
 func (m *Machine) addVsock(ctx context.Context, dev VsockDevice) error {
 	vsockCfg := models.Vsock{
-		GuestCid: int64(dev.CID),
-		ID:       &dev.Path,
+		GuestCid: Int64(int64(dev.CID)),
+		UdsPath:  &dev.Path,
+		VsockID:  &dev.ID,
 	}
 
-	resp, _, err := m.client.PutGuestVsockByID(ctx, dev.Path, &vsockCfg)
+	resp, err := m.client.PutGuestVsockByID(ctx, &vsockCfg)
 	if err != nil {
 		return err
 	}

fctesting/firecracker_mock_client.go

@@ -561,9 +561,11 @@ func testAttachSecondaryDrive(ctx context.Context, t *testing.T, m *Machine) {
 }
 
 func testAttachVsock(ctx context.Context, t *testing.T, m *Machine) {
+	timestamp := strconv.Itoa(int(time.Now().UnixNano()))
 	dev := VsockDevice{
+		ID:   "1",
 		CID:  3,
-		Path: "foo",
+		Path: timestamp + ".vsock",
 	}
 	err := m.addVsock(ctx, dev)
 	if err != nil {