Merge tag 'pci-v4.16-fixes-1' of git://git.kernel.org/pub/scm/linux/kernel/git/helgaa...
[sfrench/cifs-2.6.git] / Documentation / ABI / testing / sysfs-kernel-livepatch
1 What:           /sys/kernel/livepatch
2 Date:           Nov 2014
3 KernelVersion:  3.19.0
4 Contact:        live-patching@vger.kernel.org
5 Description:
6                 Interface for kernel live patching
7
8                 The /sys/kernel/livepatch directory contains subdirectories for
9                 each loaded live patch module.
10
11 What:           /sys/kernel/livepatch/<patch>
12 Date:           Nov 2014
13 KernelVersion:  3.19.0
14 Contact:        live-patching@vger.kernel.org
15 Description:
16                 The patch directory contains subdirectories for each kernel
17                 object (vmlinux or a module) in which it patched functions.
18
19 What:           /sys/kernel/livepatch/<patch>/enabled
20 Date:           Nov 2014
21 KernelVersion:  3.19.0
22 Contact:        live-patching@vger.kernel.org
23 Description:
24                 A writable attribute that indicates whether the patched
25                 code is currently applied.  Writing 0 will disable the patch
26                 while writing 1 will re-enable the patch.
27
28 What:           /sys/kernel/livepatch/<patch>/transition
29 Date:           Feb 2017
30 KernelVersion:  4.12.0
31 Contact:        live-patching@vger.kernel.org
32 Description:
33                 An attribute which indicates whether the patch is currently in
34                 transition.
35
36 What:           /sys/kernel/livepatch/<patch>/signal
37 Date:           Nov 2017
38 KernelVersion:  4.15.0
39 Contact:        live-patching@vger.kernel.org
40 Description:
41                 A writable attribute that allows administrator to affect the
42                 course of an existing transition. Writing 1 sends a fake
43                 signal to all remaining blocking tasks. The fake signal
44                 means that no proper signal is delivered (there is no data in
45                 signal pending structures). Tasks are interrupted or woken up,
46                 and forced to change their patched state.
47
48 What:           /sys/kernel/livepatch/<patch>/force
49 Date:           Nov 2017
50 KernelVersion:  4.15.0
51 Contact:        live-patching@vger.kernel.org
52 Description:
53                 A writable attribute that allows administrator to affect the
54                 course of an existing transition. Writing 1 clears
55                 TIF_PATCH_PENDING flag of all tasks and thus forces the tasks to
56                 the patched or unpatched state. Administrator should not
57                 use this feature without a clearance from a patch
58                 distributor. Removal (rmmod) of patch modules is permanently
59                 disabled when the feature is used. See
60                 Documentation/livepatch/livepatch.txt for more information.
61
62 What:           /sys/kernel/livepatch/<patch>/<object>
63 Date:           Nov 2014
64 KernelVersion:  3.19.0
65 Contact:        live-patching@vger.kernel.org
66 Description:
67                 The object directory contains subdirectories for each function
68                 that is patched within the object.
69
70 What:           /sys/kernel/livepatch/<patch>/<object>/<function,sympos>
71 Date:           Nov 2014
72 KernelVersion:  3.19.0
73 Contact:        live-patching@vger.kernel.org
74 Description:
75                 The function directory contains attributes regarding the
76                 properties and state of the patched function.
77
78                 The directory name contains the patched function name and a
79                 sympos number corresponding to the nth occurrence of the symbol
80                 name in kallsyms for the patched object.
81
82                 There are currently no such attributes.