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/userspace-api/liveupdatemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/zh_TW/userspace-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/it_IT/userspace-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ja_JP/userspace-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/ko_KR/userspace-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/pt_BR/userspace-api/liveupdatemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget,/translations/sp_SP/userspace-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:spacepreserveuh1hhhhhhF/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate.rsthKubhsection)}(hhh](htitle)}(hLive Update uAPIh]hLive Update uAPI}(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)}(hhh](h)}(hioctl interfaceh]hioctl interface}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hhhhhK ubh)}(hX The IOCTL user-space control interface for the LUO subsystem. It registers a character device, typically found at ``/dev/liveupdate``, which allows a userspace agent to manage the LUO state machine and its associated resources, such as preservable file descriptors.h](hrThe IOCTL user-space control interface for the LUO subsystem. It registers a character device, typically found at }(hjFhhhNhNubhliteral)}(h``/dev/liveupdate``h]h/dev/liveupdate}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjFubh, which allows a userspace agent to manage the LUO state machine and its associated resources, such as preservable file descriptors.}(hjFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:10: ./kernel/liveupdate/luo_core.chKhj5hhubh)}(hXTo ensure that the state machine is controlled by a single entity, access to this device is exclusive: only one process is permitted to have ``/dev/liveupdate`` open at any given time. Subsequent open attempts will fail with -EBUSY until the first process closes its file descriptor. This singleton model simplifies state management by preventing conflicting commands from multiple userspace agents.h](hTo ensure that the state machine is controlled by a single entity, access to this device is exclusive: only one process is permitted to have }(hjihhhNhNubjO)}(h``/dev/liveupdate``h]h/dev/liveupdate}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjiubh open at any given time. Subsequent open attempts will fail with -EBUSY until the first process closes its file descriptor. This singleton model simplifies state management by preventing conflicting commands from multiple userspace agents.}(hjihhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:10: ./kernel/liveupdate/luo_core.chKhj5hhubeh}(h]ioctl-interfaceah ]h"]ioctl interfaceah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(h ioctl uAPIh]h ioctl uAPI}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubhtarget)}(h.. _General ioctl format:h]h}(h]h ]h"]h$]h&]refidgeneral-ioctl-formatuh1jhKhjhhhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hubh)}(h**General ioctl format**h]hstrong)}(hjh]hGeneral ioctl format}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]jah ]h"]general ioctl formatah$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhexpect_referenced_by_name}jjsexpect_referenced_by_id}jjsubh)}(hX{The ioctl interface follows a general format to allow for extensibility. Each ioctl is passed in a structure pointer as the argument providing the size of the structure in the first u32. The kernel checks that any structure space beyond what it understands is 0. This allows userspace to use the backward compatible portion while consistently using the newer, larger, structures.h]hX{The ioctl interface follows a general format to allow for extensibility. Each ioctl is passed in a structure pointer as the argument providing the size of the structure in the first u32. The kernel checks that any structure space beyond what it understands is 0. This allows userspace to use the backward compatible portion while consistently using the newer, larger, structures.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h0ioctls use a standard meaning for common errnos:h]h0ioctls use a standard meaning for common errnos:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh block_quote)}(hX- ENOTTY: The IOCTL number itself is not supported at all - E2BIG: The IOCTL number is supported, but the provided structure has non-zero in a part the kernel does not understand. - EOPNOTSUPP: The IOCTL number is supported, and the structure is understood, however a known field has a value the kernel does not understand or support. - EINVAL: Everything about the IOCTL was understood, but a field is not correct. - ENOENT: A provided token does not exist. - ENOMEM: Out of memory. - EOVERFLOW: Mathematics overflowed. h]h bullet_list)}(hhh](h list_item)}(h7ENOTTY: The IOCTL number itself is not supported at allh]h)}(hjh]h7ENOTTY: The IOCTL number itself is not supported at all}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hwE2BIG: The IOCTL number is supported, but the provided structure has non-zero in a part the kernel does not understand.h]h)}(hwE2BIG: The IOCTL number is supported, but the provided structure has non-zero in a part the kernel does not understand.h]hwE2BIG: The IOCTL number is supported, but the provided structure has non-zero in a part the kernel does not understand.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hEOPNOTSUPP: The IOCTL number is supported, and the structure is understood, however a known field has a value the kernel does not understand or support.h]h)}(hEOPNOTSUPP: The IOCTL number is supported, and the structure is understood, however a known field has a value the kernel does not understand or support.h]hEOPNOTSUPP: The IOCTL number is supported, and the structure is understood, however a known field has a value the kernel does not understand or support.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj-ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hNEINVAL: Everything about the IOCTL was understood, but a field is not correct.h]h)}(hNEINVAL: Everything about the IOCTL was understood, but a field is not correct.h]hNEINVAL: Everything about the IOCTL was understood, but a field is not correct.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK hjFubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h(ENOENT: A provided token does not exist.h]h)}(hjah]h(ENOENT: A provided token does not exist.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK"hj_ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hENOMEM: Out of memory.h]h)}(hjyh]hENOMEM: Out of memory.}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK#hjwubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h#EOVERFLOW: Mathematics overflowed. h]h)}(h"EOVERFLOW: Mathematics overflowed.h]h"EOVERFLOW: Mathematics overflowed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK$hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]bullet-uh1jhj hKhjubah}(h]h ]h"]h$]h&]uh1jhj hKhjhhubh)}(h5As well as additional errnos, within specific ioctls.h]h5As well as additional errnos, within specific ioctls.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK&hjhhubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](single*liveupdate_ioctl_create_session (C struct)!c.liveupdate_ioctl_create_sessionhNtauh1jhjhhhjhNubhdesc)}(hhh](hdesc_signature)}(hliveupdate_ioctl_create_sessionh]hdesc_signature_line)}(h&struct liveupdate_ioctl_create_sessionh](hdesc_sig_keyword)}(hstructh]hstruct}(hjhhhNhNubah}(h]h ]kah"]h$]h&]uh1jhjhhhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK+ubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhjhhhjhK+ubh desc_name)}(hliveupdate_ioctl_create_sessionh]h desc_sig_name)}(hjh]hliveupdate_ioctl_create_session}(hjhhhNhNubah}(h]h ]nah"]h$]h&]uh1jhj ubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1j hjhhhjhK+ubeh}(h]h ]h"]h$]h&]hhƌ add_permalinkuh1jsphinx_line_type declaratorhjhhhjhK+ubah}(h]jah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jhjhK+hjhhubh desc_content)}(hhh]h)}(h&ioctl(LIVEUPDATE_IOCTL_CREATE_SESSION)h]h&ioctl(LIVEUPDATE_IOCTL_CREATE_SESSION)}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKBhj>hhubah}(h]h ]h"]h$]h&]uh1j<hjhhhjhK+ubeh}(h]h ](cstructeh"]h$]h&]domainjYobjtypejZdesctypejZnoindex noindexentrynocontentsentryuh1jhhhjhjhNubh container)}(hX**Definition**:: struct liveupdate_ioctl_create_session { __u32 size; __s32 fd; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; }; **Members** ``size`` Input; sizeof(struct liveupdate_ioctl_create_session) ``fd`` Output; The new file descriptor for the created session. ``name`` Input; A null-terminated string for the session name, max length ``LIVEUPDATE_SESSION_NAME_LENGTH`` including termination character.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjjubh:}(hjjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKFhjfubh literal_block)}(hxstruct liveupdate_ioctl_create_session { __u32 size; __s32 fd; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; };h]hxstruct liveupdate_ioctl_create_session { __u32 size; __s32 fd; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; };}hjsbah}(h]h ]h"]h$]h&]hhuh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKHhjfubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKNhjfubhdefinition_list)}(hhh](hdefinition_list_item)}(h?``size`` Input; sizeof(struct liveupdate_ioctl_create_session) h](hterm)}(h``size``h]jO)}(hjh]hsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKDhjubh definition)}(hhh]h)}(h5Input; sizeof(struct liveupdate_ioctl_create_session)h]h5Input; sizeof(struct liveupdate_ioctl_create_session)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKDhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKDhjubj)}(h@``fd`` Output; The new file descriptor for the created session. h](j)}(h``fd``h]jO)}(hjh]hfd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKEhjubj)}(hhh]h)}(h8Output; The new file descriptor for the created session.h]h8Output; The new file descriptor for the created session.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKEhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKEhjubj)}(h``name`` Input; A null-terminated string for the session name, max length ``LIVEUPDATE_SESSION_NAME_LENGTH`` including termination character.h](j)}(h``name``h]jO)}(hj3h]hname}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj1ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKGhj-ubj)}(hhh]h)}(hInput; A null-terminated string for the session name, max length ``LIVEUPDATE_SESSION_NAME_LENGTH`` including termination character.h](hAInput; A null-terminated string for the session name, max length }(hjLhhhNhNubjO)}(h"``LIVEUPDATE_SESSION_NAME_LENGTH``h]hLIVEUPDATE_SESSION_NAME_LENGTH}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjLubh! including termination character.}(hjLhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKFhjIubah}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]uh1jhjHhKGhjubeh}(h]h ]h"]h$]h&]uh1jhjfubeh}(h]h ] kernelindentah"]h$]h&]uh1jdhjhhhjhNubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKKhjhhubh)}(hCreates a new live update session for managing preserved resources. This ioctl can only be called on the main /dev/liveupdate device.h]hCreates a new live update session for managing preserved resources. This ioctl can only be called on the main /dev/liveupdate device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKHhjhhubh)}(h **Return**h]j)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKKhjhhubh)}(h-0 on success, negative error code on failure.h]h-0 on success, negative error code on failure.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKLhjhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j,liveupdate_ioctl_retrieve_session (C struct)#c.liveupdate_ioctl_retrieve_sessionhNtauh1jhjhhhjhNubj)}(hhh](j)}(h!liveupdate_ioctl_retrieve_sessionh]j)}(h(struct liveupdate_ioctl_retrieve_sessionh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKQubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKQubj )}(h!liveupdate_ioctl_retrieve_sessionh]j)}(hjh]h!liveupdate_ioctl_retrieve_session}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](j#j$eh"]h$]h&]hhuh1j hjhhhjhKQubeh}(h]h ]h"]h$]h&]hhj.uh1jj/j0hjhhhjhKQubah}(h]jah ](j4j5eh"]h$]h&]j9j:)j;huh1jhjhKQhjhhubj=)}(hhh]h)}(h(ioctl(LIVEUPDATE_IOCTL_RETRIEVE_SESSION)h]h(ioctl(LIVEUPDATE_IOCTL_RETRIEVE_SESSION)}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKXhj,hhubah}(h]h ]h"]h$]h&]uh1j<hjhhhjhKQubeh}(h]h ](jYstructeh"]h$]h&]j^jYj_jGj`jGjajbjcuh1jhhhjhjhNubje)}(hX**Definition**:: struct liveupdate_ioctl_retrieve_session { __u32 size; __s32 fd; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; }; **Members** ``size`` Input; sizeof(struct liveupdate_ioctl_retrieve_session) ``fd`` Output; The new file descriptor for the retrieved session. ``name`` Input; A null-terminated string identifying the session to retrieve. The name must exactly match the name used when the session was created in the previous kernel.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubh:}(hjOhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK\hjKubj)}(hzstruct liveupdate_ioctl_retrieve_session { __u32 size; __s32 fd; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; };h]hzstruct liveupdate_ioctl_retrieve_session { __u32 size; __s32 fd; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; };}hjlsbah}(h]h ]h"]h$]h&]hhuh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK^hjKubh)}(h **Members**h]j)}(hj}h]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKdhjKubj)}(hhh](j)}(hA``size`` Input; sizeof(struct liveupdate_ioctl_retrieve_session) h](j)}(h``size``h]jO)}(hjh]hsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKZhjubj)}(hhh]h)}(h7Input; sizeof(struct liveupdate_ioctl_retrieve_session)h]h7Input; sizeof(struct liveupdate_ioctl_retrieve_session)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKZhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKZhjubj)}(hB``fd`` Output; The new file descriptor for the retrieved session. h](j)}(h``fd``h]jO)}(hjh]hfd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK[hjubj)}(hhh]h)}(h:Output; The new file descriptor for the retrieved session.h]h:Output; The new file descriptor for the retrieved session.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK[hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK[hjubj)}(h``name`` Input; A null-terminated string identifying the session to retrieve. The name must exactly match the name used when the session was created in the previous kernel.h](j)}(h``name``h]jO)}(hjh]hname}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK]hjubj)}(hhh]h)}(hInput; A null-terminated string identifying the session to retrieve. The name must exactly match the name used when the session was created in the previous kernel.h]hInput; A null-terminated string identifying the session to retrieve. The name must exactly match the name used when the session was created in the previous kernel.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK\hj$ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj#hK]hjubeh}(h]h ]h"]h$]h&]uh1jhjKubeh}(h]h ] kernelindentah"]h$]h&]uh1jdhjhhhjhNubh)}(h**Description**h]j)}(hjQh]h Description}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKahjhhubh)}(hRetrieves a handle (a new file descriptor) for a preserved session by its name. This is the primary mechanism for a userspace agent to regain control of its preserved resources after a live update.h]hRetrieves a handle (a new file descriptor) for a preserved session by its name. This is the primary mechanism for a userspace agent to regain control of its preserved resources after a live update.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK^hjhhubh)}(hXThe userspace application provides the null-terminated `name` of a session it created before the live update. If a preserved session with a matching name is found, the kernel instantiates it and returns a new file descriptor in the `fd` field. This new session FD can then be used for all file-specific operations, such as restoring individual file descriptors with LIVEUPDATE_SESSION_RETRIEVE_FD.h](h7The userspace application provides the null-terminated }(hjvhhhNhNubhtitle_reference)}(h`name`h]hname}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j~hjvubh of a session it created before the live update. If a preserved session with a matching name is found, the kernel instantiates it and returns a new file descriptor in the }(hjvhhhNhNubj)}(h`fd`h]hfd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j~hjvubh field. This new session FD can then be used for all file-specific operations, such as restoring individual file descriptors with LIVEUPDATE_SESSION_RETRIEVE_FD.}(hjvhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKbhjhhubh)}(hIt is the responsibility of the userspace application to know the names of the sessions it needs to retrieve. If no session with the given name is found, the ioctl will fail with -ENOENT.h]hIt is the responsibility of the userspace application to know the names of the sessions it needs to retrieve. If no session with the given name is found, the ioctl will fail with -ENOENT.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKihjhhubh)}(hzThis ioctl can only be called on the main /dev/liveupdate device when the system is in the LIVEUPDATE_STATE_UPDATED state.h]hzThis ioctl can only be called on the main /dev/liveupdate device when the system is in the LIVEUPDATE_STATE_UPDATED state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKmhjhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j)liveupdate_session_preserve_fd (C struct) c.liveupdate_session_preserve_fdhNtauh1jhjhhhjhNubj)}(hhh](j)}(hliveupdate_session_preserve_fdh]j)}(h%struct liveupdate_session_preserve_fdh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKsubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKsubj )}(hliveupdate_session_preserve_fdh]j)}(hjh]hliveupdate_session_preserve_fd}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]hhuh1j hjhhhjhKsubeh}(h]h ]h"]h$]h&]hhj.uh1jj/j0hjhhhjhKsubah}(h]jah ](j4j5eh"]h$]h&]j9j:)j;huh1jhjhKshjhhubj=)}(hhh]h)}(h%ioctl(LIVEUPDATE_SESSION_PRESERVE_FD)h]h%ioctl(LIVEUPDATE_SESSION_PRESERVE_FD)}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhK}hj!hhubah}(h]h ]h"]h$]h&]uh1j<hjhhhjhKsubeh}(h]h ](jYstructeh"]h$]h&]j^jYj_j<j`j<jajbjcuh1jhhhjhjhNubje)}(hXP**Definition**:: struct liveupdate_session_preserve_fd { __u32 size; __s32 fd; __aligned_u64 token; }; **Members** ``size`` Input; sizeof(struct liveupdate_session_preserve_fd) ``fd`` Input; The user-space file descriptor to be preserved. ``token`` Input; An opaque, unique token for preserved resource.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubh:}(hjDhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj@ubj)}(hastruct liveupdate_session_preserve_fd { __u32 size; __s32 fd; __aligned_u64 token; };h]hastruct liveupdate_session_preserve_fd { __u32 size; __s32 fd; __aligned_u64 token; };}hjasbah}(h]h ]h"]h$]h&]hhuh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj@ubh)}(h **Members**h]j)}(hjrh]hMembers}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj@ubj)}(hhh](j)}(h>``size`` Input; sizeof(struct liveupdate_session_preserve_fd) h](j)}(h``size``h]jO)}(hjh]hsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjubj)}(hhh]h)}(h4Input; sizeof(struct liveupdate_session_preserve_fd)h]h4Input; sizeof(struct liveupdate_session_preserve_fd)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h>``fd`` Input; The user-space file descriptor to be preserved. h](j)}(h``fd``h]jO)}(hjh]hfd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjubj)}(hhh]h)}(h6Input; The user-space file descriptor to be preserved.h]h6Input; The user-space file descriptor to be preserved.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h@``token`` Input; An opaque, unique token for preserved resource.h](j)}(h ``token``h]jO)}(hjh]htoken}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjubj)}(hhh]h)}(h6Input; An opaque, unique token for preserved resource.h]h6Input; An opaque, unique token for preserved resource.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubeh}(h]h ]h"]h$]h&]uh1jhj@ubeh}(h]h ] kernelindentah"]h$]h&]uh1jdhjhhhjhNubh)}(h**Description**h]j)}(hjFh]h Description}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h2Holds parameters for preserving a file descriptor.h]h2Holds parameters for preserving a file descriptor.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(hXUser sets the **fd** field identifying the file descriptor to preserve (e.g., memfd, kvm, iommufd, VFIO). The kernel validates if this FD type and its dependencies are supported for preservation. If validation passes, the kernel marks the FD internally and *initiates the process* of preparing its state for saving. The actual snapshotting of the state typically occurs during the subsequent ``LIVEUPDATE_IOCTL_PREPARE`` execution phase, though some finalization might occur during freeze. On successful validation and initiation, the kernel uses the **token** field with an opaque identifier representing the resource being preserved. This token confirms the FD is targeted for preservation and is required for the subsequent ``LIVEUPDATE_SESSION_RETRIEVE_FD`` call after the live update.h](hUser sets the }(hjkhhhNhNubj)}(h**fd**h]hfd}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubh field identifying the file descriptor to preserve (e.g., memfd, kvm, iommufd, VFIO). The kernel validates if this FD type and its dependencies are supported for preservation. If validation passes, the kernel marks the FD internally and }(hjkhhhNhNubhemphasis)}(h*initiates the process*h]hinitiates the process}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubhp of preparing its state for saving. The actual snapshotting of the state typically occurs during the subsequent }(hjkhhhNhNubjO)}(h``LIVEUPDATE_IOCTL_PREPARE``h]hLIVEUPDATE_IOCTL_PREPARE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjkubh execution phase, though some finalization might occur during freeze. On successful validation and initiation, the kernel uses the }(hjkhhhNhNubj)}(h **token**h]htoken}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubh field with an opaque identifier representing the resource being preserved. This token confirms the FD is targeted for preservation and is required for the subsequent }(hjkhhhNhNubjO)}(h"``LIVEUPDATE_SESSION_RETRIEVE_FD``h]hLIVEUPDATE_SESSION_RETRIEVE_FD}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjkubh call after the live update.}(hjkhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h **Return**h]j)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h0 on success (validation passed, preservation initiated), negative error code on failure (e.g., unsupported FD type, dependency issue, validation failed).h]h0 on success (validation passed, preservation initiated), negative error code on failure (e.g., unsupported FD type, dependency issue, validation failed).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j)liveupdate_session_retrieve_fd (C struct) c.liveupdate_session_retrieve_fdhNtauh1jhjhhhjhNubj)}(hhh](j)}(hliveupdate_session_retrieve_fdh]j)}(h%struct liveupdate_session_retrieve_fdh](j)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKubj)}(h h]h }(hj$ hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhj# hKubj )}(hliveupdate_session_retrieve_fdh]j)}(hj h]hliveupdate_session_retrieve_fd}(hj6 hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2 ubah}(h]h ](j#j$eh"]h$]h&]hhuh1j hj hhhj# hKubeh}(h]h ]h"]h$]h&]hhj.uh1jj/j0hj hhhj# hKubah}(h]j ah ](j4j5eh"]h$]h&]j9j:)j;huh1jhj# hKhj hhubj=)}(hhh]h)}(h%ioctl(LIVEUPDATE_SESSION_RETRIEVE_FD)h]h%ioctl(LIVEUPDATE_SESSION_RETRIEVE_FD)}(hjX hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjU hhubah}(h]h ]h"]h$]h&]uh1j<hj hhhj# hKubeh}(h]h ](jYstructeh"]h$]h&]j^jYj_jp j`jp jajbjcuh1jhhhjhjhNubje)}(hXu**Definition**:: struct liveupdate_session_retrieve_fd { __u32 size; __s32 fd; __aligned_u64 token; }; **Members** ``size`` Input; sizeof(struct liveupdate_session_retrieve_fd) ``fd`` Output; The new file descriptor representing the fully restored kernel resource. ``token`` Input; An opaque, token that was used to preserve the resource.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj| hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjx ubh:}(hjx hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjt ubj)}(hastruct liveupdate_session_retrieve_fd { __u32 size; __s32 fd; __aligned_u64 token; };h]hastruct liveupdate_session_retrieve_fd { __u32 size; __s32 fd; __aligned_u64 token; };}hj sbah}(h]h ]h"]h$]h&]hhuh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjt ubh)}(h **Members**h]j)}(hj h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjt ubj)}(hhh](j)}(h>``size`` Input; sizeof(struct liveupdate_session_retrieve_fd) h](j)}(h``size``h]jO)}(hj h]hsize}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubj)}(hhh]h)}(h4Input; sizeof(struct liveupdate_session_retrieve_fd)h]h4Input; sizeof(struct liveupdate_session_retrieve_fd)}(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)}(hX``fd`` Output; The new file descriptor representing the fully restored kernel resource. h](j)}(h``fd``h]jO)}(hj h]hfd}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubj)}(hhh]h)}(hPOutput; The new file descriptor representing the fully restored kernel resource.h]hPOutput; The new file descriptor representing the fully restored kernel resource.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhj ubj)}(hI``token`` Input; An opaque, token that was used to preserve the resource.h](j)}(h ``token``h]jO)}(hj8 h]htoken}(hj: hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj6 ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj2 ubj)}(hhh]h)}(h?Input; An opaque, token that was used to preserve the resource.h]h?Input; An opaque, token that was used to preserve the resource.}(hjQ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjN ubah}(h]h ]h"]h$]h&]uh1jhj2 ubeh}(h]h ]h"]h$]h&]uh1jhjM hKhj ubeh}(h]h ]h"]h$]h&]uh1jhjt ubeh}(h]h ] kernelindentah"]h$]h&]uh1jdhjhhhjhNubh)}(h**Description**h]j)}(hj{ h]h Description}(hj} hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjy ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h0Retrieve a previously preserved file descriptor.h]h0Retrieve a previously preserved file descriptor.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(hXTUser sets the **token** field to the value obtained from a successful ``LIVEUPDATE_IOCTL_FD_PRESERVE`` call before the live update. On success, the kernel restores the state (saved during the PREPARE/FREEZE phases) associated with the token and populates the **fd** field with a new file descriptor referencing the restored resource in the current (new) kernel. This operation must be performed *before* signaling completion via ``LIVEUPDATE_IOCTL_FINISH``. If a retrieve of a token fails, subsequent attempts to retrieve the token fail with the same error code. Failed retrieves are not retried.h](hUser sets the }(hj hhhNhNubj)}(h **token**h]htoken}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh/ field to the value obtained from a successful }(hj hhhNhNubjO)}(h ``LIVEUPDATE_IOCTL_FD_PRESERVE``h]hLIVEUPDATE_IOCTL_FD_PRESERVE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubh call before the live update. On success, the kernel restores the state (saved during the PREPARE/FREEZE phases) associated with the token and populates the }(hj hhhNhNubj)}(h**fd**h]hfd}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh field with a new file descriptor referencing the restored resource in the current (new) kernel. This operation must be performed }(hj hhhNhNubj)}(h*before*h]hbefore}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh signaling completion via }(hj hhhNhNubjO)}(h``LIVEUPDATE_IOCTL_FINISH``h]hLIVEUPDATE_IOCTL_FINISH}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubh. If a retrieve of a token fails, subsequent attempts to retrieve the token fail with the same error code. Failed retrieves are not retried.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h **Return**h]j)}(hj h]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(hC0 on success, negative error code on failure (e.g., invalid token).h]hC0 on success, negative error code on failure (e.g., invalid token).}(hj! hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$liveupdate_session_finish (C struct)c.liveupdate_session_finishhNtauh1jhjhhhjhNubj)}(hhh](j)}(hliveupdate_session_finishh]j)}(h struct liveupdate_session_finishh](j)}(hjh]hstruct}(hjI hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjE hhhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKubj)}(h h]h }(hjW hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjE hhhjV hKubj )}(hliveupdate_session_finishh]j)}(hjC h]hliveupdate_session_finish}(hji hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhje ubah}(h]h ](j#j$eh"]h$]h&]hhuh1j hjE hhhjV hKubeh}(h]h ]h"]h$]h&]hhj.uh1jj/j0hjA hhhjV hKubah}(h]j< ah ](j4j5eh"]h$]h&]j9j:)j;huh1jhjV hKhj> hhubj=)}(hhh]h)}(h ioctl(LIVEUPDATE_SESSION_FINISH)h]h ioctl(LIVEUPDATE_SESSION_FINISH)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj hhubah}(h]h ]h"]h$]h&]uh1j<hj> hhhjV hKubeh}(h]h ](jYstructeh"]h$]h&]j^jYj_j j`j jajbjcuh1jhhhjhjhNubje)}(h**Definition**:: struct liveupdate_session_finish { __u32 size; __u32 reserved; }; **Members** ``size`` Input; sizeof(struct liveupdate_session_finish) ``reserved`` Input; Must be zero. Reserved for future use.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubj)}(hIstruct liveupdate_session_finish { __u32 size; __u32 reserved; };h]hIstruct liveupdate_session_finish { __u32 size; __u32 reserved; };}hj sbah}(h]h ]h"]h$]h&]hhuh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubh)}(h **Members**h]j)}(hj h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubj)}(hhh](j)}(h9``size`` Input; sizeof(struct liveupdate_session_finish) h](j)}(h``size``h]jO)}(hj h]hsize}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubj)}(hhh]h)}(h/Input; sizeof(struct liveupdate_session_finish)h]h/Input; sizeof(struct liveupdate_session_finish)}(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:``reserved`` Input; Must be zero. Reserved for future use.h](j)}(h ``reserved``h]jO)}(hj1 h]hreserved}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj/ ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj+ ubj)}(hhh]h)}(h-Input; Must be zero. Reserved for future use.h]h-Input; Must be zero. Reserved for future use.}(hjJ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjG ubah}(h]h ]h"]h$]h&]uh1jhj+ ubeh}(h]h ]h"]h$]h&]uh1jhjF hKhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1jdhjhhhjhNubh)}(h**Description**h]j)}(hjt h]h Description}(hjv hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjr ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(hSignals the completion of the restoration process for a retrieved session. This is the final operation that should be performed on a session file descriptor after a live update.h]hSignals the completion of the restoration process for a retrieved session. This is the final operation that should be performed on a session file descriptor after a live update.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(hThis ioctl must be called once all required file descriptors for the session have been successfully retrieved (using ``LIVEUPDATE_SESSION_RETRIEVE_FD``) and are fully restored from the userspace and kernel perspective.h](huThis ioctl must be called once all required file descriptors for the session have been successfully retrieved (using }(hj hhhNhNubjO)}(h"``LIVEUPDATE_SESSION_RETRIEVE_FD``h]hLIVEUPDATE_SESSION_RETRIEVE_FD}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubhC) and are fully restored from the userspace and kernel perspective.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(hUpon success, the kernel releases its ownership of the preserved resources associated with this session. This allows internal resources to be freed, typically by decrementing reference counts on the underlying preserved objects.h]hUpon success, the kernel releases its ownership of the preserved resources associated with this session. This allows internal resources to be freed, typically by decrementing reference counts on the underlying preserved objects.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(hIf this operation fails, the resources remain preserved in memory. Userspace may attempt to call finish again. The resources will otherwise be reset during the next live update cycle.h]hIf this operation fails, the resources remain preserved in memory. Userspace may attempt to call finish again. The resources will otherwise be reset during the next live update cycle.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h **Return**h]j)}(hj h]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubh)}(h-0 on success, negative error code on failure.h]h-0 on success, negative error code on failure.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&liveupdate_session_get_name (C struct)c.liveupdate_session_get_namehNtauh1jhjhhhjhNubj)}(hhh](j)}(hliveupdate_session_get_nameh]j)}(h"struct liveupdate_session_get_nameh](j)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKubj)}(h h]h }(hj& hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhj% hKubj )}(hliveupdate_session_get_nameh]j)}(hj h]hliveupdate_session_get_name}(hj8 hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4 ubah}(h]h ](j#j$eh"]h$]h&]hhuh1j hj hhhj% hKubeh}(h]h ]h"]h$]h&]hhj.uh1jj/j0hj hhhj% hKubah}(h]j ah ](j4j5eh"]h$]h&]j9j:)j;huh1jhj% hKhj hhubj=)}(hhh]h)}(h"ioctl(LIVEUPDATE_SESSION_GET_NAME)h]h"ioctl(LIVEUPDATE_SESSION_GET_NAME)}(hjZ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjW hhubah}(h]h ]h"]h$]h&]uh1j<hj hhhj% hKubeh}(h]h ](jYstructeh"]h$]h&]j^jYj_jr j`jr jajbjcuh1jhhhjhjhNubje)}(hXh**Definition**:: struct liveupdate_session_get_name { __u32 size; __u32 reserved; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; }; **Members** ``size`` Input; sizeof(struct liveupdate_session_get_name) ``reserved`` Input; Must be zero. Reserved for future use. ``name`` Output; A null-terminated string with the full session name.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj~ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjz ubh:}(hjz hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjv ubj)}(hzstruct liveupdate_session_get_name { __u32 size; __u32 reserved; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; };h]hzstruct liveupdate_session_get_name { __u32 size; __u32 reserved; __u8 name[LIVEUPDATE_SESSION_NAME_LENGTH]; };}hj sbah}(h]h ]h"]h$]h&]hhuh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjv ubh)}(h **Members**h]j)}(hj h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhjv ubj)}(hhh](j)}(h;``size`` Input; sizeof(struct liveupdate_session_get_name) h](j)}(h``size``h]jO)}(hj h]hsize}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubj)}(hhh]h)}(h1Input; sizeof(struct liveupdate_session_get_name)h]h1Input; sizeof(struct liveupdate_session_get_name)}(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;``reserved`` Input; Must be zero. Reserved for future use. h](j)}(h ``reserved``h]jO)}(hjh]hreserved}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj ubj)}(hhh]h)}(h-Input; Must be zero. Reserved for future use.h]h-Input; Must be zero. Reserved for future use.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjhKhj ubj)}(hE``name`` Output; A null-terminated string with the full session name.h](j)}(h``name``h]jO)}(hj9h]hname}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj7ubah}(h]h ]h"]h$]h&]uh1jhh/var/lib/git/docbuild/linux/Documentation/userspace-api/liveupdate:15: ./include/uapi/linux/liveupdate.hhKhj3ubj)}(hhh]h)}(h`_h]h)}(hjh](j)}(hjh]hFile Descriptor Store}(hjhhhNhNubah}(h]h ]h"]h$]h&]nameFile Descriptor Storerefuri)https://systemd.io/FILE_DESCRIPTOR_STORE/uh1jhjubj)}(h, h]h}(h]file-descriptor-storeah ]h"]file descriptor storeah$]h&]refurijuh1j referencedKhjubeh}(h]h ]h"]h$]h&]uh1hhhhK*hj}ubah}(h]h ]h"]h$]h&]uh1jhjzhhhhhNubj)}(h`systemd.service(5) FileDescriptorStorePreserve= `_h]h)}(h`systemd.service(5) FileDescriptorStorePreserve= `_h](j)}(hjh]h/systemd.service(5) FileDescriptorStorePreserve=}(hjhhhNhNubah}(h]h ]h"]h$]h&]name/systemd.service(5) FileDescriptorStorePreserve=jihttps://www.freedesktop.org/software/systemd/man/latest/systemd.service.html#FileDescriptorStorePreserve=uh1jhjubj)}(hl h]h}(h]-systemd-service-5-filedescriptorstorepreserveah ]h"]/systemd.service(5) filedescriptorstorepreserve=ah$]h&]refurijuh1jjKhjubeh}(h]h ]h"]h$]h&]uh1hhhhK+hjubah}(h]h ]h"]h$]h&]uh1jhjzhhhhhNubj)}(hds`sd_pid_notify_with_fds(3) `_ h]h)}(hr`sd_pid_notify_with_fds(3) `_h](j)}(hjh]hsd_pid_notify_with_fds(3)}(hjhhhNhNubah}(h]h ]h"]h$]h&]namesd_pid_notify_with_fds(3)jShttps://www.freedesktop.org/software/systemd/man/latest/sd_pid_notify_with_fds.htmluh1jhjubj)}(hV h]h}(h]sd-pid-notify-with-fds-3ah ]h"]sd_pid_notify_with_fds(3)ah$]h&]refurijuh1jjKhjubeh}(h]h ]h"]h$]h&]uh1hhhhK-hjubah}(h]h ]h"]h$]h&]uh1jhjzhhhhhNubeh}(h]h ]h"]h$]h&]jjuh1jhhhK*hjhhubeh}(h]userspace-integrationah ]h"]userspace integrationah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hSee Alsoh]hSee Also}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK1ubj)}(hhh]j)}(h6:doc:`Live Update Orchestrator `h]h)}(hj5h]h)}(hj5h]hinline)}(hj5h]hLive Update Orchestrator}(hj?hhhNhNubah}(h]h ](xrefstdstd-doceh"]h$]h&]uh1j=hj:ubah}(h]h ]h"]h$]h&]refdocuserspace-api/liveupdate refdomainjJreftypedoc refexplicitrefwarn reftarget/core-api/liveupdateuh1hhhhK3hj7ubah}(h]h ]h"]h$]h&]uh1hhhhK3hj3ubah}(h]h ]h"]h$]h&]uh1jhj0hhhhhNubah}(h]h ]h"]h$]h&]jjuh1jhhhK3hjhhubeh}(h]see-alsoah ]h"]see alsoah$]h&]uh1hhhhhhhhK1ubeh}(h]live-update-uapiah ]h"]live update uapiah$]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_handlerjerror_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}j]jasnameids}(j}jzjjjjjjjjjjjjjjjjjujru nametypes}(j}jjjjjjjjjuuh}(jzhjj5jjjjjjjjjjj j j< jA j j jjjjjjjjjjjrju 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]hsystem_message)}(hhh]h)}(hhh]h:Hyperlink target "general-ioctl-format" is not referenced.}hj sbah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcejlineKuh1juba transformerN include_log] decorationNhhub.