support 0.18's new vsock API

Signed-off-by: Jerome Gravel-Niquet <[email protected]>

Author: jeromegn

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

@@ -183,16 +183,16 @@ func (f *Client) PutGuestDriveByID(ctx context.Context, driveID string, drive *m
 	return f.client.Operations.PutGuestDriveByID(params)
 }
 
-// PutGuestVsockByIDOpt is a functional option to be used for the
+// PutGuestVsockOpt is a functional option to be used for the
 // PutGuestVsockByID API in setting any additional optional fields.
 type PutGuestVsockByIDOpt func(*ops.PutGuestVsockByIDParams)
 
-// PutGuestVsockByID is a wrapper for the swagger generated client to make
+// PutGuestVsock 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(*vsock.VsockID)
 	params.SetBody(vsock)
 	for _, opt := range opts {
 		opt(params)

client/operations/put_guest_vsock_by_id_responses.go

@@ -398,8 +398,8 @@ func (m *Machine) createNetworkInterfaces(ctx context.Context, ifaces ...Network
 }
 
 func (m *Machine) addVsocks(ctx context.Context, vsocks ...VsockDevice) error {
-	for _, dev := range m.Cfg.VsockDevices {
-		if err := m.addVsock(ctx, dev); err != nil {
+	for i, dev := range m.Cfg.VsockDevices {
+		if err := m.addVsock(ctx, fmt.Sprintf("%d", i), dev); err != nil {
 			return err
 		}
 	}
@@ -729,13 +729,14 @@ 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 {
+func (m *Machine) addVsock(ctx context.Context, id string, dev VsockDevice) error {
 	vsockCfg := models.Vsock{
-		GuestCid: int64(dev.CID),
-		ID:       &dev.Path,
+		GuestCid: Int64(int64(dev.CID)),
+		UdsPath:  &dev.Path,
+		VsockID:  &id,
 	}
 
-	resp, _, err := m.client.PutGuestVsockByID(ctx, dev.Path, &vsockCfg)
+	resp, err := m.client.PutGuestVsockByID(ctx, &vsockCfg)
 	if err != nil {
 		return err
 	}