Add basic Kconfig support for lima-guestagent #1790

afbjorklund · 2023-09-13T20:55:29Z

Make it possible to choose which lima-guestagent binaries to build...

This makes it possible to have optional binaries, such as FreeBSD etc.

There is support for "make config":

*
* Lima
*
guestagent OS: Linux (GUESTAGENT_OS_LINUX) [Y/n/?] 
guestagent Arch: x86_64 (GUESTAGENT_ARCH_X8664) [Y/n/?] 
guestagent Arch: aarch64 (GUESTAGENT_ARCH_AARCH64) [Y/n/?] 
guestagent Arch: armv7l (GUESTAGENT_ARCH_ARMV7L) [Y/n/?] 
guestagent Arch: riscv64 (GUESTAGENT_ARCH_RISCV64) [Y/n/?] 
#
# No change to .config
#

And also for "make menuconfig":

It is possible to just edit the .configfile (marked DO NOT EDIT).

Regenerating it requires one of the standalone Kconfig programs:

See also: https://www.kernel.org/doc/html/next/kbuild/kconfig-language.html

AkihiroSuda · 2023-09-13T21:02:58Z

Makefile

@@ -7,6 +7,9 @@ TAR ?= tar
 ZIP ?= zip
 PLANTUML ?= plantuml # may also be "java -jar plantuml.jar" if installed elsewhere

+KCONFIG_CONF ?= conf
+KCONFIG_MCONF ?= mconf


These commands are rarely available on macOS, so I don't think we should depend on this

The alternative would be compile them from source in the project, which I would like to avoid.
There is a good rationale in https://github.com/WangNan0/kbuild-standalone (or use python?)

It is also only needed, if making major changes to the Kconfig file itself. Otherwise, edit .config.
The format should be quite straight-forward, even if one needs to comment out - not set as 'n'

I guess we should just adopt vi .config or ./configure --enable-XXX

Adding support for autoconf would require more infrastructure and generate more boilerplate, imho

afbjorklund · 2023-09-13T21:13:45Z

We could remove the scary "DO NOT EDIT" comment, for instance python's alldefconfig et al does not add it.

@@ -1,9 +1,5 @@
-#
-# Automatically generated file; DO NOT EDIT.
-# Lima
-#
 CONFIG_GUESTAGENT_OS_LINUX=y
 CONFIG_GUESTAGENT_ARCH_X8664=y
 CONFIG_GUESTAGENT_ARCH_AARCH64=y
 CONFIG_GUESTAGENT_ARCH_ARMV7L=y
 CONFIG_GUESTAGENT_ARCH_RISCV64=y

It also has an alternative guiconfig (in Tkinter), which might be cross-platform enough (unlike gconf and qconf)

afbjorklund · 2023-09-13T21:26:20Z

Making a homebrew "formula" for the kbuild-standalone programs could be a good idea?

https://github.com/WangNan0/kbuild-standalone (which is GPLv2 licensed, like the kernel)

kbuild-conf
kbuild-mconf

EDIT: Apparently they get a prefix added to them, when installed globally.

Just like the "kconfig-conf" and "kconfig-mconf", from kconfig-frontends...

But it is probably easier to just pip3 install --user kconfiglib, to start with.

So changed the default to use those programs, instead of the ones in C...

afbjorklund · 2023-09-14T15:01:49Z

Changed it to look for all three systems, and to allow editing the .config file and setting the value to n as well.

Makefile

AkihiroSuda · 2023-09-14T15:08:00Z

Makefile

+help:
+	@echo  '  binaries        - Build all binaries'
+	@echo  '  manpages        - Build manual pages'
+
 exe: _output/bin/limactl$(exe)

 .PHONY: minimal


make minimal should now generate a new .config and run make binary ?

Not everything is configurable, and there is no mechanism for "host arch"

.config

afbjorklund · 2023-09-14T18:12:36Z

I added some (very) basic help text, mostly because it was mentioned in the output and interface.

export KCONFIG_CONF=kconfig-conf
export KCONFIG_MCONF=kconfig-mconf

*** End of the configuration.
*** Execute 'make' to start the build or try 'make help'.

And the guiconfig/gconf/qconf was complaining, when there was a config option without a help.

README.md

AkihiroSuda · 2023-09-15T01:42:01Z

config.default

I fear this file to be misinterpreted as the default lima YAML config.

Can we just generate the default config with heredoc?

Or put this file to somewhere like Makefile.d/ or Kconfig.d/

Renamed it to config.mk, hopefully there will be no confusion.

It is possible to edit this file (if not using kconfig tools).
The main difference is that it is checked into the repository.
To make user-specific config, it is better to edit .config.
The default make target will copy config.mk, if it is missing.

afbjorklund · 2023-09-15T06:18:06Z

It is also a problem that the python library does not implement oldaskconfig, the default mode.

The default conf mode seems missing ulfalizer/Kconfiglib#133

afbjorklund · 2023-09-15T18:03:05Z

I updated the kconfig-frontends from v4.11 to v4.19, just in case. The old repo seemed missing?

And the debian packaging only had an import of the generated files, not the original git sources.

https://github.com/afbjorklund/kconfig-frontends

~~http://ymorin.is-a-geek.org/git/kconfig-frontends~~

2017-05-03: 4.11.0.1 has been released
2013-11-09: 3.12.0.0 has been released
2012-03-19: first release ever: 3.3.0-1 has been released
2012-01-25: this project announced

README.md

Refactor the list of helpers and lima-guestagent binaries. This makes it easier to make them into optional, later on. Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

Make it possible to configure which guestagents to build. Regenerating config file requires kconfig or kbuild tools. Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

AkihiroSuda · 2023-09-19T10:32:11Z

website/content/en/docs/Installation/_index.md

+
+This requires kconfig tools installed, it is also possible to edit `.config`.
+The default configuration can be found in the file `config.mk` (make syntax).
+


This paragraphs should be inside ## Kconfig tools

It was for the user that doesn't have any tools, but edits the config as text

AkihiroSuda · 2023-09-19T10:32:28Z

website/content/en/docs/Installation/_index.md

+This requires kconfig tools installed, it is also possible to edit `.config`.
+The default configuration can be found in the file `config.mk` (make syntax).
+
+## Kconfig tools


Suggested change

## Kconfig tools

## Kconfig tools (optional)

afbjorklund mentioned this pull request Sep 13, 2023

Investigating guestagent on FreeBSD, for containerd with runj #1509

Closed

AkihiroSuda reviewed Sep 13, 2023

View reviewed changes

afbjorklund force-pushed the kconfig branch from 2ff856b to 2be798c Compare September 13, 2023 21:51

afbjorklund marked this pull request as draft September 14, 2023 06:58

afbjorklund force-pushed the kconfig branch from 2be798c to 26f3a38 Compare September 14, 2023 14:59

afbjorklund marked this pull request as ready for review September 14, 2023 15:00

AkihiroSuda reviewed Sep 14, 2023

View reviewed changes

Makefile Outdated Show resolved Hide resolved

AkihiroSuda reviewed Sep 14, 2023

View reviewed changes

.config Outdated Show resolved Hide resolved

afbjorklund force-pushed the kconfig branch from 26f3a38 to 17c610d Compare September 14, 2023 18:06

AkihiroSuda reviewed Sep 15, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

AkihiroSuda reviewed Sep 15, 2023

View reviewed changes

afbjorklund marked this pull request as draft September 15, 2023 06:12

afbjorklund force-pushed the kconfig branch from 17c610d to 230c8cb Compare September 15, 2023 09:49

afbjorklund marked this pull request as ready for review September 15, 2023 17:51

AkihiroSuda previously approved these changes Sep 15, 2023

View reviewed changes

AkihiroSuda added this to the v0.18.0 milestone Sep 15, 2023

AkihiroSuda requested a review from a team September 15, 2023 18:39

AkihiroSuda reviewed Sep 18, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

afbjorklund added 4 commits September 19, 2023 11:45

Move helpers and guestagent into make variables

7955f4b

Refactor the list of helpers and lima-guestagent binaries. This makes it easier to make them into optional, later on. Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

Add basic Kconfig support for lima-guestagent

cbd3038

Make it possible to configure which guestagents to build. Regenerating config file requires kconfig or kbuild tools. Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

Add the portable python programs for kconfig

a99965d

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

Update website with the kconfig programs

d41e74d

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

afbjorklund dismissed AkihiroSuda’s stale review via d41e74d September 19, 2023 09:58

afbjorklund force-pushed the kconfig branch from 230c8cb to d41e74d Compare September 19, 2023 09:58

AkihiroSuda reviewed Sep 19, 2023

View reviewed changes

AkihiroSuda approved these changes Sep 21, 2023

View reviewed changes

AkihiroSuda merged commit 2a1feb2 into lima-vm:master Sep 21, 2023
23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic Kconfig support for lima-guestagent #1790

Add basic Kconfig support for lima-guestagent #1790

afbjorklund commented Sep 13, 2023 •

edited

Loading

AkihiroSuda Sep 13, 2023

afbjorklund Sep 13, 2023

AkihiroSuda Sep 13, 2023

afbjorklund Sep 13, 2023

afbjorklund commented Sep 13, 2023

afbjorklund commented Sep 13, 2023 •

edited

Loading

afbjorklund commented Sep 14, 2023

AkihiroSuda Sep 14, 2023

afbjorklund Sep 14, 2023

afbjorklund commented Sep 14, 2023 •

edited

Loading

AkihiroSuda Sep 15, 2023

AkihiroSuda Sep 15, 2023

afbjorklund Sep 15, 2023

afbjorklund commented Sep 15, 2023 •

edited

Loading

afbjorklund commented Sep 15, 2023

AkihiroSuda Sep 19, 2023

afbjorklund Sep 19, 2023

AkihiroSuda Sep 19, 2023


		This requires kconfig tools installed, it is also possible to edit `.config`.
		The default configuration can be found in the file `config.mk` (make syntax).

Add basic Kconfig support for lima-guestagent #1790

Add basic Kconfig support for lima-guestagent #1790

Conversation

afbjorklund commented Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afbjorklund commented Sep 13, 2023

afbjorklund commented Sep 13, 2023 • edited Loading

afbjorklund commented Sep 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afbjorklund commented Sep 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afbjorklund commented Sep 15, 2023 • edited Loading

afbjorklund commented Sep 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afbjorklund commented Sep 13, 2023 •

edited

Loading

afbjorklund commented Sep 13, 2023 •

edited

Loading

afbjorklund commented Sep 14, 2023 •

edited

Loading

afbjorklund commented Sep 15, 2023 •

edited

Loading