]>
Commit | Line | Data |
---|---|---|
b700e7f0 SJ |
1 | /* |
2 | * core.c - 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 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt | |
22 | ||
23 | #include <linux/module.h> | |
24 | #include <linux/kernel.h> | |
25 | #include <linux/mutex.h> | |
26 | #include <linux/slab.h> | |
27 | #include <linux/ftrace.h> | |
28 | #include <linux/list.h> | |
29 | #include <linux/kallsyms.h> | |
30 | #include <linux/livepatch.h> | |
425595a7 JY |
31 | #include <linux/elf.h> |
32 | #include <linux/moduleloader.h> | |
b56b36ee | 33 | #include <asm/cacheflush.h> |
b700e7f0 | 34 | |
3c33f5b9 JP |
35 | /** |
36 | * struct klp_ops - structure for tracking registered ftrace ops structs | |
37 | * | |
38 | * A single ftrace_ops is shared between all enabled replacement functions | |
39 | * (klp_func structs) which have the same old_addr. This allows the switch | |
40 | * between function versions to happen instantaneously by updating the klp_ops | |
41 | * struct's func_stack list. The winner is the klp_func at the top of the | |
42 | * func_stack (front of the list). | |
43 | * | |
44 | * @node: node for the global klp_ops list | |
45 | * @func_stack: list head for the stack of klp_func's (active func is on top) | |
46 | * @fops: registered ftrace ops struct | |
b700e7f0 | 47 | */ |
3c33f5b9 JP |
48 | struct klp_ops { |
49 | struct list_head node; | |
50 | struct list_head func_stack; | |
51 | struct ftrace_ops fops; | |
52 | }; | |
b700e7f0 | 53 | |
3c33f5b9 JP |
54 | /* |
55 | * The klp_mutex protects the global lists and state transitions of any | |
56 | * structure reachable from them. References to any structure must be obtained | |
57 | * under mutex protection (except in klp_ftrace_handler(), which uses RCU to | |
58 | * ensure it gets consistent data). | |
59 | */ | |
b700e7f0 | 60 | static DEFINE_MUTEX(klp_mutex); |
3c33f5b9 | 61 | |
b700e7f0 | 62 | static LIST_HEAD(klp_patches); |
3c33f5b9 | 63 | static LIST_HEAD(klp_ops); |
b700e7f0 SJ |
64 | |
65 | static struct kobject *klp_root_kobj; | |
66 | ||
46c5a011 JP |
67 | /* TODO: temporary stub */ |
68 | void klp_update_patch_state(struct task_struct *task) {} | |
69 | ||
3c33f5b9 JP |
70 | static struct klp_ops *klp_find_ops(unsigned long old_addr) |
71 | { | |
72 | struct klp_ops *ops; | |
73 | struct klp_func *func; | |
74 | ||
75 | list_for_each_entry(ops, &klp_ops, node) { | |
76 | func = list_first_entry(&ops->func_stack, struct klp_func, | |
77 | stack_node); | |
78 | if (func->old_addr == old_addr) | |
79 | return ops; | |
80 | } | |
81 | ||
82 | return NULL; | |
83 | } | |
84 | ||
b700e7f0 SJ |
85 | static bool klp_is_module(struct klp_object *obj) |
86 | { | |
87 | return obj->name; | |
88 | } | |
89 | ||
90 | static bool klp_is_object_loaded(struct klp_object *obj) | |
91 | { | |
92 | return !obj->name || obj->mod; | |
93 | } | |
94 | ||
95 | /* sets obj->mod if object is not vmlinux and module is found */ | |
96 | static void klp_find_object_module(struct klp_object *obj) | |
97 | { | |
8cb2c2dc PM |
98 | struct module *mod; |
99 | ||
b700e7f0 SJ |
100 | if (!klp_is_module(obj)) |
101 | return; | |
102 | ||
103 | mutex_lock(&module_mutex); | |
104 | /* | |
8cb2c2dc PM |
105 | * We do not want to block removal of patched modules and therefore |
106 | * we do not take a reference here. The patches are removed by | |
7e545d6e | 107 | * klp_module_going() instead. |
8cb2c2dc PM |
108 | */ |
109 | mod = find_module(obj->name); | |
110 | /* | |
7e545d6e JY |
111 | * Do not mess work of klp_module_coming() and klp_module_going(). |
112 | * Note that the patch might still be needed before klp_module_going() | |
8cb2c2dc PM |
113 | * is called. Module functions can be called even in the GOING state |
114 | * until mod->exit() finishes. This is especially important for | |
115 | * patches that modify semantic of the functions. | |
b700e7f0 | 116 | */ |
8cb2c2dc PM |
117 | if (mod && mod->klp_alive) |
118 | obj->mod = mod; | |
119 | ||
b700e7f0 SJ |
120 | mutex_unlock(&module_mutex); |
121 | } | |
122 | ||
123 | /* klp_mutex must be held by caller */ | |
124 | static bool klp_is_patch_registered(struct klp_patch *patch) | |
125 | { | |
126 | struct klp_patch *mypatch; | |
127 | ||
128 | list_for_each_entry(mypatch, &klp_patches, list) | |
129 | if (mypatch == patch) | |
130 | return true; | |
131 | ||
132 | return false; | |
133 | } | |
134 | ||
135 | static bool klp_initialized(void) | |
136 | { | |
e76ff06a | 137 | return !!klp_root_kobj; |
b700e7f0 SJ |
138 | } |
139 | ||
140 | struct klp_find_arg { | |
141 | const char *objname; | |
142 | const char *name; | |
143 | unsigned long addr; | |
b700e7f0 | 144 | unsigned long count; |
b2b018ef | 145 | unsigned long pos; |
b700e7f0 SJ |
146 | }; |
147 | ||
148 | static int klp_find_callback(void *data, const char *name, | |
149 | struct module *mod, unsigned long addr) | |
150 | { | |
151 | struct klp_find_arg *args = data; | |
152 | ||
153 | if ((mod && !args->objname) || (!mod && args->objname)) | |
154 | return 0; | |
155 | ||
156 | if (strcmp(args->name, name)) | |
157 | return 0; | |
158 | ||
159 | if (args->objname && strcmp(args->objname, mod->name)) | |
160 | return 0; | |
161 | ||
b700e7f0 SJ |
162 | args->addr = addr; |
163 | args->count++; | |
164 | ||
b2b018ef CA |
165 | /* |
166 | * Finish the search when the symbol is found for the desired position | |
167 | * or the position is not defined for a non-unique symbol. | |
168 | */ | |
169 | if ((args->pos && (args->count == args->pos)) || | |
170 | (!args->pos && (args->count > 1))) | |
171 | return 1; | |
172 | ||
b700e7f0 SJ |
173 | return 0; |
174 | } | |
175 | ||
176 | static int klp_find_object_symbol(const char *objname, const char *name, | |
b2b018ef | 177 | unsigned long sympos, unsigned long *addr) |
b700e7f0 SJ |
178 | { |
179 | struct klp_find_arg args = { | |
180 | .objname = objname, | |
181 | .name = name, | |
182 | .addr = 0, | |
b2b018ef CA |
183 | .count = 0, |
184 | .pos = sympos, | |
b700e7f0 SJ |
185 | }; |
186 | ||
9a1bd63c | 187 | mutex_lock(&module_mutex); |
b700e7f0 | 188 | kallsyms_on_each_symbol(klp_find_callback, &args); |
9a1bd63c | 189 | mutex_unlock(&module_mutex); |
b700e7f0 | 190 | |
b2b018ef CA |
191 | /* |
192 | * Ensure an address was found. If sympos is 0, ensure symbol is unique; | |
193 | * otherwise ensure the symbol position count matches sympos. | |
194 | */ | |
195 | if (args.addr == 0) | |
b700e7f0 | 196 | pr_err("symbol '%s' not found in symbol table\n", name); |
b2b018ef | 197 | else if (args.count > 1 && sympos == 0) { |
f995b5f7 PM |
198 | pr_err("unresolvable ambiguity for symbol '%s' in object '%s'\n", |
199 | name, objname); | |
b2b018ef CA |
200 | } else if (sympos != args.count && sympos > 0) { |
201 | pr_err("symbol position %lu for symbol '%s' in object '%s' not found\n", | |
202 | sympos, name, objname ? objname : "vmlinux"); | |
203 | } else { | |
b700e7f0 SJ |
204 | *addr = args.addr; |
205 | return 0; | |
206 | } | |
207 | ||
208 | *addr = 0; | |
209 | return -EINVAL; | |
210 | } | |
211 | ||
425595a7 | 212 | static int klp_resolve_symbols(Elf_Shdr *relasec, struct module *pmod) |
b700e7f0 | 213 | { |
425595a7 JY |
214 | int i, cnt, vmlinux, ret; |
215 | char objname[MODULE_NAME_LEN]; | |
216 | char symname[KSYM_NAME_LEN]; | |
217 | char *strtab = pmod->core_kallsyms.strtab; | |
218 | Elf_Rela *relas; | |
219 | Elf_Sym *sym; | |
220 | unsigned long sympos, addr; | |
b700e7f0 | 221 | |
b2b018ef | 222 | /* |
425595a7 JY |
223 | * Since the field widths for objname and symname in the sscanf() |
224 | * call are hard-coded and correspond to MODULE_NAME_LEN and | |
225 | * KSYM_NAME_LEN respectively, we must make sure that MODULE_NAME_LEN | |
226 | * and KSYM_NAME_LEN have the values we expect them to have. | |
227 | * | |
228 | * Because the value of MODULE_NAME_LEN can differ among architectures, | |
229 | * we use the smallest/strictest upper bound possible (56, based on | |
230 | * the current definition of MODULE_NAME_LEN) to prevent overflows. | |
b2b018ef | 231 | */ |
425595a7 JY |
232 | BUILD_BUG_ON(MODULE_NAME_LEN < 56 || KSYM_NAME_LEN != 128); |
233 | ||
234 | relas = (Elf_Rela *) relasec->sh_addr; | |
235 | /* For each rela in this klp relocation section */ | |
236 | for (i = 0; i < relasec->sh_size / sizeof(Elf_Rela); i++) { | |
237 | sym = pmod->core_kallsyms.symtab + ELF_R_SYM(relas[i].r_info); | |
238 | if (sym->st_shndx != SHN_LIVEPATCH) { | |
239 | pr_err("symbol %s is not marked as a livepatch symbol", | |
240 | strtab + sym->st_name); | |
241 | return -EINVAL; | |
242 | } | |
243 | ||
244 | /* Format: .klp.sym.objname.symname,sympos */ | |
245 | cnt = sscanf(strtab + sym->st_name, | |
246 | ".klp.sym.%55[^.].%127[^,],%lu", | |
247 | objname, symname, &sympos); | |
248 | if (cnt != 3) { | |
249 | pr_err("symbol %s has an incorrectly formatted name", | |
250 | strtab + sym->st_name); | |
251 | return -EINVAL; | |
252 | } | |
253 | ||
254 | /* klp_find_object_symbol() treats a NULL objname as vmlinux */ | |
255 | vmlinux = !strcmp(objname, "vmlinux"); | |
256 | ret = klp_find_object_symbol(vmlinux ? NULL : objname, | |
257 | symname, sympos, &addr); | |
258 | if (ret) | |
259 | return ret; | |
260 | ||
261 | sym->st_value = addr; | |
262 | } | |
263 | ||
264 | return 0; | |
b700e7f0 SJ |
265 | } |
266 | ||
267 | static int klp_write_object_relocations(struct module *pmod, | |
268 | struct klp_object *obj) | |
269 | { | |
425595a7 JY |
270 | int i, cnt, ret = 0; |
271 | const char *objname, *secname; | |
272 | char sec_objname[MODULE_NAME_LEN]; | |
273 | Elf_Shdr *sec; | |
b700e7f0 SJ |
274 | |
275 | if (WARN_ON(!klp_is_object_loaded(obj))) | |
276 | return -EINVAL; | |
277 | ||
425595a7 | 278 | objname = klp_is_module(obj) ? obj->name : "vmlinux"; |
b700e7f0 | 279 | |
425595a7 JY |
280 | /* For each klp relocation section */ |
281 | for (i = 1; i < pmod->klp_info->hdr.e_shnum; i++) { | |
282 | sec = pmod->klp_info->sechdrs + i; | |
283 | secname = pmod->klp_info->secstrings + sec->sh_name; | |
284 | if (!(sec->sh_flags & SHF_RELA_LIVEPATCH)) | |
285 | continue; | |
b56b36ee | 286 | |
425595a7 JY |
287 | /* |
288 | * Format: .klp.rela.sec_objname.section_name | |
289 | * See comment in klp_resolve_symbols() for an explanation | |
290 | * of the selected field width value. | |
291 | */ | |
292 | cnt = sscanf(secname, ".klp.rela.%55[^.]", sec_objname); | |
293 | if (cnt != 1) { | |
294 | pr_err("section %s has an incorrectly formatted name", | |
295 | secname); | |
296 | ret = -EINVAL; | |
297 | break; | |
298 | } | |
b56b36ee | 299 | |
425595a7 JY |
300 | if (strcmp(objname, sec_objname)) |
301 | continue; | |
b56b36ee | 302 | |
425595a7 | 303 | ret = klp_resolve_symbols(sec, pmod); |
064c89df | 304 | if (ret) |
425595a7 | 305 | break; |
064c89df | 306 | |
425595a7 JY |
307 | ret = apply_relocate_add(pmod->klp_info->sechdrs, |
308 | pmod->core_kallsyms.strtab, | |
309 | pmod->klp_info->symndx, i, pmod); | |
310 | if (ret) | |
311 | break; | |
b700e7f0 SJ |
312 | } |
313 | ||
b56b36ee | 314 | return ret; |
b700e7f0 SJ |
315 | } |
316 | ||
317 | static void notrace klp_ftrace_handler(unsigned long ip, | |
318 | unsigned long parent_ip, | |
3c33f5b9 | 319 | struct ftrace_ops *fops, |
b700e7f0 SJ |
320 | struct pt_regs *regs) |
321 | { | |
3c33f5b9 JP |
322 | struct klp_ops *ops; |
323 | struct klp_func *func; | |
324 | ||
325 | ops = container_of(fops, struct klp_ops, fops); | |
326 | ||
327 | rcu_read_lock(); | |
328 | func = list_first_or_null_rcu(&ops->func_stack, struct klp_func, | |
329 | stack_node); | |
3c33f5b9 | 330 | if (WARN_ON_ONCE(!func)) |
c4ce0da8 | 331 | goto unlock; |
b700e7f0 | 332 | |
b5bfc517 | 333 | klp_arch_set_pc(regs, (unsigned long)func->new_func); |
c4ce0da8 PM |
334 | unlock: |
335 | rcu_read_unlock(); | |
b700e7f0 SJ |
336 | } |
337 | ||
28e7cbd3 ME |
338 | /* |
339 | * Convert a function address into the appropriate ftrace location. | |
340 | * | |
341 | * Usually this is just the address of the function, but on some architectures | |
342 | * it's more complicated so allow them to provide a custom behaviour. | |
343 | */ | |
344 | #ifndef klp_get_ftrace_location | |
345 | static unsigned long klp_get_ftrace_location(unsigned long faddr) | |
346 | { | |
347 | return faddr; | |
348 | } | |
349 | #endif | |
350 | ||
0937e3b0 | 351 | static void klp_disable_func(struct klp_func *func) |
b700e7f0 | 352 | { |
3c33f5b9 | 353 | struct klp_ops *ops; |
b700e7f0 | 354 | |
225f58fb MH |
355 | if (WARN_ON(func->state != KLP_ENABLED)) |
356 | return; | |
357 | if (WARN_ON(!func->old_addr)) | |
358 | return; | |
b700e7f0 | 359 | |
3c33f5b9 JP |
360 | ops = klp_find_ops(func->old_addr); |
361 | if (WARN_ON(!ops)) | |
0937e3b0 | 362 | return; |
b700e7f0 | 363 | |
3c33f5b9 | 364 | if (list_is_singular(&ops->func_stack)) { |
28e7cbd3 ME |
365 | unsigned long ftrace_loc; |
366 | ||
367 | ftrace_loc = klp_get_ftrace_location(func->old_addr); | |
368 | if (WARN_ON(!ftrace_loc)) | |
369 | return; | |
370 | ||
0937e3b0 | 371 | WARN_ON(unregister_ftrace_function(&ops->fops)); |
28e7cbd3 | 372 | WARN_ON(ftrace_set_filter_ip(&ops->fops, ftrace_loc, 1, 0)); |
3c33f5b9 JP |
373 | |
374 | list_del_rcu(&func->stack_node); | |
375 | list_del(&ops->node); | |
376 | kfree(ops); | |
377 | } else { | |
378 | list_del_rcu(&func->stack_node); | |
379 | } | |
b700e7f0 SJ |
380 | |
381 | func->state = KLP_DISABLED; | |
b700e7f0 SJ |
382 | } |
383 | ||
384 | static int klp_enable_func(struct klp_func *func) | |
385 | { | |
3c33f5b9 | 386 | struct klp_ops *ops; |
b700e7f0 SJ |
387 | int ret; |
388 | ||
389 | if (WARN_ON(!func->old_addr)) | |
390 | return -EINVAL; | |
391 | ||
392 | if (WARN_ON(func->state != KLP_DISABLED)) | |
393 | return -EINVAL; | |
394 | ||
3c33f5b9 JP |
395 | ops = klp_find_ops(func->old_addr); |
396 | if (!ops) { | |
28e7cbd3 ME |
397 | unsigned long ftrace_loc; |
398 | ||
399 | ftrace_loc = klp_get_ftrace_location(func->old_addr); | |
400 | if (!ftrace_loc) { | |
401 | pr_err("failed to find location for function '%s'\n", | |
402 | func->old_name); | |
403 | return -EINVAL; | |
404 | } | |
405 | ||
3c33f5b9 JP |
406 | ops = kzalloc(sizeof(*ops), GFP_KERNEL); |
407 | if (!ops) | |
408 | return -ENOMEM; | |
409 | ||
410 | ops->fops.func = klp_ftrace_handler; | |
411 | ops->fops.flags = FTRACE_OPS_FL_SAVE_REGS | | |
412 | FTRACE_OPS_FL_DYNAMIC | | |
413 | FTRACE_OPS_FL_IPMODIFY; | |
414 | ||
415 | list_add(&ops->node, &klp_ops); | |
416 | ||
417 | INIT_LIST_HEAD(&ops->func_stack); | |
418 | list_add_rcu(&func->stack_node, &ops->func_stack); | |
419 | ||
28e7cbd3 | 420 | ret = ftrace_set_filter_ip(&ops->fops, ftrace_loc, 0, 0); |
3c33f5b9 JP |
421 | if (ret) { |
422 | pr_err("failed to set ftrace filter for function '%s' (%d)\n", | |
423 | func->old_name, ret); | |
424 | goto err; | |
425 | } | |
426 | ||
427 | ret = register_ftrace_function(&ops->fops); | |
428 | if (ret) { | |
429 | pr_err("failed to register ftrace handler for function '%s' (%d)\n", | |
430 | func->old_name, ret); | |
28e7cbd3 | 431 | ftrace_set_filter_ip(&ops->fops, ftrace_loc, 1, 0); |
3c33f5b9 JP |
432 | goto err; |
433 | } | |
434 | ||
b700e7f0 | 435 | |
b700e7f0 | 436 | } else { |
3c33f5b9 | 437 | list_add_rcu(&func->stack_node, &ops->func_stack); |
b700e7f0 SJ |
438 | } |
439 | ||
3c33f5b9 JP |
440 | func->state = KLP_ENABLED; |
441 | ||
dbed7dda | 442 | return 0; |
3c33f5b9 JP |
443 | |
444 | err: | |
445 | list_del_rcu(&func->stack_node); | |
446 | list_del(&ops->node); | |
447 | kfree(ops); | |
b700e7f0 SJ |
448 | return ret; |
449 | } | |
450 | ||
0937e3b0 | 451 | static void klp_disable_object(struct klp_object *obj) |
b700e7f0 SJ |
452 | { |
453 | struct klp_func *func; | |
b700e7f0 | 454 | |
8cdd043a | 455 | klp_for_each_func(obj, func) |
0937e3b0 JP |
456 | if (func->state == KLP_ENABLED) |
457 | klp_disable_func(func); | |
b700e7f0 SJ |
458 | |
459 | obj->state = KLP_DISABLED; | |
b700e7f0 SJ |
460 | } |
461 | ||
462 | static int klp_enable_object(struct klp_object *obj) | |
463 | { | |
464 | struct klp_func *func; | |
465 | int ret; | |
466 | ||
467 | if (WARN_ON(obj->state != KLP_DISABLED)) | |
468 | return -EINVAL; | |
469 | ||
470 | if (WARN_ON(!klp_is_object_loaded(obj))) | |
471 | return -EINVAL; | |
472 | ||
8cdd043a | 473 | klp_for_each_func(obj, func) { |
b700e7f0 | 474 | ret = klp_enable_func(func); |
0937e3b0 JP |
475 | if (ret) { |
476 | klp_disable_object(obj); | |
477 | return ret; | |
478 | } | |
b700e7f0 SJ |
479 | } |
480 | obj->state = KLP_ENABLED; | |
481 | ||
482 | return 0; | |
b700e7f0 SJ |
483 | } |
484 | ||
485 | static int __klp_disable_patch(struct klp_patch *patch) | |
486 | { | |
487 | struct klp_object *obj; | |
b700e7f0 | 488 | |
83a90bb1 JP |
489 | /* enforce stacking: only the last enabled patch can be disabled */ |
490 | if (!list_is_last(&patch->list, &klp_patches) && | |
491 | list_next_entry(patch, list)->state == KLP_ENABLED) | |
492 | return -EBUSY; | |
493 | ||
b700e7f0 SJ |
494 | pr_notice("disabling patch '%s'\n", patch->mod->name); |
495 | ||
8cdd043a | 496 | klp_for_each_object(patch, obj) { |
0937e3b0 JP |
497 | if (obj->state == KLP_ENABLED) |
498 | klp_disable_object(obj); | |
b700e7f0 SJ |
499 | } |
500 | ||
501 | patch->state = KLP_DISABLED; | |
502 | ||
503 | return 0; | |
504 | } | |
505 | ||
506 | /** | |
507 | * klp_disable_patch() - disables a registered patch | |
508 | * @patch: The registered, enabled patch to be disabled | |
509 | * | |
510 | * Unregisters the patched functions from ftrace. | |
511 | * | |
512 | * Return: 0 on success, otherwise error | |
513 | */ | |
514 | int klp_disable_patch(struct klp_patch *patch) | |
515 | { | |
516 | int ret; | |
517 | ||
518 | mutex_lock(&klp_mutex); | |
519 | ||
520 | if (!klp_is_patch_registered(patch)) { | |
521 | ret = -EINVAL; | |
522 | goto err; | |
523 | } | |
524 | ||
525 | if (patch->state == KLP_DISABLED) { | |
526 | ret = -EINVAL; | |
527 | goto err; | |
528 | } | |
529 | ||
530 | ret = __klp_disable_patch(patch); | |
531 | ||
532 | err: | |
533 | mutex_unlock(&klp_mutex); | |
534 | return ret; | |
535 | } | |
536 | EXPORT_SYMBOL_GPL(klp_disable_patch); | |
537 | ||
538 | static int __klp_enable_patch(struct klp_patch *patch) | |
539 | { | |
540 | struct klp_object *obj; | |
541 | int ret; | |
542 | ||
543 | if (WARN_ON(patch->state != KLP_DISABLED)) | |
544 | return -EINVAL; | |
545 | ||
83a90bb1 JP |
546 | /* enforce stacking: only the first disabled patch can be enabled */ |
547 | if (patch->list.prev != &klp_patches && | |
548 | list_prev_entry(patch, list)->state == KLP_DISABLED) | |
549 | return -EBUSY; | |
550 | ||
b700e7f0 SJ |
551 | pr_notice("enabling patch '%s'\n", patch->mod->name); |
552 | ||
8cdd043a | 553 | klp_for_each_object(patch, obj) { |
b700e7f0 SJ |
554 | if (!klp_is_object_loaded(obj)) |
555 | continue; | |
556 | ||
557 | ret = klp_enable_object(obj); | |
558 | if (ret) | |
559 | goto unregister; | |
560 | } | |
561 | ||
562 | patch->state = KLP_ENABLED; | |
563 | ||
564 | return 0; | |
565 | ||
566 | unregister: | |
567 | WARN_ON(__klp_disable_patch(patch)); | |
568 | return ret; | |
569 | } | |
570 | ||
571 | /** | |
572 | * klp_enable_patch() - enables a registered patch | |
573 | * @patch: The registered, disabled patch to be enabled | |
574 | * | |
575 | * Performs the needed symbol lookups and code relocations, | |
576 | * then registers the patched functions with ftrace. | |
577 | * | |
578 | * Return: 0 on success, otherwise error | |
579 | */ | |
580 | int klp_enable_patch(struct klp_patch *patch) | |
581 | { | |
582 | int ret; | |
583 | ||
584 | mutex_lock(&klp_mutex); | |
585 | ||
586 | if (!klp_is_patch_registered(patch)) { | |
587 | ret = -EINVAL; | |
588 | goto err; | |
589 | } | |
590 | ||
591 | ret = __klp_enable_patch(patch); | |
592 | ||
593 | err: | |
594 | mutex_unlock(&klp_mutex); | |
595 | return ret; | |
596 | } | |
597 | EXPORT_SYMBOL_GPL(klp_enable_patch); | |
598 | ||
599 | /* | |
600 | * Sysfs Interface | |
601 | * | |
602 | * /sys/kernel/livepatch | |
603 | * /sys/kernel/livepatch/<patch> | |
604 | * /sys/kernel/livepatch/<patch>/enabled | |
605 | * /sys/kernel/livepatch/<patch>/<object> | |
444f9e99 | 606 | * /sys/kernel/livepatch/<patch>/<object>/<function,sympos> |
b700e7f0 SJ |
607 | */ |
608 | ||
609 | static ssize_t enabled_store(struct kobject *kobj, struct kobj_attribute *attr, | |
610 | const char *buf, size_t count) | |
611 | { | |
612 | struct klp_patch *patch; | |
613 | int ret; | |
614 | unsigned long val; | |
615 | ||
616 | ret = kstrtoul(buf, 10, &val); | |
617 | if (ret) | |
618 | return -EINVAL; | |
619 | ||
620 | if (val != KLP_DISABLED && val != KLP_ENABLED) | |
621 | return -EINVAL; | |
622 | ||
623 | patch = container_of(kobj, struct klp_patch, kobj); | |
624 | ||
625 | mutex_lock(&klp_mutex); | |
626 | ||
627 | if (val == patch->state) { | |
628 | /* already in requested state */ | |
629 | ret = -EINVAL; | |
630 | goto err; | |
631 | } | |
632 | ||
633 | if (val == KLP_ENABLED) { | |
634 | ret = __klp_enable_patch(patch); | |
635 | if (ret) | |
636 | goto err; | |
637 | } else { | |
638 | ret = __klp_disable_patch(patch); | |
639 | if (ret) | |
640 | goto err; | |
641 | } | |
642 | ||
643 | mutex_unlock(&klp_mutex); | |
644 | ||
645 | return count; | |
646 | ||
647 | err: | |
648 | mutex_unlock(&klp_mutex); | |
649 | return ret; | |
650 | } | |
651 | ||
652 | static ssize_t enabled_show(struct kobject *kobj, | |
653 | struct kobj_attribute *attr, char *buf) | |
654 | { | |
655 | struct klp_patch *patch; | |
656 | ||
657 | patch = container_of(kobj, struct klp_patch, kobj); | |
658 | return snprintf(buf, PAGE_SIZE-1, "%d\n", patch->state); | |
659 | } | |
660 | ||
661 | static struct kobj_attribute enabled_kobj_attr = __ATTR_RW(enabled); | |
662 | static struct attribute *klp_patch_attrs[] = { | |
663 | &enabled_kobj_attr.attr, | |
664 | NULL | |
665 | }; | |
666 | ||
667 | static void klp_kobj_release_patch(struct kobject *kobj) | |
668 | { | |
669 | /* | |
670 | * Once we have a consistency model we'll need to module_put() the | |
671 | * patch module here. See klp_register_patch() for more details. | |
672 | */ | |
673 | } | |
674 | ||
675 | static struct kobj_type klp_ktype_patch = { | |
676 | .release = klp_kobj_release_patch, | |
677 | .sysfs_ops = &kobj_sysfs_ops, | |
678 | .default_attrs = klp_patch_attrs, | |
679 | }; | |
680 | ||
cad706df MB |
681 | static void klp_kobj_release_object(struct kobject *kobj) |
682 | { | |
683 | } | |
684 | ||
685 | static struct kobj_type klp_ktype_object = { | |
686 | .release = klp_kobj_release_object, | |
687 | .sysfs_ops = &kobj_sysfs_ops, | |
688 | }; | |
689 | ||
b700e7f0 SJ |
690 | static void klp_kobj_release_func(struct kobject *kobj) |
691 | { | |
b700e7f0 SJ |
692 | } |
693 | ||
694 | static struct kobj_type klp_ktype_func = { | |
695 | .release = klp_kobj_release_func, | |
696 | .sysfs_ops = &kobj_sysfs_ops, | |
697 | }; | |
698 | ||
699 | /* | |
700 | * Free all functions' kobjects in the array up to some limit. When limit is | |
701 | * NULL, all kobjects are freed. | |
702 | */ | |
703 | static void klp_free_funcs_limited(struct klp_object *obj, | |
704 | struct klp_func *limit) | |
705 | { | |
706 | struct klp_func *func; | |
707 | ||
708 | for (func = obj->funcs; func->old_name && func != limit; func++) | |
709 | kobject_put(&func->kobj); | |
710 | } | |
711 | ||
712 | /* Clean up when a patched object is unloaded */ | |
713 | static void klp_free_object_loaded(struct klp_object *obj) | |
714 | { | |
715 | struct klp_func *func; | |
716 | ||
717 | obj->mod = NULL; | |
718 | ||
8cdd043a | 719 | klp_for_each_func(obj, func) |
b700e7f0 SJ |
720 | func->old_addr = 0; |
721 | } | |
722 | ||
723 | /* | |
724 | * Free all objects' kobjects in the array up to some limit. When limit is | |
725 | * NULL, all kobjects are freed. | |
726 | */ | |
727 | static void klp_free_objects_limited(struct klp_patch *patch, | |
728 | struct klp_object *limit) | |
729 | { | |
730 | struct klp_object *obj; | |
731 | ||
732 | for (obj = patch->objs; obj->funcs && obj != limit; obj++) { | |
733 | klp_free_funcs_limited(obj, NULL); | |
cad706df | 734 | kobject_put(&obj->kobj); |
b700e7f0 SJ |
735 | } |
736 | } | |
737 | ||
738 | static void klp_free_patch(struct klp_patch *patch) | |
739 | { | |
740 | klp_free_objects_limited(patch, NULL); | |
741 | if (!list_empty(&patch->list)) | |
742 | list_del(&patch->list); | |
743 | kobject_put(&patch->kobj); | |
744 | } | |
745 | ||
746 | static int klp_init_func(struct klp_object *obj, struct klp_func *func) | |
747 | { | |
f09d9086 MB |
748 | if (!func->old_name || !func->new_func) |
749 | return -EINVAL; | |
750 | ||
3c33f5b9 | 751 | INIT_LIST_HEAD(&func->stack_node); |
b700e7f0 SJ |
752 | func->state = KLP_DISABLED; |
753 | ||
444f9e99 CA |
754 | /* The format for the sysfs directory is <function,sympos> where sympos |
755 | * is the nth occurrence of this symbol in kallsyms for the patched | |
756 | * object. If the user selects 0 for old_sympos, then 1 will be used | |
757 | * since a unique symbol will be the first occurrence. | |
758 | */ | |
3c33f5b9 | 759 | return kobject_init_and_add(&func->kobj, &klp_ktype_func, |
444f9e99 CA |
760 | &obj->kobj, "%s,%lu", func->old_name, |
761 | func->old_sympos ? func->old_sympos : 1); | |
b700e7f0 SJ |
762 | } |
763 | ||
255e732c JY |
764 | /* Arches may override this to finish any remaining arch-specific tasks */ |
765 | void __weak arch_klp_init_object_loaded(struct klp_patch *patch, | |
766 | struct klp_object *obj) | |
767 | { | |
768 | } | |
769 | ||
b700e7f0 SJ |
770 | /* parts of the initialization that is done only when the object is loaded */ |
771 | static int klp_init_object_loaded(struct klp_patch *patch, | |
772 | struct klp_object *obj) | |
773 | { | |
774 | struct klp_func *func; | |
775 | int ret; | |
776 | ||
255e732c | 777 | module_disable_ro(patch->mod); |
425595a7 | 778 | ret = klp_write_object_relocations(patch->mod, obj); |
255e732c JY |
779 | if (ret) { |
780 | module_enable_ro(patch->mod, true); | |
425595a7 | 781 | return ret; |
255e732c JY |
782 | } |
783 | ||
784 | arch_klp_init_object_loaded(patch, obj); | |
785 | module_enable_ro(patch->mod, true); | |
b700e7f0 | 786 | |
8cdd043a | 787 | klp_for_each_func(obj, func) { |
b2b018ef CA |
788 | ret = klp_find_object_symbol(obj->name, func->old_name, |
789 | func->old_sympos, | |
790 | &func->old_addr); | |
b700e7f0 SJ |
791 | if (ret) |
792 | return ret; | |
793 | } | |
794 | ||
795 | return 0; | |
796 | } | |
797 | ||
798 | static int klp_init_object(struct klp_patch *patch, struct klp_object *obj) | |
799 | { | |
800 | struct klp_func *func; | |
801 | int ret; | |
802 | const char *name; | |
803 | ||
804 | if (!obj->funcs) | |
805 | return -EINVAL; | |
806 | ||
807 | obj->state = KLP_DISABLED; | |
8cb2c2dc | 808 | obj->mod = NULL; |
b700e7f0 SJ |
809 | |
810 | klp_find_object_module(obj); | |
811 | ||
812 | name = klp_is_module(obj) ? obj->name : "vmlinux"; | |
cad706df MB |
813 | ret = kobject_init_and_add(&obj->kobj, &klp_ktype_object, |
814 | &patch->kobj, "%s", name); | |
815 | if (ret) | |
816 | return ret; | |
b700e7f0 | 817 | |
8cdd043a | 818 | klp_for_each_func(obj, func) { |
b700e7f0 SJ |
819 | ret = klp_init_func(obj, func); |
820 | if (ret) | |
821 | goto free; | |
822 | } | |
823 | ||
824 | if (klp_is_object_loaded(obj)) { | |
825 | ret = klp_init_object_loaded(patch, obj); | |
826 | if (ret) | |
827 | goto free; | |
828 | } | |
829 | ||
830 | return 0; | |
831 | ||
832 | free: | |
833 | klp_free_funcs_limited(obj, func); | |
cad706df | 834 | kobject_put(&obj->kobj); |
b700e7f0 SJ |
835 | return ret; |
836 | } | |
837 | ||
838 | static int klp_init_patch(struct klp_patch *patch) | |
839 | { | |
840 | struct klp_object *obj; | |
841 | int ret; | |
842 | ||
843 | if (!patch->objs) | |
844 | return -EINVAL; | |
845 | ||
846 | mutex_lock(&klp_mutex); | |
847 | ||
848 | patch->state = KLP_DISABLED; | |
849 | ||
850 | ret = kobject_init_and_add(&patch->kobj, &klp_ktype_patch, | |
e0b561ee | 851 | klp_root_kobj, "%s", patch->mod->name); |
b700e7f0 SJ |
852 | if (ret) |
853 | goto unlock; | |
854 | ||
8cdd043a | 855 | klp_for_each_object(patch, obj) { |
b700e7f0 SJ |
856 | ret = klp_init_object(patch, obj); |
857 | if (ret) | |
858 | goto free; | |
859 | } | |
860 | ||
99590ba5 | 861 | list_add_tail(&patch->list, &klp_patches); |
b700e7f0 SJ |
862 | |
863 | mutex_unlock(&klp_mutex); | |
864 | ||
865 | return 0; | |
866 | ||
867 | free: | |
868 | klp_free_objects_limited(patch, obj); | |
869 | kobject_put(&patch->kobj); | |
870 | unlock: | |
871 | mutex_unlock(&klp_mutex); | |
872 | return ret; | |
873 | } | |
874 | ||
875 | /** | |
876 | * klp_unregister_patch() - unregisters a patch | |
877 | * @patch: Disabled patch to be unregistered | |
878 | * | |
879 | * Frees the data structures and removes the sysfs interface. | |
880 | * | |
881 | * Return: 0 on success, otherwise error | |
882 | */ | |
883 | int klp_unregister_patch(struct klp_patch *patch) | |
884 | { | |
885 | int ret = 0; | |
886 | ||
887 | mutex_lock(&klp_mutex); | |
888 | ||
889 | if (!klp_is_patch_registered(patch)) { | |
890 | ret = -EINVAL; | |
891 | goto out; | |
892 | } | |
893 | ||
894 | if (patch->state == KLP_ENABLED) { | |
895 | ret = -EBUSY; | |
896 | goto out; | |
897 | } | |
898 | ||
899 | klp_free_patch(patch); | |
900 | ||
901 | out: | |
902 | mutex_unlock(&klp_mutex); | |
903 | return ret; | |
904 | } | |
905 | EXPORT_SYMBOL_GPL(klp_unregister_patch); | |
906 | ||
907 | /** | |
908 | * klp_register_patch() - registers a patch | |
909 | * @patch: Patch to be registered | |
910 | * | |
911 | * Initializes the data structure associated with the patch and | |
912 | * creates the sysfs interface. | |
913 | * | |
914 | * Return: 0 on success, otherwise error | |
915 | */ | |
916 | int klp_register_patch(struct klp_patch *patch) | |
917 | { | |
918 | int ret; | |
919 | ||
b700e7f0 SJ |
920 | if (!patch || !patch->mod) |
921 | return -EINVAL; | |
922 | ||
425595a7 JY |
923 | if (!is_livepatch_module(patch->mod)) { |
924 | pr_err("module %s is not marked as a livepatch module", | |
925 | patch->mod->name); | |
926 | return -EINVAL; | |
927 | } | |
928 | ||
b700e7f0 SJ |
929 | if (!klp_initialized()) |
930 | return -ENODEV; | |
931 | ||
b700e7f0 SJ |
932 | /* |
933 | * A reference is taken on the patch module to prevent it from being | |
934 | * unloaded. Right now, we don't allow patch modules to unload since | |
935 | * there is currently no method to determine if a thread is still | |
936 | * running in the patched code contained in the patch module once | |
937 | * the ftrace registration is successful. | |
938 | */ | |
939 | if (!try_module_get(patch->mod)) | |
940 | return -ENODEV; | |
941 | ||
942 | ret = klp_init_patch(patch); | |
943 | if (ret) | |
944 | module_put(patch->mod); | |
945 | ||
946 | return ret; | |
947 | } | |
948 | EXPORT_SYMBOL_GPL(klp_register_patch); | |
949 | ||
7e545d6e | 950 | int klp_module_coming(struct module *mod) |
b700e7f0 | 951 | { |
b700e7f0 | 952 | int ret; |
7e545d6e JY |
953 | struct klp_patch *patch; |
954 | struct klp_object *obj; | |
b700e7f0 | 955 | |
7e545d6e JY |
956 | if (WARN_ON(mod->state != MODULE_STATE_COMING)) |
957 | return -EINVAL; | |
b700e7f0 | 958 | |
7e545d6e JY |
959 | mutex_lock(&klp_mutex); |
960 | /* | |
961 | * Each module has to know that klp_module_coming() | |
962 | * has been called. We never know what module will | |
963 | * get patched by a new patch. | |
964 | */ | |
965 | mod->klp_alive = true; | |
b700e7f0 | 966 | |
7e545d6e JY |
967 | list_for_each_entry(patch, &klp_patches, list) { |
968 | klp_for_each_object(patch, obj) { | |
969 | if (!klp_is_module(obj) || strcmp(obj->name, mod->name)) | |
970 | continue; | |
b700e7f0 | 971 | |
7e545d6e | 972 | obj->mod = mod; |
b700e7f0 | 973 | |
7e545d6e JY |
974 | ret = klp_init_object_loaded(patch, obj); |
975 | if (ret) { | |
976 | pr_warn("failed to initialize patch '%s' for module '%s' (%d)\n", | |
977 | patch->mod->name, obj->mod->name, ret); | |
978 | goto err; | |
979 | } | |
b700e7f0 | 980 | |
7e545d6e JY |
981 | if (patch->state == KLP_DISABLED) |
982 | break; | |
983 | ||
984 | pr_notice("applying patch '%s' to loading module '%s'\n", | |
985 | patch->mod->name, obj->mod->name); | |
986 | ||
987 | ret = klp_enable_object(obj); | |
988 | if (ret) { | |
989 | pr_warn("failed to apply patch '%s' to module '%s' (%d)\n", | |
990 | patch->mod->name, obj->mod->name, ret); | |
991 | goto err; | |
992 | } | |
993 | ||
994 | break; | |
995 | } | |
996 | } | |
b700e7f0 | 997 | |
7e545d6e | 998 | mutex_unlock(&klp_mutex); |
b700e7f0 | 999 | |
7e545d6e | 1000 | return 0; |
b700e7f0 | 1001 | |
7e545d6e JY |
1002 | err: |
1003 | /* | |
1004 | * If a patch is unsuccessfully applied, return | |
1005 | * error to the module loader. | |
1006 | */ | |
1007 | pr_warn("patch '%s' failed for module '%s', refusing to load module '%s'\n", | |
1008 | patch->mod->name, obj->mod->name, obj->mod->name); | |
1009 | mod->klp_alive = false; | |
b700e7f0 | 1010 | klp_free_object_loaded(obj); |
7e545d6e JY |
1011 | mutex_unlock(&klp_mutex); |
1012 | ||
1013 | return ret; | |
b700e7f0 SJ |
1014 | } |
1015 | ||
7e545d6e | 1016 | void klp_module_going(struct module *mod) |
b700e7f0 | 1017 | { |
b700e7f0 SJ |
1018 | struct klp_patch *patch; |
1019 | struct klp_object *obj; | |
1020 | ||
7e545d6e JY |
1021 | if (WARN_ON(mod->state != MODULE_STATE_GOING && |
1022 | mod->state != MODULE_STATE_COMING)) | |
1023 | return; | |
b700e7f0 SJ |
1024 | |
1025 | mutex_lock(&klp_mutex); | |
8cb2c2dc | 1026 | /* |
7e545d6e JY |
1027 | * Each module has to know that klp_module_going() |
1028 | * has been called. We never know what module will | |
1029 | * get patched by a new patch. | |
8cb2c2dc | 1030 | */ |
7e545d6e | 1031 | mod->klp_alive = false; |
8cb2c2dc | 1032 | |
b700e7f0 | 1033 | list_for_each_entry(patch, &klp_patches, list) { |
8cdd043a | 1034 | klp_for_each_object(patch, obj) { |
b700e7f0 SJ |
1035 | if (!klp_is_module(obj) || strcmp(obj->name, mod->name)) |
1036 | continue; | |
1037 | ||
7e545d6e JY |
1038 | if (patch->state != KLP_DISABLED) { |
1039 | pr_notice("reverting patch '%s' on unloading module '%s'\n", | |
1040 | patch->mod->name, obj->mod->name); | |
1041 | klp_disable_object(obj); | |
1042 | } | |
b700e7f0 | 1043 | |
7e545d6e | 1044 | klp_free_object_loaded(obj); |
b700e7f0 SJ |
1045 | break; |
1046 | } | |
1047 | } | |
1048 | ||
1049 | mutex_unlock(&klp_mutex); | |
b700e7f0 SJ |
1050 | } |
1051 | ||
26029d88 | 1052 | static int __init klp_init(void) |
b700e7f0 SJ |
1053 | { |
1054 | int ret; | |
1055 | ||
b9dfe0be JK |
1056 | ret = klp_check_compiler_support(); |
1057 | if (ret) { | |
1058 | pr_info("Your compiler is too old; turning off.\n"); | |
1059 | return -EINVAL; | |
1060 | } | |
1061 | ||
b700e7f0 | 1062 | klp_root_kobj = kobject_create_and_add("livepatch", kernel_kobj); |
7e545d6e JY |
1063 | if (!klp_root_kobj) |
1064 | return -ENOMEM; | |
b700e7f0 SJ |
1065 | |
1066 | return 0; | |
b700e7f0 SJ |
1067 | } |
1068 | ||
1069 | module_init(klp_init); |