Commit | Line | Data |
---|---|---|
b700e7f0 SJ |
1 | /* |
2 | * livepatch.h - Kernel Live Patching Core | |
3 | * | |
4 | * Copyright (C) 2014 Seth Jennings <sjenning@redhat.com> | |
5 | * Copyright (C) 2014 SUSE | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or | |
8 | * modify it under the terms of the GNU General Public License | |
9 | * as published by the Free Software Foundation; either version 2 | |
10 | * of the License, or (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, see <http://www.gnu.org/licenses/>. | |
19 | */ | |
20 | ||
21 | #ifndef _LINUX_LIVEPATCH_H_ | |
22 | #define _LINUX_LIVEPATCH_H_ | |
23 | ||
24 | #include <linux/module.h> | |
25 | #include <linux/ftrace.h> | |
3ec24776 | 26 | #include <linux/completion.h> |
b700e7f0 | 27 | |
7e545d6e JY |
28 | #if IS_ENABLED(CONFIG_LIVEPATCH) |
29 | ||
b700e7f0 SJ |
30 | #include <asm/livepatch.h> |
31 | ||
d83a7cb3 JP |
32 | /* task patch states */ |
33 | #define KLP_UNDEFINED -1 | |
34 | #define KLP_UNPATCHED 0 | |
35 | #define KLP_PATCHED 1 | |
36 | ||
b700e7f0 SJ |
37 | /** |
38 | * struct klp_func - function structure for live patching | |
39 | * @old_name: name of the function to be patched | |
40 | * @new_func: pointer to the patched function code | |
b2b018ef CA |
41 | * @old_sympos: a hint indicating which symbol position the old function |
42 | * can be found (optional) | |
43 | * @old_addr: the address of the function being patched | |
b700e7f0 | 44 | * @kobj: kobject for sysfs resources |
3c33f5b9 | 45 | * @stack_node: list node for klp_ops func_stack list |
f5e547f4 JP |
46 | * @old_size: size of the old function |
47 | * @new_size: size of the new function | |
0dade9f3 | 48 | * @patched: the func has been added to the klp_ops list |
d83a7cb3 JP |
49 | * @transition: the func is currently being applied or reverted |
50 | * | |
51 | * The patched and transition variables define the func's patching state. When | |
52 | * patching, a func is always in one of the following states: | |
53 | * | |
54 | * patched=0 transition=0: unpatched | |
55 | * patched=0 transition=1: unpatched, temporary starting state | |
56 | * patched=1 transition=1: patched, may be visible to some tasks | |
57 | * patched=1 transition=0: patched, visible to all tasks | |
58 | * | |
59 | * And when unpatching, it goes in the reverse order: | |
60 | * | |
61 | * patched=1 transition=0: patched, visible to all tasks | |
62 | * patched=1 transition=1: patched, may be visible to some tasks | |
63 | * patched=0 transition=1: unpatched, temporary ending state | |
64 | * patched=0 transition=0: unpatched | |
b700e7f0 SJ |
65 | */ |
66 | struct klp_func { | |
67 | /* external */ | |
68 | const char *old_name; | |
69 | void *new_func; | |
70 | /* | |
b2b018ef CA |
71 | * The old_sympos field is optional and can be used to resolve |
72 | * duplicate symbol names in livepatch objects. If this field is zero, | |
73 | * it is expected the symbol is unique, otherwise patching fails. If | |
74 | * this value is greater than zero then that occurrence of the symbol | |
75 | * in kallsyms for the given object is used. | |
b700e7f0 | 76 | */ |
b2b018ef | 77 | unsigned long old_sympos; |
b700e7f0 SJ |
78 | |
79 | /* internal */ | |
b2b018ef | 80 | unsigned long old_addr; |
b700e7f0 | 81 | struct kobject kobj; |
3c33f5b9 | 82 | struct list_head stack_node; |
f5e547f4 | 83 | unsigned long old_size, new_size; |
0dade9f3 | 84 | bool patched; |
d83a7cb3 | 85 | bool transition; |
b700e7f0 SJ |
86 | }; |
87 | ||
93862e38 JL |
88 | struct klp_object; |
89 | ||
90 | /** | |
91 | * struct klp_callbacks - pre/post live-(un)patch callback structure | |
92 | * @pre_patch: executed before code patching | |
93 | * @post_patch: executed after code patching | |
94 | * @pre_unpatch: executed before code unpatching | |
95 | * @post_unpatch: executed after code unpatching | |
96 | * @post_unpatch_enabled: flag indicating if post-unpatch callback | |
97 | * should run | |
98 | * | |
99 | * All callbacks are optional. Only the pre-patch callback, if provided, | |
100 | * will be unconditionally executed. If the parent klp_object fails to | |
101 | * patch for any reason, including a non-zero error status returned from | |
102 | * the pre-patch callback, no further callbacks will be executed. | |
103 | */ | |
104 | struct klp_callbacks { | |
105 | int (*pre_patch)(struct klp_object *obj); | |
106 | void (*post_patch)(struct klp_object *obj); | |
107 | void (*pre_unpatch)(struct klp_object *obj); | |
108 | void (*post_unpatch)(struct klp_object *obj); | |
109 | bool post_unpatch_enabled; | |
110 | }; | |
111 | ||
b700e7f0 SJ |
112 | /** |
113 | * struct klp_object - kernel object structure for live patching | |
114 | * @name: module name (or NULL for vmlinux) | |
b700e7f0 | 115 | * @funcs: function entries for functions to be patched in the object |
93862e38 | 116 | * @callbacks: functions to be executed pre/post (un)patching |
b700e7f0 SJ |
117 | * @kobj: kobject for sysfs resources |
118 | * @mod: kernel module associated with the patched object | |
d83a7cb3 | 119 | * (NULL for vmlinux) |
0dade9f3 | 120 | * @patched: the object's funcs have been added to the klp_ops list |
b700e7f0 SJ |
121 | */ |
122 | struct klp_object { | |
123 | /* external */ | |
124 | const char *name; | |
b700e7f0 | 125 | struct klp_func *funcs; |
93862e38 | 126 | struct klp_callbacks callbacks; |
b700e7f0 SJ |
127 | |
128 | /* internal */ | |
cad706df | 129 | struct kobject kobj; |
b700e7f0 | 130 | struct module *mod; |
0dade9f3 | 131 | bool patched; |
b700e7f0 SJ |
132 | }; |
133 | ||
134 | /** | |
135 | * struct klp_patch - patch structure for live patching | |
136 | * @mod: reference to the live patch module | |
137 | * @objs: object entries for kernel objects to be patched | |
138 | * @list: list node for global list of registered patches | |
139 | * @kobj: kobject for sysfs resources | |
0dade9f3 | 140 | * @enabled: the patch is enabled (but operation may be incomplete) |
3ec24776 | 141 | * @finish: for waiting till it is safe to remove the patch module |
b700e7f0 SJ |
142 | */ |
143 | struct klp_patch { | |
144 | /* external */ | |
145 | struct module *mod; | |
146 | struct klp_object *objs; | |
147 | ||
148 | /* internal */ | |
149 | struct list_head list; | |
150 | struct kobject kobj; | |
0dade9f3 | 151 | bool enabled; |
3ec24776 | 152 | struct completion finish; |
b700e7f0 SJ |
153 | }; |
154 | ||
8cdd043a | 155 | #define klp_for_each_object(patch, obj) \ |
f09d9086 | 156 | for (obj = patch->objs; obj->funcs || obj->name; obj++) |
8cdd043a JS |
157 | |
158 | #define klp_for_each_func(obj, func) \ | |
f09d9086 MB |
159 | for (func = obj->funcs; \ |
160 | func->old_name || func->new_func || func->old_sympos; \ | |
161 | func++) | |
8cdd043a | 162 | |
4421f8f0 MB |
163 | int klp_register_patch(struct klp_patch *); |
164 | int klp_unregister_patch(struct klp_patch *); | |
165 | int klp_enable_patch(struct klp_patch *); | |
166 | int klp_disable_patch(struct klp_patch *); | |
b700e7f0 | 167 | |
255e732c JY |
168 | void arch_klp_init_object_loaded(struct klp_patch *patch, |
169 | struct klp_object *obj); | |
170 | ||
7e545d6e JY |
171 | /* Called from the module loader during module coming/going states */ |
172 | int klp_module_coming(struct module *mod); | |
173 | void klp_module_going(struct module *mod); | |
174 | ||
d83a7cb3 | 175 | void klp_copy_process(struct task_struct *child); |
46c5a011 JP |
176 | void klp_update_patch_state(struct task_struct *task); |
177 | ||
d83a7cb3 JP |
178 | static inline bool klp_patch_pending(struct task_struct *task) |
179 | { | |
180 | return test_tsk_thread_flag(task, TIF_PATCH_PENDING); | |
181 | } | |
182 | ||
183 | static inline bool klp_have_reliable_stack(void) | |
184 | { | |
185 | return IS_ENABLED(CONFIG_STACKTRACE) && | |
186 | IS_ENABLED(CONFIG_HAVE_RELIABLE_STACKTRACE); | |
187 | } | |
188 | ||
e91c2518 PM |
189 | typedef int (*klp_shadow_ctor_t)(void *obj, |
190 | void *shadow_data, | |
191 | void *ctor_data); | |
3b2c77d0 | 192 | typedef void (*klp_shadow_dtor_t)(void *obj, void *shadow_data); |
e91c2518 | 193 | |
439e7271 | 194 | void *klp_shadow_get(void *obj, unsigned long id); |
e91c2518 PM |
195 | void *klp_shadow_alloc(void *obj, unsigned long id, |
196 | size_t size, gfp_t gfp_flags, | |
197 | klp_shadow_ctor_t ctor, void *ctor_data); | |
198 | void *klp_shadow_get_or_alloc(void *obj, unsigned long id, | |
199 | size_t size, gfp_t gfp_flags, | |
200 | klp_shadow_ctor_t ctor, void *ctor_data); | |
3b2c77d0 PM |
201 | void klp_shadow_free(void *obj, unsigned long id, klp_shadow_dtor_t dtor); |
202 | void klp_shadow_free_all(unsigned long id, klp_shadow_dtor_t dtor); | |
439e7271 | 203 | |
7e545d6e JY |
204 | #else /* !CONFIG_LIVEPATCH */ |
205 | ||
206 | static inline int klp_module_coming(struct module *mod) { return 0; } | |
46c5a011 | 207 | static inline void klp_module_going(struct module *mod) {} |
d83a7cb3 | 208 | static inline bool klp_patch_pending(struct task_struct *task) { return false; } |
46c5a011 | 209 | static inline void klp_update_patch_state(struct task_struct *task) {} |
d83a7cb3 | 210 | static inline void klp_copy_process(struct task_struct *child) {} |
7e545d6e JY |
211 | |
212 | #endif /* CONFIG_LIVEPATCH */ | |
213 | ||
b700e7f0 | 214 | #endif /* _LINUX_LIVEPATCH_H_ */ |