Makefile: Add the DEBUG flag to build binaries with debug information for use by dlv exec.

[norio-nomura]

macOS Tahoe 26.0 does not allow the debug target of dlv dap to use the com.apple.security.virtualization entitlement. See: #2651 (comment)

But macOS Tahoe 26.0 allows the precompiled binary target of dlv exec to use the entitlement. This adds the DEBUG flag to build binaries with debug information for use by dlv exec.

Configuration files for VSCode working on macOS Tahoe 26.0 launch.json:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "exec hostagent for input instance",
            "type": "go",
            "request": "launch",
            "mode": "exec",
            // Use integratedTerminal to stop using ctrl+C
            "console": "integratedTerminal",
            "program": "${workspaceFolder}/_output/bin/limactl",
            "env": {
                "LIMA_SSH_OVER_VSOCK": "false",
                "LIMA_SSH_PORT_FORWARDER": "true",
            },
            "cwd": "${userHome}/.lima/${input:targetInstance}",
            "args": [
                "--debug",
                "hostagent",
                "--pidfile",
                "ha.pid",
                "--socket",
                "ha.sock",
                "--guestagent",
                "${workspaceFolder}/_output/share/lima/lima-guestagent.Linux-aarch64",
                "--progress",
                "${input:targetInstance}"
            ],
            "preLaunchTask": "prepare launching hostagent for target instance",
            "postDebugTask": "clean up after stopping hostagent for target instance",
        },
    ],
    "inputs": [
        {
            "id": "targetInstance",
            "type": "promptString",
            "description": "Input target instance parameter for `limactl` command",
        }
    ]
}

tasks.json:

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "prepare launching hostagent for target instance",
            "dependsOn":[
                "execute: make CONFIG_GUESTAGENT_COMPRESS=n DEBUG=1",
                "execute: rm -f ${userHome}/.lima/${input:targetInstance}/ha.pid",
            ]
        },
        {
            "label": "clean up after stopping hostagent for target instance",
            "dependsOn":[
                "execute: rm -f ${userHome}/.lima/${input:targetInstance}/ha.pid",
            ]
        },
        {
            "label": "execute: make CONFIG_GUESTAGENT_COMPRESS=n DEBUG=1",
            "type": "shell",
            "command": "make CONFIG_GUESTAGENT_COMPRESS=n DEBUG=1",
            "presentation": {
                "close": true,
                "reveal": "always"
            },
        },
        {
            "label": "execute: rm -f ${userHome}/.lima/${input:targetInstance}/ha.pid",
            "type": "shell",
            "command": "rm -f ${userHome}/.lima/${input:targetInstance}/ha.pid",
            "presentation": {
                "close": true,
                "reveal": "silent"
            },
        }
    ],
    "inputs": [
        {
            "id": "targetInstance",
            "type": "promptString",
            "description": "Input <instance> for `rm -f <LIMA_HOME>/<instance>/ha.pid`",
        }
    ]
}

[Copilot]

Pull Request Overview

This PR adds a DEBUG flag to the Makefile that enables building binaries with debug information for use with dlv exec on macOS Tahoe 26.0. This addresses a compatibility issue where dlv dap cannot use certain entitlements on the new macOS version, but dlv exec with precompiled binaries can.

• Introduces conditional debug build support via DEBUG=1
• Adds GCFLAGS configuration for debug builds to disable optimizations and preserve debugging symbols
• Updates build variable extraction to handle the new GCFLAGS parameter

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[norio-nomura]

I also made a review request to copilot by mistake.

[AkihiroSuda]

Probably this should be documented in https://lima-vm.io/docs/dev/ ? Maybe create the /docs/dev/debug page.

[norio-nomura]

If I were to write a document on debugging in Visual Studio Code, I’d like to improve how ha.pid is handled to reduce the need for preLaunchTask and postDebugTask.

[AkihiroSuda]

Thanks

[norio-nomura]

Thanks! 🙏🏻

[norio-nomura]

I found a better solution than using "mode": "exec" and make DEBUG=1.
https://github.com/go-delve/delve/blob/master/Documentation/usage/README.md#environment-variables

• $DELVE_DEBUGSERVER_PATH is used to locate the debugserver executable on macOS.

By using this, the debugserver can be overriden by a script that performs codesign on the debug target before launching debugserver. I tested this, and it works as expected with the "mode": "debug" parameter.

I'll open a PR that adding the script hack/debugserver-with-codesign.sh hack/codesign/debugserver

[norio-nomura]

I'll open a PR that adding the script hack/debugserver-with-codesign.sh hack/codesign/debugserver

opened #4052