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]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/pt_BR/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}(hj hhhNhNubah}(h]h ]h"]h$]h&]refuri mailto:pasha.tatashin@soleen.comuh1jhhubh>}(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.}(hj5hhhNhNubah}(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.}(hjDhhhNhNubah}(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.}(hjShhhNhNubah}(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.}(hjbhhhNhNubah}(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.}(hjqhhhNhNubah}(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.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chK#hhhhubhnote)}(hQTo enable LUO, boot the kernel with the ``liveupdate=on`` command line parameter.h]h)}(hQTo enable LUO, boot the kernel with the ``liveupdate=on`` command line parameter.h](h(To enable LUO, boot the kernel with the }(hjhhhNhNubhliteral)}(h``liveupdate=on``h]h liveupdate=on}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh command line parameter.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:8: ./kernel/liveupdate/luo_core.chK'hjubah}(h]h ]h"]h$]h&]uh1jhhhhhNhNubh)}(hhh](h)}(h LUO Sessionsh]h LUO Sessions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK 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 hjhhubh)}(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.chKhjhhubh 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.}(hj hhhNhNubah}(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.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhj!ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hX?Serialization: Session metadata is preserved using the KHO framework. When a live update is triggered via kexec, session metadata is serialized into a chain of linked-blocks and placed in a preserved memory region. The physical address of the first block header is stored in the centralized `struct luo_ser` structure. h]h)}(hX>Serialization: Session metadata is preserved using the KHO framework. When a live update is triggered via kexec, session metadata is serialized into a chain of linked-blocks and placed in a preserved memory region. The physical address of the first block header is stored in the centralized `struct luo_ser` structure.h](hX#Serialization: Session metadata is preserved using the KHO framework. When a live update is triggered via kexec, session metadata is serialized into a chain of linked-blocks and placed in a preserved memory region. The physical address of the first block header is stored in the centralized }(hj>hhhNhNubj)}(h`struct luo_ser`h]hstruct luo_ser}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubh structure.}(hj>hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhj:ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]bullet-uh1jhjhKhjhhubh)}(hSession Lifecycle:h]hSession Lifecycle:}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKhjhhubhenumerated_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 }(hjhhhNhNubj)}(h`luo_session_create()`h]hluo_session_create()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhF to create a new, empty session and receives a file descriptor for it.}(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)}(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 }(hjhhhNhNubj)}(h `reboot(LINUX_REBOOT_CMD_KEXEC)`h]hreboot(LINUX_REBOOT_CMD_KEXEC)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh syscall is made, }(hjhhhNhNubj)}(h`luo_session_serialize()`h]hluo_session_serialize()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhr is called. It iterates through all active sessions and writes their metadata into a memory area preserved by KHO.}(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)}(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 }(hj*hhhNhNubj)}(h`luo_session_retrieve()`h]hluo_session_retrieve()}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubhQ with a session name to get a new file descriptor and access the preserved state.}(hj*hhhNhNubeh}(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~ubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1j|hjhhhNhNubh)}(hLocking:h]hLocking:}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK0hjhhubh)}(hThe LUO session subsystem uses a three-tier locking hierarchy to ensure thread safety and prevent deadlocks during concurrent session mutations and kexec serialization:h]hThe LUO session subsystem uses a three-tier locking hierarchy to ensure thread safety and prevent deadlocks during concurrent session mutations and kexec serialization:}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK2hjhhubj})}(hhh](j)}(hX-`luo_session_serialize_rwsem` (global rwsem): Protects session mutations (creation, retrieval, release, and ioctls) against the serialization process during reboot. - Readers: Taken by any path modifying or accessing session state (e.g., `luo_session_create()`, `luo_session_retrieve()`, `luo_session_release()`, and `luo_session_ioctl()`). - Writer: Taken by the serialization process (`luo_session_serialize()`) during reboot. On success, the write lock is held indefinitely to freeze the subsystem. On failure, it is released to allow recovery. h](h)}(h`luo_session_serialize_rwsem` (global rwsem): Protects session mutations (creation, retrieval, release, and ioctls) against the serialization process during reboot.h](j)}(h`luo_session_serialize_rwsem`h]hluo_session_serialize_rwsem}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh (global rwsem): Protects session mutations (creation, retrieval, release, and ioctls) against the serialization process during reboot.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chK6hj}ubj)}(hhh](j)}(hReaders: Taken by any path modifying or accessing session state (e.g., `luo_session_create()`, `luo_session_retrieve()`, `luo_session_release()`, and `luo_session_ioctl()`).h]h)}(hReaders: Taken by any path modifying or accessing session state (e.g., `luo_session_create()`, `luo_session_retrieve()`, `luo_session_release()`, and `luo_session_ioctl()`).h](hGReaders: Taken by any path modifying or accessing session state (e.g., }(hjhhhNhNubj)}(h`luo_session_create()`h]hluo_session_create()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h`luo_session_retrieve()`h]hluo_session_retrieve()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }hjsbj)}(h`luo_session_release()`h]hluo_session_release()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, and }(hjhhhNhNubj)}(h`luo_session_ioctl()`h]hluo_session_ioctl()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh).}(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&]uh1jhjubj)}(hWriter: Taken by the serialization process (`luo_session_serialize()`) during reboot. On success, the write lock is held indefinitely to freeze the subsystem. On failure, it is released to allow recovery. h]h)}(hWriter: Taken by the serialization process (`luo_session_serialize()`) during reboot. On success, the write lock is held indefinitely to freeze the subsystem. On failure, it is released to allow recovery.h](h,Writer: Taken by the serialization process (}(hjhhhNhNubj)}(h`luo_session_serialize()`h]hluo_session_serialize()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh) during reboot. On success, the write lock is held indefinitely to freeze the subsystem. On failure, it is released to allow recovery.}(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&]uh1jhjubeh}(h]h ]h"]h$]h&]jkjluh1jhjhK:hj}ubeh}(h]h ]h"]h$]h&]uh1jhjzubj)}(hX3`luo_session_header->rwsem` (per-list rwsem): Synchronizes list-level operations for the incoming and outgoing session headers. - Writer: Taken during list mutation operations (inserting or removing a session from the list). - Reader: Taken when traversing the list (e.g., retrieving a session by name). h](h)}(h`luo_session_header->rwsem` (per-list rwsem): Synchronizes list-level operations for the incoming and outgoing session headers.h](j)}(h`luo_session_header->rwsem`h]hluo_session_header->rwsem}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubhd (per-list rwsem): Synchronizes list-level operations for the incoming and outgoing session headers.}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKAhj9ubj)}(hhh](j)}(h^Writer: Taken during list mutation operations (inserting or removing a session from the list).h]h)}(h^Writer: Taken during list mutation operations (inserting or removing a session from the list).h]h^Writer: Taken during list mutation operations (inserting or removing a session from the list).}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKDhj]ubah}(h]h ]h"]h$]h&]uh1jhjZubj)}(hMReader: Taken when traversing the list (e.g., retrieving a session by name). h]h)}(hLReader: Taken when traversing the list (e.g., retrieving a session by name).h]hLReader: Taken when traversing the list (e.g., retrieving a session by name).}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKFhjvubah}(h]h ]h"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]jkjluh1jhjohKDhj9ubeh}(h]h ]h"]h$]h&]uh1jhjzubj)}(h`luo_session->mutex` (per-session mutex): Protects the internal state and file sets of an individual session. It is acquired during per-session operations such as preserving, retrieving, or freezing files. h]h)}(h`luo_session->mutex` (per-session mutex): Protects the internal state and file sets of an individual session. It is acquired during per-session operations such as preserving, retrieving, or freezing files.h](j)}(h`luo_session->mutex`h]hluo_session->mutex}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh (per-session mutex): Protects the internal state and file sets of an individual session. It is acquired during per-session operations such as preserving, retrieving, or freezing files.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKHhjubah}(h]h ]h"]h$]h&]uh1jhjzubeh}(h]h ]h"]h$]h&]jWjXjYhjZj[uh1j|hjhhhNhNubhdefinition_list)}(hhh]hdefinition_list_item)}(hfLock Hierarchy: `luo_session_serialize_rwsem` -> `luo_session_header->rwsem` -> `luo_session->mutex` h](hterm)}(hLock Hierarchy:h]hLock Hierarchy:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKOhjubh definition)}(hhh]h)}(hT`luo_session_serialize_rwsem` -> `luo_session_header->rwsem` -> `luo_session->mutex`h](j)}(h`luo_session_serialize_rwsem`h]hluo_session_serialize_rwsem}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh -> }(hjhhhNhNubj)}(h`luo_session_header->rwsem`h]hluo_session_header->rwsem}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh -> }hjsbj)}(h`luo_session->mutex`h]hluo_session->mutex}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:13: ./kernel/liveupdate/luo_session.chKNhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKOhjubah}(h]h ]h"]h$]h&]uh1jhjhhhNhNubeh}(h] luo-sessionsah ]h"] luo sessionsah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hLUO Preserving File Descriptorsh]hLUO Preserving File Descriptors}(hjChhhNhNubah}(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.}(hjQhhhNhNubah}(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.}(hj`hhhNhNubah}(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 }(hjohhhNhNubh)}(hB:c:type:`struct liveupdate_file_handler `h]j)}(hjyh]hstruct liveupdate_file_handler}(hj{hhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]refdoccore-api/liveupdate refdomainjreftypetype refexplicitrefwarn reftargetliveupdate_file_handleruh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chKhjoubht. This handler provides a set of callbacks that LUO invokes at different stages of the update process, most notably:}(hjohhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhj@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.}(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&]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.}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK'hjDubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jkjluh1jhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj@hhubh)}(h'File Preservation Lifecycle happy path:h]h'File Preservation Lifecycle happy path:}(hjihhhNhNubah}(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 }(hjhhhNhNubh)}(h$:c:type:`struct luo_file `h]j)}(hjh]hstruct luo_file}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjluo_fileuh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:18: ./kernel/liveupdate/luo_file.chK,hjubh to track the live state.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK,hj{ubah}(h]h ]h"]h$]h&]uh1jhjxubj)}(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&]uh1jhjxubj)}(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 ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjluo_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&]uh1jhjxubj)}(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 ](jjc-typeeh"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjliveupdate_flb_opsuh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chKhj4ubh!) that LUO invokes at key points:}(hj4hhhNhNubeh}(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)}(hjoh]h;.preserve(): Called for the first file. Saves global state.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:23: ./kernel/liveupdate/luo_flb.chKhjmubah}(h]h ]h"]h$]h&]uh1jhjjubj)}(h@.unpreserve(): Called for the last file (if aborted pre-reboot).h]h)}(hjh]h@.unpreserve(): Called for the last file (if aborted pre-reboot).}(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&]uh1jhjjubj)}(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&]uh1jhjjubj)}(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&]uh1jhjjubeh}(h]h ]h"]h$]h&]jkjluh1jhj~hKhjfubah}(h]h ]h"]h$]h&]uh1jhj~hKhjhhubh)}(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 registers the central `struct luo_ser` via the KHO raw subtree API.h](hLive 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 registers the central }(hj hhhNhNubj)}(h`struct luo_ser`h]hstruct luo_ser}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh via the KHO raw subtree API.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK hjhhubh)}(hX`This interface is a contract. Any modification to the structure fields, 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](hqThis interface is a contract. Any modification to the structure fields, compatible strings, or the layout of the }(hj# hhhNhNubj)}(h `__packed`h]h__packed}(hj+ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj# ubh serialization structures defined here constitutes a breaking change. Such changes require incrementing the version number in the relevant }(hj# hhhNhNubj)}(h `_COMPATIBLE`h]h _COMPATIBLE}(hj= hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj# ubhM string to prevent a new kernel from misinterpreting data from an old kernel.}(hj# hhhNhNubeh}(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.}(hjV hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhjhhubj)}(hhh](j)}(hKHO Structure Overview: The entire LUO state is encapsulated within a single KHO entry named "LUO". This entry contains the `struct luo_ser` structure. h](j)}(hKHO Structure Overview:h]hKHO Structure Overview:}(hjl hhhNhNubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhjh ubj)}(hhh]h)}(hThe entire LUO state is encapsulated within a single KHO entry named "LUO". This entry contains the `struct luo_ser` structure.h](hhThe entire LUO state is encapsulated within a single KHO entry named “LUO”. This entry contains the }(hj~ hhhNhNubj)}(h`struct luo_ser`h]hstruct luo_ser}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ ubh structure.}(hj~ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhj{ ubah}(h]h ]h"]h$]h&]uh1jhjh ubeh}(h]h ]h"]h$]h&]uh1jhjz hKhje ubj)}(hX5Serialization Structures: - struct luo_ser: The central ABI structure that contains the overall state of the LUO. It includes the compatibility string, the liveupdate-number, and pointers to sessions and FLBs. - struct luo_session_ser: Metadata for a single session, including its name and a physical pointer to the first `struct kho_block_header_ser` for all files in that session. Multiple blocks are linked via the `next` field in the header. - struct luo_file_ser: Metadata for a single preserved file. Contains the `compatible` string to find the correct handler in the new kernel, a user-provided `token` for identification, and an opaque `data` handle for the handler to use. - struct luo_flb_header_ser: Header for the FLB array. Contains the total page count of the preserved memory block and the number of `struct luo_flb_ser` entries that follow. - struct luo_flb_ser: Metadata for a single preserved global object. Contains its `name` (compatible string), an opaque `data` handle, and the `count` number of files depending on it. h](j)}(hSerialization Structures:h]hSerialization Structures:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK5hj ubj)}(hhh]j)}(hhh](j)}(hstruct luo_ser: The central ABI structure that contains the overall state of the LUO. It includes the compatibility string, the liveupdate-number, and pointers to sessions and FLBs. h]h)}(hstruct luo_ser: The central ABI structure that contains the overall state of the LUO. It includes the compatibility string, the liveupdate-number, and pointers to sessions and FLBs.h]hstruct luo_ser: The central ABI structure that contains the overall state of the LUO. It includes the compatibility string, the liveupdate-number, and pointers to sessions and FLBs.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hstruct luo_session_ser: Metadata for a single session, including its name and a physical pointer to the first `struct kho_block_header_ser` for all files in that session. Multiple blocks are linked via the `next` field in the header. h]h)}(hstruct luo_session_ser: Metadata for a single session, including its name and a physical pointer to the first `struct kho_block_header_ser` for all files in that session. Multiple blocks are linked via the `next` field in the header.h](hnstruct luo_session_ser: Metadata for a single session, including its name and a physical pointer to the first }(hj hhhNhNubj)}(h`struct kho_block_header_ser`h]hstruct kho_block_header_ser}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhC for all files in that session. Multiple blocks are linked via the }(hj hhhNhNubj)}(h`next`h]hnext}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh field in the header.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK"hj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hstruct luo_file_ser: Metadata for a single preserved file. Contains the `compatible` string to find the correct handler in the new kernel, a user-provided `token` for identification, and an opaque `data` handle for the handler to use. h]h)}(hstruct luo_file_ser: Metadata for a single preserved file. Contains the `compatible` string to find the correct handler in the new kernel, a user-provided `token` for identification, and an opaque `data` handle for the handler to use.h](hHstruct luo_file_ser: Metadata for a single preserved file. Contains the }(hj hhhNhNubj)}(h `compatible`h]h compatible}(hj& hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhG string to find the correct handler in the new kernel, a user-provided }(hj hhhNhNubj)}(h`token`h]htoken}(hj8 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh# for identification, and an opaque }(hj hhhNhNubj)}(h`data`h]hdata}(hjJ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh handle for the handler to use.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK'hj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hstruct luo_flb_header_ser: Header for the FLB array. Contains the total page count of the preserved memory block and the number of `struct luo_flb_ser` entries that follow. h]h)}(hstruct luo_flb_header_ser: Header for the FLB array. Contains the total page count of the preserved memory block and the number of `struct luo_flb_ser` entries that follow.h](hstruct luo_flb_header_ser: Header for the FLB array. Contains the total page count of the preserved memory block and the number of }(hjm hhhNhNubj)}(h`struct luo_flb_ser`h]hstruct luo_flb_ser}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjm ubh entries that follow.}(hjm hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK,hji ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hstruct luo_flb_ser: Metadata for a single preserved global object. Contains its `name` (compatible string), an opaque `data` handle, and the `count` number of files depending on it. h]h)}(hstruct luo_flb_ser: Metadata for a single preserved global object. Contains its `name` (compatible string), an opaque `data` handle, and the `count` number of files depending on it.h](hPstruct luo_flb_ser: Metadata for a single preserved global object. Contains its }(hj hhhNhNubj)}(h`name`h]hname}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh (compatible string), an opaque }(hj hhhNhNubj)}(h`data`h]hdata}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh handle, and the }(hj hhhNhNubj)}(h`count`h]hcount}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh! number of files depending on it.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:28: ./include/linux/kho/abi/luo.hhK1hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]jkjluh1jhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK5hje ubeh}(h]h ]h"]h$]h&]uh1jhjhhhNhNubh)}(h8The following types of file descriptors can be preservedh]h8The following types of file descriptors can be preserved}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubhcompound)}(hhh]htoctree)}(hhh]h}(h]h ]h"]h$]h&]hjentries]Nmm/memfd_preservationa includefiles]j amaxdepthKcaptionNglobhidden includehiddennumberedK titlesonly rawentries]uh1j hhhK!hj ubah}(h]h ]toctree-wrapperah"]h$]h&]uh1j hjhhhhhNubeh}(h]live-update-orchestrator-abiah ]h"]live update orchestrator abiah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Public APIh]h Public API}(hj: hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7 hhhhhK'ubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](single"liveupdate_file_op_args (C struct)c.liveupdate_file_op_argshNtauh1jH hj7 hhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhNubhdesc)}(hhh](hdesc_signature)}(hliveupdate_file_op_argsh]hdesc_signature_line)}(hstruct liveupdate_file_op_argsh](hdesc_sig_keyword)}(hstructh]hstruct}(hjm hhhNhNubah}(h]h ]kah"]h$]h&]uh1jk hjg hhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKubhdesc_sig_space)}(h h]h }(hj hhhNhNubah}(h]h ]wah"]h$]h&]uh1j} hjg hhhj| hKubh desc_name)}(hliveupdate_file_op_argsh]h desc_sig_name)}(hjc h]hliveupdate_file_op_args}(hj hhhNhNubah}(h]h ]nah"]h$]h&]uh1j hj ubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1j hjg hhhj| hKubeh}(h]h ]h"]h$]h&]hhƌ add_permalinkuh1je sphinx_line_type declaratorhja hhhj| hKubah}(h]jW ah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1j_ hj| hKhj\ hhubh desc_content)}(hhh]h)}(h'Arguments for file operation callbacks.h]h'Arguments for file operation callbacks.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj hhubah}(h]h ]h"]h$]h&]uh1j hj\ hhhj| hKubeh}(h]h ](jstructeh"]h$]h&]domainjobjtypej desctypej noindex noindexentrynocontentsentryuh1jZ hhhj7 hjY hNubh container)}(hX**Definition**:: struct liveupdate_file_op_args { struct liveupdate_file_handler *handler; int retrieve_status; struct file *file; u64 serialized_data; void *private_data; }; **Members** ``handler`` The file handler being called. ``retrieve_status`` The retrieve status for the 'can_finish / finish' operation. A value of 0 means the 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. ``file`` The file object. For retrieve: [OUT] The callback sets this to the new file. For other ops: [IN] The caller sets this to the file being operated on. ``serialized_data`` The opaque u64 handle, preserve/prepare/freeze may update this field. ``private_data`` 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](h)}(h**Definition**::h](hstrong)}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj ubh literal_block)}(hstruct liveupdate_file_op_args { struct liveupdate_file_handler *handler; int retrieve_status; struct file *file; u64 serialized_data; void *private_data; };h]hstruct liveupdate_file_op_args { struct liveupdate_file_handler *handler; int retrieve_status; struct file *file; u64 serialized_data; void *private_data; };}hj sbah}(h]h ]h"]h$]h&]hhuh1j h^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK hj ubh)}(h **Members**h]j )}(hj h]hMembers}(hj! hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK(hj ubj)}(hhh](j)}(h+``handler`` The file handler being called. h](j)}(h ``handler``h]j)}(hj> h]hhandler}(hj@ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj< ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj8 ubj)}(hhh]h)}(hThe file handler being called.h]hThe file handler being called.}(hjW hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjS hKhjT ubah}(h]h ]h"]h$]h&]uh1jhj8 ubeh}(h]h ]h"]h$]h&]uh1jhjS hKhj5 ubj)}(hX``retrieve_status`` The retrieve status for the 'can_finish / finish' operation. A value of 0 means the 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](j)}(h``retrieve_status``h]j)}(hjw h]hretrieve_status}(hjy hhhNhNubah}(h]h ]h"]h$]h&]uh1jhju ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK!hjq ubj)}(hhh]h)}(hXThe retrieve status for the 'can_finish / finish' operation. A value of 0 means the 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]hX The retrieve status for the ‘can_finish / finish’ operation. A value of 0 means the 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:40: ./include/linux/liveupdate.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhjq ubeh}(h]h ]h"]h$]h&]uh1jhj hK!hj5 ubj)}(h``file`` The file object. For retrieve: [OUT] The callback sets this to the new file. For other ops: [IN] The caller sets this to the file being operated on. h](j)}(h``file``h]j)}(hj h]hfile}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK$hj ubj)}(hhh]h)}(hThe file object. For retrieve: [OUT] The callback sets this to the new file. For other ops: [IN] The caller sets this to the file being operated on.h]hThe file object. For retrieve: [OUT] The callback sets this to the new file. For other ops: [IN] The caller sets this to the file being operated on.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK"hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK$hj5 ubj)}(hZ``serialized_data`` The opaque u64 handle, preserve/prepare/freeze may update this field. h](j)}(h``serialized_data``h]j)}(hj h]hserialized_data}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK&hj ubj)}(hhh]h)}(hEThe opaque u64 handle, preserve/prepare/freeze may update this field.h]hEThe opaque u64 handle, preserve/prepare/freeze may update this field.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK%hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK&hj5 ubj)}(h``private_data`` 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](j)}(h``private_data``h]j)}(hj% h]h private_data}(hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj# ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK)hj ubj)}(hhh]h)}(hPrivate 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]hPrivate 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.}(hj> hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK'hj; ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj: hK)hj5 ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjY hNubh)}(h**Description**h]j )}(hjh h]h Description}(hjj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjf ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK-hj7 hhubh)}(hThis structure bundles all parameters for the file operation callbacks. The 'data' and 'file' fields are used for both input and output.h]hThis structure bundles all parameters for the file operation callbacks. The ‘data’ and ‘file’ fields are used for both input and output.}(hj~ hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK*hj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU liveupdate_file_ops (C struct)c.liveupdate_file_opshNtauh1jH hj7 hhhjY hNubj[ )}(hhh](j` )}(hliveupdate_file_opsh]jf )}(hstruct liveupdate_file_opsh](jl )}(hjo h]hstruct}(hj hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj hhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK0ubj~ )}(h h]h }(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj hhhj hK0ubj )}(hliveupdate_file_opsh]j )}(hj h]hliveupdate_file_ops}(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj hhhj hK0ubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj hhhj hK0ubah}(h]j ah ](j j eh"]h$]h&]j j )j huh1j_ hj hK0hj hhubj )}(hhh]h)}(h#Callbacks for live-updatable files.h]h#Callbacks for live-updatable files.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK7hj hhubah}(h]h ]h"]h$]h&]uh1j hj hhhj hK0ubeh}(h]h ](jstructeh"]h$]h&]j jj jj jj j j uh1jZ hhhj7 hjY hNubj )}(hX**Definition**:: struct liveupdate_file_ops { bool (*can_preserve)(struct liveupdate_file_handler *handler, struct file *file); int (*preserve)(struct liveupdate_file_op_args *args); void (*unpreserve)(struct liveupdate_file_op_args *args); int (*freeze)(struct liveupdate_file_op_args *args); void (*unfreeze)(struct liveupdate_file_op_args *args); int (*retrieve)(struct liveupdate_file_op_args *args); bool (*can_finish)(struct liveupdate_file_op_args *args); void (*finish)(struct liveupdate_file_op_args *args); unsigned long (*get_id)(struct file *file); struct module *owner; }; **Members** ``can_preserve`` Required. Lightweight check to see if this handler is compatible with the given file. ``preserve`` Required. Performs state-saving for the file. ``unpreserve`` Required. Cleans up any resources allocated by **preserve**. ``freeze`` Optional. Final actions just before kernel transition. ``unfreeze`` Optional. Undo freeze operations. ``retrieve`` Required. Restores the file in the new kernel. ``can_finish`` Optional. Check if this FD can finish, i.e. all restoration pre-requirements for this FD are satisfied. Called prior to finish, in order to do successful finish calls for all resources in the session. ``finish`` Required. Final cleanup in the new kernel. ``get_id`` Optional. Returns a unique identifier for the file. ``owner`` Module referenceh](h)}(h**Definition**::h](j )}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK;hjubj )}(hX`struct liveupdate_file_ops { bool (*can_preserve)(struct liveupdate_file_handler *handler, struct file *file); int (*preserve)(struct liveupdate_file_op_args *args); void (*unpreserve)(struct liveupdate_file_op_args *args); int (*freeze)(struct liveupdate_file_op_args *args); void (*unfreeze)(struct liveupdate_file_op_args *args); int (*retrieve)(struct liveupdate_file_op_args *args); bool (*can_finish)(struct liveupdate_file_op_args *args); void (*finish)(struct liveupdate_file_op_args *args); unsigned long (*get_id)(struct file *file); struct module *owner; };h]hX`struct liveupdate_file_ops { bool (*can_preserve)(struct liveupdate_file_handler *handler, struct file *file); int (*preserve)(struct liveupdate_file_op_args *args); void (*unpreserve)(struct liveupdate_file_op_args *args); int (*freeze)(struct liveupdate_file_op_args *args); void (*unfreeze)(struct liveupdate_file_op_args *args); int (*retrieve)(struct liveupdate_file_op_args *args); bool (*can_finish)(struct liveupdate_file_op_args *args); void (*finish)(struct liveupdate_file_op_args *args); unsigned long (*get_id)(struct file *file); struct module *owner; };}hj%sbah}(h]h ]h"]h$]h&]hhuh1j h^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK=hjubh)}(h **Members**h]j )}(hj6h]hMembers}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKJhjubj)}(hhh](j)}(hg``can_preserve`` Required. Lightweight check to see if this handler is compatible with the given file. h](j)}(h``can_preserve``h]j)}(hjUh]h can_preserve}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK:hjOubj)}(hhh]h)}(hURequired. Lightweight check to see if this handler is compatible with the given file.h]hURequired. Lightweight check to see if this handler is compatible with the given file.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK9hjkubah}(h]h ]h"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]uh1jhjjhK:hjLubj)}(h;``preserve`` Required. Performs state-saving for the file. h](j)}(h ``preserve``h]j)}(hjh]hpreserve}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK;hjubj)}(hhh]h)}(h-Required. Performs state-saving for the file.h]h-Required. Performs state-saving for the file.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK;hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK;hjLubj)}(hL``unpreserve`` Required. Cleans up any resources allocated by **preserve**. h](j)}(h``unpreserve``h]j)}(hjh]h unpreserve}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjFubj)}(hhh]h)}(h!Optional. Undo freeze operations.h]h!Optional. Undo freeze operations.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhjahK>hjbubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhjahK>hjLubj)}(h<``retrieve`` Required. Restores the file in the new kernel. h](j)}(h ``retrieve``h]j)}(hjh]hretrieve}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK?hjubj)}(hhh]h)}(h.Required. Restores the file in the new kernel.h]h.Required. Restores the file in the new kernel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK?hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK?hjLubj)}(h``can_finish`` Optional. Check if this FD can finish, i.e. all restoration pre-requirements for this FD are satisfied. Called prior to finish, in order to do successful finish calls for all resources in the session. h](j)}(h``can_finish``h]j)}(hjh]h can_finish}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKChjubj)}(hhh]h)}(hOptional. Check if this FD can finish, i.e. all restoration pre-requirements for this FD are satisfied. Called prior to finish, in order to do successful finish calls for all resources in the session.h]hOptional. Check if this FD can finish, i.e. all restoration pre-requirements for this FD are satisfied. Called prior to finish, in order to do successful finish calls for all resources in the session.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK@hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKChjLubj)}(h6``finish`` Required. Final cleanup in the new kernel. h](j)}(h ``finish``h]j)}(hjh]hfinish}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKDhjubj)}(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&]uh1hhj hKDhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj hKDhjLubj)}(h?``get_id`` Optional. Returns a unique identifier for the file. h](j)}(h ``get_id``h]j)}(hj1h]hget_id}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKEhj+ubj)}(hhh]h)}(h3Optional. Returns a unique identifier for the file.h]h3Optional. Returns a unique identifier for the file.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhKEhjGubah}(h]h ]h"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]uh1jhjFhKEhjLubj)}(h``owner`` Module referenceh](j)}(h ``owner``h]j)}(hjjh]howner}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKEhjdubj)}(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.hhKFhjubah}(h]h ]h"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]uh1jhjhKEhjLubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjY hNubh)}(h**Description**h]j )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKIhj7 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.hhKFhj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU "liveupdate_file_handler (C struct)c.liveupdate_file_handlerhNtauh1jH hj7 hhhjY hNubj[ )}(hhh](j` )}(hliveupdate_file_handlerh]jf )}(hstruct liveupdate_file_handlerh](jl )}(hjo h]hstruct}(hjhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjhhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKLubj~ )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjhhhjhKLubj )}(hliveupdate_file_handlerh]j )}(hjh]hliveupdate_file_handler}(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j j eh"]h$]h&]hhuh1j hjhhhjhKLubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjhhhjhKLubah}(h]jah ](j j eh"]h$]h&]j j )j huh1j_ hjhKLhjhhubj )}(hhh]h)}(h4Represents a handler for a live-updatable file type.h]h4Represents a handler for a live-updatable file type.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKYhj*hhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhKLubeh}(h]h ](jstructeh"]h$]h&]j jj jEj jEj j j uh1jZ hhhj7 hjY hNubj )}(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](j )}(h**Definition**h]h Definition}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjMubh:}(hjMhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK]hjIubj )}(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]; };}hjjsbah}(h]h ]h"]h$]h&]hhuh1j h^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK_hjIubh)}(h **Members**h]j )}(hj{h]hMembers}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjyubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKdhjIubj)}(hhh](j)}(h``ops`` Callback functions h](j)}(h``ops``h]j)}(hjh]hops}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK[hjubj)}(hhh]h)}(hCallback functionsh]hCallback functions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK[hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK[hjubj)}(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](j)}(h``compatible``h]j)}(hjh]h compatible}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK^hjubj)}(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 }(hjhhhNhNubh)}(h:c:type:`struct file `h]j)}(hjh]h struct file}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarn c:parent_keysphinx.domains.c LookupKey)}data]sbjfileuh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK\hjubh instances.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK\hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK^hjubeh}(h]h ]h"]h$]h&]uh1jhjIubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjY hNubh)}(h**Description**h]j )}(hjAh]h Description}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1j hj?ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKbhj7 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.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK_hj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU !liveupdate_flb_op_args (C struct)c.liveupdate_flb_op_argshNtauh1jH hj7 hhhjY hNubj[ )}(hhh](j` )}(hliveupdate_flb_op_argsh]jf )}(hstruct liveupdate_flb_op_argsh](jl )}(hjo h]hstruct}(hjhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj{hhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKgubj~ )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj{hhhjhKgubj )}(hliveupdate_flb_op_argsh]j )}(hjyh]hliveupdate_flb_op_args}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j j eh"]h$]h&]hhuh1j hj{hhhjhKgubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjwhhhjhKgubah}(h]jrah ](j j eh"]h$]h&]j j )j huh1j_ hjhKghjthhubj )}(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.hhKuhjhhubah}(h]h ]h"]h$]h&]uh1j hjthhhjhKgubeh}(h]h ](jstructeh"]h$]h&]j jj jj jj j j uh1jZ hhhj7 hjY hNubj )}(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](j )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKyhjubj )}(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; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j h^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK{hjubh)}(h **Members**h]j )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(hhh](j)}(hB``flb`` The global FLB instance for which this call is performed. h](j)}(h``flb``h]j)}(hj.h]hflb}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKwhj(ubj)}(hhh]h)}(h9The global FLB instance for which this call is performed.h]h9The global FLB instance for which this call is performed.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjChKwhjDubah}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhjChKwhj%ubj)}(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](j)}(h``data``h]j)}(hjgh]hdata}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjeubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKzhjaubj)}(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.hhKxhj}ubah}(h]h ]h"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]uh1jhj|hKzhj%ubj)}(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](j)}(h``obj``h]j)}(hjh]hobj}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK|hjubj)}(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.hhK{hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK|hj%ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjY hNubh)}(h**Description**h]j )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj7 hhubh)}(hFThis structure bundles all parameters for the FLB operation callbacks.h]hFThis structure bundles all parameters for the FLB operation callbacks.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhK}hj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU liveupdate_flb_ops (C struct)c.liveupdate_flb_opshNtauh1jH hj7 hhhjY hNubj[ )}(hhh](j` )}(hliveupdate_flb_opsh]jf )}(hstruct liveupdate_flb_opsh](jl )}(hjo h]hstruct}(hj"hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjhhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKubj~ )}(h h]h }(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjhhhj/hKubj )}(hliveupdate_flb_opsh]j )}(hjh]hliveupdate_flb_ops}(hjBhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj>ubah}(h]h ](j j eh"]h$]h&]hhuh1j hjhhhj/hKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjhhhj/hKubah}(h]jah ](j j eh"]h$]h&]j j )j huh1j_ hj/hKhjhhubj )}(hhh]h)}(h/Callbacks for global File-Lifecycle-Bound data.h]h/Callbacks for global File-Lifecycle-Bound data.}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjahhubah}(h]h ]h"]h$]h&]uh1j hjhhhj/hKubeh}(h]h ](jstructeh"]h$]h&]j jj j|j j|j j j uh1jZ hhhj7 hjY hNubj )}(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](j )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj )}(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&]hhuh1j h^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubh)}(h **Members**h]j )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(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](j)}(h ``preserve``h]j)}(hjh]hpreserve}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(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’.}(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&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(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](j)}(h``unpreserve``h]j)}(hj h]h unpreserve}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(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’.}(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&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj 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](j)}(h ``retrieve``h]j)}(hjEh]hretrieve}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj?ubj)}(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.}(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&]uh1jhj?ubeh}(h]h ]h"]h$]h&]uh1jhjZhKhjubj)}(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](j)}(h ``finish``h]j)}(hjh]hfinish}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjyubj)}(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&]uh1jhjyubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h``owner`` Module referenceh](j)}(h ``owner``h]j)}(hjh]howner}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(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&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjY hNubh)}(h**Description**h]j )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj7 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.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU liveupdate_flb (C struct)c.liveupdate_flbhNtauh1jH hj7 hhhjY hNubj[ )}(hhh](j` )}(hliveupdate_flbh]jf )}(hstruct liveupdate_flbh](jl )}(hjo h]hstruct}(hj:hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj6hhh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKubj~ )}(h h]h }(hjHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj6hhhjGhKubj )}(hliveupdate_flbh]j )}(hj4h]hliveupdate_flb}(hjZhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjVubah}(h]h ](j j eh"]h$]h&]hhuh1j hj6hhhjGhKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj2hhhjGhKubah}(h]j-ah ](j j eh"]h$]h&]j j )j huh1j_ hjGhKhj/hhubj )}(hhh]h)}(h-A global definition for a shared data object.h]h-A global definition for a shared data object.}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjyhhubah}(h]h ]h"]h$]h&]uh1j hj/hhhjGhKubeh}(h]h ](jstructeh"]h$]h&]j jj jj jj j j uh1jZ hhhj7 hjY hNubj )}(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](j )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj )}(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&]hhuh1j h^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubh)}(h **Members**h]j )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(hhh](j)}(h``ops`` Callback functions h](j)}(h``ops``h]j)}(hjh]hops}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(hhh]h)}(hCallback functionsh]hCallback functions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(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](j)}(h``compatible``h]j)}(hj"h]h compatible}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhjubj)}(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)}(hjEh]hstruct liveupdate_flb}(hjGhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjjliveupdate_flbuh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj;ubh instances.}(hj;hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjbhKhj8ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj7hKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjY hNubh)}(h**Description**h]j )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:40: ./include/linux/liveupdate.hhKhj7 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.hhKhj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_ser (C struct) c.luo_serhNtauh1jH hj7 hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhNubj[ )}(hhh](j` )}(hluo_serh]jf )}(hstruct luo_serh](jl )}(hjo h]hstruct}(hjhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk 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_serh]j )}(hjh]hluo_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 uh1je j j hjhhhjhKubah}(h]jah ](j j eh"]h$]h&]j j )j huh1j_ hjhKhjhhubj )}(hhh]h)}(hCentralized LUO ABI header.h]hCentralized LUO ABI header.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKHhjhhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhKubeh}(h]h ](jstructeh"]h$]h&]j jj j!j j!j j j uh1jZ hhhj7 hjhNubj )}(hX**Definition**:: struct luo_ser { char compatible[LUO_ABI_COMPAT_LEN]; u64 liveupdate_num; u64 sessions_pa; u64 flbs_pa; }; **Members** ``compatible`` Compatibility string identifying the LUO ABI version. ``liveupdate_num`` A counter tracking the number of successful live updates. ``sessions_pa`` Physical address of the first session block header. ``flbs_pa`` Physical address of the FLB header.h](h)}(h**Definition**::h](j )}(h**Definition**h]h Definition}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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.hhKLhj%ubj )}(hzstruct luo_ser { char compatible[LUO_ABI_COMPAT_LEN]; u64 liveupdate_num; u64 sessions_pa; u64 flbs_pa; };h]hzstruct luo_ser { char compatible[LUO_ABI_COMPAT_LEN]; u64 liveupdate_num; u64 sessions_pa; u64 flbs_pa; };}hjFsbah}(h]h ]h"]h$]h&]hhuh1j h_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKNhj%ubh)}(h **Members**h]j )}(hjWh]hMembers}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjUubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKUhj%ubj)}(hhh](j)}(hE``compatible`` Compatibility string identifying the LUO ABI version. h](j)}(h``compatible``h]j)}(hjvh]h compatible}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKJhjpubj)}(hhh]h)}(h5Compatibility string identifying the LUO ABI version.h]h5Compatibility string identifying the LUO ABI version.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKJhjubah}(h]h ]h"]h$]h&]uh1jhjpubeh}(h]h ]h"]h$]h&]uh1jhjhKJhjmubj)}(hM``liveupdate_num`` A counter tracking the number of successful live updates. h](j)}(h``liveupdate_num``h]j)}(hjh]hliveupdate_num}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKKhjubj)}(hhh]h)}(h9A counter tracking the number of successful live updates.h]h9A counter tracking the number of successful live updates.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKKhjmubj)}(hD``sessions_pa`` Physical address of the first session block header. h](j)}(h``sessions_pa``h]j)}(hjh]h sessions_pa}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKLhjubj)}(hhh]h)}(h3Physical address of the first session block header.h]h3Physical address of the first session block header.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKLhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKLhjmubj)}(h/``flbs_pa`` Physical address of the FLB header.h](j)}(h ``flbs_pa``h]j)}(hj!h]hflbs_pa}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKLhjubj)}(hhh]h)}(h#Physical address of the FLB header.h]h#Physical address of the FLB header.}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKMhj7ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj6hKLhjmubeh}(h]h ]h"]h$]h&]uh1jhj%ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjhNubh)}(h**Description**h]j )}(hjdh]h Description}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjbubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKPhj7 hhubh)}(h6This structure is the root of all preserved LUO state.h]h6This structure is the root of all preserved LUO state.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKMhj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_file_ser (C struct)c.luo_file_serhNtauh1jH hj7 hhhjhNubj[ )}(hhh](j` )}(h luo_file_serh]jf )}(hstruct luo_file_serh](jl )}(hjo h]hstruct}(hjhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKRubj~ )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjhhhjhKRubj )}(h luo_file_serh]j )}(hjh]h luo_file_ser}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j j eh"]h$]h&]hhuh1j hjhhhjhKRubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjhhhjhKRubah}(h]jah ](j j eh"]h$]h&]j j )j huh1j_ hjhKRhjhhubj )}(hhh]h)}(h*Represents the serialized preserves files.h]h*Represents the serialized preserves files.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKZhjhhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhKRubeh}(h]h ](jstructeh"]h$]h&]j jj jj jj j j uh1jZ hhhj7 hjhNubj )}(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](j )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK^hjubj )}(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; };}hj!sbah}(h]h ]h"]h$]h&]hhuh1j h_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK`hjubh)}(h **Members**h]j )}(hj2h]hMembers}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKfhjubj)}(hhh](j)}(h/``compatible`` File handler compatible string. h](j)}(h``compatible``h]j)}(hjQh]h compatible}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK\hjKubj)}(hhh]h)}(hFile handler compatible string.h]hFile handler compatible string.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhK\hjgubah}(h]h ]h"]h$]h&]uh1jhjKubeh}(h]h ]h"]h$]h&]uh1jhjfhK\hjHubj)}(h``data`` Private data h](j)}(h``data``h]j)}(hjh]hdata}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK]hjubj)}(hhh]h)}(h Private datah]h Private data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK]hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK]hjHubj)}(h+``token`` User provided token for this fileh](j)}(h ``token``h]j)}(hjh]htoken}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK]hjubj)}(hhh]h)}(h!User provided token for this fileh]h!User provided token for this file}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK^hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK]hjHubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjhNubh)}(h**Description**h]j )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKahj7 hhubh)}(hDIf this structure is modified, `LUO_ABI_COMPATIBLE` must be updated.h](hIf this structure is modified, }(hjhhhNhNubj)}(h`LUO_ABI_COMPATIBLE`h]hLUO_ABI_COMPATIBLE}(hj$hhhNhNubah}(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.hhK^hj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_file_set_ser (C struct)c.luo_file_set_serhNtauh1jH hj7 hhhjhNubj[ )}(hhh](j` )}(hluo_file_set_serh]jf )}(hstruct luo_file_set_serh](jl )}(hjo h]hstruct}(hjVhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjRhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKcubj~ )}(h h]h }(hjdhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjRhhhjchKcubj )}(hluo_file_set_serh]j )}(hjPh]hluo_file_set_ser}(hjvhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjrubah}(h]h ](j j eh"]h$]h&]hhuh1j hjRhhhjchKcubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjNhhhjchKcubah}(h]jIah ](j j eh"]h$]h&]j j )j huh1j_ hjchKchjKhhubj )}(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.hhKhhjhhubah}(h]h ]h"]h$]h&]uh1j hjKhhhjchKcubeh}(h]h ](jstructeh"]h$]h&]j jj jj jj j j uh1jZ hhhj7 hjhNubj )}(hX**Definition**:: struct luo_file_set_ser { u64 files; u64 count; }; **Members** ``files`` The physical address of the first `struct kho_block_header_ser`. This structure is the header for a block of memory containing an array of `struct luo_file_ser` entries. Multiple blocks are linked via the `next` field in the header. ``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](j )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKlhjubj )}(h:struct luo_file_set_ser { u64 files; u64 count; };h]h:struct luo_file_set_ser { u64 files; u64 count; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j h_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKnhjubh)}(h **Members**h]j )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKshjubj)}(hhh](j)}(h``files`` The physical address of the first `struct kho_block_header_ser`. This structure is the header for a block of memory containing an array of `struct luo_file_ser` entries. Multiple blocks are linked via the `next` field in the header. h](j)}(h ``files``h]j)}(hjh]hfiles}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKmhjubj)}(hhh]h)}(hThe physical address of the first `struct kho_block_header_ser`. This structure is the header for a block of memory containing an array of `struct luo_file_ser` entries. Multiple blocks are linked via the `next` field in the header.h](h"The physical address of the first }(hjhhhNhNubj)}(h`struct kho_block_header_ser`h]hstruct kho_block_header_ser}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhL. This structure is the header for a block of memory containing an array of }(hjhhhNhNubj)}(h`struct luo_file_ser`h]hstruct luo_file_ser}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh- entries. Multiple blocks are linked via the }(hjhhhNhNubj)}(h`next`h]hnext}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh field in the header.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKjhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKmhjubj)}(h``count`` The total number of files that were part of this session during serialization. Used for iteration and validation during restoration.h](j)}(h ``count``h]j)}(hjuh]hcount}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKohjoubj)}(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.hhKnhjubah}(h]h ]h"]h$]h&]uh1jhjoubeh}(h]h ]h"]h$]h&]uh1jhjhKohjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_session_ser (C struct)c.luo_session_serhNtauh1jH hj7 hhhjhNubj[ )}(hhh](j` )}(hluo_session_serh]jf )}(hstruct luo_session_serh](jl )}(hjo h]hstruct}(hjhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKvubj~ )}(h h]h }(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjhhhjhKvubj )}(hluo_session_serh]j )}(hjh]hluo_session_ser}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjubah}(h]h ](j j eh"]h$]h&]hhuh1j hjhhhjhKvubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjhhhjhKvubah}(h]jah ](j j eh"]h$]h&]j j )j huh1j_ hjhKvhjhhubj )}(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.hhKwhjhhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhKvubeh}(h]h ](jstructeh"]h$]h&]j jj j)j j)j j j uh1jZ hhhj7 hjhNubj )}(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](j )}(h**Definition**h]h Definition}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj1ubh:}(hj1hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK{hj-ubj )}(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; };}hjNsbah}(h]h ]h"]h$]h&]hhuh1j h_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK}hj-ubh)}(h **Members**h]j )}(hj_h]hMembers}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1j hj]ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj-ubj)}(hhh](j)}(hd``name`` The unique name of the session, provided by the userspace at the time of session creation. h](j)}(h``name``h]j)}(hj~h]hname}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKzhjxubj)}(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.hhKyhjubah}(h]h ]h"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]uh1jhjhKzhjuubj)}(h<``file_set_ser`` Serialized files belonging to this session,h](j)}(h``file_set_ser``h]j)}(hjh]h file_set_ser}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKzhjubj)}(hhh]h)}(h+Serialized files belonging to this session,h]h+Serialized files belonging to this session,}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK{hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKzhjuubeh}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjhNubh)}(h**Description**h]j )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhK~hj7 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.hhK{hj7 hhubh)}(hDIf this structure is modified, `LUO_ABI_COMPATIBLE` must be updated.h](hIf this structure is modified, }(hj hhhNhNubj)}(h`LUO_ABI_COMPATIBLE`h]hLUO_ABI_COMPATIBLE}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh must be updated.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_flb_header_ser (C struct)c.luo_flb_header_serhNtauh1jH hj7 hhhjhNubj[ )}(hhh](j` )}(hluo_flb_header_serh]jf )}(hstruct luo_flb_header_serh](jl )}(hjo h]hstruct}(hjZhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjVhhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj~ )}(h h]h }(hjhhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjVhhhjghKubj )}(hluo_flb_header_serh]j )}(hjTh]hluo_flb_header_ser}(hjzhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjvubah}(h]h ](j j eh"]h$]h&]hhuh1j hjVhhhjghKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjRhhhjghKubah}(h]jMah ](j j eh"]h$]h&]j j )j huh1j_ hjghKhjOhhubj )}(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 hjOhhhjghKubeh}(h]h ](jstructeh"]h$]h&]j jj jj jj j j uh1jZ hhhj7 hjhNubj )}(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](j )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubj )}(h` entries. h](j)}(h ``pgcnt``h]j)}(hj h]hpgcnt}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjubj)}(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 }(hj"hhhNhNubh)}(h*:c:type:`struct luo_flb_ser `h]j)}(hj,h]hstruct luo_flb_ser}(hj.hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjj luo_flb_seruh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj"ubh entries.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjIhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(hw``count`` The number of :c:type:`struct luo_flb_ser ` entries that follow this header in the memory block.h](j)}(h ``count``h]j)}(hjfh]hcount}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjdubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj`ubj)}(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}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjj luo_flb_seruh1hhj{hKhjubh5 entries that follow this header in the memory block.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj{hKhj|ubah}(h]h ]h"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]uh1jhj{hKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjhNubh)}(h**Description**h]j )}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj7 hhubh)}(hVThis structure is located at the physical address specified by the flbs_pa in luo_ser.h]hVThis structure is located at the physical address specified by the flbs_pa in luo_ser.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj7 hhubh)}(hDIf this structure is modified, `LUO_ABI_COMPATIBLE` must be updated.h](hIf this structure is modified, }(hjhhhNhNubj)}(h`LUO_ABI_COMPATIBLE`h]hLUO_ABI_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.hhKhj7 hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_flb_ser (C struct) c.luo_flb_serhNtauh1jH hj7 hhhjhNubj[ )}(hhh](j` )}(h luo_flb_serh]jf )}(hstruct luo_flb_serh](jl )}(hjo h]hstruct}(hj* hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj& hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKubj~ )}(h h]h }(hj8 hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj& hhhj7 hKubj )}(h luo_flb_serh]j )}(hj$ h]h luo_flb_ser}(hjJ hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjF ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj& hhhj7 hKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj" hhhj7 hKubah}(h]j ah ](j j eh"]h$]h&]j j )j huh1j_ hj7 hKhj hhubj )}(hhh]h)}(h7Represents the serialized state of a single FLB object.h]h7Represents the serialized state of a single FLB object.}(hjl hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhji hhubah}(h]h ]h"]h$]h&]uh1j hj hhhj7 hKubeh}(h]h ](jstructeh"]h$]h&]j jj j j j j j j uh1jZ hhhj7 hjhNubj )}(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](j )}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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.hhKhj ubj )}(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&]hhuh1j h_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj ubh)}(h **Members**h]j )}(hj h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj ubj)}(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](j)}(h``name``h]j)}(hj h]hname}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj ubj)}(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 }(hj hhhNhNubh)}(h0:c:type:`struct liveupdate_flb `h]j)}(hj h]hstruct liveupdate_flb}(hj hhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjjliveupdate_flbuh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj ubh handler in the new kernel.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj!hKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhj ubj)}(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](j)}(h``data``h]j)}(hj6!h]hdata}(hj8!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4!ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj0!ubj)}(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.}(hjO!hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjL!ubah}(h]h ]h"]h$]h&]uh1jhj0!ubeh}(h]h ]h"]h$]h&]uh1jhjK!hKhj ubj)}(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](j)}(h ``count``h]j)}(hjp!h]hcount}(hjr!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjn!ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhjj!ubj)}(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&]uh1jhjj!ubeh}(h]h ]h"]h$]h&]uh1jhj!hKhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj7 hhhjhNubh)}(h**Description**h]j )}(hj!h]h Description}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj!ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj7 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.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj7 hhubh)}(hDIf this structure is modified, `LUO_ABI_COMPATIBLE` must be updated.h](hIf this structure is modified, }(hj!hhhNhNubj)}(h`LUO_ABI_COMPATIBLE`h]hLUO_ABI_COMPATIBLE}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh must be updated.}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:42: ./include/linux/kho/abi/luo.hhKhj7 hhubeh}(h] public-apiah ]h"] public apiah$]h&]uh1hhhhhhhhK'ubh)}(hhh](h)}(h Internal APIh]h Internal API}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hhhhhK7ubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU liveupdate_reboot (C function)c.liveupdate_reboothNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hint liveupdate_reboot (void)h]jf )}(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}(hjO"hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjK"ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj'"hhhj<"hKubhdesc_parameterlist)}(h(void)h]hdesc_parameter)}(hvoidh]j,")}(hvoidh]hvoid}(hjo"hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hjk"ubah}(h]h ]h"]h$]h&]noemphhhuh1ji"hje"ubah}(h]h ]h"]h$]h&]hhuh1jc"hj'"hhhj<"hKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj#"hhhj<"hKubah}(h]j"ah ](j j eh"]h$]h&]j j )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 ](jfunctioneh"]h$]h&]j jj j"j j"j j j uh1jZ hhhj"hNhNubj )}(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]j )}(hj"h]h Parameters}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj"ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj"ubj)}(hhh]j)}(h``void`` no arguments h](j)}(h``void``h]j)}(hj"h]hvoid}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj"ubj)}(hhh]h)}(h no argumentsh]h no arguments}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hKhj"ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj"hKhj"ubah}(h]h ]h"]h$]h&]uh1jhj"ubh)}(h**Description**h]j )}(hj#h]h Description}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU liveupdate_enabled (C function)c.liveupdate_enabledhNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hbool liveupdate_enabled (void)h]jf )}(hbool liveupdate_enabled(void)h](j,")}(hboolh]hbool}(hji#hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hje#hhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKubj~ )}(h h]h }(hjx#hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hje#hhhjw#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 hje#hhhjw#hKubjd")}(h(void)h]jj")}(hvoidh]j,")}(hvoidh]hvoid}(hj#hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj#ubah}(h]h ]h"]h$]h&]noemphhhuh1ji"hj#ubah}(h]h ]h"]h$]h&]hhuh1jc"hje#hhhjw#hKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hja#hhhjw#hKubah}(h]j\#ah ](j j eh"]h$]h&]j j )j huh1j_ hjw#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^#hhhjw#hKubeh}(h]h ](jfunctioneh"]h$]h&]j jj j#j j#j j j uh1jZ hhhj"hNhNubj )}(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]j )}(hj#h]h Parameters}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj#ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj#ubj)}(hhh]j)}(h``void`` no arguments h](j)}(h``void``h]j)}(hj$h]hvoid}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj $ubj)}(hhh]h)}(h no argumentsh]h no arguments}(hj*$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&$hKhj'$ubah}(h]h ]h"]h$]h&]uh1jhj $ubeh}(h]h ]h"]h$]h&]uh1jhj&$hKhj$ubah}(h]h ]h"]h$]h&]uh1jhj#ubh)}(h**Description**h]j )}(hjL$h]h Description}(hjN$hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjJ$ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj#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 }(hjb$hhhNhNubj)}(h``liveupdate``h]h liveupdate}(hjj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjb$ubh kernel command-line parameter.}(hjb$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:56: ./kernel/liveupdate/luo_core.chKhj#ubh)}(h;**return** true if live update is enabled, false otherwise.h](j )}(h **return**h]hreturn}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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.chKhj#ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU "luo_flb_file_preserve (C function)c.luo_flb_file_preservehNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(h>int luo_flb_file_preserve (struct liveupdate_file_handler *fh)h]jf )}(h=int luo_flb_file_preserve(struct liveupdate_file_handler *fh)h](j,")}(hinth]hint}(hj$hhhNhNubah}(h]h ]j8"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}(hj$hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj$ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj$hhhj$hKubjd")}(h$(struct liveupdate_file_handler *fh)h]jj")}(h"struct liveupdate_file_handler *fhh](jl )}(hjo h]hstruct}(hj$hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj$ubj~ )}(h h]h }(hj %hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj$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&] refdomainjreftype identifier reftargetj%modnameN classnameNjj)}j]j ASTIdentifier)}j1%j$sbc.luo_flb_file_preserveasbuh1hhj$ubj~ )}(h h]h }(hj>%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj$ubhdesc_sig_punctuation)}(h*h]h*}(hjN%hhhNhNubah}(h]h ]pah"]h$]h&]uh1jL%hj$ubj )}(hfhh]hfh}(hj]%hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj$ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj$ubah}(h]h ]h"]h$]h&]hhuh1jc"hj$hhhj$hKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj$hhhj$hKubah}(h]j$ah ](j j eh"]h$]h&]j j )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 ](jfunctioneh"]h$]h&]j jj j%j j%j j j uh1jZ hhhj"hNhNubj )}(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]j )}(hj%h]h Parameters}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj%ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj%ubj)}(hhh]j)}(hP``struct liveupdate_file_handler *fh`` The file handler for the preserved file. h](j)}(h&``struct liveupdate_file_handler *fh``h]j)}(hj%h]h"struct liveupdate_file_handler *fh}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj%ubj)}(hhh]h)}(h(The file handler for the preserved file.h]h(The file handler for the preserved file.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKhj%ubah}(h]h ]h"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]uh1jhj%hKhj%ubah}(h]h ]h"]h$]h&]uh1jhj%ubh)}(h**Description**h]j )}(hj&h]h Description}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj&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]j )}(hj9&h]hContext}(hj;&hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj7&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()}(hjO&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]j )}(hj`&h]hReturn}(hjb&hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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.}(hjv&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&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU $luo_flb_file_unpreserve (C function)c.luo_flb_file_unpreservehNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hAvoid luo_flb_file_unpreserve (struct liveupdate_file_handler *fh)h]jf )}(h@void luo_flb_file_unpreserve(struct liveupdate_file_handler *fh)h](j,")}(hvoidh]hvoid}(hj&hhhNhNubah}(h]h ]j8"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}(hj&hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj&ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj&hhhj&hMubjd")}(h$(struct liveupdate_file_handler *fh)h]jj")}(h"struct liveupdate_file_handler *fhh](jl )}(hjo h]hstruct}(hj&hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj&ubj~ )}(h h]h }(hj&hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj&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&] refdomainjreftypej1% reftargetj'modnameN classnameNjj)}j]j9%)}j1%j&sbc.luo_flb_file_unpreserveasbuh1hhj&ubj~ )}(h h]h }(hj 'hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj&ubjM%)}(hjP%h]h*}(hj.'hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj&ubj )}(hfhh]hfh}(hj;'hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj&ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj&ubah}(h]h ]h"]h$]h&]hhuh1jc"hj&hhhj&hMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj&hhhj&hMubah}(h]j&ah ](j j eh"]h$]h&]j j )j huh1j_ hj&hMhj&hhubj )}(hhh]h)}(h4Notifies FLBs that a dependent file was unpreserved.h]h4Notifies FLBs that a dependent file was unpreserved.}(hje'hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjb'hhubah}(h]h ]h"]h$]h&]uh1j hj&hhhj&hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j}'j j}'j j j uh1jZ hhhj"hNhNubj )}(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]j )}(hj'h]h Parameters}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj'ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj'ubj)}(hhh]j)}(hR``struct liveupdate_file_handler *fh`` The file handler for the unpreserved file. h](j)}(h&``struct liveupdate_file_handler *fh``h]j)}(hj'h]h"struct liveupdate_file_handler *fh}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj'ubj)}(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&]uh1jhj'ubeh}(h]h ]h"]h$]h&]uh1jhj'hMhj'ubah}(h]h ]h"]h$]h&]uh1jhj'ubh)}(h**Description**h]j )}(hj'h]h Description}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj'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.}(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 **Context**h]j )}(hj(h]hContext}(hj (hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj(ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj'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.chMhj'ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_flb_file_finish (C function)c.luo_flb_file_finishhNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(h=void luo_flb_file_finish (struct liveupdate_file_handler *fh)h]jf )}(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.chMuhj,hhubah}(h]h ]h"]h$]h&]uh1j hjk+hhhj+hMuubeh}(h]h ](jfunctioneh"]h$]h&]j jj j,j j,j j j uh1jZ hhhj"hNhNubj )}(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]j )}(hj,h]h Parameters}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj,ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMyhj,ubj)}(hhh](j)}(hY``struct liveupdate_file_handler *fh`` The file handler that will now depend on the FLB. h](j)}(h&``struct liveupdate_file_handler *fh``h]j)}(hj,h]h"struct liveupdate_file_handler *fh}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMvhj,ubj)}(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,hMvhj,ubah}(h]h ]h"]h$]h&]uh1jhj,ubeh}(h]h ]h"]h$]h&]uh1jhj,hMvhj,ubj)}(hM``struct liveupdate_flb *flb`` The File-Lifecycle-Bound object to associate. h](j)}(h``struct liveupdate_flb *flb``h]j)}(hj -h]hstruct liveupdate_flb *flb}(hj"-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMwhj-ubj)}(hhh]h)}(h-The File-Lifecycle-Bound object to associate.h]h-The File-Lifecycle-Bound object to associate.}(hj9-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5-hMwhj6-ubah}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]uh1jhj5-hMwhj,ubeh}(h]h ]h"]h$]h&]uh1jhj,ubh)}(h**Description**h]j )}(hj[-h]h Description}(hj]-hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjY-ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMyhj,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 }(hjq-hhhNhNubj )}(h**fh**h]hfh}(hjy-hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjq-ubh is preserved, the state of }(hjq-hhhNhNubj )}(h**flb**h]hflb}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjq-ubh must also be managed.}(hjq-hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMxhj,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-hhhNhNubj )}(h**flb**h]hflb}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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.chM{hj,ubh)}(h **Context**h]j )}(hj-h]hContext}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj-ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj,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.chMhj,ubh)}(h **Return**h]j )}(hj-h]hReturn}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj-ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj,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.chMhj,ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU &liveupdate_unregister_flb (C function)c.liveupdate_unregister_flbhNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(h_void liveupdate_unregister_flb (struct liveupdate_file_handler *fh, struct liveupdate_flb *flb)h]jf )}(h^void liveupdate_unregister_flb(struct liveupdate_file_handler *fh, struct liveupdate_flb *flb)h](j,")}(hvoidh]hvoid}(hj3.hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj/.hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMubj~ )}(h h]h }(hjB.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj/.hhhjA.hMubj )}(hliveupdate_unregister_flbh]j )}(hliveupdate_unregister_flbh]hliveupdate_unregister_flb}(hjT.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjP.ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj/.hhhjA.hMubjd")}(h@(struct liveupdate_file_handler *fh, struct liveupdate_flb *flb)h](jj")}(h"struct liveupdate_file_handler *fhh](jl )}(hjo h]hstruct}(hjp.hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjl.ubj~ )}(h h]h }(hj}.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjl.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&] refdomainjreftypej1% reftargetj.modnameN classnameNjj)}j]j9%)}j1%jV.sbc.liveupdate_unregister_flbasbuh1hhjl.ubj~ )}(h h]h }(hj.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjl.ubjM%)}(hjP%h]h*}(hj.hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjl.ubj )}(hfhh]hfh}(hj.hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjl.ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjh.ubjj")}(hstruct liveupdate_flb *flbh](jl )}(hjo h]hstruct}(hj.hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk 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&] refdomainjreftypej1% reftargetj/modnameN classnameNjj)}j]j.c.liveupdate_unregister_flbasbuh1hhj.ubj~ )}(h h]h }(hj/hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj.ubjM%)}(hjP%h]h*}(hj,/hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj.ubj )}(hflbh]hflb}(hj9/hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj.ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjh.ubeh}(h]h ]h"]h$]h&]hhuh1jc"hj/.hhhjA.hMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj+.hhhjA.hMubah}(h]j&.ah ](j j eh"]h$]h&]j j )j huh1j_ hjA.hMhj(.hhubj )}(hhh]h)}(h-Remove an FLB dependency from a file handler.h]h-Remove an FLB dependency from a file handler.}(hjc/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(.hhhjA.hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j{/j j{/j j j uh1jZ hhhj"hNhNubj )}(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** It is typically called from a subsystem's module exit function.h](h)}(h**Parameters**h]j )}(hj/h]h Parameters}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj/ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj/ubj)}(hhh](j)}(h```struct liveupdate_file_handler *fh`` The file handler that is currently depending on the FLB. h](j)}(h&``struct liveupdate_file_handler *fh``h]j)}(hj/h]h"struct liveupdate_file_handler *fh}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj/ubj)}(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&]uh1jhj/ubeh}(h]h ]h"]h$]h&]uh1jhj/hMhj/ubj)}(hJ``struct liveupdate_flb *flb`` The File-Lifecycle-Bound object to remove. h](j)}(h``struct liveupdate_flb *flb``h]j)}(hj/h]hstruct liveupdate_flb *flb}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj/ubj)}(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&]uh1jhj/ubeh}(h]h ]h"]h$]h&]uh1jhj/hMhj/ubeh}(h]h ]h"]h$]h&]uh1jhj/ubh)}(h**Description**h]j )}(hj0h]h Description}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj/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.0hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj/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=0hhhNhNubah}(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]j )}(hjN0h]hContext}(hjP0hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjL0ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj/ubh)}(h?It is typically called from a subsystem's module exit function.h]hAIt is typically called from a subsystem’s module exit function.}(hjd0hhhNhNubah}(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&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU (liveupdate_flb_get_incoming (C function)c.liveupdate_flb_get_incominghNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hIint liveupdate_flb_get_incoming (struct liveupdate_flb *flb, void **objp)h]jf )}(hHint liveupdate_flb_get_incoming(struct liveupdate_flb *flb, void **objp)h](j,")}(hinth]hint}(hj0hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj0hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMubj~ )}(h h]h }(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj0hhhj0hMubj )}(hliveupdate_flb_get_incomingh]j )}(hliveupdate_flb_get_incomingh]hliveupdate_flb_get_incoming}(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj0hhhj0hMubjd")}(h)(struct liveupdate_flb *flb, void **objp)h](jj")}(hstruct liveupdate_flb *flbh](jl )}(hjo h]hstruct}(hj0hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj0ubj~ )}(h h]h }(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj0ubh)}(hhh]j )}(hliveupdate_flbh]hliveupdate_flb}(hj0hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetj0modnameN classnameNjj)}j]j9%)}j1%j0sbc.liveupdate_flb_get_incomingasbuh1hhj0ubj~ )}(h h]h }(hj1hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj0ubjM%)}(hjP%h]h*}(hj1hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj0ubj )}(hflbh]hflb}(hj)1hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj0ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj0ubjj")}(h void **objph](j,")}(hvoidh]hvoid}(hjB1hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj>1ubj~ )}(h h]h }(hjP1hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj>1ubjM%)}(hjP%h]h*}(hj^1hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj>1ubjM%)}(hjP%h]h*}(hjk1hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj>1ubj )}(hobjph]hobjp}(hjx1hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj>1ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj0ubeh}(h]h ]h"]h$]h&]hhuh1jc"hj0hhhj0hMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj0hhhj0hMubah}(h]j0ah ](j j eh"]h$]h&]j j )j huh1j_ hj0hMhj0hhubj )}(hhh]h)}(h!Retrieve the incoming FLB object.h]h!Retrieve the incoming FLB object.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1hhubah}(h]h ]h"]h$]h&]uh1j hj0hhhj0hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j1j j1j j j uh1jZ hhhj"hNhNubj )}(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, -ENODEV if the FLB's module is unloading, and -EOPNOTSUPP when live update is disabled or not configured.h](h)}(h**Parameters**h]j )}(hj1h]h Parameters}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj1ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubj)}(hhh](j)}(h3``struct liveupdate_flb *flb`` The FLB definition. h](j)}(h``struct liveupdate_flb *flb``h]j)}(hj1h]hstruct liveupdate_flb *flb}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubj)}(hhh]h)}(hThe FLB definition.h]hThe FLB definition.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMhj1ubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1jhj1hMhj1ubj)}(hQ``void **objp`` Output parameter; will be populated with the live shared object. h](j)}(h``void **objp``h]j)}(hj2h]h void **objp}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj2ubj)}(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.}(hj52hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj12hMhj22ubah}(h]h ]h"]h$]h&]uh1jhj2ubeh}(h]h ]h"]h$]h&]uh1jhj12hMhj1ubeh}(h]h ]h"]h$]h&]uh1jhj1ubh)}(h**Description**h]j )}(hjW2h]h Description}(hjY2hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjU2ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubh)}(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.}(hjm2hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubh)}(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|2hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubh)}(h **Return**h]j )}(hj2h]hReturn}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj2ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj1ubh)}(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, -ENODEV if the FLB's module is unloading, 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, -ENODEV if the FLB’s module is unloading, and -EOPNOTSUPP when live update is disabled or not configured.}(hj2hhhNhNubah}(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&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU (liveupdate_flb_get_outgoing (C function)c.liveupdate_flb_get_outgoinghNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hIint liveupdate_flb_get_outgoing (struct liveupdate_flb *flb, void **objp)h]jf )}(hHint liveupdate_flb_get_outgoing(struct liveupdate_flb *flb, void **objp)h](j,")}(hinth]hint}(hj2hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj2hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMubj~ )}(h h]h }(hj2hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj2hhhj2hMubj )}(hliveupdate_flb_get_outgoingh]j )}(hliveupdate_flb_get_outgoingh]hliveupdate_flb_get_outgoing}(hj2hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj2ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj2hhhj2hMubjd")}(h)(struct liveupdate_flb *flb, void **objp)h](jj")}(hstruct liveupdate_flb *flbh](jl )}(hjo h]hstruct}(hj3hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj 3ubj~ )}(h h]h }(hj3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj 3ubh)}(hhh]j )}(hliveupdate_flbh]hliveupdate_flb}(hj-3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj*3ubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetj/3modnameN classnameNjj)}j]j9%)}j1%j2sbc.liveupdate_flb_get_outgoingasbuh1hhj 3ubj~ )}(h h]h }(hjM3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj 3ubjM%)}(hjP%h]h*}(hj[3hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj 3ubj )}(hflbh]hflb}(hjh3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj 3ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj3ubjj")}(h void **objph](j,")}(hvoidh]hvoid}(hj3hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj}3ubj~ )}(h h]h }(hj3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj}3ubjM%)}(hjP%h]h*}(hj3hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj}3ubjM%)}(hjP%h]h*}(hj3hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj}3ubj )}(hobjph]hobjp}(hj3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj}3ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj3ubeh}(h]h ]h"]h$]h&]hhuh1jc"hj2hhhj2hMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj2hhhj2hMubah}(h]j2ah ](j j eh"]h$]h&]j j )j huh1j_ hj2hMhj2hhubj )}(hhh]h)}(h!Retrieve the outgoing FLB object.h]h!Retrieve the outgoing FLB object.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj3hhubah}(h]h ]h"]h$]h&]uh1j hj2hhhj2hMubeh}(h]h ](jfunctioneh"]h$]h&]j jj j3j j3j j j uh1jZ hhhj"hNhNubj )}(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]j )}(hj4h]h Parameters}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj3ubj)}(hhh](j)}(h3``struct liveupdate_flb *flb`` The FLB definition. h](j)}(h``struct liveupdate_flb *flb``h]j)}(hj"4h]hstruct liveupdate_flb *flb}(hj$4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj 4ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj4ubj)}(hhh]h)}(hThe FLB definition.h]hThe FLB definition.}(hj;4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj74hMhj84ubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]uh1jhj74hMhj4ubj)}(hQ``void **objp`` Output parameter; will be populated with the live shared object. h](j)}(h``void **objp``h]j)}(hj[4h]h void **objp}(hj]4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjY4ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhjU4ubj)}(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.}(hjt4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjp4hMhjq4ubah}(h]h ]h"]h$]h&]uh1jhjU4ubeh}(h]h ]h"]h$]h&]uh1jhjp4hMhj4ubeh}(h]h ]h"]h$]h&]uh1jhj3ubh)}(h**Description**h]j )}(hj4h]h Description}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj3ubh)}(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.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj3ubh)}(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.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj3ubh)}(h **Return**h]j )}(hj4h]hReturn}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj4ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj3ubh)}(h-0 on success, or a negative errno on failure.h]h-0 on success, or a negative errno on failure.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMhj3ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_flb_serialize (C function)c.luo_flb_serializehNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hvoid luo_flb_serialize (void)h]jf )}(hvoid luo_flb_serialize(void)h](j,")}(hvoidh]hvoid}(hj5hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj 5hhh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMHubj~ )}(h h]h }(hj 5hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj 5hhhj5hMHubj )}(hluo_flb_serializeh]j )}(hluo_flb_serializeh]hluo_flb_serialize}(hj25hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj.5ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj 5hhhj5hMHubjd")}(h(void)h]jj")}(hvoidh]j,")}(hvoidh]hvoid}(hjN5hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hjJ5ubah}(h]h ]h"]h$]h&]noemphhhuh1ji"hjF5ubah}(h]h ]h"]h$]h&]hhuh1jc"hj 5hhhj5hMHubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj 5hhhj5hMHubah}(h]j5ah ](j j eh"]h$]h&]j j )j huh1j_ hj5hMHhj5hhubj )}(hhh]h)}(h*Serializes all active FLB objects for KHO.h]h*Serializes all active FLB objects for KHO.}(hjx5hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMHhju5hhubah}(h]h ]h"]h$]h&]uh1j hj5hhhj5hMHubeh}(h]h ](jfunctioneh"]h$]h&]j jj j5j j5j j j uh1jZ hhhj"hNhNubj )}(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]j )}(hj5h]h Parameters}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMLhj5ubj)}(hhh]j)}(h``void`` no arguments h](j)}(h``void``h]j)}(hj5h]hvoid}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubah}(h]h ]h"]h$]h&]uh1jh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj5ubj)}(hhh]h)}(h no argumentsh]h no arguments}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hKhj5ubah}(h]h ]h"]h$]h&]uh1jhj5ubeh}(h]h ]h"]h$]h&]uh1jhj5hKhj5ubah}(h]h ]h"]h$]h&]uh1jhj5ubh)}(h**Description**h]j )}(hj5h]h Description}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj5ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chKhj5ubh)}(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.}(hj 6hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMIhj5ubh)}(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.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMNhj5ubh)}(h **Context**h]j )}(hj*6h]hContext}(hj,6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj(6ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMRhj5ubh)}(h;Called from liveupdate_reboot() just before kho_finalize().h]h;Called from liveupdate_reboot() just before kho_finalize().}(hj@6hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:59: ./kernel/liveupdate/luo_flb.chMShj5ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_session_header (C struct)c.luo_session_headerhNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hluo_session_headerh]jf )}(hstruct luo_session_headerh](jl )}(hjo h]hstruct}(hjo6hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjk6hhhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKubj~ )}(h h]h }(hj}6hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjk6hhhj|6hKubj )}(hluo_session_headerh]j )}(hji6h]hluo_session_header}(hj6hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj6ubah}(h]h ](j j eh"]h$]h&]hhuh1j hjk6hhhj|6hKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjg6hhhj|6hKubah}(h]jb6ah ](j j eh"]h$]h&]j j )j huh1j_ hj|6hKhjd6hhubj )}(hhh]h)}(h(Header struct for managing LUO sessions.h]h(Header struct for managing LUO sessions.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKihj6hhubah}(h]h ]h"]h$]h&]uh1j hjd6hhhj|6hKubeh}(h]h ](jstructeh"]h$]h&]j jj j6j j6j j j uh1jZ hhhj"hNhNubj )}(hX**Definition**:: struct luo_session_header { long count; struct list_head list; struct rw_semaphore rwsem; struct kho_block_set block_set; u64 *sessions_pa; 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. ``block_set`` The set of serialization blocks. ``sessions_pa`` Points to the location of sessions_pa within struct luo_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](j )}(h**Definition**h]h Definition}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubh:}(hj6hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKmhj6ubj )}(hstruct luo_session_header { long count; struct list_head list; struct rw_semaphore rwsem; struct kho_block_set block_set; u64 *sessions_pa; bool active; };h]hstruct luo_session_header { long count; struct list_head list; struct rw_semaphore rwsem; struct kho_block_set block_set; u64 *sessions_pa; bool active; };}hj6sbah}(h]h ]h"]h$]h&]hhuh1j hc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKohj6ubh)}(h **Members**h]j )}(hj6h]hMembers}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKxhj6ubj)}(hhh](j)}(hD``count`` The number of sessions currently tracked in the **list**. h](j)}(h ``count``h]j)}(hj7h]hcount}(hj 7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKkhj7ubj)}(hhh]h)}(h9The number of sessions currently tracked in the **list**.h](h0The number of sessions currently tracked in the }(hj77hhhNhNubj )}(h**list**h]hlist}(hj?7hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj77ubh.}(hj77hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj37hKkhj47ubah}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhj37hKkhj7ubj)}(hH``list`` The head of the linked list of `struct luo_session` instances. h](j)}(h``list``h]j)}(hji7h]hlist}(hjk7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjg7ubah}(h]h ]h"]h$]h&]uh1jhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKlhjc7ubj)}(hhh]h)}(h>The head of the linked list of `struct luo_session` instances.h](hThe head of the linked list of }(hj7hhhNhNubj)}(h`struct luo_session`h]hstruct luo_session}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubh instances.}(hj7hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj~7hKlhj7ubah}(h]h ]h"]h$]h&]uh1jhjc7ubeh}(h]h ]h"]h$]h&]uh1jhj~7hKlhj7ubj)}(hw``rwsem`` A read-write semaphore providing synchronized access to the session list and other fields in this structure. h](j)}(h ``rwsem``h]j)}(hj7h]hrwsem}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKnhj7ubj)}(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.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKmhj7ubah}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhj7hKnhj7ubj)}(h/``block_set`` The set of serialization blocks. h](j)}(h ``block_set``h]j)}(hj7h]h block_set}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKohj7ubj)}(hhh]h)}(h The set of serialization blocks.h]h The set of serialization blocks.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8hKohj8ubah}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhj8hKohj7ubj)}(hM``sessions_pa`` Points to the location of sessions_pa within struct luo_ser. h](j)}(h``sessions_pa``h]j)}(hj'8h]h sessions_pa}(hj)8hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%8ubah}(h]h ]h"]h$]h&]uh1jhc/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:62: ./kernel/liveupdate/luo_session.chKphj!8ubj)}(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](j )}(h**Definition**h]h Definition}(hja:hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj]:ubh:}(hj]:hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chK~hjY:ubj )}(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; };}hjz:sbah}(h]h ]h"]h$]h&]hhuh1j h`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjY:ubh)}(h **Members**h]j )}(hj:h]hMembers}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj:ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjY:ubj)}(hhh](j)}(hy``fh`` Pointer to the :c:type:`struct liveupdate_file_handler ` that manages this type of file. h](j)}(h``fh``h]j)}(hj:h]hfh}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj:ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chK}hj:ubj)}(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 ](jjc-typeeh"]h$]h&]uh1jhj:ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjjliveupdate_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|hj:ubah}(h]h ]h"]h$]h&]uh1jhj:ubeh}(h]h ]h"]h$]h&]uh1jhj: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](j)}(h``file``h]j)}(hj;h]hfile}(hj ;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubj)}(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 ](jjc-typeeh"]h$]h&]uh1jhj(;ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjjfileuh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chK~hj ;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&]uh1hhjG;hK~hj;ubah}(h]h ]h"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1jhj;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](j)}(h``serialized_data``h]j)}(hjd;h]hserialized_data}(hjf;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjb;ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj^;ubj)}(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.}(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&]uh1jhj^;ubeh}(h]h ]h"]h$]h&]uh1jhjy;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](j)}(h``private_data``h]j)}(hj;h]h private_data}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubj)}(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.}(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&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1jhj;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](j)}(h``retrieve_status``h]j)}(hj;h]hretrieve_status}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj;ubj)}(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&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1jhj;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](j)}(h ``mutex``h]j)}(hj<h]hmutex}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj <ubj)}(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+<hhhNhNubj )}(h **retrieved**h]h retrieved}(hj3<hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj+<ubh, }(hj+<hhhNhNubj )}(h**file**h]hfile}(hjE<hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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&]uh1jhj <ubeh}(h]h ]h"]h$]h&]uh1jhj'<hKhj:ubj)}(ha``list`` The list_head linking this instance into its parent file_set's list of preserved files. h](j)}(h``list``h]j)}(hjp<h]hlist}(hjr<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjn<ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhjj<ubj)}(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.}(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&]uh1jhjj<ubeh}(h]h ]h"]h$]h&]uh1jhj<hKhj:ubj)}(hD``token`` The user-provided unique token used to identify this file.h](j)}(h ``token``h]j)}(hj<h]htoken}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj<ubj)}(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.chKhj<ubah}(h]h ]h"]h$]h&]uh1jhj<ubeh}(h]h ]h"]h$]h&]uh1jhj<hKhj:ubeh}(h]h ]h"]h$]h&]uh1jhjY:ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubh)}(h**Description**h]j )}(hj<h]h Description}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj<ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj"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.chKhj"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=hhhNhNubj )}(h**serialized_data**h]hserialized_data}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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.chKhj"hhubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_preserve_file (C function)c.luo_preserve_filehNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hHint luo_preserve_file (struct luo_file_set *file_set, u64 token, int fd)h]jf )}(hGint luo_preserve_file(struct luo_file_set *file_set, u64 token, int fd)h](j,")}(hinth]hint}(hjL=hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hjH=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} hjH=hhhjZ=hKubj )}(hluo_preserve_fileh]j )}(hluo_preserve_fileh]hluo_preserve_file}(hjm=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hji=ubah}(h]h ](j j eh"]h$]h&]hhuh1j hjH=hhhjZ=hKubjd")}(h2(struct luo_file_set *file_set, u64 token, int fd)h](jj")}(hstruct luo_file_set *file_seth](jl )}(hjo h]hstruct}(hj=hhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk 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&] refdomainjreftypej1% reftargetj=modnameN classnameNjj)}j]j9%)}j1%jo=sbc.luo_preserve_fileasbuh1hhj=ubj~ )}(h h]h }(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj=ubjM%)}(hjP%h]h*}(hj=hhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj=ubj )}(hfile_seth]hfile_set}(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj=ubjj")}(h u64 tokenh](h)}(hhh]j )}(hu64h]hu64}(hj=hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj=ubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetj>modnameN classnameNjj)}j]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&]noemphhhuh1ji"hj=ubjj")}(hint fdh](j,")}(hinth]hint}(hjC>hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj?>ubj~ )}(h h]h }(hjQ>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&]noemphhhuh1ji"hj=ubeh}(h]h ]h"]h$]h&]hhuh1jc"hjH=hhhjZ=hKubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjD=hhhjZ=hKubah}(h]j?=ah ](j j eh"]h$]h&]j j )j huh1j_ hjZ=hKhjA=hhubj )}(hhh]h)}(h/Initiate the preservation of a file descriptor.h]h/Initiate the preservation of a file descriptor.}(hj>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 hjA=hhhjZ=hKubeh}(h]h ](jfunctioneh"]h$]h&]j jj j>j j>j j j uh1jZ hhhj"hNhNubj )}(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. -EBUSY if the file descriptor is already preserved by another session. -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]j )}(hj>h]h Parameters}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj>ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj>ubj)}(hhh](j)}(hZ``struct luo_file_set *file_set`` The file_set to which the preserved file will be added. h](j)}(h!``struct luo_file_set *file_set``h]j)}(hj>h]hstruct luo_file_set *file_set}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj>ubj)}(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&]uh1jhj>ubeh}(h]h ]h"]h$]h&]uh1jhj>hKhj>ubj)}(h?``u64 token`` A unique, user-provided identifier for the file. h](j)}(h ``u64 token``h]j)}(hj?h]h u64 token}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj>ubj)}(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&]uh1jhj>ubeh}(h]h ]h"]h$]h&]uh1jhj?hKhj>ubj)}(h0``int fd`` The file descriptor to be preserved. h](j)}(h ``int fd``h]j)}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj:?ubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj6?ubj)}(hhh]h)}(h$The file descriptor to be preserved.h]h$The file descriptor to be preserved.}(hjU?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQ?hKhjR?ubah}(h]h ]h"]h$]h&]uh1jhj6?ubeh}(h]h ]h"]h$]h&]uh1jhjQ?hKhj>ubeh}(h]h ]h"]h$]h&]uh1jhj>ubh)}(h**Description**h]j )}(hjw?h]h Description}(hjy?hhhNhNubah}(h]h ]h"]h$]h&]uh1j hju?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.}(hj?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:}(hj?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)}(hj?h](hValidates that the }(hj?hhhNhNubj )}(h **token**h]htoken}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj?ubh+ is not already in use within the file_set.}(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&]uh1jhj?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&]uh1jhj?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?hhhNhNubj )}(h**fd**h]hfd}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1j 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&]uh1jhj?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&]uh1jhj?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.}(hj9@hhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj5@ubah}(h]h ]h"]h$]h&]uh1jhj?ubeh}(h]h ]h"]h$]h&]jWjXjYhjZj[uh1j|hj>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.}(hjT@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.}(hjc@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]j )}(hjt@h]hContext}(hjv@hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjr@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.}(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 **Return**h]j )}(hj@h]hReturn}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj@ubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chKhj>ubh)}(hXi0 on success. Returns a negative errno on failure: -EEXIST if the token is already used. -EBUSY if the file descriptor is already preserved by another session. -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]hXi0 on success. Returns a negative errno on failure: -EEXIST if the token is already used. -EBUSY if the file descriptor is already preserved by another session. -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().}(hj@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&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU &luo_file_unpreserve_files (C function)c.luo_file_unpreserve_fileshNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(h>void luo_file_unpreserve_files (struct luo_file_set *file_set)h]jf )}(h=void luo_file_unpreserve_files(struct luo_file_set *file_set)h](j,")}(hvoidh]hvoid}(hj@hhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj@hhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM<ubj~ )}(h h]h }(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj@hhhj@hM<ubj )}(hluo_file_unpreserve_filesh]j )}(hluo_file_unpreserve_filesh]hluo_file_unpreserve_files}(hjAhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj@ubah}(h]h ](j j eh"]h$]h&]hhuh1j hj@hhhj@hM<ubjd")}(h(struct luo_file_set *file_set)h]jj")}(hstruct luo_file_set *file_seth](jl )}(hjo h]hstruct}(hjAhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjAubj~ )}(h h]h }(hj*AhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjAubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hj;AhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj8Aubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetj=AmodnameN classnameNjj)}j]j9%)}j1%jAsbc.luo_file_unpreserve_filesasbuh1hhjAubj~ )}(h h]h }(hj[AhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjAubjM%)}(hjP%h]h*}(hjiAhhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjAubj )}(hfile_seth]hfile_set}(hjvAhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjAubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjAubah}(h]h ]h"]h$]h&]hhuh1jc"hj@hhhj@hM<ubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj@hhhj@hM<ubah}(h]j@ah ](j j eh"]h$]h&]j j )j huh1j_ hj@hM<hj@hhubj )}(hhh]h)}(h&Unpreserves all files from a file_set.h]h&Unpreserves all files from a file_set.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM<hjAhhubah}(h]h ]h"]h$]h&]uh1j hj@hhhj@hM<ubeh}(h]h ](jfunctioneh"]h$]h&]j jj jAj jAj j j uh1jZ hhhj"hNhNubj )}(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]j )}(hjAh]h Parameters}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjAubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM@hjAubj)}(hhh]j)}(h>``struct luo_file_set *file_set`` The files to be cleaned up. h](j)}(h!``struct luo_file_set *file_set``h]j)}(hjAh]hstruct luo_file_set *file_set}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM=hjAubj)}(hhh]h)}(hThe files to be cleaned up.h]hThe files to be cleaned up.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhM=hjAubah}(h]h ]h"]h$]h&]uh1jhjAubeh}(h]h ]h"]h$]h&]uh1jhjAhM=hjAubah}(h]h ]h"]h$]h&]uh1jhjAubh)}(h**Description**h]j )}(hjBh]h Description}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjBubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM?hjAubh)}(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.}(hj2BhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM>hjAubj)}(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](j)}(h9For each file, it performs the following cleanup actions:h]h9For each file, it performs the following cleanup actions:}(hjHBhhhNhNubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMGhjDBubj)}(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.}(hjaBhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMBhj]Bubah}(h]h ]h"]h$]h&]uh1jhjZBubj)}(hRemoves the file from the file_set’s internal tracking list.}(hjzBhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMDhjvBubah}(h]h ]h"]h$]h&]uh1jhjZBubj)}(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.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMEhjBubah}(h]h ]h"]h$]h&]uh1jhjZBubj)}(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’.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVBhMGhjBubah}(h]h ]h"]h$]h&]uh1jhjZBubeh}(h]h ]h"]h$]h&]jWjXjYhjZj[uh1j|hjWBubah}(h]h ]h"]h$]h&]uh1jhjDBubeh}(h]h ]h"]h$]h&]uh1jhjVBhMGhjABubah}(h]h ]h"]h$]h&]uh1jhjAubh)}(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.chMIhjAubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_file_freeze (C function)c.luo_file_freezehNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hZint luo_file_freeze (struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h]jf )}(hYint luo_file_freeze(struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h](j,")}(hinth]hint}(hjChhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hjChhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMubj~ )}(h h]h }(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjChhhjChMubj )}(hluo_file_freezeh]j )}(hluo_file_freezeh]hluo_file_freeze}(hj'ChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj#Cubah}(h]h ](j j eh"]h$]h&]hhuh1j hjChhhjChMubjd")}(hF(struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h](jj")}(hstruct luo_file_set *file_seth](jl )}(hjo h]hstruct}(hjCChhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj?Cubj~ )}(h h]h }(hjPChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj?Cubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hjaChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj^Cubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetjcCmodnameN classnameNjj)}j]j9%)}j1%j)Csbc.luo_file_freezeasbuh1hhj?Cubj~ )}(h h]h }(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj?CubjM%)}(hjP%h]h*}(hjChhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj?Cubj )}(hfile_seth]hfile_set}(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj?Cubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj;Cubjj")}(h%struct luo_file_set_ser *file_set_serh](jl )}(hjo h]hstruct}(hjChhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjCubj~ )}(h h]h }(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjCubh)}(hhh]j )}(hluo_file_set_serh]hluo_file_set_ser}(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjCubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetjCmodnameN classnameNjj)}j]j}Cc.luo_file_freezeasbuh1hhjCubj~ )}(h h]h }(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjCubjM%)}(hjP%h]h*}(hjChhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjCubj )}(h file_set_serh]h file_set_ser}(hj DhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjCubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj;Cubeh}(h]h ]h"]h$]h&]hhuh1jc"hjChhhjChMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjBhhhjChMubah}(h]jBah ](j j eh"]h$]h&]j j )j huh1j_ hjChMhjBhhubj )}(hhh]h)}(h:Freezes all preserved files and serializes their metadata.h]h:Freezes all preserved files and serializes their metadata.}(hj6DhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj3Dhhubah}(h]h ]h"]h$]h&]uh1j hjBhhhjChMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jNDj jNDj j j uh1jZ hhhj"hNhNubj )}(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]j )}(hjXDh]h Parameters}(hjZDhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjVDubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubj)}(hhh](j)}(hM``struct luo_file_set *file_set`` The file_set whose files are to be frozen. h](j)}(h!``struct luo_file_set *file_set``h]j)}(hjwDh]hstruct luo_file_set *file_set}(hjyDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuDubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjqDubj)}(hhh]h)}(h*The file_set whose files are to be frozen.h]h*The file_set whose files are to be frozen.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhMhjDubah}(h]h ]h"]h$]h&]uh1jhjqDubeh}(h]h ]h"]h$]h&]uh1jhjDhMhjnDubj)}(hP``struct luo_file_set_ser *file_set_ser`` Where to put the serialized file_set. h](j)}(h)``struct luo_file_set_ser *file_set_ser``h]j)}(hjDh]h%struct luo_file_set_ser *file_set_ser}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjDubj)}(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&]uh1jhjDubeh}(h]h ]h"]h$]h&]uh1jhjDhMhjnDubeh}(h]h ]h"]h$]h&]uh1jhjRDubh)}(h**Description**h]j )}(hjDh]h Description}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjDubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubh)}(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.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubh)}(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:}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubj})}(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.}(hj&EhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj"Eubah}(h]h ]h"]h$]h&]uh1jhjEubj)}(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.}(hj?EhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj;Eubah}(h]h ]h"]h$]h&]uh1jhjEubeh}(h]h ]h"]h$]h&]jWjXjYhjZj[uh1j|hjRDubh)}(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.}(hjZEhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubh)}(h **Context**h]j )}(hjkEh]hContext}(hjmEhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjiEubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubh)}(h.Called only from the liveupdate_reboot() path.h]h.Called only from the liveupdate_reboot() path.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubh)}(h **Return**h]j )}(hjEh]hReturn}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjEubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubh)}(h-0 on success, or a negative errno on failure.h]h-0 on success, or a negative errno on failure.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjRDubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_file_unfreeze (C function)c.luo_file_unfreezehNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(h]void luo_file_unfreeze (struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h]jf )}(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 ]j8"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 hjEhhhjEhMubjd")}(hF(struct luo_file_set *file_set, struct luo_file_set_ser *file_set_ser)h](jj")}(hstruct luo_file_set *file_seth](jl )}(hjo h]hstruct}(hjFhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjFubj~ )}(h h]h }(hj!FhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjFubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hj2FhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj/Fubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetj4FmodnameN classnameNjj)}j]j9%)}j1%jEsbc.luo_file_unfreezeasbuh1hhjFubj~ )}(h h]h }(hjRFhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjFubjM%)}(hjP%h]h*}(hj`FhhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjFubj )}(hfile_seth]hfile_set}(hjmFhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjFubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj Fubjj")}(h%struct luo_file_set_ser *file_set_serh](jl )}(hjo h]hstruct}(hjFhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjFubj~ )}(h h]h }(hjFhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjFubh)}(hhh]j )}(hluo_file_set_serh]hluo_file_set_ser}(hjFhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjFubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetjFmodnameN classnameNjj)}j]jNFc.luo_file_unfreezeasbuh1hhjFubj~ )}(h h]h }(hjFhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjFubjM%)}(hjP%h]h*}(hjFhhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjFubj )}(h file_set_serh]h file_set_ser}(hjFhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjFubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hj Fubeh}(h]h ]h"]h$]h&]hhuh1jc"hjEhhhjEhMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjEhhhjEhMubah}(h]jEah ](j j eh"]h$]h&]j j )j huh1j_ hjEhMhjEhhubj )}(hhh]h)}(h9Unfreezes all files in a file_set and clear serializationh]h9Unfreezes all files in a file_set and clear serialization}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjGhhubah}(h]h ]h"]h$]h&]uh1j hjEhhhjEhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jGj jGj j j uh1jZ hhhj"hNhNubj )}(hX**Parameters** ``struct luo_file_set *file_set`` The file_set whose files are to be unfrozen. ``struct luo_file_set_ser *file_set_ser`` Serialized file_set. **Description** This function rolls back the state of all files in a file_set after the freeze phase has begun but must be aborted. It is the counterpart to luo_file_freeze(). It invokes the __luo_file_unfreeze() helper with a NULL argument, which signals the helper to iterate through all files in the file_set and call their respective .unfreeze() handler callbacks. **Context** This is called when the live update is aborted during the reboot() syscall, after luo_file_freeze() has been called.h](h)}(h**Parameters**h]j )}(hj)Gh]h Parameters}(hj+GhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj'Gubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj#Gubj)}(hhh](j)}(hO``struct luo_file_set *file_set`` The file_set whose files are to be unfrozen. h](j)}(h!``struct luo_file_set *file_set``h]j)}(hjHGh]hstruct luo_file_set *file_set}(hjJGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFGubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjBGubj)}(hhh]h)}(h,The file_set whose files are to be unfrozen.h]h,The file_set whose files are to be unfrozen.}(hjaGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]GhMhj^Gubah}(h]h ]h"]h$]h&]uh1jhjBGubeh}(h]h ]h"]h$]h&]uh1jhj]GhMhj?Gubj)}(h?``struct luo_file_set_ser *file_set_ser`` Serialized file_set. h](j)}(h)``struct luo_file_set_ser *file_set_ser``h]j)}(hjGh]h%struct luo_file_set_ser *file_set_ser}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj{Gubj)}(hhh]h)}(hSerialized file_set.h]hSerialized file_set.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGhMhjGubah}(h]h ]h"]h$]h&]uh1jhj{Gubeh}(h]h ]h"]h$]h&]uh1jhjGhMhj?Gubeh}(h]h ]h"]h$]h&]uh1jhj#Gubh)}(h**Description**h]j )}(hjGh]h Description}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjGubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj#Gubh)}(hThis function rolls back the state of all files in a file_set after the freeze phase has begun but must be aborted. It is the counterpart to luo_file_freeze().h]hThis function rolls back the state of all files in a file_set after the freeze phase has begun but must be aborted. It is the counterpart to luo_file_freeze().}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj#Gubh)}(hIt invokes the __luo_file_unfreeze() helper with a NULL argument, which signals the helper to iterate through all files in the file_set and call their respective .unfreeze() handler callbacks.h]hIt invokes the __luo_file_unfreeze() helper with a NULL argument, which signals the helper to iterate through all files in the file_set and call their respective .unfreeze() handler callbacks.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj#Gubh)}(h **Context**h]j )}(hjGh]hContext}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjGubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj#Gubh)}(htThis is called when the live update is aborted during the reboot() syscall, after luo_file_freeze() has been called.h]htThis is called when the live update is aborted during the reboot() syscall, after luo_file_freeze() has been called.}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj#Gubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_retrieve_file (C function)c.luo_retrieve_filehNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hUint luo_retrieve_file (struct luo_file_set *file_set, u64 token, struct file **filep)h]jf )}(hTint luo_retrieve_file(struct luo_file_set *file_set, u64 token, struct file **filep)h](j,")}(hinth]hint}(hj7HhhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hj3Hhhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMubj~ )}(h h]h }(hjFHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj3HhhhjEHhMubj )}(hluo_retrieve_fileh]j )}(hluo_retrieve_fileh]hluo_retrieve_file}(hjXHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjTHubah}(h]h ](j j eh"]h$]h&]hhuh1j hj3HhhhjEHhMubjd")}(h?(struct luo_file_set *file_set, u64 token, struct file **filep)h](jj")}(hstruct luo_file_set *file_seth](jl )}(hjo h]hstruct}(hjtHhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjpHubj~ )}(h h]h }(hjHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjpHubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hjHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjHubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetjHmodnameN classnameNjj)}j]j9%)}j1%jZHsbc.luo_retrieve_fileasbuh1hhjpHubj~ )}(h h]h }(hjHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjpHubjM%)}(hjP%h]h*}(hjHhhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjpHubj )}(hfile_seth]hfile_set}(hjHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjpHubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjlHubjj")}(h u64 tokenh](h)}(hhh]j )}(hu64h]hu64}(hjHhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjHubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetjHmodnameN classnameNjj)}j]jHc.luo_retrieve_fileasbuh1hhjHubj~ )}(h h]h }(hjIhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjHubj )}(htokenh]htoken}(hjIhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjHubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjlHubjj")}(hstruct file **fileph](jl )}(hjo h]hstruct}(hj.IhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hj*Iubj~ )}(h h]h }(hj;IhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj*Iubh)}(hhh]j )}(hfileh]hfile}(hjLIhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjIIubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetjNImodnameN classnameNjj)}j]jHc.luo_retrieve_fileasbuh1hhj*Iubj~ )}(h h]h }(hjjIhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hj*IubjM%)}(hjP%h]h*}(hjxIhhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj*IubjM%)}(hjP%h]h*}(hjIhhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hj*Iubj )}(hfileph]hfilep}(hjIhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj*Iubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjlHubeh}(h]h ]h"]h$]h&]hhuh1jc"hj3HhhhjEHhMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hj/HhhhjEHhMubah}(h]j*Hah ](j j eh"]h$]h&]j j )j huh1j_ hjEHhMhj,Hhhubj )}(hhh]h)}(h7Restores a preserved file from a file_set by its token.h]h7Restores a preserved file from a file_set by its token.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjIhhubah}(h]h ]h"]h$]h&]uh1j hj,HhhhjEHhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jIj jIj j j uh1jZ hhhj"hNhNubj )}(hXw**Parameters** ``struct luo_file_set *file_set`` The file_set from which to retrieve the file. ``u64 token`` The unique token identifying the file to be restored. ``struct file **filep`` Output parameter; on success, this is populated with a pointer to the newly retrieved 'struct file'. **Description** This 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**. The 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. File retrieval can happen in any order; it is not bound by the order of preservation. **Context** Can be called from an ioctl or other in-kernel code in the new kernel. **Return** 0 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](h)}(h**Parameters**h]j )}(hjIh]h Parameters}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjIubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjIubj)}(hhh](j)}(hP``struct luo_file_set *file_set`` The file_set from which to retrieve the file. h](j)}(h!``struct luo_file_set *file_set``h]j)}(hjIh]hstruct luo_file_set *file_set}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjIubj)}(hhh]h)}(h-The file_set from which to retrieve the file.h]h-The file_set from which to retrieve the file.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhMhjJubah}(h]h ]h"]h$]h&]uh1jhjIubeh}(h]h ]h"]h$]h&]uh1jhjJhMhjIubj)}(hD``u64 token`` The unique token identifying the file to be restored. h](j)}(h ``u64 token``h]j)}(hj6Jh]h u64 token}(hj8JhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4Jubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj0Jubj)}(hhh]h)}(h5The unique token identifying the file to be restored.h]h5The unique token identifying the file to be restored.}(hjOJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjKJhMhjLJubah}(h]h ]h"]h$]h&]uh1jhj0Jubeh}(h]h ]h"]h$]h&]uh1jhjKJhMhjIubj)}(h}``struct file **filep`` Output parameter; on success, this is populated with a pointer to the newly retrieved 'struct file'. h](j)}(h``struct file **filep``h]j)}(hjoJh]hstruct file **filep}(hjqJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmJubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjiJubj)}(hhh]h)}(hdOutput parameter; on success, this is populated with a pointer to the newly retrieved 'struct file'.h]hhOutput parameter; on success, this is populated with a pointer to the newly retrieved ‘struct file’.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjJubah}(h]h ]h"]h$]h&]uh1jhjiJubeh}(h]h ]h"]h$]h&]uh1jhjJhMhjIubeh}(h]h ]h"]h$]h&]uh1jhjIubh)}(h**Description**h]j )}(hjJh]h Description}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjJubah}(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 }(hjJhhhNhNubj )}(h **token**h]htoken}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjJubh.}(hjJhhhNhNubeh}(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.chMhjIubh)}(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.chMhjIubh)}(h **Context**h]j )}(hjKh]hContext}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjKubah}(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.}(hjKhhhNhNubah}(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]j )}(hj)Kh]hReturn}(hj+KhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj'Kubah}(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.}(hj?KhhhNhNubah}(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&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU luo_file_finish (C function)c.luo_file_finishhNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(h3int luo_file_finish (struct luo_file_set *file_set)h]jf )}(h2int luo_file_finish(struct luo_file_set *file_set)h](j,")}(hinth]hint}(hjnKhhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hjjKhhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMubj~ )}(h h]h }(hj}KhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjjKhhhj|KhMubj )}(hluo_file_finishh]j )}(hluo_file_finishh]hluo_file_finish}(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjKubah}(h]h ](j j eh"]h$]h&]hhuh1j hjjKhhhj|KhMubjd")}(h(struct luo_file_set *file_set)h]jj")}(hstruct luo_file_set *file_seth](jl )}(hjo h]hstruct}(hjKhhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjKubj~ )}(h h]h }(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjKubh)}(hhh]j )}(h luo_file_seth]h luo_file_set}(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjKubah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetjKmodnameN classnameNjj)}j]j9%)}j1%jKsbc.luo_file_finishasbuh1hhjKubj~ )}(h h]h }(hjKhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjKubjM%)}(hjP%h]h*}(hjKhhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjKubj )}(hfile_seth]hfile_set}(hjLhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjKubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjKubah}(h]h ]h"]h$]h&]hhuh1jc"hjjKhhhj|KhMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjfKhhhj|KhMubah}(h]jaKah ](j j eh"]h$]h&]j j )j huh1j_ hj|KhMhjcKhhubj )}(hhh]h)}(h4Completes the lifecycle for all files in a file_set.h]h4Completes the lifecycle for all files in a file_set.}(hj.LhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj+Lhhubah}(h]h ]h"]h$]h&]uh1j hjcKhhhj|KhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jFLj jFLj j j uh1jZ hhhj"hNhNubj )}(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]j )}(hjPLh]h Parameters}(hjRLhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjNLubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjJLubj)}(hhh]j)}(h@``struct luo_file_set *file_set`` The file_set to be finalized. h](j)}(h!``struct luo_file_set *file_set``h]j)}(hjoLh]hstruct luo_file_set *file_set}(hjqLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmLubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjiLubj)}(hhh]h)}(hThe file_set to be finalized.h]hThe file_set to be finalized.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLhMhjLubah}(h]h ]h"]h$]h&]uh1jhjiLubeh}(h]h ]h"]h$]h&]uh1jhjLhMhjfLubah}(h]h ]h"]h$]h&]uh1jhjJLubh)}(h**Description**h]j )}(hjLh]h Description}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjLubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjJLubh)}(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.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjJLubh)}(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.chMhjJLubj})}(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().}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjMubah}(h]h ]h"]h$]h&]uh1jhjLubj)}(h@Removes the 'struct luo_file' from the file_set's internal list.h]h)}(hj.Mh]hFRemoves the ‘struct luo_file’ from the file_set’s internal list.}(hj0MhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhj,Mubah}(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]j )}(hjQh]h Parameters}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjQubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMchjQubj)}(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](j)}(h&``struct liveupdate_file_handler *fh``h]j)}(hjQh]h"struct liveupdate_file_handler *fh}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMchjQubj)}(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 }(hjRhhhNhNubh)}(hB:c:type:`struct liveupdate_file_handler `h]j)}(hj!Rh]hstruct liveupdate_file_handler}(hj#RhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjjliveupdate_file_handleruh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chM`hjRubh. 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.}(hjRhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj>RhM`hjRubah}(h]h ]h"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]uh1jhjRhMchjQubah}(h]h ]h"]h$]h&]uh1jhjQubh)}(h **Context**h]j )}(hj]Rh]hContext}(hj_RhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj[Rubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMehjQubh)}(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.}(hjsRhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMehjQubh)}(h **Return**h]j )}(hjRh]hReturn}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjRubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhhjQubh)}(h(0 on success. Negative errno on failure.h]h(0 on success. Negative errno on failure.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhhjQubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubjI )}(hhh]h}(h]h ]h"]h$]h&]entries](jU /liveupdate_unregister_file_handler (C function)$c.liveupdate_unregister_file_handlerhNtauh1jH hj"hhhNhNubj[ )}(hhh](j` )}(hLvoid liveupdate_unregister_file_handler (struct liveupdate_file_handler *fh)h]jf )}(hKvoid liveupdate_unregister_file_handler(struct liveupdate_file_handler *fh)h](j,")}(hvoidh]hvoid}(hjRhhhNhNubah}(h]h ]j8"ah"]h$]h&]uh1j+"hjRhhh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMubj~ )}(h h]h }(hjRhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjRhhhjRhMubj )}(h"liveupdate_unregister_file_handlerh]j )}(h"liveupdate_unregister_file_handlerh]h"liveupdate_unregister_file_handler}(hjRhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjRubah}(h]h ](j j eh"]h$]h&]hhuh1j hjRhhhjRhMubjd")}(h$(struct liveupdate_file_handler *fh)h]jj")}(h"struct liveupdate_file_handler *fhh](jl )}(hjo h]hstruct}(hjShhhNhNubah}(h]h ]jx ah"]h$]h&]uh1jk hjSubj~ )}(h h]h }(hjShhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjSubh)}(hhh]j )}(hliveupdate_file_handlerh]hliveupdate_file_handler}(hj$ShhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj!Subah}(h]h ]h"]h$]h&] refdomainjreftypej1% reftargetj&SmodnameN classnameNjj)}j]j9%)}j1%jRsb$c.liveupdate_unregister_file_handlerasbuh1hhjSubj~ )}(h h]h }(hjDShhhNhNubah}(h]h ]j ah"]h$]h&]uh1j} hjSubjM%)}(hjP%h]h*}(hjRShhhNhNubah}(h]h ]jY%ah"]h$]h&]uh1jL%hjSubj )}(hfhh]hfh}(hj_ShhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjSubeh}(h]h ]h"]h$]h&]noemphhhuh1ji"hjRubah}(h]h ]h"]h$]h&]hhuh1jc"hjRhhhjRhMubeh}(h]h ]h"]h$]h&]hhj uh1je j j hjRhhhjRhMubah}(h]jRah ](j j eh"]h$]h&]j j )j huh1j_ hjRhMhjRhhubj )}(hhh]h)}(h$Unregister a liveupdate file handlerh]h$Unregister a liveupdate file handler}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjShhubah}(h]h ]h"]h$]h&]uh1j hjRhhhjRhMubeh}(h]h ](jfunctioneh"]h$]h&]j jj jSj jSj j j uh1jZ hhhj"hNhNubj )}(h**Parameters** ``struct liveupdate_file_handler *fh`` The file handler to unregister **Description** Unregisters the file handler from the liveupdate core. This function reverses the operations of liveupdate_register_file_handler().h](h)}(h**Parameters**h]j )}(hjSh]h Parameters}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1j hjSubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjSubj)}(hhh]j)}(hF``struct liveupdate_file_handler *fh`` The file handler to unregister h](j)}(h&``struct liveupdate_file_handler *fh``h]j)}(hjSh]h"struct liveupdate_file_handler *fh}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjSubj)}(hhh]h)}(hThe file handler to unregisterh]hThe file handler to unregister}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjShMhjSubah}(h]h ]h"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]uh1jhjShMhjSubah}(h]h ]h"]h$]h&]uh1jhjSubh)}(h**Description**h]j )}(hjTh]h Description}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1j hjTubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjSubh)}(hUnregisters the file handler from the liveupdate core. This function reverses the operations of liveupdate_register_file_handler().h]hUnregisters the file handler from the liveupdate core. This function reverses the operations of liveupdate_register_file_handler().}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hh`/var/lib/git/docbuild/linux/Documentation/core-api/liveupdate:65: ./kernel/liveupdate/luo_file.chMhjSubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj"hhhNhNubeh}(h] internal-apiah ]h"] internal apiah$]h&]uh1hhhhhhhhK7ubh)}(hhh](h)}(hSee Alsoh]hSee Also}(hj`h]h)}(hjOTh]h)}(hjOTh]hinline)}(hjOTh]hLive Update uAPI}(hjYThhhNhNubah}(h]h ](jstdstd-doceh"]h$]h&]uh1jWThjTTubah}(h]h ]h"]h$]h&]refdocj refdomainjcTreftypedoc refexplicitrefwarnj/userspace-api/liveupdateuh1hhhhKGhjQTubah}(h]h ]h"]h$]h&]uh1hhhhKGhjMTubah}(h]h ]h"]h$]h&]uh1jhjJThhhhhNubj)}(h:doc:`/core-api/kho/index`h]h)}(hjTh]h)}(hjTh]jXT)}(hjTh]h/core-api/kho/index}(hjThhhNhNubah}(h]h ](jstdstd-doceh"]h$]h&]uh1jWThjTubah}(h]h ]h"]h$]h&]refdocj refdomainjTreftypedoc refexplicitrefwarnj/core-api/kho/indexuh1hhhhKHhjTubah}(h]h ]h"]h$]h&]uh1hhhhKHhjTubah}(h]h ]h"]h$]h&]uh1jhjJThhhhhNubeh}(h]h ]h"]h$]h&]jkjluh1jhhhKGhj9Thhubeh}(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_sourcehnj _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}(jTjTj=j:jjjjj4 j1 j!j!j6Tj3TjTjTu nametypes}(jTj=jjj4 j!j6TjTuh}(jThj:jjj@jjj1 jj!j7 jW ja j j jjjrjwjjj-j2jjjjjIjNjjjMjRj j" j3Tj"j"j#"j\#ja#j$j$j&j&j@(jE(j)j)ji+jn+j&.j+.j0j0j2j2j5j 5jb6jg6j8j8j9j9j?=jD=j@j@jBjBjEjEj*Hj/HjaKjfKjMjMjPjPjRjRjTj9Tu 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.