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:

src/runtime/pkg/katautils/config.go

@@ -132,11 +132,12 @@ type runtime struct {
 }
 
 type agent struct {
-	Debug         bool     `toml:"enable_debug"`
-	Tracing       bool     `toml:"enable_tracing"`
-	TraceMode     string   `toml:"trace_mode"`
-	TraceType     string   `toml:"trace_type"`
-	KernelModules []string `toml:"kernel_modules"`
+	Debug               bool     `toml:"enable_debug"`
+	Tracing             bool     `toml:"enable_tracing"`
+	TraceMode           string   `toml:"trace_mode"`
+	TraceType           string   `toml:"trace_type"`
+	KernelModules       []string `toml:"kernel_modules"`
+	DebugConsoleEnabled bool     `toml:"debug_console_enabled"`
 }
 
 type netmon struct {
@@ -441,6 +442,10 @@ func (h hypervisor) getIOMMUPlatform() bool {
 	return h.IOMMUPlatform
 }
 
+func (a agent) debugConsoleEnabled() bool {
+	return a.DebugConsoleEnabled
+}
+
 func (a agent) debug() bool {
 	return a.Debug
 }
@@ -866,23 +871,15 @@ func updateRuntimeConfigHypervisor(configPath string, tomlConf tomlConfig, confi
 }
 
 func updateRuntimeConfigAgent(configPath string, tomlConf tomlConfig, config *oci.RuntimeConfig, builtIn bool) error {
-	if builtIn {
-		config.AgentConfig = vc.KataAgentConfig{
-			LongLiveConn:  true,
-			Debug:         config.AgentConfig.Debug,
-			KernelModules: config.AgentConfig.KernelModules,
-		}
-
-		return nil
-	}
-
 	for _, agent := range tomlConf.Agent {
 		config.AgentConfig = vc.KataAgentConfig{
-			Debug:         agent.debug(),
-			Trace:         agent.trace(),
-			TraceMode:     agent.traceMode(),
-			TraceType:     agent.traceType(),
-			KernelModules: agent.kernelModules(),
+			LongLiveConn:       true,
+			Debug:              agent.debug(),
+			Trace:              agent.trace(),
+			TraceMode:          agent.traceMode(),
+			TraceType:          agent.traceType(),
+			KernelModules:      agent.kernelModules(),
+			EnableDebugConsole: agent.debugConsoleEnabled(),
 		}
 	}
 
@@ -1026,12 +1023,10 @@ func initConfig() (config oci.RuntimeConfig, err error) {
 		return oci.RuntimeConfig{}, err
 	}
 
-	defaultAgentConfig := vc.KataAgentConfig{}
-
 	config = oci.RuntimeConfig{
 		HypervisorType:   defaultHypervisor,
 		HypervisorConfig: GetDefaultHypervisorConfig(),
-		AgentConfig:      defaultAgentConfig,
+		AgentConfig:      vc.KataAgentConfig{},
 	}
 
 	return config, nil

src/runtime/pkg/katautils/config_test.go

@@ -167,7 +167,9 @@ func createAllRuntimeConfigFiles(dir, hypervisor string) (config testRuntimeConf
 		VirtioFSCache:         defaultVirtioFSCacheMode,
 	}
 
-	agentConfig := vc.KataAgentConfig{}
+	agentConfig := vc.KataAgentConfig{
+		LongLiveConn: true,
+	}
 
 	netmonConfig := vc.NetmonConfig{
 		Path:   netmonPath,
@@ -519,7 +521,8 @@ func TestMinimalRuntimeConfig(t *testing.T) {
 	# Runtime configuration file
 
 	[agent.kata]
-
+	debug_console_enabled=true
+	kernel_modules=["a", "b", "c"]
 	[netmon]
 	path = "` + netmonPath + `"
 `
@@ -576,7 +579,11 @@ func TestMinimalRuntimeConfig(t *testing.T) {
 		VirtioFSCache:         defaultVirtioFSCacheMode,
 	}
 
-	expectedAgentConfig := vc.KataAgentConfig{}
+	expectedAgentConfig := vc.KataAgentConfig{
+		LongLiveConn:       true,
+		EnableDebugConsole: true,
+		KernelModules:      []string{"a", "b", "c"},
+	}
 
 	expectedNetmonConfig := vc.NetmonConfig{
 		Path:   netmonPath,

src/runtime/virtcontainers/kata_agent.go

@@ -52,6 +52,11 @@ const (
 
 	// path to vfio devices
 	vfioPath = "/dev/vfio/"
+
+	// enable debug console
+	kernelParamDebugConsole           = "agent.debug_console"
+	kernelParamDebugConsoleVPort      = "agent.debug_console_vport"
+	kernelParamDebugConsoleVPortValue = "1026"
 )
 
 var (
@@ -195,13 +200,14 @@ func ephemeralPath() string {
 // KataAgentConfig is a structure storing information needed
 // to reach the Kata Containers agent.
 type KataAgentConfig struct {
-	LongLiveConn      bool
-	Debug             bool
-	Trace             bool
-	ContainerPipeSize uint32
-	TraceMode         string
-	TraceType         string
-	KernelModules     []string
+	LongLiveConn       bool
+	Debug              bool
+	Trace              bool
+	EnableDebugConsole bool
+	ContainerPipeSize  uint32
+	TraceMode          string
+	TraceType          string
+	KernelModules      []string
 }
 
 // KataAgentState is the structure describing the data stored from this
@@ -294,6 +300,11 @@ func KataAgentKernelParams(config KataAgentConfig) []Param {
 		params = append(params, Param{Key: vcAnnotations.ContainerPipeSizeKernelParam, Value: containerPipeSize})
 	}
 
+	if config.EnableDebugConsole {
+		params = append(params, Param{Key: kernelParamDebugConsole, Value: ""})
+		params = append(params, Param{Key: kernelParamDebugConsoleVPort, Value: kernelParamDebugConsoleVPortValue})
+	}
+
 	return params
 }
 
@@ -1208,16 +1219,6 @@ func (k *kataAgent) buildContainerRootfs(sandbox *Sandbox, c *Container, rootPat
 	return nil, nil
 }
 
-func (k *kataAgent) hasAgentDebugConsole(sandbox *Sandbox) bool {
-	for _, p := range sandbox.config.HypervisorConfig.KernelParams {
-		if p.Key == "agent.debug_console" {
-			k.Logger().Info("agent has debug console")
-			return true
-		}
-	}
-	return false
-}
-
 func (k *kataAgent) createContainer(sandbox *Sandbox, c *Container) (p *Process, err error) {
 	span, _ := k.trace("createContainer")
 	defer span.Finish()

src/runtime/virtcontainers/vm_test.go

@@ -101,7 +101,15 @@ func TestVMConfigGrpc(t *testing.T) {
 	config := VMConfig{
 		HypervisorType:   QemuHypervisor,
 		HypervisorConfig: newQemuConfig(),
-		AgentConfig:      KataAgentConfig{true, false, false, 0, "", "", []string{}},
+		AgentConfig: KataAgentConfig{
+			LongLiveConn:       true,
+			Debug:              false,
+			Trace:              false,
+			EnableDebugConsole: false,
+			ContainerPipeSize:  0,
+			TraceMode:          "",
+			TraceType:          "",
+			KernelModules:      []string{}},
 	}
 
 	p, err := config.ToGrpc()