runtime: add enable_debug_console configuration item for agent

Set enable_debug_console=true in Kata's congiguration file,
runtime will pass `agent.debug_console`
and `agent.debug_console_vport=1026` to agent.

Fixes: #245

Signed-off-by: bin liu <bin@hyper.sh>

src/runtime/cli/config-generated.go.in

@@ -39,7 +39,6 @@ var version = "@VERSION@"
 // project-specific command names
 var envCmd = fmt.Sprintf("%s-env", projectPrefix)
 var checkCmd = fmt.Sprintf("%s-check", projectPrefix)
-var execCmd = "exec"
 
 // project-specific option names
 var configFilePathOption = fmt.Sprintf("%s-config", projectPrefix)

src/runtime/cli/config/configuration-acrn.toml.in

@@ -127,6 +127,13 @@ block_device_driver = "@DEFBLOCKSTORAGEDRIVER_ACRN@"
 #trace_mode = "dynamic"
 #trace_type = "isolated"
 
+# Enable debug console.
+
+# If enabled, user can connect guest OS running inside hypervisor
+# through "kata-runtime exec <sandbox-id>" command
+
+#debug_console_enabled = true
+
 [netmon]
 # If enabled, the network monitoring process gets started when the
 # sandbox is created. This allows for the detection of some additional

src/runtime/cli/config/configuration-clh.toml.in

@@ -125,6 +125,12 @@ block_device_driver = "virtio-blk"
 #trace_mode = "dynamic"
 #trace_type = "isolated"
 
+# Enable debug console.
+
+# If enabled, user can connect guest OS running inside hypervisor
+# through "kata-runtime exec <sandbox-id>" command
+
+#debug_console_enabled = true
 
 [netmon]
 # If enabled, the network monitoring process gets started when the

src/runtime/cli/config/configuration-fc.toml.in

@@ -256,6 +256,13 @@ block_device_driver = "@DEFBLOCKSTORAGEDRIVER_FC@"
 #
 kernel_modules=[]
 
+# Enable debug console.
+
+# If enabled, user can connect guest OS running inside hypervisor
+# through "kata-runtime exec <sandbox-id>" command
+
+#debug_console_enabled = true
+
 [netmon]
 # If enabled, the network monitoring process gets started when the
 # sandbox is created. This allows for the detection of some additional

src/runtime/cli/config/configuration-qemu-virtiofs.toml.in

@@ -352,6 +352,12 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
 #
 kernel_modules=[]
 
+# Enable debug console.
+
+# If enabled, user can connect guest OS running inside hypervisor
+# through "kata-runtime exec <sandbox-id>" command
+
+#debug_console_enabled = true
 
 [netmon]
 # If enabled, the network monitoring process gets started when the

src/runtime/cli/config/configuration-qemu.toml.in

@@ -375,6 +375,12 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
 #
 kernel_modules=[]
 
+# Enable debug console.
+
+# If enabled, user can connect guest OS running inside hypervisor
+# through "kata-runtime exec <sandbox-id>" command
+
+#debug_console_enabled = true
 
 [netmon]
 # If enabled, the network monitoring process gets started when the

src/runtime/cli/kata-exec.go

@@ -28,9 +28,16 @@ import (
 const (
 
 	// The buffer size used to specify the buffer for IO streams copy
-	bufSize = 32 << 10
+	bufSize = 1024 * 2
 
 	defaultTimeout = 3 * time.Second
+
+	subCommandName = "exec"
+	// command-line parameters name
+	paramKataMonitorAddr                     = "kata-monitor-addr"
+	paramDebugConsolePort                    = "kata-debug-port"
+	defaultKernelParamDebugConsoleVPortValue = 1026
+	defaultParamKataMonitorAddr              = "http://localhost:8090"
 )
 
 var (
@@ -43,15 +50,15 @@ var (
 )
 
 var kataExecCLICommand = cli.Command{
-	Name:  execCmd,
+	Name:  subCommandName,
 	Usage: "Enter into guest by debug console",
 	Flags: []cli.Flag{
 		cli.StringFlag{
-			Name:  "monitor-addr",
+			Name:  paramKataMonitorAddr,
 			Usage: "Kata monitor listen address.",
 		},
 		cli.Uint64Flag{
-			Name:  "debug-port",
+			Name:  paramDebugConsolePort,
 			Usage: "Port that debug console is listening on.",
 		},
 	},
@@ -60,17 +67,17 @@ var kataExecCLICommand = cli.Command{
 		if err != nil {
 			return err
 		}
-		span, _ := katautils.Trace(ctx, "exec")
+		span, _ := katautils.Trace(ctx, subCommandName)
 		defer span.Finish()
 
-		endPoint := context.String("monitor-addr")
+		endPoint := context.String(paramKataMonitorAddr)
 		if endPoint == "" {
-			endPoint = "http://localhost:8090"
+			endPoint = defaultParamKataMonitorAddr
 		}
 
-		port := context.Uint64("debug-port")
+		port := context.Uint64(paramDebugConsolePort)
 		if port == 0 {
-			port = 1026
+			port = defaultKernelParamDebugConsoleVPortValue
 		}
 
 		sandboxID := context.Args().Get(0)
@@ -188,8 +195,11 @@ func getConn(endPoint, sandboxID string, port uint64) (net.Conn, error) {
 	switch addr.Scheme {
 	case clientUtils.VSockSocketScheme:
 		// vsock://31513974:1024
-		shimAddr := clientUtils.VSockSocketScheme + ":" + addr.Host
-		shimAddr = strings.Replace(shimAddr, ":1024", fmt.Sprintf(":%d", port), -1)
+		cidAndPort := strings.Split(addr.Host, ":")
+		if len(cidAndPort) != 2 {
+			return nil, fmt.Errorf("Invalid vsock scheme: %s", sock)
+		}
+		shimAddr := fmt.Sprintf("%s:%s:%d", clientUtils.VSockSocketScheme, cidAndPort[0], port)
 		return clientUtils.VsockDialer(shimAddr, defaultTimeout)
 
 	case clientUtils.HybridVSockScheme: