xref: /linux/Documentation/core-api/liveupdate.rst (revision 23b0f90ba871f096474e1c27c3d14f455189d2d9) 
1.. SPDX-License-Identifier: GPL-2.0
2
3========================
4Live Update Orchestrator
5========================
6:Author: Pasha Tatashin <pasha.tatashin@soleen.com>
7
8.. kernel-doc:: kernel/liveupdate/luo_core.c
9   :doc: Live Update Orchestrator (LUO)
10
11LUO Sessions
12============
13.. kernel-doc:: kernel/liveupdate/luo_session.c
14   :doc: LUO Sessions
15
16LUO Preserving File Descriptors
17===============================
18.. kernel-doc:: kernel/liveupdate/luo_file.c
19   :doc: LUO File Descriptors
20
21LUO File Lifecycle Bound Global Data
22====================================
23.. kernel-doc:: kernel/liveupdate/luo_flb.c
24   :doc: LUO File Lifecycle Bound Global Data
25
26Live Update Orchestrator ABI
27============================
28.. kernel-doc:: include/linux/kho/abi/luo.h
29   :doc: Live Update Orchestrator ABI
30
31The following types of file descriptors can be preserved
32
33.. toctree::
34   :maxdepth: 1
35
36   ../mm/memfd_preservation
37
38Public API
39==========
40.. kernel-doc:: include/linux/liveupdate.h
41
42.. kernel-doc:: include/linux/kho/abi/luo.h
43   :functions:
44
45.. kernel-doc:: kernel/liveupdate/luo_core.c
46   :export:
47
48.. kernel-doc:: kernel/liveupdate/luo_flb.c
49   :export:
50
51.. kernel-doc:: kernel/liveupdate/luo_file.c
52   :export:
53
54Internal API
55============
56.. kernel-doc:: kernel/liveupdate/luo_core.c
57   :internal:
58
59.. kernel-doc:: kernel/liveupdate/luo_flb.c
60   :internal:
61
62.. kernel-doc:: kernel/liveupdate/luo_session.c
63   :internal:
64
65.. kernel-doc:: kernel/liveupdate/luo_file.c
66   :internal:
67
68See Also
69========
70
71- :doc:`Live Update uAPI </userspace-api/liveupdate>`
72- :doc:`/core-api/kho/index`
73