Skip to contentSkip to conversation

systemd-serialgetty: add comments explaining use

PATCH In review Ross Burton 3 participants 6 messages Jan 30, 2025 – Jan 31, 2025

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 systemd-serialgetty: add comments explaining use

Add some comments to clarify exactly what this recipe is for.

---
 meta/recipes-core/systemd/systemd-serialgetty.bb | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
meta/recipes-core/systemd/systemd-serialgetty.bb +6 -1
index 9035b8c335a..7b525b10f0c 100644
@@ -1,8 +1,13 @@
-SUMMARY = "Serial terminal support for systemd"
+SUMMARY = "Serial terminal support for systemd (using SERIAL_CONSOLES)"
 HOMEPAGE = "https://www.freedesktop.org/wiki/Software/systemd/"
 LICENSE = "GPL-2.0-or-later"
 LIC_FILES_CHKSUM = "file://${COREBASE}/meta/files/common-licenses/GPL-2.0-only;md5=801f80980d171dd6425610833a22dbe6"
 
+# Note that this recipe explicitly creates a serial-getty@ service for every tty
+# in SERIAL_CONSOLES. This is typically not always needed with systemd as it
+# will probe at boot and generate getty instances for any active consoles as
+# required.  This recipe (enabled via disabling serial-getty-generator in systemd)
+# should only be used if the generator is not appropriate.
 
 SERIAL_CONSOLES ?= "115200;ttyS0"
 SERIAL_TERM ?= "linux"
Signature · 1 line
2.43.0
#1 lore raw

PATCH 2/2 systemd: use getty generators by default

systemd can automatically create getty service units at boot time by probing the hardware: if will check for a list of known hypervisor consoles and also spawn a getty on every active console.

However in a historical attempt to change as little behaviour as possible, we disabled this and instead wrote hard-coded units at build time that respect the SERIAL_CONSOLES variable.

This variable may be acceptable for fixed known platforms, but is not usable for generic machines. The genericarm64 machine for example lists a number of potential consoles:

- ttyAMA0: physical ARM PL011 uarts
- hvc0: hypervisor virtual console
- ttyS0-2: physical uarts

We have to list multiple ttyS? names because different platforms use different devices: specifically on the BeaglePlay the Linux console is ttyS2, with S0 and S1 being the uarts connecting the expansion port.

However, it's not ideal to randomly open ports and hope for the best:
with kernel 6.7 onwards a power management/tty bug results in system hangs if a getty is sitting on ttyS1 (see #15704).

A better solution is to just use the getty generator in systemd: this will automatically spawn gettys on any hypervisor consoles found and all of the consoles that Linux is aware of. On the BeaglePlay this means it puts a getty on just ttyS2, as expected.

The fixed configuration recipe is still present for people who wish to have absolute control by simply disabling the serial-getty-generator PACKAGECONFIG.

---
 meta/recipes-core/systemd/systemd_257.1.bb | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
meta/recipes-core/systemd/systemd_257.1.bb +5 -2
index cdf72a50157..f464b979b07 100644
@@ -92,6 +92,7 @@ PACKAGECONFIG ??= " \
     quotacheck \
     randomseed \
     resolved \
+    serial-getty-generator \
     set-time-epoch \
     sysusers \
     timedated \
@@ -126,7 +127,7 @@ TARGET_CC_ARCH:append:libc-musl = " -D__UAPI_DEF_ETHHDR=0 -D_LARGEFILE64_SOURCE"
 
 # Use the upstream systemd [email protected] and rely on
 # systemd-getty-generator instead of using the OE-core specific
-# systemd-serialgetty.bb - not enabled by default.
+# systemd-serialgetty.bb
 PACKAGECONFIG[serial-getty-generator] = ""
 
 PACKAGECONFIG[acl] = "-Dacl=enabled,-Dacl=disabled,acl"
@@ -287,8 +288,10 @@ do_install() {
 		fi
 	fi
 	install -d ${D}/${base_sbindir}
+
 	if ${@bb.utils.contains('PACKAGECONFIG', 'serial-getty-generator', 'false', 'true', d)}; then
-		# Provided by a separate recipe
+		# Remove the serial-getty generator and instead use explicit services
+		# created by the systemd-serialgetty recipe
 		rm ${D}${systemd_system_unitdir}/serial-getty* -f
 	fi
 
Signature · 1 line
2.43.0
#2 lore raw

Re: [OE-core] [PATCH 2/2] systemd: use getty generators by default

Hi,

Quoted 24 lines · Ross Burton via lists.openembedded.org

systemd can automatically create getty service units at boot time by probing the hardware: if will check for a list of known hypervisor consoles and also spawn a getty on every active console.

However in a historical attempt to change as little behaviour as possible, we disabled this and instead wrote hard-coded units at build time that respect the SERIAL_CONSOLES variable.

This variable may be acceptable for fixed known platforms, but is not usable for generic machines. The genericarm64 machine for example lists a number of potential consoles:

- ttyAMA0: physical ARM PL011 uarts
- hvc0: hypervisor virtual console
- ttyS0-2: physical uarts

We have to list multiple ttyS? names because different platforms use different devices: specifically on the BeaglePlay the Linux console is ttyS2, with S0 and S1 being the uarts connecting the expansion port.

However, it's not ideal to randomly open ports and hope for the best:
with kernel 6.7 onwards a power management/tty bug results in system hangs if a getty is sitting on ttyS1 (see #15704).

Quoted 8 lines

A better solution is to just use the getty generator in systemd: this will automatically spawn gettys on any hypervisor consoles found and all of the consoles that Linux is aware of. On the BeaglePlay this means it puts a getty on just ttyS2, as expected.

The fixed configuration recipe is still present for people who wish to have absolute control by simply disabling the serial-getty-generator PACKAGECONFIG.

ACK, we have also found that systemd and udev handle serial consoles correctly when supporting multiple devices like rockpi4b, synquacer, AMD KV260, zcu102, AVA, qemu etc from a single build.

systemd-serialgetty did not work so well.

Cheers,

-Mikko

#3 lore raw

Re: [OE-core] [PATCH 2/2] systemd: use getty generators by default

Quoted 3 lines · Mikko Rapeli

ACK, we have also found that systemd and udev handle serial consoles correctly when supporting multiple devices like rockpi4b, synquacer, AMD KV260, zcu102, AVA, qemu etc from a single build.

The challenge is doing the same for sysvinit…

Sharing for the wider community: genericarm64 defines SERIAL_CONSOLES to hvc0 (if its inside a qemu), ttyAMA0 (hardware using the Arm PL011 uart), and ttyS[0-2] (other hardware using serial ports). It has to be the first three serial ports because hardware is different: specifically the BeaglePlay has the Linux console on ttyS2 as two internal uarts that connect to the expansion port are 0 and 1. However, throwing a getty on ttyS1 doesn’t go well, but there doesn’t appear to be a good way to know that from userspace.

My current best idea is to replicate the logic in systemd inside syvinit somehow, but that’s… not trivial. Possibly a shell wrapper that init starts and it forks off gettys, respawning them as needed? It’s almost easier to extend sysvinit so that it can start inittab lines dynamically.

Ross

#4 lore raw
In reply to Ross Burton
Quoted 4 lines · Ross Burton via lists.openembedded.org

Add some comments to clarify exactly what this recipe is for.

---

Hi Ross,

Sorry, I believe this is breaking the autobuilder builds using QEMU:
maybe something with the detection of finished boot ?

Final symptom is:

RuntimeError: core-image-minimal - FAILED to start qemu - check the task log and the boot log

Some example logs:

https://autobuilder.yoctoproject.org/valkyrie/#/builders/48/builds/833/steps/14/logs/stdio
https://autobuilder.yoctoproject.org/valkyrie/#/builders/35/builds/882/steps/14/logs/stdio
https://autobuilder.yoctoproject.org/valkyrie/#/builders/26/builds/904/steps/23/logs/stdio

Can you have a look at this please ?

Signature · 3 lines
Mathieu Dubois-Briand, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#5 lore raw
Quoted 16 lines · Mathieu Dubois-Briand
Quoted 4 lines · Ross Burton via lists.openembedded.org

Add some comments to clarify exactly what this recipe is for.

---

Hi Ross,

Sorry, I believe this is breaking the autobuilder builds using QEMU:
maybe something with the detection of finished boot ?

Final symptom is:

RuntimeError: core-image-minimal - FAILED to start qemu - check the task log and the boot log

Quoted 7 lines

Some example logs:

https://autobuilder.yoctoproject.org/valkyrie/#/builders/48/builds/833/steps/14/logs/stdio
https://autobuilder.yoctoproject.org/valkyrie/#/builders/35/builds/882/steps/14/logs/stdio
https://autobuilder.yoctoproject.org/valkyrie/#/builders/26/builds/904/steps/23/logs/stdio

Can you have a look at this please ?

Drats, I even ran selftest locally and verified it worked…. I’ll dig.

Thanks,
Ross