sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget'/translations/zh_CN/core-api/liveupdatemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/zh_TW/core-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/it_IT/core-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/ja_JP/core-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/ko_KR/core-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/sp_SP/core-api/liveupdatemodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhA/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate.rsthKubhsection)}(hhh](htitle)}(hLive Update Orchestratorh]hLive Update Orchestrator}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh field_list)}(hhh]hfield)}(hhh](h field_name)}(hAuthorh]hAuthor}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhKubh field_body)}(h+Pasha Tatashin h]h paragraph)}(h*Pasha Tatashin h](hPasha Tatashin <}(hhhhhNhNubh reference)}(hpasha.tatashin@soleen.comh]hpasha.tatashin@soleen.com}(hhhhhNhNubah}(h]h ]h"]h$]h&]refuri mailto:pasha.tatashin@soleen.comuh1hhhubh>}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhubah}(h]h ]h"]h$]h&]uh1hhhubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hX4Live Update is a specialized, kexec-based reboot process that allows a running kernel to be updated from one version to another while preserving the state of selected resources and keeping designated hardware devices operational. For these devices, DMA activity may continue throughout the kernel transition.h]hX4Live Update is a specialized, kexec-based reboot process that allows a running kernel to be updated from one version to another while preserving the state of selected resources and keeping designated hardware devices operational. For these devices, DMA activity may continue throughout the kernel transition.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chK hhhhubh)}(hXWhile the primary use case driving this work is supporting live updates of the Linux kernel when it is used as a hypervisor in cloud environments, the LUO framework itself is designed to be workload-agnostic. Live Update facilitates a full kernel version upgrade for any type of system.h]hXWhile the primary use case driving this work is supporting live updates of the Linux kernel when it is used as a hypervisor in cloud environments, the LUO framework itself is designed to be workload-agnostic. Live Update facilitates a full kernel version upgrade for any type of system.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chKhhhhubh)}(hXFor example, a non-hypervisor system running an in-memory cache like memcached with many gigabytes of data can use LUO. The userspace service can place its cache into a memfd, have its state preserved by LUO, and restore it immediately after the kernel kexec.h]hXFor example, a non-hypervisor system running an in-memory cache like memcached with many gigabytes of data can use LUO. The userspace service can place its cache into a memfd, have its state preserved by LUO, and restore it immediately after the kernel kexec.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chKhhhhubh)}(hWhether the system is running virtual machines, containers, a high-performance database, or networking services, LUO's primary goal is to enable a full kernel update by preserving critical userspace state and keeping essential devices operational.h]hWhether the system is running virtual machines, containers, a high-performance database, or networking services, LUO’s primary goal is to enable a full kernel update by preserving critical userspace state and keeping essential devices operational.}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chKhhhhubh)}(hX)The core of LUO is a mechanism that tracks the progress of a live update, along with a callback API that allows other kernel subsystems to participate in the process. Example subsystems that can hook into LUO include: kvm, iommu, interrupts, vfio, participating filesystems, and memory management.h]hX)The core of LUO is a mechanism that tracks the progress of a live update, along with a callback API that allows other kernel subsystems to participate in the process. Example subsystems that can hook into LUO include: kvm, iommu, interrupts, vfio, participating filesystems, and memory management.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chKhhhhubh)}(hLUO uses Kexec Handover to transfer memory state from the current kernel to the next kernel. For more details see Documentation/core-api/kho/index.rst.h]hLUO uses Kexec Handover to transfer memory state from the current kernel to the next kernel. For more details see Documentation/core-api/kho/index.rst.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chK#hhhhubh)}(hhh](h)}(h LUO Sessionsh]h LUO Sessions}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{hhhhhK ubh)}(hX1LUO Sessions provide the core mechanism for grouping and managing `struct file *` instances that need to be preserved across a kexec-based live update. Each session acts as a named container for a set of file objects, allowing a userspace agent to manage the lifecycle of resources critical to a workload.h](hBLUO Sessions provide the core mechanism for grouping and managing }(hjhhhNhNubhtitle_reference)}(h`struct file *`h]h struct file *}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh instances that need to be preserved across a kexec-based live update. Each session acts as a named container for a set of file objects, allowing a userspace agent to manage the lifecycle of resources critical to a workload.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK hj{hhubh)}(hCore Concepts:h]hCore Concepts:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhj{hhubh bullet_list)}(hhh](h list_item)}(hNamed Containers: Sessions are identified by a unique, user-provided name, which is used for both creation in the current kernel and retrieval in the next kernel. h]h)}(hNamed Containers: Sessions are identified by a unique, user-provided name, which is used for both creation in the current kernel and retrieval in the next kernel.h]hNamed Containers: Sessions are identified by a unique, user-provided name, which is used for both creation in the current kernel and retrieval in the next kernel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h`Userspace Interface: Session management is driven from userspace via ioctls on /dev/liveupdate. h]h)}(h_Userspace Interface: Session management is driven from userspace via ioctls on /dev/liveupdate.h]h_Userspace Interface: Session management is driven from userspace via ioctls on /dev/liveupdate.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hX2Serialization: Session metadata is preserved using the KHO framework. When a live update is triggered via kexec, an array of `struct luo_session_ser` is populated and placed in a preserved memory region. An FDT node is also created, containing the count of sessions and the physical address of this array. h]h)}(hX1Serialization: Session metadata is preserved using the KHO framework. When a live update is triggered via kexec, an array of `struct luo_session_ser` is populated and placed in a preserved memory region. An FDT node is also created, containing the count of sessions and the physical address of this array.h](h}Serialization: Session metadata is preserved using the KHO framework. When a live update is triggered via kexec, an array of }(hjhhhNhNubj)}(h`struct luo_session_ser`h]hstruct luo_session_ser}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh is populated and placed in a preserved memory region. An FDT node is also created, containing the count of sessions and the physical address of this array.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]bullet-uh1jhjhKhj{hhubh)}(hSession Lifecycle:h]hSession Lifecycle:}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhj{hhubhenumerated_list)}(hhh](j)}(hCreation: A userspace agent calls `luo_session_create()` to create a new, empty session and receives a file descriptor for it. h]h)}(h~Creation: A userspace agent calls `luo_session_create()` to create a new, empty session and receives a file descriptor for it.h](h"Creation: A userspace agent calls }(hjBhhhNhNubj)}(h`luo_session_create()`h]hluo_session_create()}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubhF to create a new, empty session and receives a file descriptor for it.}(hjBhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK hj>ubah}(h]h ]h"]h$]h&]uh1jhj;ubj)}(hSerialization: When the `reboot(LINUX_REBOOT_CMD_KEXEC)` syscall is made, `luo_session_serialize()` is called. It iterates through all active sessions and writes their metadata into a memory area preserved by KHO. h]h)}(hSerialization: When the `reboot(LINUX_REBOOT_CMD_KEXEC)` syscall is made, `luo_session_serialize()` is called. It iterates through all active sessions and writes their metadata into a memory area preserved by KHO.h](hSerialization: When the }(hjmhhhNhNubj)}(h `reboot(LINUX_REBOOT_CMD_KEXEC)`h]hreboot(LINUX_REBOOT_CMD_KEXEC)}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubh syscall is made, }(hjmhhhNhNubj)}(h`luo_session_serialize()`h]hluo_session_serialize()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubhr is called. It iterates through all active sessions and writes their metadata into a memory area preserved by KHO.}(hjmhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK#hjiubah}(h]h ]h"]h$]h&]uh1jhj;ubj)}(hDeserialization (in new kernel): After kexec, `luo_session_deserialize()` runs, reading the serialized data and creating a list of `struct luo_session` objects representing the preserved sessions. h]h)}(hDeserialization (in new kernel): After kexec, `luo_session_deserialize()` runs, reading the serialized data and creating a list of `struct luo_session` objects representing the preserved sessions.h](h.Deserialization (in new kernel): After kexec, }(hjhhhNhNubj)}(h`luo_session_deserialize()`h]hluo_session_deserialize()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh: runs, reading the serialized data and creating a list of }(hjhhhNhNubj)}(h`struct luo_session`h]hstruct luo_session}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh- objects representing the preserved sessions.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK(hjubah}(h]h ]h"]h$]h&]uh1jhj;ubj)}(hRetrieval: A userspace agent in the new kernel can then call `luo_session_retrieve()` with a session name to get a new file descriptor and access the preserved state. h]h)}(hRetrieval: A userspace agent in the new kernel can then call `luo_session_retrieve()` with a session name to get a new file descriptor and access the preserved state.h](h=Retrieval: A userspace agent in the new kernel can then call }(hjhhhNhNubj)}(h`luo_session_retrieve()`h]hluo_session_retrieve()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhQ with a session name to get a new file descriptor and access the preserved state.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK,hjubah}(h]h ]h"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1j9hj{hhhNhNubeh}(h] luo-sessionsah ]h"] luo sessionsah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hLUO Preserving File Descriptorsh]hLUO Preserving File Descriptors}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hhhhhKubh)}(hXLUO provides the infrastructure to preserve specific, stateful file descriptors across a kexec-based live update. The primary goal is to allow workloads, such as virtual machines using vfio, memfd, or iommufd, to retain access to their essential resources without interruption.h]hXLUO provides the infrastructure to preserve specific, stateful file descriptors across a kexec-based live update. The primary goal is to allow workloads, such as virtual machines using vfio, memfd, or iommufd, to retain access to their essential resources without interruption.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK hj!hhubh)}(hsThe framework is built around a callback-based handler model and a well- defined lifecycle for each preserved file.h]hsThe framework is built around a callback-based handler model and a well- defined lifecycle for each preserved file.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chKhj!hhubh)}(hXHandler Registration: Kernel modules responsible for a specific file type (e.g., memfd, vfio) register a :c:type:`struct liveupdate_file_handler `. This handler provides a set of callbacks that LUO invokes at different stages of the update process, most notably:h](hiHandler Registration: Kernel modules responsible for a specific file type (e.g., memfd, vfio) register a }(hjPhhhNhNubh)}(hB:c:type:`struct liveupdate_file_handler `h]hliteral)}(hjZh]hstruct liveupdate_file_handler}(hj^hhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1j\hjXubah}(h]h ]h"]h$]h&]refdoccore-api/liveupdate refdomainjireftypetype refexplicitrefwarn reftargetliveupdate_file_handleruh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chKhjPubht. This handler provides a set of callbacks that LUO invokes at different stages of the update process, most notably:}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj}hKhj!hhubh block_quote)}(hX- can_preserve(): A lightweight check to determine if the handler is compatible with a given 'struct file'. - preserve(): The heavyweight operation that saves the file's state and returns an opaque u64 handle. This is typically performed while the workload is still active to minimize the downtime during the actual reboot transition. - unpreserve(): Cleans up any resources allocated by .preserve(), called if the preservation process is aborted before the reboot (i.e. session is closed). - freeze(): A final pre-reboot opportunity to prepare the state for kexec. We are already in reboot syscall, and therefore userspace cannot mutate the file anymore. - unfreeze(): Undoes the actions of .freeze(), called if the live update is aborted after the freeze phase. - retrieve(): Reconstructs the file in the new kernel from the preserved handle. - finish(): Performs final check and cleanup in the new kernel. After succesul finish call, LUO gives up ownership to this file. h]j)}(hhh](j)}(hican_preserve(): A lightweight check to determine if the handler is compatible with a given 'struct file'.h]h)}(hican_preserve(): A lightweight check to determine if the handler is compatible with a given 'struct file'.h]hmcan_preserve(): A lightweight check to determine if the handler is compatible with a given ‘struct file’.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hpreserve(): The heavyweight operation that saves the file's state and returns an opaque u64 handle. This is typically performed while the workload is still active to minimize the downtime during the actual reboot transition.h]h)}(hpreserve(): The heavyweight operation that saves the file's state and returns an opaque u64 handle. This is typically performed while the workload is still active to minimize the downtime during the actual reboot transition.h]hpreserve(): The heavyweight operation that saves the file’s state and returns an opaque u64 handle. This is typically performed while the workload is still active to minimize the downtime during the actual reboot transition.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hunpreserve(): Cleans up any resources allocated by .preserve(), called if the preservation process is aborted before the reboot (i.e. session is closed).h]h)}(hunpreserve(): Cleans up any resources allocated by .preserve(), called if the preservation process is aborted before the reboot (i.e. session is closed).h]hunpreserve(): Cleans up any resources allocated by .preserve(), called if the preservation process is aborted before the reboot (i.e. session is closed).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hfreeze(): A final pre-reboot opportunity to prepare the state for kexec. We are already in reboot syscall, and therefore userspace cannot mutate the file anymore.h]h)}(hfreeze(): A final pre-reboot opportunity to prepare the state for kexec. We are already in reboot syscall, and therefore userspace cannot mutate the file anymore.h]hfreeze(): A final pre-reboot opportunity to prepare the state for kexec. We are already in reboot syscall, and therefore userspace cannot mutate the file anymore.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hiunfreeze(): Undoes the actions of .freeze(), called if the live update is aborted after the freeze phase.h]h)}(hiunfreeze(): Undoes the actions of .freeze(), called if the live update is aborted after the freeze phase.h]hiunfreeze(): Undoes the actions of .freeze(), called if the live update is aborted after the freeze phase.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK#hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hNretrieve(): Reconstructs the file in the new kernel from the preserved handle.h]h)}(hNretrieve(): Reconstructs the file in the new kernel from the preserved handle.h]hNretrieve(): Reconstructs the file in the new kernel from the preserved handle.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK%hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hfinish(): Performs final check and cleanup in the new kernel. After succesul finish call, LUO gives up ownership to this file. h]h)}(h~finish(): Performs final check and cleanup in the new kernel. After succesul finish call, LUO gives up ownership to this file.h]h~finish(): Performs final check and cleanup in the new kernel. After succesul finish call, LUO gives up ownership to this file.}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK'hj'ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j(j)uh1jhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj!hhubh)}(h'File Preservation Lifecycle happy path:h]h'File Preservation Lifecycle happy path:}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK*hj!hhubj:)}(hhh](j)}(hXPreserve (Normal Operation): A userspace agent preserves files one by one via an ioctl. For each file, luo_preserve_file() finds a compatible handler, calls its .preserve() operation, and creates an internal :c:type:`struct luo_file ` to track the live state. h]h)}(hX Preserve (Normal Operation): A userspace agent preserves files one by one via an ioctl. For each file, luo_preserve_file() finds a compatible handler, calls its .preserve() operation, and creates an internal :c:type:`struct luo_file ` to track the live state.h](hPreserve (Normal Operation): A userspace agent preserves files one by one via an ioctl. For each file, luo_preserve_file() finds a compatible handler, calls its .preserve() operation, and creates an internal }(hjbhhhNhNubh)}(h$:c:type:`struct luo_file `h]j])}(hjlh]hstruct luo_file}(hjnhhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjjubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnj{luo_fileuh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK,hjbubh to track the live state.}(hjbhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK,hj^ubah}(h]h ]h"]h$]h&]uh1jhj[ubj)}(hXFreeze (Pre-Reboot): Just before the kexec, luo_file_freeze() is called. It iterates through all preserved files, calls their respective .freeze() operation, and serializes their final metadata (compatible string, token, and data handle) into a contiguous memory block for KHO. h]h)}(hXFreeze (Pre-Reboot): Just before the kexec, luo_file_freeze() is called. It iterates through all preserved files, calls their respective .freeze() operation, and serializes their final metadata (compatible string, token, and data handle) into a contiguous memory block for KHO.h]hXFreeze (Pre-Reboot): Just before the kexec, luo_file_freeze() is called. It iterates through all preserved files, calls their respective .freeze() operation, and serializes their final metadata (compatible string, token, and data handle) into a contiguous memory block for KHO.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK1hjubah}(h]h ]h"]h$]h&]uh1jhj[ubj)}(hXVDeserialize: After kexec, luo_file_deserialize() runs when session gets deserialized (which is when /dev/liveupdate is first opened). It reads the serialized data from the KHO memory region and reconstructs the in-memory list of :c:type:`struct luo_file ` instances for the new kernel, linking them to their corresponding handlers. h]h)}(hXUDeserialize: After kexec, luo_file_deserialize() runs when session gets deserialized (which is when /dev/liveupdate is first opened). It reads the serialized data from the KHO memory region and reconstructs the in-memory list of :c:type:`struct luo_file ` instances for the new kernel, linking them to their corresponding handlers.h](hDeserialize: After kexec, luo_file_deserialize() runs when session gets deserialized (which is when /dev/liveupdate is first opened). It reads the serialized data from the KHO memory region and reconstructs the in-memory list of }(hjhhhNhNubh)}(h$:c:type:`struct luo_file `h]j])}(hjh]hstruct luo_file}(hjhhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnj{luo_fileuh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK6hjubhL instances for the new kernel, linking them to their corresponding handlers.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK6hjubah}(h]h ]h"]h$]h&]uh1jhj[ubj)}(hX'Retrieve (New Kernel - Userspace Ready): The userspace agent can now restore file descriptors by providing a token. luo_retrieve_file() searches for the matching token, calls the handler's .retrieve() op to re-create the 'struct file', and returns a new FD. Files can be retrieved in ANY order. h]h)}(hX&Retrieve (New Kernel - Userspace Ready): The userspace agent can now restore file descriptors by providing a token. luo_retrieve_file() searches for the matching token, calls the handler's .retrieve() op to re-create the 'struct file', and returns a new FD. Files can be retrieved in ANY order.h]hX,Retrieve (New Kernel - Userspace Ready): The userspace agent can now restore file descriptors by providing a token. luo_retrieve_file() searches for the matching token, calls the handler’s .retrieve() op to re-create the ‘struct file’, and returns a new FD. Files can be retrieved in ANY order.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK`) that LUO invokes at key points:h](h`h]j])}(hj!h]hstruct liveupdate_flb_ops}(hj#hhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnj{liveupdate_flb_opsuh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chKhjubh!) that LUO invokes at key points:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj>hKhjhhubj)}(hX- .preserve(): Called for the first file. Saves global state. - .unpreserve(): Called for the last file (if aborted pre-reboot). - .retrieve(): Called on-demand in the new kernel to restore the state. - .finish(): Called for the last file in the new kernel for cleanup. h]j)}(hhh](j)}(h;.preserve(): Called for the first file. Saves global state.h]h)}(hjRh]h;.preserve(): Called for the first file. Saves global state.}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chKhjPubah}(h]h ]h"]h$]h&]uh1jhjMubj)}(h@.unpreserve(): Called for the last file (if aborted pre-reboot).h]h)}(hjjh]h@.unpreserve(): Called for the last file (if aborted pre-reboot).}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chKhjhubah}(h]h ]h"]h$]h&]uh1jhjMubj)}(hE.retrieve(): Called on-demand in the new kernel to restore the state.h]h)}(hjh]hE.retrieve(): Called on-demand in the new kernel to restore the state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chKhjubah}(h]h ]h"]h$]h&]uh1jhjMubj)}(hC.finish(): Called for the last file in the new kernel for cleanup. h]h)}(hB.finish(): Called for the last file in the new kernel for cleanup.h]hB.finish(): Called for the last file in the new kernel for cleanup.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chKhjubah}(h]h ]h"]h$]h&]uh1jhjMubeh}(h]h ]h"]h$]h&]j(j)uh1jhjahKhjIubah}(h]h ]h"]h$]h&]uh1jhjahKhjhhubh)}(hThis reference-counted approach ensures that shared state is saved exactly once and restored exactly once, regardless of how many files depend on it, and that its lifecycle is correctly managed across the kexec transition.h]hThis reference-counted approach ensures that shared state is saved exactly once and restored exactly once, regardless of how many files depend on it, and that its lifecycle is correctly managed across the kexec transition.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chK hjhhubeh}(h]$luo-file-lifecycle-bound-global-dataah ]h"]$luo file lifecycle bound global dataah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hLive Update Orchestrator ABIh]hLive Update Orchestrator ABI}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hXLive Update Orchestrator uses the stable Application Binary Interface defined below to pass state from a pre-update kernel to a post-update kernel. The ABI is built upon the Kexec HandOver framework and uses a Flattened Device Tree to describe the preserved data.h]hXLive Update Orchestrator uses the stable Application Binary Interface defined below to pass state from a pre-update kernel to a post-update kernel. The ABI is built upon the Kexec HandOver framework and uses a Flattened Device Tree to describe the preserved data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK hjhhubh)}(hXnThis interface is a contract. Any modification to the FDT structure, node properties, compatible strings, or the layout of the `__packed` serialization structures defined here constitutes a breaking change. Such changes require incrementing the version number in the relevant `_COMPATIBLE` string to prevent a new kernel from misinterpreting data from an old kernel.h](hThis interface is a contract. Any modification to the FDT structure, node properties, compatible strings, or the layout of the }(hjhhhNhNubj)}(h `__packed`h]h__packed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh serialization structures defined here constitutes a breaking change. Such changes require incrementing the version number in the relevant }(hjhhhNhNubj)}(h `_COMPATIBLE`h]h _COMPATIBLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhM string to prevent a new kernel from misinterpreting data from an old kernel.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhjhhubh)}(hChanges are allowed provided the compatibility version is incremented; however, backward/forward compatibility is only guaranteed for kernels supporting the same ABI version.h]hChanges are allowed provided the compatibility version is incremented; however, backward/forward compatibility is only guaranteed for kernels supporting the same ABI version.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhjhhubhdefinition_list)}(hhh]hdefinition_list_item)}(hXFDT Structure Overview: The entire LUO state is encapsulated within a single KHO entry named "LUO". This entry contains an FDT with the following layout: .. code-block:: none / { compatible = "luo-v1"; liveupdate-number = <...>; luo-session { compatible = "luo-session-v1"; luo-session-header = ; }; luo-flb { compatible = "luo-flb-v1"; luo-flb-header = ; }; }; h](hterm)}(hFDT Structure Overview:h]hFDT Structure Overview:}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK+hj=ubh definition)}(hhh](h)}(hThe entire LUO state is encapsulated within a single KHO entry named "LUO". This entry contains an FDT with the following layout:h]hThe entire LUO state is encapsulated within a single KHO entry named “LUO”. This entry contains an FDT with the following layout:}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhjTubh literal_block)}(hX2/ { compatible = "luo-v1"; liveupdate-number = <...>; luo-session { compatible = "luo-session-v1"; luo-session-header = ; }; luo-flb { compatible = "luo-flb-v1"; luo-flb-header = ; }; };h]hX2/ { compatible = "luo-v1"; liveupdate-number = <...>; luo-session { compatible = "luo-session-v1"; luo-session-header = ; }; luo-flb { compatible = "luo-flb-v1"; luo-flb-header = ; }; };}hjhsbah}(h]h ]h"]h$]h&]hhforcelanguagenonehighlight_args}uh1jfh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhjTubeh}(h]h ]h"]h$]h&]uh1jRhj=ubeh}(h]h ]h"]h$]h&]uh1j;hjQhK+hj8ubah}(h]h ]h"]h$]h&]uh1j6hjhhhNhNubh)}(hMain LUO Node (/):h]hMain LUO Node (/):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK-hjhhubj)}(h- compatible: "luo-v1" Identifies the overall LUO ABI version. - liveupdate-number: u64 A counter tracking the number of successful live updates performed. h]j)}(hhh](j)}(hhjMubah}(h]h ]h"]h$]h&]uh1jRhj1ubeh}(h]h ]h"]h$]h&]uh1j;hjLhKAhj ubj<)}(h6``finish`` Required. Final cleanup in the new kernel. h](jB)}(h ``finish``h]j])}(hjqh]hfinish}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjoubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKBhjkubjS)}(hhh]h)}(h*Required. Final cleanup in the new kernel.h]h*Required. Final cleanup in the new kernel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKBhjubah}(h]h ]h"]h$]h&]uh1jRhjkubeh}(h]h ]h"]h$]h&]uh1j;hjhKBhj ubj<)}(h``owner`` Module referenceh](jB)}(h ``owner``h]j])}(hjh]howner}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKBhjubjS)}(hhh]h)}(hModule referenceh]hModule reference}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKChjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKBhj ubeh}(h]h ]h"]h$]h&]uh1j6hj} ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhj hNubh)}(h**Description**h]jm )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKFhj hhubh)}(h~All operations (except can_preserve) receive a pointer to a 'struct liveupdate_file_op_args' containing the necessary context.h]hAll operations (except can_preserve) receive a pointer to a ‘struct liveupdate_file_op_args’ containing the necessary context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKChj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j "liveupdate_file_handler (C struct)c.liveupdate_file_handlerhNtauh1j hj hhhj hNubj )}(hhh](j )}(hliveupdate_file_handlerh]j )}(hstruct liveupdate_file_handlerh](j )}(hj h]hstruct}(hj+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj'hhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKIubj )}(h h]h }(hj9hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj'hhhj8hKIubj )}(hliveupdate_file_handlerh]j )}(hj%h]hliveupdate_file_handler}(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjGubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj'hhhj8hKIubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj#hhhj8hKIubah}(h]jah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj8hKIhj hhubj< )}(hhh]h)}(h4Represents a handler for a live-updatable file type.h]h4Represents a handler for a live-updatable file type.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKUhjjhhubah}(h]h ]h"]h$]h&]uh1j; hj hhhj8hKIubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jj^ jj_ j` ja uh1j hhhj hj hNubjc )}(hX**Definition**:: struct liveupdate_file_handler { const struct liveupdate_file_ops *ops; const char compatible[LIVEUPDATE_HNDL_COMPAT_LENGTH]; }; **Members** ``ops`` Callback functions ``compatible`` The compatibility string (e.g., "memfd-v1", "vfiofd-v1") that uniquely identifies the file type this handler supports. This is matched against the compatible string associated with individual :c:type:`struct file ` instances.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKYhjubjg)}(hstruct liveupdate_file_handler { const struct liveupdate_file_ops *ops; const char compatible[LIVEUPDATE_HNDL_COMPAT_LENGTH]; };h]hstruct liveupdate_file_handler { const struct liveupdate_file_ops *ops; const char compatible[LIVEUPDATE_HNDL_COMPAT_LENGTH]; };}hjsbah}(h]h ]h"]h$]h&]hhuh1jfh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK[hjubh)}(h **Members**h]jm )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK`hjubj7)}(hhh](j<)}(h``ops`` Callback functions h](jB)}(h``ops``h]j])}(hjh]hops}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKWhjubjS)}(hhh]h)}(hCallback functionsh]hCallback functions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKWhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKWhjubj<)}(h``compatible`` The compatibility string (e.g., "memfd-v1", "vfiofd-v1") that uniquely identifies the file type this handler supports. This is matched against the compatible string associated with individual :c:type:`struct file ` instances.h](jB)}(h``compatible``h]j])}(hjh]h compatible}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKZhj ubjS)}(hhh]h)}(hThe compatibility string (e.g., "memfd-v1", "vfiofd-v1") that uniquely identifies the file type this handler supports. This is matched against the compatible string associated with individual :c:type:`struct file ` instances.h](hThe compatibility string (e.g., “memfd-v1”, “vfiofd-v1”) that uniquely identifies the file type this handler supports. This is matched against the compatible string associated with individual }(hj,hhhNhNubh)}(h:c:type:`struct file `h]j])}(hj6h]h struct file}(hj8hhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hj4ubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarn c:parent_keysphinx.domains.c LookupKey)}data]sbj{fileuh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKXhj,ubh instances.}(hj,hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj[hKXhj)ubah}(h]h ]h"]h$]h&]uh1jRhj ubeh}(h]h ]h"]h$]h&]uh1j;hj(hKZhjubeh}(h]h ]h"]h$]h&]uh1j6hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhj hNubh)}(h**Description**h]jm )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK^hj hhubh)}(hXModules that want to support live update for specific file types should register an instance of this structure. LUO uses this registration to determine if a given file can be preserved and to find the appropriate operations to manage its state across the update.h]hXModules that want to support live update for specific file types should register an instance of this structure. LUO uses this registration to determine if a given file can be preserved and to find the appropriate operations to manage its state across the update.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK[hj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j !liveupdate_flb_op_args (C struct)c.liveupdate_flb_op_argshNtauh1j hj hhhj hNubj )}(hhh](j )}(hliveupdate_flb_op_argsh]j )}(hstruct liveupdate_flb_op_argsh](j )}(hj h]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKcubj )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhhjhKcubj )}(hliveupdate_flb_op_argsh]j )}(hjh]hliveupdate_flb_op_args}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjhhhjhKcubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjhhhjhKcubah}(h]jah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjhKchjhhubj< )}(hhh]h)}(h&Arguments for FLB operation callbacks.h]h&Arguments for FLB operation callbacks.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKqhjhhubah}(h]h ]h"]h$]h&]uh1j; hjhhhjhKcubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jj^ jj_ j` ja uh1j hhhj hj hNubjc )}(hX>**Definition**:: struct liveupdate_flb_op_args { struct liveupdate_flb *flb; u64 data; void *obj; }; **Members** ``flb`` The global FLB instance for which this call is performed. ``data`` For .preserve(): [OUT] The callback sets this field. For .unpreserve(): [IN] The handle from .preserve(). For .retrieve(): [IN] The handle from .preserve(). ``obj`` For .preserve(): [OUT] Sets this to the live object. For .retrieve(): [OUT] Sets this to the live object. For .finish(): [IN] The live object from .retrieve().h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj!ubh:}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKuhjubjg)}(h_struct liveupdate_flb_op_args { struct liveupdate_flb *flb; u64 data; void *obj; };h]h_struct liveupdate_flb_op_args { struct liveupdate_flb *flb; u64 data; void *obj; };}hj>sbah}(h]h ]h"]h$]h&]hhuh1jfh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKwhjubh)}(h **Members**h]jm )}(hjOh]hMembers}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjMubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK}hjubj7)}(hhh](j<)}(hB``flb`` The global FLB instance for which this call is performed. h](jB)}(h``flb``h]j])}(hjnh]hflb}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjlubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKshjhubjS)}(hhh]h)}(h9The global FLB instance for which this call is performed.h]h9The global FLB instance for which this call is performed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKshjubah}(h]h ]h"]h$]h&]uh1jRhjhubeh}(h]h ]h"]h$]h&]uh1j;hjhKshjeubj<)}(h``data`` For .preserve(): [OUT] The callback sets this field. For .unpreserve(): [IN] The handle from .preserve(). For .retrieve(): [IN] The handle from .preserve(). h](jB)}(h``data``h]j])}(hjh]hdata}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKvhjubjS)}(hhh]h)}(hFor .preserve(): [OUT] The callback sets this field. For .unpreserve(): [IN] The handle from .preserve(). For .retrieve(): [IN] The handle from .preserve().h]hFor .preserve(): [OUT] The callback sets this field. For .unpreserve(): [IN] The handle from .preserve(). For .retrieve(): [IN] The handle from .preserve().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKthjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKvhjeubj<)}(h``obj`` For .preserve(): [OUT] Sets this to the live object. For .retrieve(): [OUT] Sets this to the live object. For .finish(): [IN] The live object from .retrieve().h](jB)}(h``obj``h]j])}(hjh]hobj}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKxhjubjS)}(hhh]h)}(hFor .preserve(): [OUT] Sets this to the live object. For .retrieve(): [OUT] Sets this to the live object. For .finish(): [IN] The live object from .retrieve().h]hFor .preserve(): [OUT] Sets this to the live object. For .retrieve(): [OUT] Sets this to the live object. For .finish(): [IN] The live object from .retrieve().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKwhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKxhjeubeh}(h]h ]h"]h$]h&]uh1j6hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhj hNubh)}(h**Description**h]jm )}(hj$h]h Description}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj"ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK|hj hhubh)}(hFThis structure bundles all parameters for the FLB operation callbacks.h]hFThis structure bundles all parameters for the FLB operation callbacks.}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKyhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j liveupdate_flb_ops (C struct)c.liveupdate_flb_opshNtauh1j hj hhhj hNubj )}(hhh](j )}(hliveupdate_flb_opsh]j )}(hstruct liveupdate_flb_opsh](j )}(hj h]hstruct}(hjbhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj^hhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK~ubj )}(h h]h }(hjphhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj^hhhjohK~ubj )}(hliveupdate_flb_opsh]j )}(hj\h]hliveupdate_flb_ops}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj~ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj^hhhjohK~ubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjZhhhjohK~ubah}(h]jUah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjohK~hjWhhubj< )}(hhh]h)}(h/Callbacks for global File-Lifecycle-Bound data.h]h/Callbacks for global File-Lifecycle-Bound data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjhhubah}(h]h ]h"]h$]h&]uh1j; hjWhhhjohK~ubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jj^ jj_ j` ja uh1j hhhj hj hNubjc )}(hX**Definition**:: struct liveupdate_flb_ops { int (*preserve)(struct liveupdate_flb_op_args *argp); void (*unpreserve)(struct liveupdate_flb_op_args *argp); int (*retrieve)(struct liveupdate_flb_op_args *argp); void (*finish)(struct liveupdate_flb_op_args *argp); struct module *owner; }; **Members** ``preserve`` Called when the first file using this FLB is preserved. The callback must save its state and return a single, self-contained u64 handle by setting the 'argp->data' field and 'argp->obj'. ``unpreserve`` Called when the last file using this FLB is unpreserved (aborted before reboot). Receives the handle via 'argp->data' and live object via 'argp->obj'. ``retrieve`` Called on-demand in the new kernel, the first time a component requests access to the shared object. It receives the preserved handle via 'argp->data' and must reconstruct the live object, returning it by setting the 'argp->obj' field. ``finish`` Called in the new kernel when the last file using this FLB is finished. Receives the live object via 'argp->obj' for cleanup. ``owner`` Module referenceh](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubjg)}(hX"struct liveupdate_flb_ops { int (*preserve)(struct liveupdate_flb_op_args *argp); void (*unpreserve)(struct liveupdate_flb_op_args *argp); int (*retrieve)(struct liveupdate_flb_op_args *argp); void (*finish)(struct liveupdate_flb_op_args *argp); struct module *owner; };h]hX"struct liveupdate_flb_ops { int (*preserve)(struct liveupdate_flb_op_args *argp); void (*unpreserve)(struct liveupdate_flb_op_args *argp); int (*retrieve)(struct liveupdate_flb_op_args *argp); void (*finish)(struct liveupdate_flb_op_args *argp); struct module *owner; };}hjsbah}(h]h ]h"]h$]h&]hhuh1jfh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubh)}(h **Members**h]jm )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj7)}(hhh](j<)}(h``preserve`` Called when the first file using this FLB is preserved. The callback must save its state and return a single, self-contained u64 handle by setting the 'argp->data' field and 'argp->obj'. h](jB)}(h ``preserve``h]j])}(hjh]hpreserve}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj ubjS)}(hhh]h)}(hCalled when the first file using this FLB is preserved. The callback must save its state and return a single, self-contained u64 handle by setting the 'argp->data' field and 'argp->obj'.h]hCalled when the first file using this FLB is preserved. The callback must save its state and return a single, self-contained u64 handle by setting the ‘argp->data’ field and ‘argp->obj’.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj'ubah}(h]h ]h"]h$]h&]uh1jRhj ubeh}(h]h ]h"]h$]h&]uh1j;hj&hKhjubj<)}(h``unpreserve`` Called when the last file using this FLB is unpreserved (aborted before reboot). Receives the handle via 'argp->data' and live object via 'argp->obj'. h](jB)}(h``unpreserve``h]j])}(hjKh]h unpreserve}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjIubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjEubjS)}(hhh]h)}(hCalled when the last file using this FLB is unpreserved (aborted before reboot). Receives the handle via 'argp->data' and live object via 'argp->obj'.h]hCalled when the last file using this FLB is unpreserved (aborted before reboot). Receives the handle via ‘argp->data’ and live object via ‘argp->obj’.}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjaubah}(h]h ]h"]h$]h&]uh1jRhjEubeh}(h]h ]h"]h$]h&]uh1j;hj`hKhjubj<)}(h``retrieve`` Called on-demand in the new kernel, the first time a component requests access to the shared object. It receives the preserved handle via 'argp->data' and must reconstruct the live object, returning it by setting the 'argp->obj' field. h](jB)}(h ``retrieve``h]j])}(hjh]hretrieve}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubjS)}(hhh]h)}(hCalled on-demand in the new kernel, the first time a component requests access to the shared object. It receives the preserved handle via 'argp->data' and must reconstruct the live object, returning it by setting the 'argp->obj' field.h]hCalled on-demand in the new kernel, the first time a component requests access to the shared object. It receives the preserved handle via ‘argp->data’ and must reconstruct the live object, returning it by setting the ‘argp->obj’ field.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjubj<)}(h``finish`` Called in the new kernel when the last file using this FLB is finished. Receives the live object via 'argp->obj' for cleanup. h](jB)}(h ``finish``h]j])}(hjh]hfinish}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubjS)}(hhh]h)}(h}Called in the new kernel when the last file using this FLB is finished. Receives the live object via 'argp->obj' for cleanup.h]hCalled in the new kernel when the last file using this FLB is finished. Receives the live object via ‘argp->obj’ for cleanup.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjubj<)}(h``owner`` Module referenceh](jB)}(h ``owner``h]j])}(hjh]howner}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubjS)}(hhh]h)}(hModule referenceh]hModule reference}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjubeh}(h]h ]h"]h$]h&]uh1j6hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhj hNubh)}(h**Description**h]jm )}(hj<h]h Description}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj:ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj hhubh)}(hOperations that manage global shared data with file bound lifecycle, triggered by the first file that uses it and concluded by the last file that uses it, across all sessions.h]hOperations that manage global shared data with file bound lifecycle, triggered by the first file that uses it and concluded by the last file that uses it, across all sessions.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j liveupdate_flb (C struct)c.liveupdate_flbhNtauh1j hj hhhj hNubj )}(hhh](j )}(hliveupdate_flbh]j )}(hstruct liveupdate_flbh](j )}(hj h]hstruct}(hjzhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjvhhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKubj )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjvhhhjhKubj )}(hliveupdate_flbh]j )}(hjth]hliveupdate_flb}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjvhhhjhKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjrhhhjhKubah}(h]jmah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjhKhjohhubj< )}(hhh]h)}(h-A global definition for a shared data object.h]h-A global definition for a shared data object.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjhhubah}(h]h ]h"]h$]h&]uh1j; hjohhhjhKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jj^ jj_ j` ja uh1j hhhj hj hNubjc )}(hX**Definition**:: struct liveupdate_flb { const struct liveupdate_flb_ops *ops; const char compatible[LIVEUPDATE_FLB_COMPAT_LENGTH]; }; **Members** ``ops`` Callback functions ``compatible`` The compatibility string (e.g., "iommu-core-v1" that uniquely identifies the FLB type this handler supports. This is matched against the compatible string associated with individual :c:type:`struct liveupdate_flb ` instances.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubjg)}(h}struct liveupdate_flb { const struct liveupdate_flb_ops *ops; const char compatible[LIVEUPDATE_FLB_COMPAT_LENGTH]; };h]h}struct liveupdate_flb { const struct liveupdate_flb_ops *ops; const char compatible[LIVEUPDATE_FLB_COMPAT_LENGTH]; };}hjsbah}(h]h ]h"]h$]h&]hhuh1jfh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubh)}(h **Members**h]jm )}(hj h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj7)}(hhh](j<)}(h``ops`` Callback functions h](jB)}(h``ops``h]j])}(hj)h]hops}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj'ubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj#ubjS)}(hhh]h)}(hCallback functionsh]hCallback functions}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hKhj?ubah}(h]h ]h"]h$]h&]uh1jRhj#ubeh}(h]h ]h"]h$]h&]uh1j;hj>hKhj ubj<)}(hX``compatible`` The compatibility string (e.g., "iommu-core-v1" that uniquely identifies the FLB type this handler supports. This is matched against the compatible string associated with individual :c:type:`struct liveupdate_flb ` instances.h](jB)}(h``compatible``h]j])}(hjbh]h compatible}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj`ubah}(h]h ]h"]h$]h&]uh1jAh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj\ubjS)}(hhh]h)}(hThe compatibility string (e.g., "iommu-core-v1" that uniquely identifies the FLB type this handler supports. This is matched against the compatible string associated with individual :c:type:`struct liveupdate_flb ` instances.h](hThe compatibility string (e.g., “iommu-core-v1” that uniquely identifies the FLB type this handler supports. This is matched against the compatible string associated with individual }(hj{hhhNhNubh)}(h0:c:type:`struct liveupdate_flb `h]j])}(hjh]hstruct liveupdate_flb}(hjhhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnjRjVj{liveupdate_flbuh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj{ubh instances.}(hj{hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjxubah}(h]h ]h"]h$]h&]uh1jRhj\ubeh}(h]h ]h"]h$]h&]uh1j;hjwhKhj ubeh}(h]h ]h"]h$]h&]uh1j6hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhj hNubh)}(h**Description**h]jm )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj hhubh)}(hThis struct is the "template" that a driver registers to define a shared, file-lifecycle-bound object. The actual runtime state (the live object, refcount, etc.) is managed privately by the LUO core.h]hThis struct is the “template” that a driver registers to define a shared, file-lifecycle-bound object. The actual runtime state (the live object, refcount, etc.) is managed privately by the LUO core.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_file_ser (C struct)c.luo_file_serhNtauh1j hj hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhNubj )}(hhh](j )}(h luo_file_serh]j )}(hstruct luo_file_serh](j )}(hj h]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhhjhKubj )}(h luo_file_serh]j )}(hjh]h luo_file_ser}(hj'hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj#ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjhhhjhKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjhhhjhKubah}(h]jah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjhKhjhhubj< )}(hhh]h)}(h*Represents the serialized preserves files.h]h*Represents the serialized preserves files.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK{hjFhhubah}(h]h ]h"]h$]h&]uh1j; hjhhhjhKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jaj^ jaj_ j` ja uh1j hhhj hjhNubjc )}(hX **Definition**:: struct luo_file_ser { char compatible[LIVEUPDATE_HNDL_COMPAT_LENGTH]; u64 data; u64 token; }; **Members** ``compatible`` File handler compatible string. ``data`` Private data ``token`` User provided token for this fileh](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjiubh:}(hjihhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjeubjg)}(histruct luo_file_ser { char compatible[LIVEUPDATE_HNDL_COMPAT_LENGTH]; u64 data; u64 token; };h]histruct luo_file_ser { char compatible[LIVEUPDATE_HNDL_COMPAT_LENGTH]; u64 data; u64 token; };}hjsbah}(h]h ]h"]h$]h&]hhuh1jfh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjeubh)}(h **Members**h]jm )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjeubj7)}(hhh](j<)}(h/``compatible`` File handler compatible string. h](jB)}(h``compatible``h]j])}(hjh]h compatible}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK}hjubjS)}(hhh]h)}(hFile handler compatible string.h]hFile handler compatible string.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK}hjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhK}hjubj<)}(h``data`` Private data h](jB)}(h``data``h]j])}(hjh]hdata}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK~hjubjS)}(hhh]h)}(h Private datah]h Private data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK~hjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhK~hjubj<)}(h+``token`` User provided token for this fileh](jB)}(h ``token``h]j])}(hj(h]htoken}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj&ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK~hj"ubjS)}(hhh]h)}(h!User provided token for this fileh]h!User provided token for this file}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj>ubah}(h]h ]h"]h$]h&]uh1jRhj"ubeh}(h]h ]h"]h$]h&]uh1j;hj=hK~hjubeh}(h]h ]h"]h$]h&]uh1j6hjeubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhjhNubh)}(h**Description**h]jm )}(hjkh]h Description}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjiubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hFIf this structure is modified, LUO_SESSION_COMPATIBLE must be updated.h]hFIf this structure is modified, LUO_SESSION_COMPATIBLE must be updated.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_file_set_ser (C struct)c.luo_file_set_serhNtauh1j hj hhhjhNubj )}(hhh](j )}(hluo_file_set_serh]j )}(hstruct luo_file_set_serh](j )}(hj h]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhhjhKubj )}(hluo_file_set_serh]j )}(hjh]hluo_file_set_ser}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjhhhjhKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjhhhjhKubah}(h]jah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjhKhjhhubj< )}(hhh]h)}(h/Represents the serialized metadata for file seth]h/Represents the serialized metadata for file set}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjhhubah}(h]h ]h"]h$]h&]uh1j; hjhhhjhKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jj^ jj_ j` ja uh1j hhhj hjhNubjc )}(hX**Definition**:: struct luo_file_set_ser { u64 files; u64 count; }; **Members** ``files`` The physical address of a contiguous memory block that holds the serialized state of files (array of luo_file_ser) in this file set. ``count`` The total number of files that were part of this session during serialization. Used for iteration and validation during restoration.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj ubh:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjg)}(h:struct luo_file_set_ser { u64 files; u64 count; };h]h:struct luo_file_set_ser { u64 files; u64 count; };}hj(sbah}(h]h ]h"]h$]h&]hhuh1jfh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubh)}(h **Members**h]jm )}(hj9h]hMembers}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj7ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubj7)}(hhh](j<)}(h``files`` The physical address of a contiguous memory block that holds the serialized state of files (array of luo_file_ser) in this file set. h](jB)}(h ``files``h]j])}(hjXh]hfiles}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjVubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjRubjS)}(hhh]h)}(hThe physical address of a contiguous memory block that holds the serialized state of files (array of luo_file_ser) in this file set.h]hThe physical address of a contiguous memory block that holds the serialized state of files (array of luo_file_ser) in this file set.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjnubah}(h]h ]h"]h$]h&]uh1jRhjRubeh}(h]h ]h"]h$]h&]uh1j;hjmhKhjOubj<)}(h``count`` The total number of files that were part of this session during serialization. Used for iteration and validation during restoration.h](jB)}(h ``count``h]j])}(hjh]hcount}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjS)}(hhh]h)}(hThe total number of files that were part of this session during serialization. Used for iteration and validation during restoration.h]hThe total number of files that were part of this session during serialization. Used for iteration and validation during restoration.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjOubeh}(h]h ]h"]h$]h&]uh1j6hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhjhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j !luo_session_header_ser (C struct)c.luo_session_header_serhNtauh1j hj hhhjhNubj )}(hhh](j )}(hluo_session_header_serh]j )}(hstruct luo_session_header_serh](j )}(hj h]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhhjhKubj )}(hluo_session_header_serh]j )}(hjh]hluo_session_header_ser}(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjhhhjhKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjhhhjhKubah}(h]jah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjhKhjhhubj< )}(hhh]h)}(h-Header for the serialized session data block.h]h-Header for the serialized session data block.}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj+hhubah}(h]h ]h"]h$]h&]uh1j; hjhhhjhKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jFj^ jFj_ j` ja uh1j hhhj hjhNubjc )}(h**Definition**:: struct luo_session_header_ser { u64 count; }; **Members** ``count`` The number of `struct luo_session_ser` entries that immediately follow this header in the memory block.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjNubh:}(hjNhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjJubjg)}(h1struct luo_session_header_ser { u64 count; };h]h1struct luo_session_header_ser { u64 count; };}hjksbah}(h]h ]h"]h$]h&]hhuh1jfh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjJubh)}(h **Members**h]jm )}(hj|h]hMembers}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjzubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjJubj7)}(hhh]j<)}(hq``count`` The number of `struct luo_session_ser` entries that immediately follow this header in the memory block.h](jB)}(h ``count``h]j])}(hjh]hcount}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjS)}(hhh]h)}(hgThe number of `struct luo_session_ser` entries that immediately follow this header in the memory block.h](hThe number of }(hjhhhNhNubj)}(h`struct luo_session_ser`h]hstruct luo_session_ser}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhA entries that immediately follow this header in the memory block.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjubah}(h]h ]h"]h$]h&]uh1j6hjJubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhjhNubh)}(h**Description**h]jm )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hThis structure is located at the beginning of a contiguous block of physical memory preserved across the kexec. It provides the necessary metadata to interpret the array of session entries that follow.h]hThis structure is located at the beginning of a contiguous block of physical memory preserved across the kexec. It provides the necessary metadata to interpret the array of session entries that follow.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hLIf this structure is modified, `LUO_FDT_SESSION_COMPATIBLE` must be updated.h](hIf this structure is modified, }(hjhhhNhNubj)}(h`LUO_FDT_SESSION_COMPATIBLE`h]hLUO_FDT_SESSION_COMPATIBLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh must be updated.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_session_ser (C struct)c.luo_session_serhNtauh1j hj hhhjhNubj )}(hhh](j )}(hluo_session_serh]j )}(hstruct luo_session_serh](j )}(hj h]hstruct}(hjNhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjJhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj )}(h h]h }(hj\hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjJhhhj[hKubj )}(hluo_session_serh]j )}(hjHh]hluo_session_ser}(hjnhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjjubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjJhhhj[hKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjFhhhj[hKubah}(h]jAah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj[hKhjChhubj< )}(hhh]h)}(h5Represents the serialized metadata for a LUO session.h]h5Represents the serialized metadata for a LUO session.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjhhubah}(h]h ]h"]h$]h&]uh1j; hjChhhj[hKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jj^ jj_ j` ja uh1j hhhj hjhNubjc )}(hXD**Definition**:: struct luo_session_ser { char name[LIVEUPDATE_SESSION_NAME_LENGTH]; struct luo_file_set_ser file_set_ser; }; **Members** ``name`` The unique name of the session, provided by the userspace at the time of session creation. ``file_set_ser`` Serialized files belonging to this session,h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjg)}(htstruct luo_session_ser { char name[LIVEUPDATE_SESSION_NAME_LENGTH]; struct luo_file_set_ser file_set_ser; };h]htstruct luo_session_ser { char name[LIVEUPDATE_SESSION_NAME_LENGTH]; struct luo_file_set_ser file_set_ser; };}hjsbah}(h]h ]h"]h$]h&]hhuh1jfh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubh)}(h **Members**h]jm )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubj7)}(hhh](j<)}(hd``name`` The unique name of the session, provided by the userspace at the time of session creation. h](jB)}(h``name``h]j])}(hjh]hname}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjS)}(hhh]h)}(hZThe unique name of the session, provided by the userspace at the time of session creation.h]hZThe unique name of the session, provided by the userspace at the time of session creation.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjubj<)}(h<``file_set_ser`` Serialized files belonging to this session,h](jB)}(h``file_set_ser``h]j])}(hj7h]h file_set_ser}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj5ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj1ubjS)}(hhh]h)}(h+Serialized files belonging to this session,h]h+Serialized files belonging to this session,}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjMubah}(h]h ]h"]h$]h&]uh1jRhj1ubeh}(h]h ]h"]h$]h&]uh1j;hjLhKhjubeh}(h]h ]h"]h$]h&]uh1j6hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhjhNubh)}(h**Description**h]jm )}(hjzh]h Description}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjxubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hThis structure is used to package session-specific metadata for transfer between kernels via Kexec Handover. An array of these structures (one per session) is created and passed to the new kernel, allowing it to reconstruct the session context.h]hThis structure is used to package session-specific metadata for transfer between kernels via Kexec Handover. An array of these structures (one per session) is created and passed to the new kernel, allowing it to reconstruct the session context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hLIf this structure is modified, `LUO_FDT_SESSION_COMPATIBLE` must be updated.h](hIf this structure is modified, }(hjhhhNhNubj)}(h`LUO_FDT_SESSION_COMPATIBLE`h]hLUO_FDT_SESSION_COMPATIBLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh must be updated.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_flb_header_ser (C struct)c.luo_flb_header_serhNtauh1j hj hhhjhNubj )}(hhh](j )}(hluo_flb_header_serh]j )}(hstruct luo_flb_header_serh](j )}(hj h]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhhjhKubj )}(hluo_flb_header_serh]j )}(hjh]hluo_flb_header_ser}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjhhhjhKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjhhhjhKubah}(h]jah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjhKhjhhubj< )}(hhh]h)}(h)Header for the serialized FLB data block.h]h)Header for the serialized FLB data block.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjhhubah}(h]h ]h"]h$]h&]uh1j; hjhhhjhKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] j3j^ j3j_ j` ja uh1j hhhj hjhNubjc )}(hX**Definition**:: struct luo_flb_header_ser { u64 pgcnt; u64 count; }; **Members** ``pgcnt`` The total number of pages occupied by the entire preserved memory region, including this header and the subsequent array of :c:type:`struct luo_flb_ser ` entries. ``count`` The number of :c:type:`struct luo_flb_ser ` entries that follow this header in the memory block.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj;ubh:}(hj;hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj7ubjg)}(h` entries. h](jB)}(h ``pgcnt``h]j])}(hjh]hpgcnt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjS)}(hhh]h)}(hThe total number of pages occupied by the entire preserved memory region, including this header and the subsequent array of :c:type:`struct luo_flb_ser ` entries.h](h|The total number of pages occupied by the entire preserved memory region, including this header and the subsequent array of }(hjhhhNhNubh)}(h*:c:type:`struct luo_flb_ser `h]j])}(hjh]hstruct luo_flb_ser}(hjhhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnjRjVj{ luo_flb_seruh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubh entries.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjubj<)}(hw``count`` The number of :c:type:`struct luo_flb_ser ` entries that follow this header in the memory block.h](jB)}(h ``count``h]j])}(hjh]hcount}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjS)}(hhh]h)}(hmThe number of :c:type:`struct luo_flb_ser ` entries that follow this header in the memory block.h](hThe number of }(hjhhhNhNubh)}(h*:c:type:`struct luo_flb_ser `h]j])}(hjh]hstruct luo_flb_ser}(hj hhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnjRjVj{ luo_flb_seruh1hhjhKhjubh5 entries that follow this header in the memory block.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjubeh}(h]h ]h"]h$]h&]uh1j6hj7ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhjhNubh)}(h**Description**h]jm )}(hjJh]h Description}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjHubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hXThis structure is located at the physical address specified by the `LUO_FDT_FLB_HEADER` FDT property. It provides the new kernel with the necessary information to find and iterate over the array of preserved File-Lifecycle-Bound objects and to manage the underlying memory.h](hCThis structure is located at the physical address specified by the }(hj`hhhNhNubj)}(h`LUO_FDT_FLB_HEADER`h]hLUO_FDT_FLB_HEADER}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubh FDT property. It provides the new kernel with the necessary information to find and iterate over the array of preserved File-Lifecycle-Bound objects and to manage the underlying memory.}(hj`hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hFIf this structure is modified, LUO_FDT_FLB_COMPATIBLE must be updated.h]hFIf this structure is modified, LUO_FDT_FLB_COMPATIBLE must be updated.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_flb_ser (C struct) c.luo_flb_serhNtauh1j hj hhhjhNubj )}(hhh](j )}(h luo_flb_serh]j )}(hstruct luo_flb_serh](j )}(hj h]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjhhhjhKubj )}(h luo_flb_serh]j )}(hjh]h luo_flb_ser}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjhhhjhKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjhhhjhKubah}(h]jah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjhKhjhhubj< )}(hhh]h)}(h7Represents the serialized state of a single FLB object.h]h7Represents the serialized state of a single FLB object.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjhhubah}(h]h ]h"]h$]h&]uh1j; hjhhhjhKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] jj^ jj_ j` ja uh1j hhhj hjhNubjc )}(hX**Definition**:: struct luo_flb_ser { char name[LIVEUPDATE_FLB_COMPAT_LENGTH]; u64 data; u64 count; }; **Members** ``name`` The unique compatibility string of the FLB object, used to find the corresponding :c:type:`struct liveupdate_flb ` handler in the new kernel. ``data`` The opaque u64 handle returned by the FLB's .preserve() operation in the old kernel. This handle encapsulates the entire state needed for restoration. ``count`` The reference count at the time of serialization; i.e., the number of preserved files that depended on this FLB. This is used by the new kernel to correctly manage the FLB's lifecycle.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj ubh:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjg)}(hastruct luo_flb_ser { char name[LIVEUPDATE_FLB_COMPAT_LENGTH]; u64 data; u64 count; };h]hastruct luo_flb_ser { char name[LIVEUPDATE_FLB_COMPAT_LENGTH]; u64 data; u64 count; };}hj(sbah}(h]h ]h"]h$]h&]hhuh1jfh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubh)}(h **Members**h]jm )}(hj9h]hMembers}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj7ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubj7)}(hhh](j<)}(h``name`` The unique compatibility string of the FLB object, used to find the corresponding :c:type:`struct liveupdate_flb ` handler in the new kernel. h](jB)}(h``name``h]j])}(hjXh]hname}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjVubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjRubjS)}(hhh]h)}(hThe unique compatibility string of the FLB object, used to find the corresponding :c:type:`struct liveupdate_flb ` handler in the new kernel.h](hRThe unique compatibility string of the FLB object, used to find the corresponding }(hjqhhhNhNubh)}(h0:c:type:`struct liveupdate_flb `h]j])}(hj{h]hstruct liveupdate_flb}(hj}hhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjyubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnjRjVj{liveupdate_flbuh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjqubh handler in the new kernel.}(hjqhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjnubah}(h]h ]h"]h$]h&]uh1jRhjRubeh}(h]h ]h"]h$]h&]uh1j;hjmhKhjOubj<)}(h``data`` The opaque u64 handle returned by the FLB's .preserve() operation in the old kernel. This handle encapsulates the entire state needed for restoration. h](jB)}(h``data``h]j])}(hjh]hdata}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjS)}(hhh]h)}(hThe opaque u64 handle returned by the FLB's .preserve() operation in the old kernel. This handle encapsulates the entire state needed for restoration.h]hThe opaque u64 handle returned by the FLB’s .preserve() operation in the old kernel. This handle encapsulates the entire state needed for restoration.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hjhKhjOubj<)}(h``count`` The reference count at the time of serialization; i.e., the number of preserved files that depended on this FLB. This is used by the new kernel to correctly manage the FLB's lifecycle.h](jB)}(h ``count``h]j])}(hjh]hcount}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubjS)}(hhh]h)}(hThe reference count at the time of serialization; i.e., the number of preserved files that depended on this FLB. This is used by the new kernel to correctly manage the FLB's lifecycle.h]hThe reference count at the time of serialization; i.e., the number of preserved files that depended on this FLB. This is used by the new kernel to correctly manage the FLB’s lifecycle.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj ubah}(h]h ]h"]h$]h&]uh1jRhjubeh}(h]h ]h"]h$]h&]uh1j;hj hKhjOubeh}(h]h ]h"]h$]h&]uh1j6hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hj hhhjhNubh)}(h**Description**h]jm )}(hj2 h]h Description}(hj4 hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj0 ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hAn array of these structures is created in a preserved memory region and passed to the new kernel. Each entry allows the LUO core to restore one global, shared object.h]hAn array of these structures is created in a preserved memory region and passed to the new kernel. Each entry allows the LUO core to restore one global, shared object.}(hjH hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubh)}(hFIf this structure is modified, LUO_FDT_FLB_COMPATIBLE must be updated.h]hFIf this structure is modified, LUO_FDT_FLB_COMPATIBLE must be updated.}(hjW hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj hhubeh}(h] public-apiah ]h"] public apiah$]h&]uh1hhhhhhhhK'ubh)}(hhh](h)}(h Internal APIh]h Internal API}(hjq hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjn hhhhhK7ubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j liveupdate_reboot (C function)c.liveupdate_reboothNtauh1j hjn hhhNhNubj )}(hhh](j )}(hint liveupdate_reboot (void)h]j )}(hint liveupdate_reboot(void)h](hdesc_sig_keyword_type)}(hinth]hint}(hj hhhNhNubah}(h]h ]ktah"]h$]h&]uh1j hj hhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKubj )}(h h]h }(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj hhhj hKubj )}(hliveupdate_rebooth]j )}(hliveupdate_rebooth]hliveupdate_reboot}(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj hhhj hKubhdesc_parameterlist)}(h(void)h]hdesc_parameter)}(hvoidh]j )}(hvoidh]hvoid}(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj ubah}(h]h ]h"]h$]h&]noemphhhuh1j hj ubah}(h]h ]h"]h$]h&]hhuh1j hj hhhj hKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj hhhj hKubah}(h]j ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj hKhj hhubj< )}(hhh]h)}(h;Kernel reboot notifier for live update final serialization.h]h;Kernel reboot notifier for live update final serialization.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj!hhubah}(h]h ]h"]h$]h&]uh1j; hj hhhj hKubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j!j^ j!j_ j` ja uh1j hhhjn hNhNubjc )}(h**Parameters** ``void`` no arguments **Description** This function is invoked directly from the reboot() syscall pathway if kexec is in progress. If any callback fails, this function aborts KHO, undoes the freeze() callbacks, and returns an error.h](h)}(h**Parameters**h]jm )}(hj(!h]h Parameters}(hj*!hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj&!ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj"!ubj7)}(hhh]j<)}(h``void`` no arguments h](jB)}(h``void``h]j])}(hjG!h]hvoid}(hjI!hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjE!ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhjA!ubjS)}(hhh]h)}(h no argumentsh]h no arguments}(hj`!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\!hKhj]!ubah}(h]h ]h"]h$]h&]uh1jRhjA!ubeh}(h]h ]h"]h$]h&]uh1j;hj\!hKhj>!ubah}(h]h ]h"]h$]h&]uh1j6hj"!ubh)}(h**Description**h]jm )}(hj!h]h Description}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj!ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj"!ubh)}(h\This function is invoked directly from the reboot() syscall pathway if kexec is in progress.h]h\This function is invoked directly from the reboot() syscall pathway if kexec is in progress.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj"!ubh)}(heIf any callback fails, this function aborts KHO, undoes the freeze() callbacks, and returns an error.h]heIf any callback fails, this function aborts KHO, undoes the freeze() callbacks, and returns an error.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj"!ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j liveupdate_enabled (C function)c.liveupdate_enabledhNtauh1j hjn hhhNhNubj )}(hhh](j )}(hbool liveupdate_enabled (void)h]j )}(hbool liveupdate_enabled(void)h](j )}(hboolh]hbool}(hj!hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj!hhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKubj )}(h h]h }(hj!hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj!hhhj!hKubj )}(hliveupdate_enabledh]j )}(hliveupdate_enabledh]hliveupdate_enabled}(hj!hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj!ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj!hhhj!hKubj )}(h(void)h]j )}(hvoidh]j )}(hvoidh]hvoid}(hj"hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj"ubah}(h]h ]h"]h$]h&]noemphhhuh1j hj "ubah}(h]h ]h"]h$]h&]hhuh1j hj!hhhj!hKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj!hhhj!hKubah}(h]j!ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj!hKhj!hhubj< )}(hhh]h)}(h,Check if the live update feature is enabled.h]h,Check if the live update feature is enabled.}(hj="hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj:"hhubah}(h]h ]h"]h$]h&]uh1j; hj!hhhj!hKubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] jU"j^ jU"j_ j` ja uh1j hhhjn hNhNubjc )}(hX**Parameters** ``void`` no arguments **Description** This function returns the state of the live update feature flag, which can be controlled via the ``liveupdate`` kernel command-line parameter. **return** true if live update is enabled, false otherwise.h](h)}(h**Parameters**h]jm )}(hj_"h]h Parameters}(hja"hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj]"ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhjY"ubj7)}(hhh]j<)}(h``void`` no arguments h](jB)}(h``void``h]j])}(hj~"h]hvoid}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj|"ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhjx"ubjS)}(hhh]h)}(h no argumentsh]h no arguments}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hKhj"ubah}(h]h ]h"]h$]h&]uh1jRhjx"ubeh}(h]h ]h"]h$]h&]uh1j;hj"hKhju"ubah}(h]h ]h"]h$]h&]uh1j6hjY"ubh)}(h**Description**h]jm )}(hj"h]h Description}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj"ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhjY"ubh)}(hThis function returns the state of the live update feature flag, which can be controlled via the ``liveupdate`` kernel command-line parameter.h](haThis function returns the state of the live update feature flag, which can be controlled via the }(hj"hhhNhNubj])}(h``liveupdate``h]h liveupdate}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj"ubh kernel command-line parameter.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhjY"ubh)}(h;**return** true if live update is enabled, false otherwise.h](jm )}(h **return**h]hreturn}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj"ubh1 true if live update is enabled, false otherwise.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhjY"ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j "luo_flb_file_preserve (C function)c.luo_flb_file_preservehNtauh1j hjn hhhNhNubj )}(hhh](j )}(h>int luo_flb_file_preserve (struct liveupdate_file_handler *fh)h]j )}(h=int luo_flb_file_preserve(struct liveupdate_file_handler *fh)h](j )}(hinth]hint}(hj-#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj)#hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKubj )}(h h]h }(hj<#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj)#hhhj;#hKubj )}(hluo_flb_file_preserveh]j )}(hluo_flb_file_preserveh]hluo_flb_file_preserve}(hjN#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjJ#ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj)#hhhj;#hKubj )}(h$(struct liveupdate_file_handler *fh)h]j )}(h"struct liveupdate_file_handler *fhh](j )}(hj h]hstruct}(hjj#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjf#ubj )}(h h]h }(hjw#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjf#ubh)}(hhh]j )}(hliveupdate_file_handlerh]hliveupdate_file_handler}(hj#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj#ubah}(h]h ]h"]h$]h&] refdomainjireftype identifier reftargetj#modnameN classnameNjRjU)}jX]jS ASTIdentifier)}j#jP#sbc.luo_flb_file_preserveasbuh1hhjf#ubj )}(h h]h }(hj#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjf#ubhdesc_sig_punctuation)}(h*h]h*}(hj#hhhNhNubah}(h]h ]pah"]h$]h&]uh1j#hjf#ubj )}(hfhh]hfh}(hj#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjf#ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hjb#ubah}(h]h ]h"]h$]h&]hhuh1j hj)#hhhj;#hKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj%#hhhj;#hKubah}(h]j #ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj;#hKhj"#hhubj< )}(hhh]h)}(h3Notifies FLBs that a file is about to be preserved.h]h3Notifies FLBs that a file is about to be preserved.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj#hhubah}(h]h ]h"]h$]h&]uh1j; hj"#hhhj;#hKubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j $j^ j $j_ j` ja uh1j hhhjn hNhNubjc )}(hXa**Parameters** ``struct liveupdate_file_handler *fh`` The file handler for the preserved file. **Description** This function iterates through all FLBs associated with the given file handler. It increments the reference count for each FLB. If the count becomes 1, it triggers the FLB's .preserve() callback to save the global state. This operation is atomic. If any FLB's .preserve() op fails, it will roll back by calling .unpreserve() on any FLBs that were successfully preserved during this call. **Context** Called from luo_preserve_file() **Return** 0 on success, or a negative errno on failure.h](h)}(h**Parameters**h]jm )}(hj$h]h Parameters}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj$ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubj7)}(hhh]j<)}(hP``struct liveupdate_file_handler *fh`` The file handler for the preserved file. h](jB)}(h&``struct liveupdate_file_handler *fh``h]j])}(hj5$h]h"struct liveupdate_file_handler *fh}(hj7$hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj3$ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj/$ubjS)}(hhh]h)}(h(The file handler for the preserved file.h]h(The file handler for the preserved file.}(hjN$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJ$hKhjK$ubah}(h]h ]h"]h$]h&]uh1jRhj/$ubeh}(h]h ]h"]h$]h&]uh1j;hjJ$hKhj,$ubah}(h]h ]h"]h$]h&]uh1j6hj$ubh)}(h**Description**h]jm )}(hjp$h]h Description}(hjr$hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjn$ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubh)}(hThis function iterates through all FLBs associated with the given file handler. It increments the reference count for each FLB. If the count becomes 1, it triggers the FLB's .preserve() callback to save the global state.h]hThis function iterates through all FLBs associated with the given file handler. It increments the reference count for each FLB. If the count becomes 1, it triggers the FLB’s .preserve() callback to save the global state.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubh)}(hThis operation is atomic. If any FLB's .preserve() op fails, it will roll back by calling .unpreserve() on any FLBs that were successfully preserved during this call.h]hThis operation is atomic. If any FLB’s .preserve() op fails, it will roll back by calling .unpreserve() on any FLBs that were successfully preserved during this call.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubh)}(h **Context**h]jm )}(hj$h]hContext}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj$ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubh)}(hCalled from luo_preserve_file()h]hCalled from luo_preserve_file()}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubh)}(h **Return**h]jm )}(hj$h]hReturn}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj$ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubh)}(h-0 on success, or a negative errno on failure.h]h-0 on success, or a negative errno on failure.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj$ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j $luo_flb_file_unpreserve (C function)c.luo_flb_file_unpreservehNtauh1j hjn hhhNhNubj )}(hhh](j )}(hAvoid luo_flb_file_unpreserve (struct liveupdate_file_handler *fh)h]j )}(h@void luo_flb_file_unpreserve(struct liveupdate_file_handler *fh)h](j )}(hvoidh]hvoid}(hj%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj%hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMubj )}(h h]h }(hj!%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj%hhhj %hMubj )}(hluo_flb_file_unpreserveh]j )}(hluo_flb_file_unpreserveh]hluo_flb_file_unpreserve}(hj3%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj/%ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj%hhhj %hMubj )}(h$(struct liveupdate_file_handler *fh)h]j )}(h"struct liveupdate_file_handler *fhh](j )}(hj h]hstruct}(hjO%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjK%ubj )}(h h]h }(hj\%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjK%ubh)}(hhh]j )}(hliveupdate_file_handlerh]hliveupdate_file_handler}(hjm%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjj%ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetjo%modnameN classnameNjRjU)}jX]j#)}j#j5%sbc.luo_flb_file_unpreserveasbuh1hhjK%ubj )}(h h]h }(hj%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjK%ubj#)}(hj#h]h*}(hj%hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjK%ubj )}(hfhh]hfh}(hj%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjK%ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hjG%ubah}(h]h ]h"]h$]h&]hhuh1j hj%hhhj %hMubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj %hhhj %hMubah}(h]j%ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj %hMhj%hhubj< )}(hhh]h)}(h4Notifies FLBs that a dependent file was unpreserved.h]h4Notifies FLBs that a dependent file was unpreserved.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj%hhubah}(h]h ]h"]h$]h&]uh1j; hj%hhhj %hMubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j%j^ j%j_ j` ja uh1j hhhjn hNhNubjc )}(hX**Parameters** ``struct liveupdate_file_handler *fh`` The file handler for the unpreserved file. **Description** This function iterates through all FLBs associated with the given file handler, in reverse order of registration. It decrements the reference count for each FLB. If the count becomes 0, it triggers the FLB's .unpreserve() callback to clean up the global state. **Context** Called when a preserved file is being cleaned up before reboot (e.g., from luo_file_unpreserve_files()).h](h)}(h**Parameters**h]jm )}(hj%h]h Parameters}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj%ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj%ubj7)}(hhh]j<)}(hR``struct liveupdate_file_handler *fh`` The file handler for the unpreserved file. h](jB)}(h&``struct liveupdate_file_handler *fh``h]j])}(hj&h]h"struct liveupdate_file_handler *fh}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj&ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj &ubjS)}(hhh]h)}(h*The file handler for the unpreserved file.h]h*The file handler for the unpreserved file.}(hj,&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(&hMhj)&ubah}(h]h ]h"]h$]h&]uh1jRhj &ubeh}(h]h ]h"]h$]h&]uh1j;hj(&hMhj &ubah}(h]h ]h"]h$]h&]uh1j6hj%ubh)}(h**Description**h]jm )}(hjN&h]h Description}(hjP&hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjL&ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj%ubh)}(hXThis function iterates through all FLBs associated with the given file handler, in reverse order of registration. It decrements the reference count for each FLB. If the count becomes 0, it triggers the FLB's .unpreserve() callback to clean up the global state.h]hXThis function iterates through all FLBs associated with the given file handler, in reverse order of registration. It decrements the reference count for each FLB. If the count becomes 0, it triggers the FLB’s .unpreserve() callback to clean up the global state.}(hjd&hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj%ubh)}(h **Context**h]jm )}(hju&h]hContext}(hjw&hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjs&ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM hj%ubh)}(hhCalled when a preserved file is being cleaned up before reboot (e.g., from luo_file_unpreserve_files()).h]hhCalled when a preserved file is being cleaned up before reboot (e.g., from luo_file_unpreserve_files()).}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM hj%ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_flb_file_finish (C function)c.luo_flb_file_finishhNtauh1j hjn hhhNhNubj )}(hhh](j )}(h=void luo_flb_file_finish (struct liveupdate_file_handler *fh)h]j )}(hAssociate an FLB with a file handler and register it globally.h]h>Associate an FLB with a file handler and register it globally.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM,hj)hhubah}(h]h ]h"]h$]h&]uh1j; hjW(hhhjp(hM,ubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j)j^ j)j_ j` ja uh1j hhhjn hNhNubjc )}(hX7**Parameters** ``struct liveupdate_file_handler *fh`` The file handler that will now depend on the FLB. ``struct liveupdate_flb *flb`` The File-Lifecycle-Bound object to associate. **Description** Establishes a dependency, informing the LUO core that whenever a file of type **fh** is preserved, the state of **flb** must also be managed. On the first registration of a given **flb** object, it is added to a global registry. This function checks for duplicate registrations, both for a specific handler and globally, and ensures the total number of unique FLBs does not exceed the system limit. **Context** Typically called from a subsystem's module init function after both the handler and the FLB have been defined and initialized. **Return** 0 on success. Returns a negative errno on failure: -EINVAL if arguments are NULL or not initialized. -ENOMEM on memory allocation failure. -EEXIST if this FLB is already registered with this handler. -ENOSPC if the maximum number of global FLBs has been reached. -EOPNOTSUPP if live update is disabled or not configured.h](h)}(h**Parameters**h]jm )}(hj)h]h Parameters}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj)ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM0hj)ubj7)}(hhh](j<)}(hY``struct liveupdate_file_handler *fh`` The file handler that will now depend on the FLB. h](jB)}(h&``struct liveupdate_file_handler *fh``h]j])}(hj)h]h"struct liveupdate_file_handler *fh}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj)ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM-hj)ubjS)}(hhh]h)}(h1The file handler that will now depend on the FLB.h]h1The file handler that will now depend on the FLB.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hM-hj)ubah}(h]h ]h"]h$]h&]uh1jRhj)ubeh}(h]h ]h"]h$]h&]uh1j;hj)hM-hj)ubj<)}(hM``struct liveupdate_flb *flb`` The File-Lifecycle-Bound object to associate. h](jB)}(h``struct liveupdate_flb *flb``h]j])}(hj *h]hstruct liveupdate_flb *flb}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj *ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM.hj*ubjS)}(hhh]h)}(h-The File-Lifecycle-Bound object to associate.h]h-The File-Lifecycle-Bound object to associate.}(hj%*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!*hM.hj"*ubah}(h]h ]h"]h$]h&]uh1jRhj*ubeh}(h]h ]h"]h$]h&]uh1j;hj!*hM.hj)ubeh}(h]h ]h"]h$]h&]uh1j6hj)ubh)}(h**Description**h]jm )}(hjG*h]h Description}(hjI*hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjE*ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM0hj)ubh)}(hEstablishes a dependency, informing the LUO core that whenever a file of type **fh** is preserved, the state of **flb** must also be managed.h](hNEstablishes a dependency, informing the LUO core that whenever a file of type }(hj]*hhhNhNubjm )}(h**fh**h]hfh}(hje*hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj]*ubh is preserved, the state of }(hj]*hhhNhNubjm )}(h**flb**h]hflb}(hjw*hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj]*ubh must also be managed.}(hj]*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM/hj)ubh)}(hXOn the first registration of a given **flb** object, it is added to a global registry. This function checks for duplicate registrations, both for a specific handler and globally, and ensures the total number of unique FLBs does not exceed the system limit.h](h%On the first registration of a given }(hj*hhhNhNubjm )}(h**flb**h]hflb}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj*ubh object, it is added to a global registry. This function checks for duplicate registrations, both for a specific handler and globally, and ensures the total number of unique FLBs does not exceed the system limit.}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM2hj)ubh)}(h **Context**h]jm )}(hj*h]hContext}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj*ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM7hj)ubh)}(h~Typically called from a subsystem's module init function after both the handler and the FLB have been defined and initialized.h]hTypically called from a subsystem’s module init function after both the handler and the FLB have been defined and initialized.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM8hj)ubh)}(h **Return**h]jm )}(hj*h]hReturn}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj*ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM;hj)ubh)}(hX@0 on success. Returns a negative errno on failure: -EINVAL if arguments are NULL or not initialized. -ENOMEM on memory allocation failure. -EEXIST if this FLB is already registered with this handler. -ENOSPC if the maximum number of global FLBs has been reached. -EOPNOTSUPP if live update is disabled or not configured.h]hX@0 on success. Returns a negative errno on failure: -EINVAL if arguments are NULL or not initialized. -ENOMEM on memory allocation failure. -EEXIST if this FLB is already registered with this handler. -ENOSPC if the maximum number of global FLBs has been reached. -EOPNOTSUPP if live update is disabled or not configured.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM:hj)ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j &liveupdate_unregister_flb (C function)c.liveupdate_unregister_flbhNtauh1j hjn hhhNhNubj )}(hhh](j )}(h^int liveupdate_unregister_flb (struct liveupdate_file_handler *fh, struct liveupdate_flb *flb)h]j )}(h]int liveupdate_unregister_flb(struct liveupdate_file_handler *fh, struct liveupdate_flb *flb)h](j )}(hinth]hint}(hj+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj+hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMubj )}(h h]h }(hj.+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj+hhhj-+hMubj )}(hliveupdate_unregister_flbh]j )}(hliveupdate_unregister_flbh]hliveupdate_unregister_flb}(hj@+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj<+ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj+hhhj-+hMubj )}(h@(struct liveupdate_file_handler *fh, struct liveupdate_flb *flb)h](j )}(h"struct liveupdate_file_handler *fhh](j )}(hj h]hstruct}(hj\+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjX+ubj )}(h h]h }(hji+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjX+ubh)}(hhh]j )}(hliveupdate_file_handlerh]hliveupdate_file_handler}(hjz+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjw+ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetj|+modnameN classnameNjRjU)}jX]j#)}j#jB+sbc.liveupdate_unregister_flbasbuh1hhjX+ubj )}(h h]h }(hj+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjX+ubj#)}(hj#h]h*}(hj+hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjX+ubj )}(hfhh]hfh}(hj+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjX+ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hjT+ubj )}(hstruct liveupdate_flb *flbh](j )}(hj h]hstruct}(hj+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj+ubj )}(h h]h }(hj+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj+ubh)}(hhh]j )}(hliveupdate_flbh]hliveupdate_flb}(hj+hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj+ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetj+modnameN classnameNjRjU)}jX]j+c.liveupdate_unregister_flbasbuh1hhj+ubj )}(h h]h }(hj ,hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj+ubj#)}(hj#h]h*}(hj,hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hj+ubj )}(hflbh]hflb}(hj%,hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj+ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hjT+ubeh}(h]h ]h"]h$]h&]hhuh1j hj+hhhj-+hMubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj+hhhj-+hMubah}(h]j+ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj-+hMhj+hhubj< )}(hhh]h)}(h-Remove an FLB dependency from a file handler.h]h-Remove an FLB dependency from a file handler.}(hjO,hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjL,hhubah}(h]h ]h"]h$]h&]uh1j; hj+hhhj-+hMubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] jg,j^ jg,j_ j` ja uh1j hhhjn hNhNubjc )}(hX**Parameters** ``struct liveupdate_file_handler *fh`` The file handler that is currently depending on the FLB. ``struct liveupdate_flb *flb`` The File-Lifecycle-Bound object to remove. **Description** Removes the association between the specified file handler and the FLB previously established by liveupdate_register_flb(). This function manages the global lifecycle of the FLB. It decrements the FLB's usage count. If this was the last file handler referencing this FLB, the FLB is removed from the global registry and the reference to its owner module (acquired during registration) is released. **Context** This function ensures the session is quiesced (no active FDs being created) during the update. It is typically called from a subsystem's module exit function. **Return** 0 on success. -EOPNOTSUPP if live update is disabled. -EBUSY if the live update session is active and cannot be quiesced. -ENOENT if the FLB was not found in the file handler's list.h](h)}(h**Parameters**h]jm )}(hjq,h]h Parameters}(hjs,hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjo,ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubj7)}(hhh](j<)}(h```struct liveupdate_file_handler *fh`` The file handler that is currently depending on the FLB. h](jB)}(h&``struct liveupdate_file_handler *fh``h]j])}(hj,h]h"struct liveupdate_file_handler *fh}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj,ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj,ubjS)}(hhh]h)}(h8The file handler that is currently depending on the FLB.h]h8The file handler that is currently depending on the FLB.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMhj,ubah}(h]h ]h"]h$]h&]uh1jRhj,ubeh}(h]h ]h"]h$]h&]uh1j;hj,hMhj,ubj<)}(hJ``struct liveupdate_flb *flb`` The File-Lifecycle-Bound object to remove. h](jB)}(h``struct liveupdate_flb *flb``h]j])}(hj,h]hstruct liveupdate_flb *flb}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj,ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj,ubjS)}(hhh]h)}(h*The File-Lifecycle-Bound object to remove.h]h*The File-Lifecycle-Bound object to remove.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMhj,ubah}(h]h ]h"]h$]h&]uh1jRhj,ubeh}(h]h ]h"]h$]h&]uh1j;hj,hMhj,ubeh}(h]h ]h"]h$]h&]uh1j6hjk,ubh)}(h**Description**h]jm )}(hj-h]h Description}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj-ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubh)}(h{Removes the association between the specified file handler and the FLB previously established by liveupdate_register_flb().h]h{Removes the association between the specified file handler and the FLB previously established by liveupdate_register_flb().}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubh)}(hXThis function manages the global lifecycle of the FLB. It decrements the FLB's usage count. If this was the last file handler referencing this FLB, the FLB is removed from the global registry and the reference to its owner module (acquired during registration) is released.h]hXThis function manages the global lifecycle of the FLB. It decrements the FLB’s usage count. If this was the last file handler referencing this FLB, the FLB is removed from the global registry and the reference to its owner module (acquired during registration) is released.}(hj)-hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubh)}(h **Context**h]jm )}(hj:-h]hContext}(hj<-hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj8-ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubh)}(hThis function ensures the session is quiesced (no active FDs being created) during the update. It is typically called from a subsystem's module exit function.h]hThis function ensures the session is quiesced (no active FDs being created) during the update. It is typically called from a subsystem’s module exit function.}(hjP-hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubh)}(h **Return**h]jm )}(hja-h]hReturn}(hjc-hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj_-ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubh)}(h0 on success. -EOPNOTSUPP if live update is disabled. -EBUSY if the live update session is active and cannot be quiesced. -ENOENT if the FLB was not found in the file handler's list.h]h0 on success. -EOPNOTSUPP if live update is disabled. -EBUSY if the live update session is active and cannot be quiesced. -ENOENT if the FLB was not found in the file handler’s list.}(hjw-hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjk,ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j (liveupdate_flb_get_incoming (C function)c.liveupdate_flb_get_incominghNtauh1j hjn hhhNhNubj )}(hhh](j )}(hIint liveupdate_flb_get_incoming (struct liveupdate_flb *flb, void **objp)h]j )}(hHint liveupdate_flb_get_incoming(struct liveupdate_flb *flb, void **objp)h](j )}(hinth]hint}(hj-hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMubj )}(h h]h }(hj-hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-hhhj-hMubj )}(hliveupdate_flb_get_incomingh]j )}(hliveupdate_flb_get_incomingh]hliveupdate_flb_get_incoming}(hj-hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj-hhhj-hMubj )}(h)(struct liveupdate_flb *flb, void **objp)h](j )}(hstruct liveupdate_flb *flbh](j )}(hj h]hstruct}(hj-hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-ubj )}(h h]h }(hj-hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-ubh)}(hhh]j )}(hliveupdate_flbh]hliveupdate_flb}(hj.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetj.modnameN classnameNjRjU)}jX]j#)}j#j-sbc.liveupdate_flb_get_incomingasbuh1hhj-ubj )}(h h]h }(hj!.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-ubj#)}(hj#h]h*}(hj/.hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hj-ubj )}(hflbh]hflb}(hj<.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj-ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj-ubj )}(h void **objph](j )}(hvoidh]hvoid}(hjU.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjQ.ubj )}(h h]h }(hjc.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjQ.ubj#)}(hj#h]h*}(hjq.hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjQ.ubj#)}(hj#h]h*}(hj~.hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjQ.ubj )}(hobjph]hobjp}(hj.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjQ.ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj-ubeh}(h]h ]h"]h$]h&]hhuh1j hj-hhhj-hMubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj-hhhj-hMubah}(h]j-ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj-hMhj-hhubj< )}(hhh]h)}(h!Retrieve the incoming FLB object.h]h!Retrieve the incoming FLB object.}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.hhubah}(h]h ]h"]h$]h&]uh1j; hj-hhhj-hMubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j.j^ j.j_ j` ja uh1j hhhjn hNhNubjc )}(hX**Parameters** ``struct liveupdate_flb *flb`` The FLB definition. ``void **objp`` Output parameter; will be populated with the live shared object. **Description** Returns a pointer to its shared live object for the incoming (post-reboot) path. If this is the first time the object is requested in the new kernel, this function will trigger the FLB's .retrieve() callback to reconstruct the object from its preserved state. Subsequent calls will return the same cached object. **Return** 0 on success, or a negative errno on failure. -ENODATA means no incoming FLB data, -ENOENT means specific flb not found in the incoming data, and -EOPNOTSUPP when live update is disabled or not configured.h](h)}(h**Parameters**h]jm )}(hj.h]h Parameters}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj.ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.ubj7)}(hhh](j<)}(h3``struct liveupdate_flb *flb`` The FLB definition. h](jB)}(h``struct liveupdate_flb *flb``h]j])}(hj.h]hstruct liveupdate_flb *flb}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj.ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.ubjS)}(hhh]h)}(hThe FLB definition.h]hThe FLB definition.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj /hMhj /ubah}(h]h ]h"]h$]h&]uh1jRhj.ubeh}(h]h ]h"]h$]h&]uh1j;hj /hMhj.ubj<)}(hQ``void **objp`` Output parameter; will be populated with the live shared object. h](jB)}(h``void **objp``h]j])}(hj//h]h void **objp}(hj1/hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj-/ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj)/ubjS)}(hhh]h)}(h@Output parameter; will be populated with the live shared object.h]h@Output parameter; will be populated with the live shared object.}(hjH/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjD/hMhjE/ubah}(h]h ]h"]h$]h&]uh1jRhj)/ubeh}(h]h ]h"]h$]h&]uh1j;hjD/hMhj.ubeh}(h]h ]h"]h$]h&]uh1j6hj.ubh)}(h**Description**h]jm )}(hjj/h]h Description}(hjl/hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjh/ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.ubh)}(hPReturns a pointer to its shared live object for the incoming (post-reboot) path.h]hPReturns a pointer to its shared live object for the incoming (post-reboot) path.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.ubh)}(hIf this is the first time the object is requested in the new kernel, this function will trigger the FLB's .retrieve() callback to reconstruct the object from its preserved state. Subsequent calls will return the same cached object.h]hIf this is the first time the object is requested in the new kernel, this function will trigger the FLB’s .retrieve() callback to reconstruct the object from its preserved state. Subsequent calls will return the same cached object.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.ubh)}(h **Return**h]jm )}(hj/h]hReturn}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj/ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.ubh)}(h0 on success, or a negative errno on failure. -ENODATA means no incoming FLB data, -ENOENT means specific flb not found in the incoming data, and -EOPNOTSUPP when live update is disabled or not configured.h]h0 on success, or a negative errno on failure. -ENODATA means no incoming FLB data, -ENOENT means specific flb not found in the incoming data, and -EOPNOTSUPP when live update is disabled or not configured.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj.ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j (liveupdate_flb_get_outgoing (C function)c.liveupdate_flb_get_outgoinghNtauh1j hjn hhhNhNubj )}(hhh](j )}(hIint liveupdate_flb_get_outgoing (struct liveupdate_flb *flb, void **objp)h]j )}(hHint liveupdate_flb_get_outgoing(struct liveupdate_flb *flb, void **objp)h](j )}(hinth]hint}(hj/hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj/hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMubj )}(h h]h }(hj/hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj/hhhj/hMubj )}(hliveupdate_flb_get_outgoingh]j )}(hliveupdate_flb_get_outgoingh]hliveupdate_flb_get_outgoing}(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj/hhhj/hMubj )}(h)(struct liveupdate_flb *flb, void **objp)h](j )}(hstruct liveupdate_flb *flbh](j )}(hj h]hstruct}(hj"0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubj )}(h h]h }(hj/0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubh)}(hhh]j )}(hliveupdate_flbh]hliveupdate_flb}(hj@0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=0ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetjB0modnameN classnameNjRjU)}jX]j#)}j#j0sbc.liveupdate_flb_get_outgoingasbuh1hhj0ubj )}(h h]h }(hj`0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubj#)}(hj#h]h*}(hjn0hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hj0ubj )}(hflbh]hflb}(hj{0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj0ubj )}(h void **objph](j )}(hvoidh]hvoid}(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubj )}(h h]h }(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubj#)}(hj#h]h*}(hj0hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hj0ubj#)}(hj#h]h*}(hj0hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hj0ubj )}(hobjph]hobjp}(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj0ubeh}(h]h ]h"]h$]h&]hhuh1j hj/hhhj/hMubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj/hhhj/hMubah}(h]j/ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj/hMhj/hhubj< )}(hhh]h)}(h!Retrieve the outgoing FLB object.h]h!Retrieve the outgoing FLB object.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj0hhubah}(h]h ]h"]h$]h&]uh1j; hj/hhhj/hMubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j 1j^ j 1j_ j` ja uh1j hhhjn hNhNubjc )}(hX**Parameters** ``struct liveupdate_flb *flb`` The FLB definition. ``void **objp`` Output parameter; will be populated with the live shared object. **Description** Returns a pointer to its shared live object for the outgoing (pre-reboot) path. This function assumes the object has already been created by the FLB's .preserve() callback, which is triggered when the first dependent file is preserved. **Return** 0 on success, or a negative errno on failure.h](h)}(h**Parameters**h]jm )}(hj1h]h Parameters}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj1ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM hj1ubj7)}(hhh](j<)}(h3``struct liveupdate_flb *flb`` The FLB definition. h](jB)}(h``struct liveupdate_flb *flb``h]j])}(hj51h]hstruct liveupdate_flb *flb}(hj71hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj31ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj/1ubjS)}(hhh]h)}(hThe FLB definition.h]hThe FLB definition.}(hjN1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJ1hMhjK1ubah}(h]h ]h"]h$]h&]uh1jRhj/1ubeh}(h]h ]h"]h$]h&]uh1j;hjJ1hMhj,1ubj<)}(hQ``void **objp`` Output parameter; will be populated with the live shared object. h](jB)}(h``void **objp``h]j])}(hjn1h]h void **objp}(hjp1hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjl1ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjh1ubjS)}(hhh]h)}(h@Output parameter; will be populated with the live shared object.h]h@Output parameter; will be populated with the live shared object.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMhj1ubah}(h]h ]h"]h$]h&]uh1jRhjh1ubeh}(h]h ]h"]h$]h&]uh1j;hj1hMhj,1ubeh}(h]h ]h"]h$]h&]uh1j6hj1ubh)}(h**Description**h]jm )}(hj1h]h Description}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj1ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM hj1ubh)}(hOReturns a pointer to its shared live object for the outgoing (pre-reboot) path.h]hOReturns a pointer to its shared live object for the outgoing (pre-reboot) path.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM hj1ubh)}(hThis function assumes the object has already been created by the FLB's .preserve() callback, which is triggered when the first dependent file is preserved.h]hThis function assumes the object has already been created by the FLB’s .preserve() callback, which is triggered when the first dependent file is preserved.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chM hj1ubh)}(h **Return**h]jm )}(hj1h]hReturn}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj1ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubh)}(h-0 on success, or a negative errno on failure.h]h-0 on success, or a negative errno on failure.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_flb_serialize (C function)c.luo_flb_serializehNtauh1j hjn hhhNhNubj )}(hhh](j )}(hvoid luo_flb_serialize (void)h]j )}(hvoid luo_flb_serialize(void)h](j )}(hvoidh]hvoid}(hj$2hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj 2hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMnubj )}(h h]h }(hj32hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj 2hhhj22hMnubj )}(hluo_flb_serializeh]j )}(hluo_flb_serializeh]hluo_flb_serialize}(hjE2hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjA2ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj 2hhhj22hMnubj )}(h(void)h]j )}(hvoidh]j )}(hvoidh]hvoid}(hja2hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj]2ubah}(h]h ]h"]h$]h&]noemphhhuh1j hjY2ubah}(h]h ]h"]h$]h&]hhuh1j hj 2hhhj22hMnubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj2hhhj22hMnubah}(h]j2ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj22hMnhj2hhubj< )}(hhh]h)}(h*Serializes all active FLB objects for KHO.h]h*Serializes all active FLB objects for KHO.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMnhj2hhubah}(h]h ]h"]h$]h&]uh1j; hj2hhhj22hMnubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j2j^ j2j_ j` ja uh1j hhhjn hNhNubjc )}(hXm**Parameters** ``void`` no arguments **Description** This function is called from the reboot path. It iterates through all registered File-Lifecycle-Bound (FLB) objects. For each FLB that has been preserved (i.e., its reference count is greater than zero), it writes its metadata into the memory region designated for Kexec Handover. The serialized data includes the FLB's compatibility string, its opaque data handle, and the final reference count. This allows the new kernel to find the appropriate handler and reconstruct the FLB's state. **Context** Called from liveupdate_reboot() just before kho_finalize().h](h)}(h**Parameters**h]jm )}(hj2h]h Parameters}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj2ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMrhj2ubj7)}(hhh]j<)}(h``void`` no arguments h](jB)}(h``void``h]j])}(hj2h]hvoid}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj2ubah}(h]h ]h"]h$]h&]uh1jAh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj2ubjS)}(hhh]h)}(h no argumentsh]h no arguments}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hKhj2ubah}(h]h ]h"]h$]h&]uh1jRhj2ubeh}(h]h ]h"]h$]h&]uh1j;hj2hKhj2ubah}(h]h ]h"]h$]h&]uh1j6hj2ubh)}(h**Description**h]jm )}(hj3h]h Description}(hj 3hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj3ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj2ubh)}(hXThis function is called from the reboot path. It iterates through all registered File-Lifecycle-Bound (FLB) objects. For each FLB that has been preserved (i.e., its reference count is greater than zero), it writes its metadata into the memory region designated for Kexec Handover.h]hXThis function is called from the reboot path. It iterates through all registered File-Lifecycle-Bound (FLB) objects. For each FLB that has been preserved (i.e., its reference count is greater than zero), it writes its metadata into the memory region designated for Kexec Handover.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMohj2ubh)}(hThe serialized data includes the FLB's compatibility string, its opaque data handle, and the final reference count. This allows the new kernel to find the appropriate handler and reconstruct the FLB's state.h]hThe serialized data includes the FLB’s compatibility string, its opaque data handle, and the final reference count. This allows the new kernel to find the appropriate handler and reconstruct the FLB’s state.}(hj,3hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMthj2ubh)}(h **Context**h]jm )}(hj=3h]hContext}(hj?3hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj;3ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMxhj2ubh)}(h;Called from liveupdate_reboot() just before kho_finalize().h]h;Called from liveupdate_reboot() just before kho_finalize().}(hjS3hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMyhj2ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_session_header (C struct)c.luo_session_headerhNtauh1j hjn hhhNhNubj )}(hhh](j )}(hluo_session_headerh]j )}(hstruct luo_session_headerh](j )}(hj h]hstruct}(hj3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj~3hhhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKubj )}(h h]h }(hj3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj~3hhhj3hKubj )}(hluo_session_headerh]j )}(hj|3h]hluo_session_header}(hj3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj3ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj~3hhhj3hKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjz3hhhj3hKubah}(h]ju3ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj3hKhjw3hhubj< )}(hhh]h)}(h(Header struct for managing LUO sessions.h]h(Header struct for managing LUO sessions.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKOhj3hhubah}(h]h ]h"]h$]h&]uh1j; hjw3hhhj3hKubeh}(h]h ](jistructeh"]h$]h&]j\ jij] j3j^ j3j_ j` ja uh1j hhhjn hNhNubjc )}(hX**Definition**:: struct luo_session_header { long count; struct list_head list; struct rw_semaphore rwsem; struct luo_session_header_ser *header_ser; struct luo_session_ser *ser; bool active; }; **Members** ``count`` The number of sessions currently tracked in the **list**. ``list`` The head of the linked list of `struct luo_session` instances. ``rwsem`` A read-write semaphore providing synchronized access to the session list and other fields in this structure. ``header_ser`` The header data of serialization array. ``ser`` The serialized session data (an array of `struct luo_session_ser`). ``active`` Set to true when first initialized. If previous kernel did not send session data, active stays false for incoming.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj3ubh:}(hj3hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKShj3ubjg)}(hstruct luo_session_header { long count; struct list_head list; struct rw_semaphore rwsem; struct luo_session_header_ser *header_ser; struct luo_session_ser *ser; bool active; };h]hstruct luo_session_header { long count; struct list_head list; struct rw_semaphore rwsem; struct luo_session_header_ser *header_ser; struct luo_session_ser *ser; bool active; };}hj4sbah}(h]h ]h"]h$]h&]hhuh1jfhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKUhj3ubh)}(h **Members**h]jm )}(hj4h]hMembers}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj4ubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chK^hj3ubj7)}(hhh](j<)}(hD``count`` The number of sessions currently tracked in the **list**. h](jB)}(h ``count``h]j])}(hj14h]hcount}(hj34hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj/4ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKQhj+4ubjS)}(hhh]h)}(h9The number of sessions currently tracked in the **list**.h](h0The number of sessions currently tracked in the }(hjJ4hhhNhNubjm )}(h**list**h]hlist}(hjR4hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjJ4ubh.}(hjJ4hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjF4hKQhjG4ubah}(h]h ]h"]h$]h&]uh1jRhj+4ubeh}(h]h ]h"]h$]h&]uh1j;hjF4hKQhj(4ubj<)}(hH``list`` The head of the linked list of `struct luo_session` instances. h](jB)}(h``list``h]j])}(hj|4h]hlist}(hj~4hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjz4ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKRhjv4ubjS)}(hhh]h)}(h>The head of the linked list of `struct luo_session` instances.h](hThe head of the linked list of }(hj4hhhNhNubj)}(h`struct luo_session`h]hstruct luo_session}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubh instances.}(hj4hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj4hKRhj4ubah}(h]h ]h"]h$]h&]uh1jRhjv4ubeh}(h]h ]h"]h$]h&]uh1j;hj4hKRhj(4ubj<)}(hw``rwsem`` A read-write semaphore providing synchronized access to the session list and other fields in this structure. h](jB)}(h ``rwsem``h]j])}(hj4h]hrwsem}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj4ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKThj4ubjS)}(hhh]h)}(hlA read-write semaphore providing synchronized access to the session list and other fields in this structure.h]hlA read-write semaphore providing synchronized access to the session list and other fields in this structure.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKShj4ubah}(h]h ]h"]h$]h&]uh1jRhj4ubeh}(h]h ]h"]h$]h&]uh1j;hj4hKThj(4ubj<)}(h7``header_ser`` The header data of serialization array. h](jB)}(h``header_ser``h]j])}(hj5h]h header_ser}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj4ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKUhj4ubjS)}(hhh]h)}(h'The header data of serialization array.h]h'The header data of serialization array.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hKUhj5ubah}(h]h ]h"]h$]h&]uh1jRhj4ubeh}(h]h ]h"]h$]h&]uh1j;hj5hKUhj(4ubj<)}(hL``ser`` The serialized session data (an array of `struct luo_session_ser`). h](jB)}(h``ser``h]j])}(hj:5h]hser}(hj<5hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj85ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKWhj45ubjS)}(hhh]h)}(hCThe serialized session data (an array of `struct luo_session_ser`).h](h)The serialized session data (an array of }(hjS5hhhNhNubj)}(h`struct luo_session_ser`h]hstruct luo_session_ser}(hj[5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjS5ubh).}(hjS5hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKVhjP5ubah}(h]h ]h"]h$]h&]uh1jRhj45ubeh}(h]h ]h"]h$]h&]uh1j;hjO5hKWhj(4ubj<)}(h}``active`` Set to true when first initialized. If previous kernel did not send session data, active stays false for incoming.h](jB)}(h ``active``h]j])}(hj5h]hactive}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj5ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKXhj5ubjS)}(hhh]h)}(hrSet to true when first initialized. If previous kernel did not send session data, active stays false for incoming.h]hrSet to true when first initialized. If previous kernel did not send session data, active stays false for incoming.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hKXhj5ubah}(h]h ]h"]h$]h&]uh1jRhj5ubeh}(h]h ]h"]h$]h&]uh1j;hj5hKXhj(4ubeh}(h]h ]h"]h$]h&]uh1j6hj3ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_session_global (C struct)c.luo_session_globalhNtauh1j hjn hhhNhNubj )}(hhh](j )}(hluo_session_globalh]j )}(hstruct luo_session_globalh](j )}(hj h]hstruct}(hj5hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj5hhhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chK_ubj )}(h h]h }(hj5hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj5hhhj5hK_ubj )}(hluo_session_globalh]j )}(hj5h]hluo_session_global}(hj5hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj5ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj5hhhj5hK_ubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj5hhhj5hK_ubah}(h]j5ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj5hK_hj5hhubj< )}(hhh]h)}(h+Global container for managing LUO sessions.h]h+Global container for managing LUO sessions.}(hj!6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKdhj6hhubah}(h]h ]h"]h$]h&]uh1j; hj5hhhj5hK_ubeh}(h]h ](jistructeh"]h$]h&]j\ jij] j96j^ j96j_ j` ja uh1j hhhjn hNhNubjc )}(hX **Definition**:: struct luo_session_global { struct luo_session_header incoming; struct luo_session_header outgoing; }; **Members** ``incoming`` The sessions passed from the previous kernel. ``outgoing`` The sessions that are going to be passed to the next kernel.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hjE6hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjA6ubh:}(hjA6hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKhhj=6ubjg)}(hnstruct luo_session_global { struct luo_session_header incoming; struct luo_session_header outgoing; };h]hnstruct luo_session_global { struct luo_session_header incoming; struct luo_session_header outgoing; };}hj^6sbah}(h]h ]h"]h$]h&]hhuh1jfhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKjhj=6ubh)}(h **Members**h]jm )}(hjo6h]hMembers}(hjq6hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjm6ubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKohj=6ubj7)}(hhh](j<)}(h;``incoming`` The sessions passed from the previous kernel. h](jB)}(h ``incoming``h]j])}(hj6h]hincoming}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj6ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKfhj6ubjS)}(hhh]h)}(h-The sessions passed from the previous kernel.h]h-The sessions passed from the previous kernel.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hKfhj6ubah}(h]h ]h"]h$]h&]uh1jRhj6ubeh}(h]h ]h"]h$]h&]uh1j;hj6hKfhj6ubj<)}(hI``outgoing`` The sessions that are going to be passed to the next kernel.h](jB)}(h ``outgoing``h]j])}(hj6h]houtgoing}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj6ubah}(h]h ]h"]h$]h&]uh1jAhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKfhj6ubjS)}(hhh]h)}(h` that manages this type of file. ``file`` Pointer to the kernel's :c:type:`struct file ` that is being preserved. This is NULL in the new kernel until the file is successfully retrieved. ``serialized_data`` The opaque u64 handle to the serialized state of the file. This handle is passed back to the handler's .freeze(), .retrieve(), and .finish() callbacks, allowing it to track and update its serialized state across phases. ``private_data`` Pointer to the private data for the file used to hold runtime state that is not preserved. Set by the handler's .preserve() callback, and must be freed in the handler's .unpreserve() callback. ``retrieve_status`` Status code indicating whether a user/kernel in the new kernel has successfully called retrieve() on this file. This prevents multiple retrieval attempts. A value of 0 means a retrieve() has not been attempted, a positive value means the retrieve() was successful, and a negative value means the retrieve() failed, and the value is the error code of the call. ``mutex`` A mutex that protects the fields of this specific instance (e.g., **retrieved**, **file**), ensuring that operations like retrieving or finishing a file are atomic. ``list`` The list_head linking this instance into its parent file_set's list of preserved files. ``token`` The user-provided unique token used to identify this file.h](h)}(h**Definition**::h](jm )}(h**Definition**h]h Definition}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj:ubh:}(hj:hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj:ubjg)}(hstruct luo_file { struct liveupdate_file_handler *fh; struct file *file; u64 serialized_data; void *private_data; int retrieve_status; struct mutex mutex; struct list_head list; u64 token; };h]hstruct luo_file { struct liveupdate_file_handler *fh; struct file *file; u64 serialized_data; void *private_data; int retrieve_status; struct mutex mutex; struct list_head list; u64 token; };}hj4:sbah}(h]h ]h"]h$]h&]hhuh1jfh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj:ubh)}(h **Members**h]jm )}(hjE:h]hMembers}(hjG:hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjC:ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj:ubj7)}(hhh](j<)}(hy``fh`` Pointer to the :c:type:`struct liveupdate_file_handler ` that manages this type of file. h](jB)}(h``fh``h]j])}(hjd:h]hfh}(hjf:hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjb:ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chK~hj^:ubjS)}(hhh]h)}(hqPointer to the :c:type:`struct liveupdate_file_handler ` that manages this type of file.h](hPointer to the }(hj}:hhhNhNubh)}(hB:c:type:`struct liveupdate_file_handler `h]j])}(hj:h]hstruct liveupdate_file_handler}(hj:hhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hj:ubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnjRjVj{liveupdate_file_handleruh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chK}hj}:ubh that manages this type of file.}(hj}:hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj:hK}hjz:ubah}(h]h ]h"]h$]h&]uh1jRhj^:ubeh}(h]h ]h"]h$]h&]uh1j;hjy:hK~hj[:ubj<)}(h``file`` Pointer to the kernel's :c:type:`struct file ` that is being preserved. This is NULL in the new kernel until the file is successfully retrieved. h](jB)}(h``file``h]j])}(hj:h]hfile}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj:ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj:ubjS)}(hhh]h)}(hPointer to the kernel's :c:type:`struct file ` that is being preserved. This is NULL in the new kernel until the file is successfully retrieved.h](hPointer to the kernel’s }(hj:hhhNhNubh)}(h:c:type:`struct file `h]j])}(hj:h]h struct file}(hj:hhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hj:ubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnjRjVj{fileuh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj:ubhb that is being preserved. This is NULL in the new kernel until the file is successfully retrieved.}(hj:hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj;hKhj:ubah}(h]h ]h"]h$]h&]uh1jRhj:ubeh}(h]h ]h"]h$]h&]uh1j;hj:hKhj[:ubj<)}(h``serialized_data`` The opaque u64 handle to the serialized state of the file. This handle is passed back to the handler's .freeze(), .retrieve(), and .finish() callbacks, allowing it to track and update its serialized state across phases. h](jB)}(h``serialized_data``h]j])}(hj;h]hserialized_data}(hj ;hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj;ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubjS)}(hhh]h)}(hThe opaque u64 handle to the serialized state of the file. This handle is passed back to the handler's .freeze(), .retrieve(), and .finish() callbacks, allowing it to track and update its serialized state across phases.h]hThe opaque u64 handle to the serialized state of the file. This handle is passed back to the handler’s .freeze(), .retrieve(), and .finish() callbacks, allowing it to track and update its serialized state across phases.}(hj7;hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj4;ubah}(h]h ]h"]h$]h&]uh1jRhj;ubeh}(h]h ]h"]h$]h&]uh1j;hj3;hKhj[:ubj<)}(h``private_data`` Pointer to the private data for the file used to hold runtime state that is not preserved. Set by the handler's .preserve() callback, and must be freed in the handler's .unpreserve() callback. h](jB)}(h``private_data``h]j])}(hjX;h]h private_data}(hjZ;hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjV;ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjR;ubjS)}(hhh]h)}(hPointer to the private data for the file used to hold runtime state that is not preserved. Set by the handler's .preserve() callback, and must be freed in the handler's .unpreserve() callback.h]hPointer to the private data for the file used to hold runtime state that is not preserved. Set by the handler’s .preserve() callback, and must be freed in the handler’s .unpreserve() callback.}(hjq;hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjn;ubah}(h]h ]h"]h$]h&]uh1jRhjR;ubeh}(h]h ]h"]h$]h&]uh1j;hjm;hKhj[:ubj<)}(hX|``retrieve_status`` Status code indicating whether a user/kernel in the new kernel has successfully called retrieve() on this file. This prevents multiple retrieval attempts. A value of 0 means a retrieve() has not been attempted, a positive value means the retrieve() was successful, and a negative value means the retrieve() failed, and the value is the error code of the call. h](jB)}(h``retrieve_status``h]j])}(hj;h]hretrieve_status}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj;ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubjS)}(hhh]h)}(hXgStatus code indicating whether a user/kernel in the new kernel has successfully called retrieve() on this file. This prevents multiple retrieval attempts. A value of 0 means a retrieve() has not been attempted, a positive value means the retrieve() was successful, and a negative value means the retrieve() failed, and the value is the error code of the call.h]hXgStatus code indicating whether a user/kernel in the new kernel has successfully called retrieve() on this file. This prevents multiple retrieval attempts. A value of 0 means a retrieve() has not been attempted, a positive value means the retrieve() was successful, and a negative value means the retrieve() failed, and the value is the error code of the call.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubah}(h]h ]h"]h$]h&]uh1jRhj;ubeh}(h]h ]h"]h$]h&]uh1j;hj;hKhj[:ubj<)}(h``mutex`` A mutex that protects the fields of this specific instance (e.g., **retrieved**, **file**), ensuring that operations like retrieving or finishing a file are atomic. h](jB)}(h ``mutex``h]j])}(hj;h]hmutex}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj;ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubjS)}(hhh]h)}(hA mutex that protects the fields of this specific instance (e.g., **retrieved**, **file**), ensuring that operations like retrieving or finishing a file are atomic.h](hBA mutex that protects the fields of this specific instance (e.g., }(hj;hhhNhNubjm )}(h **retrieved**h]h retrieved}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj;ubh, }(hj;hhhNhNubjm )}(h**file**h]hfile}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj;ubhK), ensuring that operations like retrieving or finishing a file are atomic.}(hj;hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubah}(h]h ]h"]h$]h&]uh1jRhj;ubeh}(h]h ]h"]h$]h&]uh1j;hj;hKhj[:ubj<)}(ha``list`` The list_head linking this instance into its parent file_set's list of preserved files. h](jB)}(h``list``h]j])}(hj*<h]hlist}(hj,<hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj(<ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj$<ubjS)}(hhh]h)}(hWThe list_head linking this instance into its parent file_set's list of preserved files.h]hYThe list_head linking this instance into its parent file_set’s list of preserved files.}(hjC<hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj@<ubah}(h]h ]h"]h$]h&]uh1jRhj$<ubeh}(h]h ]h"]h$]h&]uh1j;hj?<hKhj[:ubj<)}(hD``token`` The user-provided unique token used to identify this file.h](jB)}(h ``token``h]j])}(hjd<h]htoken}(hjf<hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjb<ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj^<ubjS)}(hhh]h)}(h:The user-provided unique token used to identify this file.h]h:The user-provided unique token used to identify this file.}(hj}<hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjz<ubah}(h]h ]h"]h$]h&]uh1jRhj^<ubeh}(h]h ]h"]h$]h&]uh1j;hjy<hKhj[:ubeh}(h]h ]h"]h$]h&]uh1j6hj:ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubh)}(h**Description**h]jm )}(hj<h]h Description}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj<ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjn hhubh)}(hX5This structure is the core in-kernel representation of a single file being managed through a live update. An instance is created by luo_preserve_file() to link a 'struct file' to its corresponding handler, a user-provided token, and the serialized state handle returned by the handler's .preserve() operation.h]hX;This structure is the core in-kernel representation of a single file being managed through a live update. An instance is created by luo_preserve_file() to link a ‘struct file’ to its corresponding handler, a user-provided token, and the serialized state handle returned by the handler’s .preserve() operation.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjn hhubh)}(hXYThese instances are tracked in a per-file_set list. The **serialized_data** field, which holds a handle to the file's serialized state, may be updated during the .freeze() callback before being serialized for the next kernel. After reboot, these structures are recreated by luo_file_deserialize() and are finally cleaned up by luo_file_finish().h](h8These instances are tracked in a per-file_set list. The }(hj<hhhNhNubjm )}(h**serialized_data**h]hserialized_data}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj<ubhX field, which holds a handle to the file’s serialized state, may be updated during the .freeze() callback before being serialized for the next kernel. After reboot, these structures are recreated by luo_file_deserialize() and are finally cleaned up by luo_file_finish().}(hj<hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjn hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_preserve_file (C function)c.luo_preserve_filehNtauh1j hjn hhhNhNubj )}(hhh](j )}(hHint luo_preserve_file (struct luo_file_set *file_set, u64 token, int fd)h]j )}(hGint luo_preserve_file(struct luo_file_set *file_set, u64 token, int fd)h](j )}(hinth]hint}(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=hhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKubj )}(h h]h }(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=hhhj=hKubj )}(hluo_preserve_fileh]j )}(hluo_preserve_fileh]hluo_preserve_file}(hj'=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj#=ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj=hhhj=hKubj )}(h2(struct luo_file_set *file_set, u64 token, int fd)h](j )}(hstruct luo_file_set *file_seth](j )}(hj h]hstruct}(hjC=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj?=ubj )}(h h]h }(hjP=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj?=ubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hja=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj^=ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetjc=modnameN classnameNjRjU)}jX]j#)}j#j)=sbc.luo_preserve_fileasbuh1hhj?=ubj )}(h h]h }(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj?=ubj#)}(hj#h]h*}(hj=hhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hj?=ubj )}(hfile_seth]hfile_set}(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj?=ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj;=ubj )}(h u64 tokenh](h)}(hhh]j )}(hu64h]hu64}(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetj=modnameN classnameNjRjU)}jX]j}=c.luo_preserve_fileasbuh1hhj=ubj )}(h h]h }(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubj )}(htokenh]htoken}(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj;=ubj )}(hint fdh](j )}(hinth]hint}(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubj )}(h h]h }(hj >hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubj )}(hfdh]hfd}(hj>hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj;=ubeh}(h]h ]h"]h$]h&]hhuh1j hj=hhhj=hKubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj<hhhj=hKubah}(h]j<ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj=hKhj<hhubj< )}(hhh]h)}(h/Initiate the preservation of a file descriptor.h]h/Initiate the preservation of a file descriptor.}(hjC>hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj@>hhubah}(h]h ]h"]h$]h&]uh1j; hj<hhhj=hKubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] j[>j^ j[>j_ j` ja uh1j hhhjn hNhNubjc )}(hX**Parameters** ``struct luo_file_set *file_set`` The file_set to which the preserved file will be added. ``u64 token`` A unique, user-provided identifier for the file. ``int fd`` The file descriptor to be preserved. **Description** This function orchestrates the first phase of preserving a file. Upon entry, it takes a reference to the 'struct file' via fget(), effectively making LUO a co-owner of the file. This reference is held until the file is either unpreserved or successfully finished in the next kernel, preventing the file from being prematurely destroyed. This function orchestrates the first phase of preserving a file. It performs the following steps: 1. Validates that the **token** is not already in use within the file_set. 2. Ensures the file_set's memory for files serialization is allocated (allocates if needed). 3. Iterates through registered handlers, calling can_preserve() to find one compatible with the given **fd**. 4. Calls the handler's .preserve() operation, which saves the file's state and returns an opaque private data handle. 5. Adds the new instance to the file_set's internal list. On success, LUO takes a reference to the 'struct file' and considers it under its management until it is unpreserved or finished. In case of any failure, all intermediate allocations (file reference, memory for the 'luo_file' struct, etc.) are cleaned up before returning an error. **Context** Can be called from an ioctl handler during normal system operation. **Return** 0 on success. Returns a negative errno on failure: -EEXIST if the token is already used. -EBADF if the file descriptor is invalid. -ENOSPC if the file_set is full. -ENOENT if no compatible handler is found. -ENOMEM on memory allocation failure. Other erros might be returned by .preserve().h](h)}(h**Parameters**h]jm )}(hje>h]h Parameters}(hjg>hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjc>ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubj7)}(hhh](j<)}(hZ``struct luo_file_set *file_set`` The file_set to which the preserved file will be added. h](jB)}(h!``struct luo_file_set *file_set``h]j])}(hj>h]hstruct luo_file_set *file_set}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj>ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj~>ubjS)}(hhh]h)}(h7The file_set to which the preserved file will be added.h]h7The file_set to which the preserved file will be added.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hKhj>ubah}(h]h ]h"]h$]h&]uh1jRhj~>ubeh}(h]h ]h"]h$]h&]uh1j;hj>hKhj{>ubj<)}(h?``u64 token`` A unique, user-provided identifier for the file. h](jB)}(h ``u64 token``h]j])}(hj>h]h u64 token}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj>ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj>ubjS)}(hhh]h)}(h0A unique, user-provided identifier for the file.h]h0A unique, user-provided identifier for the file.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hKhj>ubah}(h]h ]h"]h$]h&]uh1jRhj>ubeh}(h]h ]h"]h$]h&]uh1j;hj>hKhj{>ubj<)}(h0``int fd`` The file descriptor to be preserved. h](jB)}(h ``int fd``h]j])}(hj>h]hint fd}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj>ubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj>ubjS)}(hhh]h)}(h$The file descriptor to be preserved.h]h$The file descriptor to be preserved.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ?hKhj ?ubah}(h]h ]h"]h$]h&]uh1jRhj>ubeh}(h]h ]h"]h$]h&]uh1j;hj ?hKhj{>ubeh}(h]h ]h"]h$]h&]uh1j6hj_>ubh)}(h**Description**h]jm )}(hj1?h]h Description}(hj3?hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj/?ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubh)}(hXPThis function orchestrates the first phase of preserving a file. Upon entry, it takes a reference to the 'struct file' via fget(), effectively making LUO a co-owner of the file. This reference is held until the file is either unpreserved or successfully finished in the next kernel, preventing the file from being prematurely destroyed.h]hXTThis function orchestrates the first phase of preserving a file. Upon entry, it takes a reference to the ‘struct file’ via fget(), effectively making LUO a co-owner of the file. This reference is held until the file is either unpreserved or successfully finished in the next kernel, preventing the file from being prematurely destroyed.}(hjG?hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubh)}(haThis function orchestrates the first phase of preserving a file. It performs the following steps:h]haThis function orchestrates the first phase of preserving a file. It performs the following steps:}(hjV?hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubj:)}(hhh](j)}(hGValidates that the **token** is not already in use within the file_set.h]h)}(hjj?h](hValidates that the }(hjl?hhhNhNubjm )}(h **token**h]htoken}(hjs?hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjl?ubh+ is not already in use within the file_set.}(hjl?hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjh?ubah}(h]h ]h"]h$]h&]uh1jhje?ubj)}(hYEnsures the file_set's memory for files serialization is allocated (allocates if needed).h]h)}(hYEnsures the file_set's memory for files serialization is allocated (allocates if needed).h]h[Ensures the file_set’s memory for files serialization is allocated (allocates if needed).}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj?ubah}(h]h ]h"]h$]h&]uh1jhje?ubj)}(hjIterates through registered handlers, calling can_preserve() to find one compatible with the given **fd**.h]h)}(hjIterates through registered handlers, calling can_preserve() to find one compatible with the given **fd**.h](hcIterates through registered handlers, calling can_preserve() to find one compatible with the given }(hj?hhhNhNubjm )}(h**fd**h]hfd}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj?ubh.}(hj?hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj?ubah}(h]h ]h"]h$]h&]uh1jhje?ubj)}(hrCalls the handler's .preserve() operation, which saves the file's state and returns an opaque private data handle.h]h)}(hrCalls the handler's .preserve() operation, which saves the file's state and returns an opaque private data handle.h]hvCalls the handler’s .preserve() operation, which saves the file’s state and returns an opaque private data handle.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj?ubah}(h]h ]h"]h$]h&]uh1jhje?ubj)}(h7Adds the new instance to the file_set's internal list. h]h)}(h6Adds the new instance to the file_set's internal list.h]h8Adds the new instance to the file_set’s internal list.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj?ubah}(h]h ]h"]h$]h&]uh1jhje?ubeh}(h]h ]h"]h$]h&]jjjhjjuh1j9hj_>ubh)}(hOn success, LUO takes a reference to the 'struct file' and considers it under its management until it is unpreserved or finished.h]hOn success, LUO takes a reference to the ‘struct file’ and considers it under its management until it is unpreserved or finished.}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubh)}(hIn case of any failure, all intermediate allocations (file reference, memory for the 'luo_file' struct, etc.) are cleaned up before returning an error.h]hIn case of any failure, all intermediate allocations (file reference, memory for the ‘luo_file’ struct, etc.) are cleaned up before returning an error.}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubh)}(h **Context**h]jm )}(hj.@h]hContext}(hj0@hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj,@ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubh)}(hCCan be called from an ioctl handler during normal system operation.h]hCCan be called from an ioctl handler during normal system operation.}(hjD@hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubh)}(h **Return**h]jm )}(hjU@h]hReturn}(hjW@hhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjS@ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubh)}(hX"0 on success. Returns a negative errno on failure: -EEXIST if the token is already used. -EBADF if the file descriptor is invalid. -ENOSPC if the file_set is full. -ENOENT if no compatible handler is found. -ENOMEM on memory allocation failure. Other erros might be returned by .preserve().h]hX"0 on success. Returns a negative errno on failure: -EEXIST if the token is already used. -EBADF if the file descriptor is invalid. -ENOSPC if the file_set is full. -ENOENT if no compatible handler is found. -ENOMEM on memory allocation failure. Other erros might be returned by .preserve().}(hjk@hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj_>ubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j &luo_file_unpreserve_files (C function)c.luo_file_unpreserve_fileshNtauh1j hjn hhhNhNubj )}(hhh](j )}(h>void luo_file_unpreserve_files (struct luo_file_set *file_set)h]j )}(h=void luo_file_unpreserve_files(struct luo_file_set *file_set)h](j )}(hvoidh]hvoid}(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@hhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMLubj )}(h h]h }(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@hhhj@hMLubj )}(hluo_file_unpreserve_filesh]j )}(hluo_file_unpreserve_filesh]hluo_file_unpreserve_files}(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@ubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj@hhhj@hMLubj )}(h(struct luo_file_set *file_set)h]j )}(hstruct luo_file_set *file_seth](j )}(hj h]hstruct}(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@ubj )}(h h]h }(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@ubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@ubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetj@modnameN classnameNjRjU)}jX]j#)}j#j@sbc.luo_file_unpreserve_filesasbuh1hhj@ubj )}(h h]h }(hjAhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@ubj#)}(hj#h]h*}(hj#AhhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hj@ubj )}(hfile_seth]hfile_set}(hj0AhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@ubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj@ubah}(h]h ]h"]h$]h&]hhuh1j hj@hhhj@hMLubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj@hhhj@hMLubah}(h]j@ah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj@hMLhj@hhubj< )}(hhh]h)}(h&Unpreserves all files from a file_set.h]h&Unpreserves all files from a file_set.}(hjZAhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMLhjWAhhubah}(h]h ]h"]h$]h&]uh1j; hj@hhhj@hMLubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] jrAj^ jrAj_ j` ja uh1j hhhjn hNhNubjc )}(hX(**Parameters** ``struct luo_file_set *file_set`` The files to be cleaned up. **Description** This function serves as the primary cleanup path for a file_set. It is invoked when the userspace agent closes the file_set's file descriptor. For each file, it performs the following cleanup actions: 1. Calls the handler's .unpreserve() callback to allow the handler to release any resources it allocated. 2. Removes the file from the file_set's internal tracking list. 3. Releases the reference to the 'struct file' that was taken by luo_preserve_file() via fput(), returning ownership. 4. Frees the memory associated with the internal 'struct luo_file'. After all individual files are unpreserved, it frees the contiguous memory block that was allocated to hold their serialization data.h](h)}(h**Parameters**h]jm )}(hj|Ah]h Parameters}(hj~AhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjzAubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMPhjvAubj7)}(hhh]j<)}(h>``struct luo_file_set *file_set`` The files to be cleaned up. h](jB)}(h!``struct luo_file_set *file_set``h]j])}(hjAh]hstruct luo_file_set *file_set}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjAubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMMhjAubjS)}(hhh]h)}(hThe files to be cleaned up.h]hThe files to be cleaned up.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhMMhjAubah}(h]h ]h"]h$]h&]uh1jRhjAubeh}(h]h ]h"]h$]h&]uh1j;hjAhMMhjAubah}(h]h ]h"]h$]h&]uh1j6hjvAubh)}(h**Description**h]jm )}(hjAh]h Description}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjAubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMOhjvAubh)}(hThis function serves as the primary cleanup path for a file_set. It is invoked when the userspace agent closes the file_set's file descriptor.h]hThis function serves as the primary cleanup path for a file_set. It is invoked when the userspace agent closes the file_set’s file descriptor.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMNhjvAubj7)}(hhh]j<)}(hXFor each file, it performs the following cleanup actions: 1. Calls the handler's .unpreserve() callback to allow the handler to release any resources it allocated. 2. Removes the file from the file_set's internal tracking list. 3. Releases the reference to the 'struct file' that was taken by luo_preserve_file() via fput(), returning ownership. 4. Frees the memory associated with the internal 'struct luo_file'. h](jB)}(h9For each file, it performs the following cleanup actions:h]h9For each file, it performs the following cleanup actions:}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMWhjAubjS)}(hhh]j:)}(hhh](j)}(hfCalls the handler's .unpreserve() callback to allow the handler to release any resources it allocated.h]h)}(hfCalls the handler's .unpreserve() callback to allow the handler to release any resources it allocated.h]hhCalls the handler’s .unpreserve() callback to allow the handler to release any resources it allocated.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMRhjBubah}(h]h ]h"]h$]h&]uh1jhjBubj)}(hRemoves the file from the file_set’s internal tracking list.}(hj4BhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMThj0Bubah}(h]h ]h"]h$]h&]uh1jhjBubj)}(hrReleases the reference to the 'struct file' that was taken by luo_preserve_file() via fput(), returning ownership.h]h)}(hrReleases the reference to the 'struct file' that was taken by luo_preserve_file() via fput(), returning ownership.h]hvReleases the reference to the ‘struct file’ that was taken by luo_preserve_file() via fput(), returning ownership.}(hjLBhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMUhjHBubah}(h]h ]h"]h$]h&]uh1jhjBubj)}(hAFrees the memory associated with the internal 'struct luo_file'. h]h)}(h@Frees the memory associated with the internal 'struct luo_file'.h]hDFrees the memory associated with the internal ‘struct luo_file’.}(hjeBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjBhMWhjaBubah}(h]h ]h"]h$]h&]uh1jhjBubeh}(h]h ]h"]h$]h&]jjjhjjuh1j9hjBubah}(h]h ]h"]h$]h&]uh1jRhjAubeh}(h]h ]h"]h$]h&]uh1j;hjBhMWhjAubah}(h]h ]h"]h$]h&]uh1j6hjvAubh)}(hAfter all individual files are unpreserved, it frees the contiguous memory block that was allocated to hold their serialization data.h]hAfter all individual files are unpreserved, it frees the contiguous memory block that was allocated to hold their serialization data.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMYhjvAubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_file_freeze (C function)c.luo_file_freezehNtauh1j hjn hhhNhNubj )}(hhh](j )}(hZint luo_file_freeze (struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h]j )}(hYint luo_file_freeze(struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h](j )}(hinth]hint}(hjBhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjBhhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMubj )}(h h]h }(hjBhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjBhhhjBhMubj )}(hluo_file_freezeh]j )}(hluo_file_freezeh]hluo_file_freeze}(hjBhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjBubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjBhhhjBhMubj )}(hF(struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h](j )}(hstruct luo_file_set *file_seth](j )}(hj h]hstruct}(hjBhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjBubj )}(h h]h }(hj ChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjBubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjCubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetjCmodnameN classnameNjRjU)}jX]j#)}j#jBsbc.luo_file_freezeasbuh1hhjBubj )}(h h]h }(hj;ChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjBubj#)}(hj#h]h*}(hjIChhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjBubj )}(hfile_seth]hfile_set}(hjVChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjBubeh}(h]h ]h"]h$]h&]noemphhhuh1j hjBubj )}(h%struct luo_file_set_ser *file_set_serh](j )}(hj h]hstruct}(hjoChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjkCubj )}(h h]h }(hj|ChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjkCubh)}(hhh]j )}(hluo_file_set_serh]hluo_file_set_ser}(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjCubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetjCmodnameN classnameNjRjU)}jX]j7Cc.luo_file_freezeasbuh1hhjkCubj )}(h h]h }(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjkCubj#)}(hj#h]h*}(hjChhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjkCubj )}(h file_set_serh]h file_set_ser}(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjkCubeh}(h]h ]h"]h$]h&]noemphhhuh1j hjBubeh}(h]h ]h"]h$]h&]hhuh1j hjBhhhjBhMubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hjBhhhjBhMubah}(h]jBah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hjBhMhjBhhubj< )}(hhh]h)}(h:Freezes all preserved files and serializes their metadata.h]h:Freezes all preserved files and serializes their metadata.}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjChhubah}(h]h ]h"]h$]h&]uh1j; hjBhhhjBhMubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] jDj^ jDj_ j` ja uh1j hhhjn hNhNubjc )}(hXS**Parameters** ``struct luo_file_set *file_set`` The file_set whose files are to be frozen. ``struct luo_file_set_ser *file_set_ser`` Where to put the serialized file_set. **Description** This function is called from the reboot() syscall path, just before the kernel transitions to the new image via kexec. Its purpose is to perform the final preparation and serialization of all preserved files in the file_set. It iterates through each preserved file in FIFO order (the order of preservation) and performs two main actions: 1. Freezes the File: It calls the handler's .freeze() callback for each file. This gives the handler a final opportunity to quiesce the device or prepare its state for the upcoming reboot. The handler may update its private data handle during this step. 2. Serializes Metadata: After a successful freeze, it copies the final file metadata—the handler's compatible string, the user token, and the final private data handle—into the pre-allocated contiguous memory buffer (file_set->files) that will be handed over to the next kernel via KHO. Error Handling (Rollback): This function is atomic. If any handler's .freeze() operation fails, the entire live update is aborted. The __luo_file_unfreeze() helper is immediately called to invoke the .unfreeze() op on all files that were successfully frozen before the point of failure, rolling them back to a running state. The function then returns an error, causing the reboot() syscall to fail. **Context** Called only from the liveupdate_reboot() path. **Return** 0 on success, or a negative errno on failure.h](h)}(h**Parameters**h]jm )}(hjDh]h Parameters}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjDubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubj7)}(hhh](j<)}(hM``struct luo_file_set *file_set`` The file_set whose files are to be frozen. h](jB)}(h!``struct luo_file_set *file_set``h]j])}(hj1Dh]hstruct luo_file_set *file_set}(hj3DhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj/Dubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj+DubjS)}(hhh]h)}(h*The file_set whose files are to be frozen.h]h*The file_set whose files are to be frozen.}(hjJDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFDhMhjGDubah}(h]h ]h"]h$]h&]uh1jRhj+Dubeh}(h]h ]h"]h$]h&]uh1j;hjFDhMhj(Dubj<)}(hP``struct luo_file_set_ser *file_set_ser`` Where to put the serialized file_set. h](jB)}(h)``struct luo_file_set_ser *file_set_ser``h]j])}(hjjDh]h%struct luo_file_set_ser *file_set_ser}(hjlDhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjhDubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjdDubjS)}(hhh]h)}(h%Where to put the serialized file_set.h]h%Where to put the serialized file_set.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhMhjDubah}(h]h ]h"]h$]h&]uh1jRhjdDubeh}(h]h ]h"]h$]h&]uh1j;hjDhMhj(Dubeh}(h]h ]h"]h$]h&]uh1j6hj Dubh)}(h**Description**h]jm )}(hjDh]h Description}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjDubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubh)}(hThis function is called from the reboot() syscall path, just before the kernel transitions to the new image via kexec. Its purpose is to perform the final preparation and serialization of all preserved files in the file_set.h]hThis function is called from the reboot() syscall path, just before the kernel transitions to the new image via kexec. Its purpose is to perform the final preparation and serialization of all preserved files in the file_set.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubh)}(hpIt iterates through each preserved file in FIFO order (the order of preservation) and performs two main actions:h]hpIt iterates through each preserved file in FIFO order (the order of preservation) and performs two main actions:}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubj:)}(hhh](j)}(hFreezes the File: It calls the handler's .freeze() callback for each file. This gives the handler a final opportunity to quiesce the device or prepare its state for the upcoming reboot. The handler may update its private data handle during this step. h]h)}(hFreezes the File: It calls the handler's .freeze() callback for each file. This gives the handler a final opportunity to quiesce the device or prepare its state for the upcoming reboot. The handler may update its private data handle during this step.h]hFreezes the File: It calls the handler’s .freeze() callback for each file. This gives the handler a final opportunity to quiesce the device or prepare its state for the upcoming reboot. The handler may update its private data handle during this step.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjDubah}(h]h ]h"]h$]h&]uh1jhjDubj)}(hX Serializes Metadata: After a successful freeze, it copies the final file metadata—the handler's compatible string, the user token, and the final private data handle—into the pre-allocated contiguous memory buffer (file_set->files) that will be handed over to the next kernel via KHO. h]h)}(hXSerializes Metadata: After a successful freeze, it copies the final file metadata—the handler's compatible string, the user token, and the final private data handle—into the pre-allocated contiguous memory buffer (file_set->files) that will be handed over to the next kernel via KHO.h]hX!Serializes Metadata: After a successful freeze, it copies the final file metadata—the handler’s compatible string, the user token, and the final private data handle—into the pre-allocated contiguous memory buffer (file_set->files) that will be handed over to the next kernel via KHO.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjDubah}(h]h ]h"]h$]h&]uh1jhjDubeh}(h]h ]h"]h$]h&]jjjhjjuh1j9hj Dubh)}(hXError Handling (Rollback): This function is atomic. If any handler's .freeze() operation fails, the entire live update is aborted. The __luo_file_unfreeze() helper is immediately called to invoke the .unfreeze() op on all files that were successfully frozen before the point of failure, rolling them back to a running state. The function then returns an error, causing the reboot() syscall to fail.h]hXError Handling (Rollback): This function is atomic. If any handler’s .freeze() operation fails, the entire live update is aborted. The __luo_file_unfreeze() helper is immediately called to invoke the .unfreeze() op on all files that were successfully frozen before the point of failure, rolling them back to a running state. The function then returns an error, causing the reboot() syscall to fail.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubh)}(h **Context**h]jm )}(hj%Eh]hContext}(hj'EhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj#Eubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubh)}(h.Called only from the liveupdate_reboot() path.h]h.Called only from the liveupdate_reboot() path.}(hj;EhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubh)}(h **Return**h]jm )}(hjLEh]hReturn}(hjNEhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjJEubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubh)}(h-0 on success, or a negative errno on failure.h]h-0 on success, or a negative errno on failure.}(hjbEhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj Dubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_file_unfreeze (C function)c.luo_file_unfreezehNtauh1j hjn hhhNhNubj )}(hhh](j )}(h]void luo_file_unfreeze (struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h]j )}(h\void luo_file_unfreeze(struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h](j )}(hvoidh]hvoid}(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEhhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMubj )}(h h]h }(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEhhhjEhMubj )}(hluo_file_unfreezeh]j )}(hluo_file_unfreezeh]hluo_file_unfreeze}(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hjEhhhjEhMubj )}(hF(struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h](j )}(hstruct luo_file_set *file_seth](j )}(hj h]hstruct}(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEubj )}(h h]h }(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetjEmodnameN classnameNjRjU)}jX]j#)}j#jEsbc.luo_file_unfreezeasbuh1hhjEubj )}(h h]h }(hj FhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEubj#)}(hj#h]h*}(hjFhhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjEubj )}(hfile_seth]hfile_set}(hj'FhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEubeh}(h]h ]h"]h$]h&]noemphhhuh1j hjEubj )}(h%struct luo_file_set_ser *file_set_serh](j )}(hj h]hstruct}(hj@FhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjJhMhjIubeh}(h]h ]h"]h$]h&]uh1j6hjIubh)}(h**Description**h]jm )}(hjeJh]h Description}(hjgJhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjcJubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjIubh)}(hThis function is the primary mechanism for recreating a file in the new kernel after a live update. It searches the file_set's list of deserialized files for an entry matching the provided **token**.h](hThis function is the primary mechanism for recreating a file in the new kernel after a live update. It searches the file_set’s list of deserialized files for an entry matching the provided }(hj{JhhhNhNubjm )}(h **token**h]htoken}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj{Jubh.}(hj{JhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjIubh)}(hXThe operation is idempotent: if a file has already been successfully retrieved, this function will simply return a pointer to the existing 'struct file' and report success without re-executing the retrieve operation. This is handled by checking the 'retrieved' flag under a lock.h]hXThe operation is idempotent: if a file has already been successfully retrieved, this function will simply return a pointer to the existing ‘struct file’ and report success without re-executing the retrieve operation. This is handled by checking the ‘retrieved’ flag under a lock.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM!hjIubh)}(hUFile retrieval can happen in any order; it is not bound by the order of preservation.h]hUFile retrieval can happen in any order; it is not bound by the order of preservation.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM&hjIubh)}(h **Context**h]jm )}(hjJh]hContext}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjJubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM)hjIubh)}(hFCan be called from an ioctl or other in-kernel code in the new kernel.h]hFCan be called from an ioctl or other in-kernel code in the new kernel.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM*hjIubh)}(h **Return**h]jm )}(hjJh]hReturn}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjJubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM-hjIubh)}(h0 on success. Returns a negative errno on failure: -ENOENT if no file with the matching token is found. Any error code returned by the handler's .retrieve() op.h]h0 on success. Returns a negative errno on failure: -ENOENT if no file with the matching token is found. Any error code returned by the handler’s .retrieve() op.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM,hjIubeh}(h]h ] kernelindentah"]h$]h&]uh1jb hjn hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j luo_file_finish (C function)c.luo_file_finishhNtauh1j hjn hhhNhNubj )}(hhh](j )}(h3int luo_file_finish (struct luo_file_set *file_set)h]j )}(h2int luo_file_finish(struct luo_file_set *file_set)h](j )}(hinth]hint}(hj(KhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj$Khhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMubj )}(h h]h }(hj7KhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj$Khhhj6KhMubj )}(hluo_file_finishh]j )}(hluo_file_finishh]hluo_file_finish}(hjIKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjEKubah}(h]h ](j" j# eh"]h$]h&]hhuh1j hj$Khhhj6KhMubj )}(h(struct luo_file_set *file_set)h]j )}(hstruct luo_file_set *file_seth](j )}(hj h]hstruct}(hjeKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjaKubj )}(h h]h }(hjrKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjaKubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjKubah}(h]h ]h"]h$]h&] refdomainjireftypej# reftargetjKmodnameN classnameNjRjU)}jX]j#)}j#jKKsbc.luo_file_finishasbuh1hhjaKubj )}(h h]h }(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjaKubj#)}(hj#h]h*}(hjKhhhNhNubah}(h]h ]j#ah"]h$]h&]uh1j#hjaKubj )}(hfile_seth]hfile_set}(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjaKubeh}(h]h ]h"]h$]h&]noemphhhuh1j hj]Kubah}(h]h ]h"]h$]h&]hhuh1j hj$Khhhj6KhMubeh}(h]h ]h"]h$]h&]hhj- uh1j j. j/ hj Khhhj6KhMubah}(h]jKah ](j3 j4 eh"]h$]h&]j8 j9 )j: huh1j hj6KhMhjKhhubj< )}(hhh]h)}(h4Completes the lifecycle for all files in a file_set.h]h4Completes the lifecycle for all files in a file_set.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjKhhubah}(h]h ]h"]h$]h&]uh1j; hjKhhhj6KhMubeh}(h]h ](jifunctioneh"]h$]h&]j\ jij] jLj^ jLj_ j` ja uh1j hhhjn hNhNubjc )}(hX**Parameters** ``struct luo_file_set *file_set`` The file_set to be finalized. **Description** This function orchestrates the final teardown of a live update file_set in the new kernel. It should be called after all necessary files have been retrieved and the userspace agent is ready to release the preserved state. The function iterates through all tracked files. For each file, it performs the following sequence of cleanup actions: 1. If file is not yet retrieved, retrieves it, and calls can_finish() on every file in the file_set. If all can_finish return true, continue to finish. 2. Calls the handler's .finish() callback (via luo_file_finish_one) to allow for final resource cleanup within the handler. 3. Releases LUO's ownership reference on the 'struct file' via fput(). This is the counterpart to the get_file() call in luo_retrieve_file(). 4. Removes the 'struct luo_file' from the file_set's internal list. 5. Frees the memory for the 'struct luo_file' instance itself. After successfully finishing all individual files, it frees the contiguous memory block that was used to transfer the serialized metadata from the previous kernel. Error Handling (Atomic Failure): This operation is atomic. If any handler's .can_finish() op fails, the entire function aborts immediately and returns an error. **Context** Can be called from an ioctl handler in the new kernel. **Return** 0 on success, or a negative errno on failure.h](h)}(h**Parameters**h]jm )}(hj Lh]h Parameters}(hj LhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjLubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubj7)}(hhh]j<)}(h@``struct luo_file_set *file_set`` The file_set to be finalized. h](jB)}(h!``struct luo_file_set *file_set``h]j])}(hj)Lh]hstruct luo_file_set *file_set}(hj+LhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hj'Lubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj#LubjS)}(hhh]h)}(hThe file_set to be finalized.h]hThe file_set to be finalized.}(hjBLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>LhMhj?Lubah}(h]h ]h"]h$]h&]uh1jRhj#Lubeh}(h]h ]h"]h$]h&]uh1j;hj>LhMhj Lubah}(h]h ]h"]h$]h&]uh1j6hjLubh)}(h**Description**h]jm )}(hjdLh]h Description}(hjfLhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjbLubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubh)}(hThis function orchestrates the final teardown of a live update file_set in the new kernel. It should be called after all necessary files have been retrieved and the userspace agent is ready to release the preserved state.h]hThis function orchestrates the final teardown of a live update file_set in the new kernel. It should be called after all necessary files have been retrieved and the userspace agent is ready to release the preserved state.}(hjzLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubh)}(hvThe function iterates through all tracked files. For each file, it performs the following sequence of cleanup actions:h]hvThe function iterates through all tracked files. For each file, it performs the following sequence of cleanup actions:}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubj:)}(hhh](j)}(hIf file is not yet retrieved, retrieves it, and calls can_finish() on every file in the file_set. If all can_finish return true, continue to finish.h]h)}(hIf file is not yet retrieved, retrieves it, and calls can_finish() on every file in the file_set. If all can_finish return true, continue to finish.h]hIf file is not yet retrieved, retrieves it, and calls can_finish() on every file in the file_set. If all can_finish return true, continue to finish.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubah}(h]h ]h"]h$]h&]uh1jhjLubj)}(hxCalls the handler's .finish() callback (via luo_file_finish_one) to allow for final resource cleanup within the handler.h]h)}(hxCalls the handler's .finish() callback (via luo_file_finish_one) to allow for final resource cleanup within the handler.h]hzCalls the handler’s .finish() callback (via luo_file_finish_one) to allow for final resource cleanup within the handler.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubah}(h]h ]h"]h$]h&]uh1jhjLubj)}(hReleases LUO's ownership reference on the 'struct file' via fput(). This is the counterpart to the get_file() call in luo_retrieve_file().h]h)}(hReleases LUO's ownership reference on the 'struct file' via fput(). This is the counterpart to the get_file() call in luo_retrieve_file().h]hReleases LUO’s ownership reference on the ‘struct file’ via fput(). This is the counterpart to the get_file() call in luo_retrieve_file().}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubah}(h]h ]h"]h$]h&]uh1jhjLubj)}(h@Removes the 'struct luo_file' from the file_set's internal list.h]h)}(hjLh]hFRemoves the ‘struct luo_file’ from the file_set’s internal list.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjLubah}(h]h ]h"]h$]h&]uh1jhjLubj)}(h`. The caller must initialize this structure, including a unique 'compatible' string and a valid 'fh' callbacks. This function adds the handler to the global list of supported file handlers. **Context** Typically called during module initialization for file types that support live update preservation. **Return** 0 on success. Negative errno on failure.h](h)}(h**Parameters**h]jm )}(hjQh]h Parameters}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjQubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM8hjQubj7)}(hhh]j<)}(hXE``struct liveupdate_file_handler *fh`` Pointer to a caller-allocated :c:type:`struct liveupdate_file_handler `. The caller must initialize this structure, including a unique 'compatible' string and a valid 'fh' callbacks. This function adds the handler to the global list of supported file handlers. h](jB)}(h&``struct liveupdate_file_handler *fh``h]j])}(hjQh]h"struct liveupdate_file_handler *fh}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1j\hjQubah}(h]h ]h"]h$]h&]uh1jAh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM8hjQubjS)}(hhh]h)}(hXPointer to a caller-allocated :c:type:`struct liveupdate_file_handler `. The caller must initialize this structure, including a unique 'compatible' string and a valid 'fh' callbacks. This function adds the handler to the global list of supported file handlers.h](hPointer to a caller-allocated }(hjQhhhNhNubh)}(hB:c:type:`struct liveupdate_file_handler `h]j])}(hjQh]hstruct liveupdate_file_handler}(hjQhhhNhNubah}(h]h ](jhjic-typeeh"]h$]h&]uh1j\hjQubah}(h]h ]h"]h$]h&]refdocju refdomainjireftypetype refexplicitrefwarnjRjVj{liveupdate_file_handleruh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM5hjQubh. The caller must initialize this structure, including a unique ‘compatible’ string and a valid ‘fh’ callbacks. This function adds the handler to the global list of supported file handlers.}(hjQhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjQhM5hjQubah}(h]h ]h"]h$]h&]uh1jRhjQubeh}(h]h ]h"]h$]h&]uh1j;hjQhM8hjQubah}(h]h ]h"]h$]h&]uh1j6hjQubh)}(h **Context**h]jm )}(hjRh]hContext}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hjRubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM:hjQubh)}(hcTypically called during module initialization for file types that support live update preservation.h]hcTypically called during module initialization for file types that support live update preservation.}(hj-RhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM:hjQubh)}(h **Return**h]jm )}(hj>Rh]hReturn}(hj@RhhhNhNubah}(h]h ]h"]h$]h&]uh1jl hj`h]h)}(hjNTh]h)}(hjNTh]hinline)}(hjNTh]hLive Update uAPI}(hjXThhhNhNubah}(h]h ](jhstdstd-doceh"]h$]h&]uh1jVThjSTubah}(h]h ]h"]h$]h&]refdocju refdomainjbTreftypedoc refexplicitrefwarnj{/userspace-api/liveupdateuh1hhhhKGhjPTubah}(h]h ]h"]h$]h&]uh1hhhhKGhjLTubah}(h]h ]h"]h$]h&]uh1jhjIThhhhhNubj)}(h:doc:`/core-api/kho/index`h]h)}(hjTh]h)}(hjTh]jWT)}(hjTh]h/core-api/kho/index}(hjThhhNhNubah}(h]h ](jhstdstd-doceh"]h$]h&]uh1jVThjTubah}(h]h ]h"]h$]h&]refdocju refdomainjTreftypedoc refexplicitrefwarnj{/core-api/kho/indexuh1hhhhKHhjTubah}(h]h ]h"]h$]h&]uh1hhhhKHhjTubah}(h]h ]h"]h$]h&]uh1jhjIThhhhhNubeh}(h]h ]h"]h$]h&]j(j)uh1jhhhKGhj8Thhubeh}(h]see-alsoah ]h"]see alsoah$]h&]uh1hhhhhhhhKEubeh}(h]live-update-orchestratorah ]h"]live update orchestratorah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjTerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(jTjTjjjjjjj j jk jh j5Tj2TjTjTu nametypes}(jTjjjj jk j5TjTuh}(jThjj{jj!jjj jjh j j j j j jj#jjjUjZjmjrjjjjjjjAjFjjjjj2Tjn j j j!j!j #j%#j%j %j&j&jU(jZ(j+j+j-j-j/j/j2j2ju3jz3j5j5j7j7j8j8j9j9j<j<j@j@jBjBjEjEjGjGjKj KjMjMjPjPjvRj{RjTj8Tu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.