Skip to contentSkip to conversation

liveupdate: document systemd support

PATCH Applied [email protected] 3 participants 5 messages May 19 – May 21

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 liveupdate: document systemd support

From: Luca Boccassi <[email protected]>

systemd v261 will add native support for LUO via the file descriptor store mechanism. Add a brief paragraph in the LUO userspace documentation page to inform users.

---
NOTE: the external links will mention LUO after the next release is
published, which should happen within ~4 weeks

 Documentation/userspace-api/liveupdate.rst | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)
Documentation/userspace-api/liveupdate.rst +23 -0
index 41c0473e4f16..f6efc32fb40b 100644
@@ -14,6 +14,29 @@ ioctl uAPI
 ===========
 .. kernel-doc:: include/uapi/linux/liveupdate.h
 
+Userspace Integration
+=====================
+
+systemd (since version v261) uses LUO to preserve its per-service file
+descriptor store across a kexec-based live update. Services opt in by setting
+``FileDescriptorStoreMax=`` and ``FileDescriptorStorePreserve=`` in their unit,
+and push file descriptors with a name into the store via
+``sd_pid_notify_with_fds(... "FDSTORE=1\nFDNAME=foo")``.
+
+Services may also create their own LUO sessions (via ``/dev/liveupdate``) and
+push the resulting session fds into their file descriptor store like any other
+fd. systemd detects such session fds and handles them accordingly, and
+hands the re-retrieved session fd back to the service after kexec, using the
+existing file descriptor store service interface.
+
+For details, see:
+
+- `File Descriptor Store <https://systemd.io/FILE_DESCRIPTOR_STORE/>`_
+- `systemd.service(5) FileDescriptorStorePreserve=
+  <https://www.freedesktop.org/software/systemd/man/latest/systemd.service.html#FileDescriptorStorePreserve=>`_
+- `sd_pid_notify_with_fds(3)
+  <https://www.freedesktop.org/software/systemd/man/latest/sd_pid_notify_with_fds.html>`_
+
 See Also
 ========
 
Signature · 1 line
2.47.3
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 7 lines · On Tue, May 19 2026, [email protected] wrote:

From: Luca Boccassi <[email protected]>

systemd v261 will add native support for LUO via the file descriptor store mechanism. Add a brief paragraph in the LUO userspace documentation page to inform users.

But of course, we should only apply this once systemd v261 is released.

Quoted 4 lines

---
NOTE: the external links will mention LUO after the next release is
published, which should happen within ~4 weeks

Signature · 2 lines
Regards,
Pratyush Yadav
maintainer
#2 lore raw
Quoted 8 lines · Pratyush Yadav
Quoted 6 lines · On Tue, May 19 2026, [email protected] wrote:

From: Luca Boccassi <[email protected]>

systemd v261 will add native support for LUO via the file descriptor store mechanism. Add a brief paragraph in the LUO userspace documentation page to inform users.

Quoted 5 lines
Quoted 1 line

But of course, we should only apply this once systemd v261 is released.

I think, time wise it is fair just to add it to liveupdate/next branch instead of micro-mange the exact time when this lands.

Pasha

Quoted 9 lines
Quoted 5 lines

---
NOTE: the external links will mention LUO after the next release is
published, which should happen within ~4 weeks

Signature · 2 lines
Regards,
Pratyush Yadav
maintainer Reviewed-by on v1 1/1
#3 lore raw
In reply to [email protected]
Quoted 35 lines · On 05-19 16:28, [email protected] wrote:

From: Luca Boccassi <[email protected]>

systemd v261 will add native support for LUO via the file descriptor store mechanism. Add a brief paragraph in the LUO userspace documentation page to inform users.

---
NOTE: the external links will mention LUO after the next release is
published, which should happen within ~4 weeks

 Documentation/userspace-api/liveupdate.rst | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)
Documentation/userspace-api/liveupdate.rst +13 -0
index 41c0473e4f16..f6efc32fb40b 100644
@@ -14,6 +14,29 @@ ioctl uAPI
 ===========
 .. kernel-doc:: include/uapi/linux/liveupdate.h
 
+Userspace Integration
+=====================
+
+systemd (since version v261) uses LUO to preserve its per-service file
+descriptor store across a kexec-based live update. Services opt in by setting
+``FileDescriptorStoreMax=`` and ``FileDescriptorStorePreserve=`` in their unit,
+and push file descriptors with a name into the store via
+``sd_pid_notify_with_fds(... "FDSTORE=1\nFDNAME=foo")``.
+
+Services may also create their own LUO sessions (via ``/dev/liveupdate``) and
+push the resulting session fds into their file descriptor store like any other
+fd. systemd detects such session fds and handles them accordingly, and
+hands the re-retrieved session fd back to the service after kexec, using the

Documentation/userspace-api/liveupdate.rst ioctl uAPI · line 39

Quoted 10 lines
Documentation/userspace-api/liveupdate.rst +10 -0
+existing file descriptor store service interface.
+
+For details, see:
+
+- `File Descriptor Store <https://systemd.io/FILE_DESCRIPTOR_STORE/>`_
+- `systemd.service(5) FileDescriptorStorePreserve=
+  <https://www.freedesktop.org/software/systemd/man/latest/systemd.service.html#FileDescriptorStorePreserve=>`_
+- `sd_pid_notify_with_fds(3)
+  <https://www.freedesktop.org/software/systemd/man/latest/sd_pid_notify_with_fds.html>`_
+
Quoted 6 lines
Documentation/userspace-api/liveupdate.rst +0 -0
 See Also
 ========
 
Signature · 1 line
2.47.3
maintainer Applied
#4 lore raw
In reply to [email protected]
Quoted 5 lines · On Tue, 19 May 2026 16:28:39 +0100, [email protected] wrote:

systemd v261 will add native support for LUO via the file descriptor store mechanism. Add a brief paragraph in the LUO userspace documentation page to inform users.

Applied, thanks!

[1/1] liveupdate: document systemd support

      commit: 1b7ce86f23a430ac91a2ed6cd88046e16751b285

Best regards,

Signature · 1 line
Pasha Tatashin <[email protected]>