Merge branch 'dev' into feat/hostname

Author: IDisposable

.devcontainer/install-deps.sh

@@ -18,6 +18,7 @@ sudo apt-get install -y --no-install-recommends \
   build-essential \
   device-tree-compiler \
   gperf g++-multilib gcc-multilib \
+  gdb-multiarch \
   libnl-3-dev libdbus-1-dev libelf-dev libmpc-dev dwarves \
   bc openssl flex bison libssl-dev python3 python-is-python3 texinfo kmod cmake \
   wget zstd \

.vscode/c_cpp_properties.json

@@ -0,0 +1,17 @@
+{
+    "configurations": [
+        {
+            "name": "Linux",
+            "includePath": [
+                "${workspaceFolder}/**"
+            ],
+            "defines": [],
+            "compilerPath": "/opt/jetkvm-native-buildkit/bin/arm-rockchip830-linux-uclibcgnueabihf-gcc",
+            "cStandard": "c17",
+            "cppStandard": "gnu++17",
+            "intelliSenseMode": "linux-gcc-arm",
+            "configurationProvider": "ms-vscode.cmake-tools"
+        }
+    ],
+    "version": 4
+}

.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "GDB Debug - Native (binary)",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "internal/native/cgo/build/jknative-bin",
+            "args": [],
+            "stopAtEntry": true,
+            "cwd": "${workspaceFolder}",
+            "environment": [],
+            "MIMode": "gdb",
+            "miDebuggerPath": "/usr/bin/gdb-multiarch",
+            "miDebuggerServerAddress": "${config:TARGET_IP}:${config:DEBUG_PORT}",
+            "targetArchitecture": "arm",
+            "preLaunchTask": "deploy",
+            "setupCommands": [
+                {
+                    "description": "Pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                }
+            ],
+            "externalConsole": true
+        }
+    ]
+}

.vscode/settings.json

@@ -10,5 +10,19 @@
     ]
   },
   "git.ignoreLimitWarning": true,
-  "cmake.sourceDirectory": "/workspaces/kvm-static-ip/internal/native/cgo"
+  "cmake.sourceDirectory": "${workspaceFolder}/internal/native/cgo",
+  "cmake.ignoreCMakeListsMissing": true,
+  "C_Cpp.inlayHints.autoDeclarationTypes.enabled": true,
+  "C_Cpp.inlayHints.parameterNames.enabled": true,
+  "C_Cpp.inlayHints.referenceOperator.enabled": true,
+  "TARGET_IP": "192.168.0.199",
+  "DEBUG_PORT": "2345",
+  "json.schemas": [
+    {
+      "fileMatch": [
+        "/internal/ota/testdata/ota/*.json"
+      ],
+      "url": "./internal/ota/testdata/ota.schema.json"
+    }
+  ]
 }

.vscode/tasks.json

@@ -0,0 +1,30 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "deploy",
+            "isBackground": true,
+            "type": "shell",
+            "command": "bash",
+            "args": [
+                "dev_deploy.sh",
+                "-r",
+                "${config:TARGET_IP}",
+                "--gdb-port",
+                "${config:DEBUG_PORT}",
+                "--native-binary",
+                "--disable-docker"
+            ],
+            "problemMatcher": {
+                "base": "$gcc",
+                "background": {
+                    "activeOnStart": true,
+                    "beginsPattern": "${config:BINARY}",
+                    "endsPattern": "Listening on port [0-9]{4}"
+                }
+            }
+        },
+    ]
+}

DEVELOPMENT.md

@@ -208,6 +208,12 @@ rm /userdata/kvm_config.json
 systemctl restart jetkvm
 ```
 
+### Debug native code with gdbserver
+
+Change the `TARGET_IP` in `.vscode/settings.json` to your JetKVM device IP, then set breakpoints in your native code and start the `Debug Native` configuration in VSCode.
+
+The code and GDB server will be deployed automatically.
+
 ---
 
 ## Testing Your Changes

Makefile

@@ -14,6 +14,8 @@ SKIP_NATIVE_IF_EXISTS ?= 0
 SKIP_UI_BUILD ?= 0
 ENABLE_SYNC_TRACE ?= 0
 
+CMAKE_BUILD_TYPE ?= Release
+
 GO_BUILD_ARGS := -tags netgo,timetzdata,nomsgpack
 ifeq ($(ENABLE_SYNC_TRACE), 1)
 	GO_BUILD_ARGS := $(GO_BUILD_ARGS),synctrace
@@ -52,6 +54,7 @@ build_native:
 		echo "Building native..."; \
 			CC="$(BUILDKIT_PATH)/bin/$(BUILDKIT_FLAVOR)-gcc" \
 			LD="$(BUILDKIT_PATH)/bin/$(BUILDKIT_FLAVOR)-ld" \
+			CMAKE_BUILD_TYPE=$(CMAKE_BUILD_TYPE) \
 			./scripts/build_cgo.sh; \
 	fi
 

cmd/main.go

@@ -13,23 +13,39 @@ import (
 
 	"github.com/erikdubbelboer/gspt"
 	"github.com/jetkvm/kvm"
+	"github.com/jetkvm/kvm/internal/native"
+	"github.com/jetkvm/kvm/internal/supervisor"
 )
 
-const (
-	envChildID        = "JETKVM_CHILD_ID"
-	errorDumpDir      = "/userdata/jetkvm/crashdump"
-	errorDumpLastFile = "last-crash.log"
-	errorDumpTemplate = "jetkvm-%s.log"
+var (
+	subcomponent string
 )
 
 func program() {
-	gspt.SetProcTitle(os.Args[0] + " [app]")
-	kvm.Main()
+	subcomponentOverride := os.Getenv(supervisor.EnvSubcomponent)
+	if subcomponentOverride != "" {
+		subcomponent = subcomponentOverride
+	}
+	switch subcomponent {
+	case "native":
+		native.RunNativeProcess(os.Args[0])
+	default:
+		kvm.Main()
+	}
+}
+
+func setProcTitle(status string) {
+	if status != "" {
+		status = " " + status
+	}
+	title := fmt.Sprintf("jetkvm: [supervisor]%s", status)
+	gspt.SetProcTitle(title)
 }
 
 func main() {
 	versionPtr := flag.Bool("version", false, "print version and exit")
 	versionJSONPtr := flag.Bool("version-json", false, "print version as json and exit")
+	flag.StringVar(&subcomponent, "subcomponent", "", "subcomponent to run")
 	flag.Parse()
 
 	if *versionPtr || *versionJSONPtr {
@@ -42,7 +58,7 @@ func main() {
 		return
 	}
 
-	childID := os.Getenv(envChildID)
+	childID := os.Getenv(supervisor.EnvChildID)
 	switch childID {
 	case "":
 		doSupervise()
@@ -55,6 +71,8 @@ func main() {
 }
 
 func supervise() error {
+	setProcTitle("")
+
 	// check binary path
 	binPath, err := os.Executable()
 	if err != nil {
@@ -74,7 +92,12 @@ func supervise() error {
 	// run the child binary
 	cmd := exec.Command(binPath)
 
-	cmd.Env = append(os.Environ(), []string{envChildID + "=" + kvm.GetBuiltAppVersion()}...)
+	lastFilePath := filepath.Join(supervisor.ErrorDumpDir, supervisor.ErrorDumpLastFile)
+
+	cmd.Env = append(os.Environ(), []string{
+		fmt.Sprintf("%s=%s", supervisor.EnvChildID, kvm.GetBuiltAppVersion()),
+		fmt.Sprintf("%s=%s", supervisor.ErrorDumpLastFile, lastFilePath),
+	}...)
 	cmd.Args = os.Args
 
 	logFile, err := os.CreateTemp("", "jetkvm-stdout.log")
@@ -94,6 +117,8 @@ func supervise() error {
 		return fmt.Errorf("failed to start command: %w", startErr)
 	}
 
+	setProcTitle(fmt.Sprintf("started (pid=%d)", cmd.Process.Pid))
+
 	go func() {
 		sigChan := make(chan os.Signal, 1)
 		signal.Notify(sigChan, syscall.SIGTERM)
@@ -102,8 +127,6 @@ func supervise() error {
 		_ = cmd.Process.Signal(sig)
 	}()
 
-	gspt.SetProcTitle(os.Args[0] + " [sup]")
-
 	cmdErr := cmd.Wait()
 	if cmdErr == nil {
 		return nil
@@ -181,11 +204,11 @@ func renameFile(f *os.File, newName string) error {
 
 func ensureErrorDumpDir() error {
 	// TODO: check if the directory is writable
-	f, err := os.Stat(errorDumpDir)
+	f, err := os.Stat(supervisor.ErrorDumpDir)
 	if err == nil && f.IsDir() {
 		return nil
 	}
-	if err := os.MkdirAll(errorDumpDir, 0755); err != nil {
+	if err := os.MkdirAll(supervisor.ErrorDumpDir, 0755); err != nil {
 		return fmt.Errorf("failed to create error dump directory: %w", err)
 	}
 	return nil
@@ -195,7 +218,7 @@ func createErrorDump(logFile *os.File) {
 	fmt.Println()
 
 	fileName := fmt.Sprintf(
-		errorDumpTemplate,
+		supervisor.ErrorDumpTemplate,
 		time.Now().Format("20060102-150405"),
 	)
 
@@ -205,15 +228,15 @@ func createErrorDump(logFile *os.File) {
 		return
 	}
 
-	filePath := filepath.Join(errorDumpDir, fileName)
+	filePath := filepath.Join(supervisor.ErrorDumpDir, fileName)
 	if err := renameFile(logFile, filePath); err != nil {
 		fmt.Printf("failed to rename file: %v\n", err)
 		return
 	}
 
 	fmt.Printf("error dump copied: %s\n", filePath)
 
-	lastFilePath := filepath.Join(errorDumpDir, errorDumpLastFile)
+	lastFilePath := filepath.Join(supervisor.ErrorDumpDir, supervisor.ErrorDumpLastFile)
 
 	if err := ensureSymlink(filePath, lastFilePath); err != nil {
 		fmt.Printf("failed to create symlink: %v\n", err)

config.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 	"strconv"
+	"strings"
 	"sync"
 
 	"github.com/jetkvm/kvm/internal/confparser"
@@ -15,6 +16,10 @@ import (
 	"github.com/prometheus/client_golang/prometheus/promauto"
 )
 
+const (
+	DefaultAPIURL = "https://api.jetkvm.com"
+)
+
 type WakeOnLanDevice struct {
 	Name       string `json:"name"`
 	MacAddress string `json:"macAddress"`
@@ -80,6 +85,7 @@ func (m *KeyboardMacro) Validate() error {
 
 type Config struct {
 	CloudURL             string               `json:"cloud_url"`
+	UpdateAPIURL         string               `json:"update_api_url"`
 	CloudAppURL          string               `json:"cloud_app_url"`
 	CloudToken           string               `json:"cloud_token"`
 	GoogleIdentity       string               `json:"google_identity"`
@@ -107,8 +113,18 @@ type Config struct {
 	DefaultLogLevel      string               `json:"default_log_level"`
 	VideoSleepAfterSec   int                  `json:"video_sleep_after_sec"`
 	VideoQualityFactor   float64              `json:"video_quality_factor"`
+	NativeMaxRestart     uint                 `json:"native_max_restart_attempts"`
+}
+
+// GetUpdateAPIURL returns the update API URL
+func (c *Config) GetUpdateAPIURL() string {
+	if c.UpdateAPIURL == "" {
+		return DefaultAPIURL
+	}
+	return strings.TrimSuffix(c.UpdateAPIURL, "/") + "/releases"
 }
 
+// GetDisplayRotation returns the display rotation
 func (c *Config) GetDisplayRotation() uint16 {
 	rotationInt, err := strconv.ParseUint(c.DisplayRotation, 10, 16)
 	if err != nil {
@@ -118,6 +134,7 @@ func (c *Config) GetDisplayRotation() uint16 {
 	return uint16(rotationInt)
 }
 
+// SetDisplayRotation sets the display rotation
 func (c *Config) SetDisplayRotation(rotation string) error {
 	_, err := strconv.ParseUint(rotation, 10, 16)
 	if err != nil {
@@ -156,7 +173,8 @@ var (
 
 func getDefaultConfig() Config {
 	return Config{
-		CloudURL:             "https://api.jetkvm.com",
+		CloudURL:             DefaultAPIURL,
+		UpdateAPIURL:         DefaultAPIURL,
 		CloudAppURL:          "https://app.jetkvm.com",
 		AutoUpdateEnabled:    true, // Set a default value
 		ActiveExtension:      "",

display.go

@@ -252,6 +252,14 @@ func updateStaticContents() {
 	nativeInstance.UpdateLabelAndChangeVisibility("device_id", GetDeviceID())
 }
 
+// configureDisplayOnNativeRestart is called when the native process restarts
+// it ensures the display is configured correctly after the restart
+func configureDisplayOnNativeRestart() {
+	displayLogger.Info().Msg("native restarted, configuring display")
+	updateStaticContents()
+	requestDisplayUpdate(true, "native_restart")
+}
+
 // setDisplayBrightness sets /sys/class/backlight/backlight/brightness to alter
 // the backlight brightness of the JetKVM hardware's display.
 func setDisplayBrightness(brightness int, reason string) error {