Skip to content

Locate the limactl executable via os.Args[0] instead of os.Executable() #3566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025

Conversation

jandubois
Copy link
Member

@jandubois jandubois commented May 21, 2025

We need the symlink directory to find the the ../share/lima directory relative to it. os.Executable() uses /proc/self/exe on Linux and returns the symlink target, which will break things with a Homebrew installation.

This commit also removes the dead code that pretends to resolve any symlinks. It never worked because it called os.Stat() instead of os.Lstat(). If it had worked, then code would have been broken on macOS too.

Alternative implementation to #3564

Fixes #3562

@AkihiroSuda
Copy link
Member

#3564 is still better in the robustness; the binary can be executed via an arbitrary path

@jandubois
Copy link
Member Author

jandubois commented May 21, 2025

#3564 is still better in the robustness; the binary can be executed via an arbitrary path

The only way I can think this can happen is if you invoke limactl via execve and not setup argv[0] (or set it to an incorrect value). Are there others?

That is unfortunate, but I think this is not a reasonable use case; why would anyone do that? If it doesn't work the way they expect, it is really their fault and not ours. I don't even think it would be worth documenting.

@jandubois jandubois force-pushed the executable-symlink branch 2 times, most recently from 4fad10d to 53c5792 Compare May 21, 2025 20:33
We need the symlink directory to find the the ../share/lima directory
relative to it. os.Executable() uses /proc/self/exe on Linux and returns
the symlink target, which will break things with a Homebrew installation.

This commit also removes the dead code that pretends to resolve any
symlinks. It never worked because it called os.Stat() instead of os.Lstat().
If it had worked, then code would have been broken on macOS too.

Signed-off-by: Jan Dubois <jan.dubois@suse.com>
@jandubois jandubois force-pushed the executable-symlink branch from 53c5792 to 955222b Compare May 21, 2025 20:45
@jandubois
Copy link
Member Author

jandubois commented May 21, 2025

The only way I can think this can happen is if you invoke limactl via execve and not setup argv[0]

Not sure if this is really necessary, but I've added code to fall back on os.Executable() when os.Args[0] is empty, or can't be resolved with exec.LookPath().

If the user intentionally passes the path to a different executable, then I don't consider this an error; the user probably wants to resolve the directory relative to that location.

So the only remaining failure path has 4 preconditions:

  • Must pass empty string (or invalid name) for os.Args[0] via execve or similar
  • Must be running on Linux
  • Must be using Homebrew style symlink setup
  • Must require one of the additional guest agents

My facetious response would be: "Welcome to Café Karma! We have no menu; you get what you deserve."

There are many other programs (including all multi-call binaries like busybox) that rely on os.Args[0] to be set correctly, so why can't we?

@jandubois jandubois added this to the v1.1.1 milestone May 21, 2025
@jandubois
Copy link
Member Author

jandubois commented May 21, 2025

Further testing showed that #3564 is not robust either; it only works correctly when the desired lima-additional-guestagents-path is first on the PATH.

I think the Args[0] approach is simpler, more reliable, and enables more functionality (allows locating libexec directory), so should be the one we pick.

@jandubois jandubois added the area/homebrew Homebrew formula label May 21, 2025
// absolute path if the argument contained any of `:/\` (or just `/` on Unix).
return filepath.Abs(executable)
}
logrus.Warnf("os.Args[0] is invalid: %v", err)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: logrus.WithError.Warn could be used

Copy link
Member

@AkihiroSuda AkihiroSuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, let's release v1.1.1 with this and see if it works

@AkihiroSuda AkihiroSuda merged commit 44f3da4 into lima-vm:master May 22, 2025
34 checks passed
@jandubois jandubois deleted the executable-symlink branch May 22, 2025 05:11
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request May 23, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [lima-vm/lima](https://github.com/lima-vm/lima) | minor | `v1.0.7` -> `v1.1.1` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>lima-vm/lima (lima-vm/lima)</summary>

### [`v1.1.1`](https://github.com/lima-vm/lima/releases/tag/v1.1.1)

[Compare Source](lima-vm/lima@v1.1.0...v1.1.1)

#### Changes

-   Fixed the guestagent path issues with Homebrew  ([#&#8203;3566](lima-vm/lima#3566), thanks to [@&#8203;jandubois](https://github.com/jandubois))
-   Documentation for disk management https://lima-vm.io/docs/config/disk/ ([#&#8203;3539](lima-vm/lima#3539), thanks to [@&#8203;Sonichigo](https://github.com/Sonichigo))

#### Usage

```console
[macOS]$ limactl create
[macOS]$ limactl start
...
INFO[0029] READY. Run `lima` to open the shell.

[macOS]$ lima uname
Linux
```

***

The binaries were built automatically on GitHub Actions.
The build log is available for 90 days: https://github.com/lima-vm/lima/actions/runs/15178234655

The sha256sum of the SHA256SUMS file itself is `0d2d3fb073c8e26df163937dd605e9f2b9f227814a697411cc2b8879347bdd7f` .

***

Release manager: [@&#8203;AkihiroSuda](https://github.com/AkihiroSuda)

### [`v1.1.0`](https://github.com/lima-vm/lima/releases/tag/v1.1.0)

[Compare Source](lima-vm/lima@v1.0.7...v1.1.0)

> \[!IMPORTANT]
> Package maintainers should refer to "Hint for package maintainers" below

Highlights:

-   Simplification of YAMLs
-   New port forwarder implementation by default
-   DragonflyBSD hosts
-   S390X and PPC64LE guests
-   Smaller binary packages

#### Changes

-   Build system:
    -   Split `lima-additional-guestagents-*.tar.gz` from `lima-*.tar.gz` ([#&#8203;3503](lima-vm/lima#3503))
    -   Set `CONFIG_GUESTAGENT_COMPRESS=y` by default ([#&#8203;3529](lima-vm/lima#3529))
-   YAML:
    -   Support inheritance ([#&#8203;3072](lima-vm/lima#3072), thanks to [@&#8203;jandubois](https://github.com/jandubois))
    -   Deprecate provision mode `ansible` ([#&#8203;3451](lima-vm/lima#3451), thanks to [@&#8203;afbjorklund](https://github.com/afbjorklund))
    -   Add new provision mode `data` ([#&#8203;3302](lima-vm/lima#3302), thanks to [@&#8203;jandubois](https://github.com/jandubois))
-   QEMU:
    -   Support DragonflyBSD hosts ([#&#8203;3356](lima-vm/lima#3356), thanks to [@&#8203;tuxillo](https://github.com/tuxillo))
    -   Support S390X guests ([#&#8203;3319](lima-vm/lima#3319))
    -   Support PPC64LE guests ([#&#8203;3488](lima-vm/lima#3488))
    -   TCG: change the default CPU from `qemu64` (x86-64 v1) to `max` ([#&#8203;3487](lima-vm/lima#3487))
    -   Bump up the minimum QEMU version to v8.2.1 on ARM Mac. On Linux/x86\_64, QEMU v6.2.0 is still supported. ([#&#8203;3491](lima-vm/lima#3491))
-   WSL2:
    -   Lots of improvements (several MRs, thanks to [@&#8203;arixmkii](https://github.com/arixmkii))
-   Port forwarding:
    -   Enable faster gRPC implementation by default ([#&#8203;3046](lima-vm/lima#3046))
-   `limactl` CLI:
    -   Add `--yes` flag as an alias of `--tty=false` ([#&#8203;3342](lima-vm/lima#3342), thanks to [@&#8203;suryaaprakassh](https://github.com/suryaaprakassh))
    -   Support resizing disk in `limactl edit` ([#&#8203;3437](lima-vm/lima#3437), [#&#8203;3533](lima-vm/lima#3533), thanks to [@&#8203;songponssw](https://github.com/songponssw))
    -   Add `limactl disk import` command ([#&#8203;3439](lima-vm/lima#3439), thanks to [@&#8203;songponssw](https://github.com/songponssw))
-   Rootless Containers:
    -   Allow UID >= 524288 ([#&#8203;3435](lima-vm/lima#3435))
-   nerdctl:
    -   Update from v2.0.4 to [v2.1.2](https://github.com/containerd/nerdctl/releases/tag/v2.1.2). ([#&#8203;3483](lima-vm/lima#3483), [#&#8203;3534](lima-vm/lima#3534), [#&#8203;3560](lima-vm/lima#3560))
        See also the release notes of [v2.0.5](https://github.com/containerd/nerdctl/releases/tag/v2.0.5), [v2.1.0](https://github.com/containerd/nerdctl/releases/tag/v2.1.0), [v2.1.1](https://github.com/containerd/nerdctl/releases/tag/v2.1.1).
        -   nerdctl v2.1.1 included in Lima v1.1.0-rc.0 had a vulnerability of containerd CVE-2025-47290 (GHSA-cm76-qm8v-3j95). Other versions of Lima are not affected.
-   Templates:
    -   `ubuntu-25.04`: New template ([#&#8203;3445](lima-vm/lima#3445)).
        The `default` template still refers to Ubuntu 24.10, as `ubuntu-25.04` needs
        the very recent release of macOS on Intel Mac by default (see the note below).
    -   `fedora-42`: New template ([#&#8203;3434](lima-vm/lima#3434))
    -   `linuxbrew`: New template ([#&#8203;3454](lima-vm/lima#3454))
    -   `almalinux-kitten-10`: New template ([#&#8203;3084](lima-vm/lima#3084), thanks to [@&#8203;afbjorklund](https://github.com/afbjorklund))
    -   `oraclelinux-8`: Fix virtiofs support ([#&#8203;3441](lima-vm/lima#3441))

> \[!NOTE]
> On Intel Mac with `--vm-type=vz`, macOS 15.5 or later is needed to boot `ubuntu-25.04` and `fedora-42`

Full changes: https://github.com/lima-vm/lima/milestone/26?closed=1
Thanks to [@&#8203;KGB33](https://github.com/KGB33) [@&#8203;Nino-K](https://github.com/Nino-K) [@&#8203;afbjorklund](https://github.com/afbjorklund) [@&#8203;alexandear](https://github.com/alexandear) [@&#8203;apachex692](https://github.com/apachex692) [@&#8203;arixmkii](https://github.com/arixmkii) [@&#8203;cakemanny](https://github.com/cakemanny) [@&#8203;jandubois](https://github.com/jandubois) [@&#8203;jonas-peter](https://github.com/jonas-peter) [@&#8203;kairveeehh](https://github.com/kairveeehh) [@&#8203;liangyuanpeng](https://github.com/liangyuanpeng) [@&#8203;nirs](https://github.com/nirs) [@&#8203;shenki](https://github.com/shenki) [@&#8203;songponssw](https://github.com/songponssw) [@&#8203;unsuman](https://github.com/unsuman) [@&#8203;ycdzj](https://github.com/ycdzj)

#### Hint for package maintainers

Starting with v1.1, the official binary packages of Lima are split to two files for the each of the host OS and the architectures to save the disk space:

1.  `lima-<VERSION>-Darwin-arm64.tar.gz`: (Built with `make native`)

-   The core components (`bin/lima`, `bin/limactl`, `share/lima/templates`, ...)
-   The guest agent for the native architecture (`share/lima/lima-guestagent.Linux-aarch64.gz`)

2.  `lima-additional-guestagents-<VERSION>-Darwin-arm64.tar.gz`: (Built with `make additional-guestagents`)

-   The guest agents for emulating non-native architectures (`share/lima/lima-guestagent.Linux-{armv7l,ppc64le,riscv64,s390x,x86_64}.gz)`)

For compatibility reason, `make` still builds the guest agents for all the architectures by default.

Package maintainers are suggested to split their `lima` package to `lima` (`make native`) and `lima-additional-guestagents` (`make additional-guestagents`).

#### Usage

```console
[macOS]$ limactl create
[macOS]$ limactl start
...
INFO[0029] READY. Run `lima` to open the shell.

[macOS]$ lima uname
Linux
```

***

The binaries were built automatically on GitHub Actions.
The build log is available for 90 days: https://github.com/lima-vm/lima/actions/runs/15154830653

The sha256sum of the SHA256SUMS file itself is `4391505a7f833c8245497b29fec65743abb1561a275037f6d268026284883c8a` .

***

Release manager: [@&#8203;AkihiroSuda](https://github.com/AkihiroSuda)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MC4yMS4wIiwidXBkYXRlZEluVmVyIjoiNDAuMjMuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/homebrew Homebrew formula
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[v1.1 RC] /opt/homebrew/opt/lima/bin/limactl, /home/linuxbrew/.linuxbrew/bin/limactl can't detect non-native guest agents
2 participants