2 * core.c - Kernel Live Patching Core
4 * Copyright (C) 2014 Seth Jennings <sjenning@redhat.com>
5 * Copyright (C) 2014 SUSE
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.
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.
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/>.
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23 #include <linux/module.h>
24 #include <linux/kernel.h>
25 #include <linux/mutex.h>
26 #include <linux/slab.h>
27 #include <linux/list.h>
28 #include <linux/kallsyms.h>
29 #include <linux/livepatch.h>
30 #include <linux/elf.h>
31 #include <linux/moduleloader.h>
32 #include <linux/completion.h>
33 #include <asm/cacheflush.h>
36 #include "transition.h"
39 * klp_mutex is a coarse lock which serializes access to klp data. All
40 * accesses to klp-related variables and structures must have mutex protection,
41 * except within the following functions which carefully avoid the need for it:
43 * - klp_ftrace_handler()
44 * - klp_update_patch_state()
46 DEFINE_MUTEX(klp_mutex
);
48 static LIST_HEAD(klp_patches
);
50 static struct kobject
*klp_root_kobj
;
52 static bool klp_is_module(struct klp_object
*obj
)
57 static bool klp_is_object_loaded(struct klp_object
*obj
)
59 return !obj
->name
|| obj
->mod
;
62 /* sets obj->mod if object is not vmlinux and module is found */
63 static void klp_find_object_module(struct klp_object
*obj
)
67 if (!klp_is_module(obj
))
70 mutex_lock(&module_mutex
);
72 * We do not want to block removal of patched modules and therefore
73 * we do not take a reference here. The patches are removed by
74 * klp_module_going() instead.
76 mod
= find_module(obj
->name
);
78 * Do not mess work of klp_module_coming() and klp_module_going().
79 * Note that the patch might still be needed before klp_module_going()
80 * is called. Module functions can be called even in the GOING state
81 * until mod->exit() finishes. This is especially important for
82 * patches that modify semantic of the functions.
84 if (mod
&& mod
->klp_alive
)
87 mutex_unlock(&module_mutex
);
90 static bool klp_is_patch_registered(struct klp_patch
*patch
)
92 struct klp_patch
*mypatch
;
94 list_for_each_entry(mypatch
, &klp_patches
, list
)
101 static bool klp_initialized(void)
103 return !!klp_root_kobj
;
106 struct klp_find_arg
{
114 static int klp_find_callback(void *data
, const char *name
,
115 struct module
*mod
, unsigned long addr
)
117 struct klp_find_arg
*args
= data
;
119 if ((mod
&& !args
->objname
) || (!mod
&& args
->objname
))
122 if (strcmp(args
->name
, name
))
125 if (args
->objname
&& strcmp(args
->objname
, mod
->name
))
132 * Finish the search when the symbol is found for the desired position
133 * or the position is not defined for a non-unique symbol.
135 if ((args
->pos
&& (args
->count
== args
->pos
)) ||
136 (!args
->pos
&& (args
->count
> 1)))
142 static int klp_find_object_symbol(const char *objname
, const char *name
,
143 unsigned long sympos
, unsigned long *addr
)
145 struct klp_find_arg args
= {
153 mutex_lock(&module_mutex
);
155 module_kallsyms_on_each_symbol(klp_find_callback
, &args
);
157 kallsyms_on_each_symbol(klp_find_callback
, &args
);
158 mutex_unlock(&module_mutex
);
161 * Ensure an address was found. If sympos is 0, ensure symbol is unique;
162 * otherwise ensure the symbol position count matches sympos.
165 pr_err("symbol '%s' not found in symbol table\n", name
);
166 else if (args
.count
> 1 && sympos
== 0) {
167 pr_err("unresolvable ambiguity for symbol '%s' in object '%s'\n",
169 } else if (sympos
!= args
.count
&& sympos
> 0) {
170 pr_err("symbol position %lu for symbol '%s' in object '%s' not found\n",
171 sympos
, name
, objname
? objname
: "vmlinux");
181 static int klp_resolve_symbols(Elf_Shdr
*relasec
, struct module
*pmod
)
183 int i
, cnt
, vmlinux
, ret
;
184 char objname
[MODULE_NAME_LEN
];
185 char symname
[KSYM_NAME_LEN
];
186 char *strtab
= pmod
->core_kallsyms
.strtab
;
189 unsigned long sympos
, addr
;
192 * Since the field widths for objname and symname in the sscanf()
193 * call are hard-coded and correspond to MODULE_NAME_LEN and
194 * KSYM_NAME_LEN respectively, we must make sure that MODULE_NAME_LEN
195 * and KSYM_NAME_LEN have the values we expect them to have.
197 * Because the value of MODULE_NAME_LEN can differ among architectures,
198 * we use the smallest/strictest upper bound possible (56, based on
199 * the current definition of MODULE_NAME_LEN) to prevent overflows.
201 BUILD_BUG_ON(MODULE_NAME_LEN
< 56 || KSYM_NAME_LEN
!= 128);
203 relas
= (Elf_Rela
*) relasec
->sh_addr
;
204 /* For each rela in this klp relocation section */
205 for (i
= 0; i
< relasec
->sh_size
/ sizeof(Elf_Rela
); i
++) {
206 sym
= pmod
->core_kallsyms
.symtab
+ ELF_R_SYM(relas
[i
].r_info
);
207 if (sym
->st_shndx
!= SHN_LIVEPATCH
) {
208 pr_err("symbol %s is not marked as a livepatch symbol\n",
209 strtab
+ sym
->st_name
);
213 /* Format: .klp.sym.objname.symname,sympos */
214 cnt
= sscanf(strtab
+ sym
->st_name
,
215 ".klp.sym.%55[^.].%127[^,],%lu",
216 objname
, symname
, &sympos
);
218 pr_err("symbol %s has an incorrectly formatted name\n",
219 strtab
+ sym
->st_name
);
223 /* klp_find_object_symbol() treats a NULL objname as vmlinux */
224 vmlinux
= !strcmp(objname
, "vmlinux");
225 ret
= klp_find_object_symbol(vmlinux
? NULL
: objname
,
226 symname
, sympos
, &addr
);
230 sym
->st_value
= addr
;
236 static int klp_write_object_relocations(struct module
*pmod
,
237 struct klp_object
*obj
)
240 const char *objname
, *secname
;
241 char sec_objname
[MODULE_NAME_LEN
];
244 if (WARN_ON(!klp_is_object_loaded(obj
)))
247 objname
= klp_is_module(obj
) ? obj
->name
: "vmlinux";
249 /* For each klp relocation section */
250 for (i
= 1; i
< pmod
->klp_info
->hdr
.e_shnum
; i
++) {
251 sec
= pmod
->klp_info
->sechdrs
+ i
;
252 secname
= pmod
->klp_info
->secstrings
+ sec
->sh_name
;
253 if (!(sec
->sh_flags
& SHF_RELA_LIVEPATCH
))
257 * Format: .klp.rela.sec_objname.section_name
258 * See comment in klp_resolve_symbols() for an explanation
259 * of the selected field width value.
261 cnt
= sscanf(secname
, ".klp.rela.%55[^.]", sec_objname
);
263 pr_err("section %s has an incorrectly formatted name\n",
269 if (strcmp(objname
, sec_objname
))
272 ret
= klp_resolve_symbols(sec
, pmod
);
276 ret
= apply_relocate_add(pmod
->klp_info
->sechdrs
,
277 pmod
->core_kallsyms
.strtab
,
278 pmod
->klp_info
->symndx
, i
, pmod
);
286 static int __klp_disable_patch(struct klp_patch
*patch
)
288 if (klp_transition_patch
)
291 /* enforce stacking: only the last enabled patch can be disabled */
292 if (!list_is_last(&patch
->list
, &klp_patches
) &&
293 list_next_entry(patch
, list
)->enabled
)
296 klp_init_transition(patch
, KLP_UNPATCHED
);
299 * Enforce the order of the func->transition writes in
300 * klp_init_transition() and the TIF_PATCH_PENDING writes in
301 * klp_start_transition(). In the rare case where klp_ftrace_handler()
302 * is called shortly after klp_update_patch_state() switches the task,
303 * this ensures the handler sees that func->transition is set.
307 klp_start_transition();
308 klp_try_complete_transition();
309 patch
->enabled
= false;
315 * klp_disable_patch() - disables a registered patch
316 * @patch: The registered, enabled patch to be disabled
318 * Unregisters the patched functions from ftrace.
320 * Return: 0 on success, otherwise error
322 int klp_disable_patch(struct klp_patch
*patch
)
326 mutex_lock(&klp_mutex
);
328 if (!klp_is_patch_registered(patch
)) {
333 if (!patch
->enabled
) {
338 ret
= __klp_disable_patch(patch
);
341 mutex_unlock(&klp_mutex
);
344 EXPORT_SYMBOL_GPL(klp_disable_patch
);
346 static int __klp_enable_patch(struct klp_patch
*patch
)
348 struct klp_object
*obj
;
351 if (klp_transition_patch
)
354 if (WARN_ON(patch
->enabled
))
357 /* enforce stacking: only the first disabled patch can be enabled */
358 if (patch
->list
.prev
!= &klp_patches
&&
359 !list_prev_entry(patch
, list
)->enabled
)
363 * A reference is taken on the patch module to prevent it from being
366 * Note: For immediate (no consistency model) patches we don't allow
367 * patch modules to unload since there is no safe/sane method to
368 * determine if a thread is still running in the patched code contained
369 * in the patch module once the ftrace registration is successful.
371 if (!try_module_get(patch
->mod
))
374 pr_notice("enabling patch '%s'\n", patch
->mod
->name
);
376 klp_init_transition(patch
, KLP_PATCHED
);
379 * Enforce the order of the func->transition writes in
380 * klp_init_transition() and the ops->func_stack writes in
381 * klp_patch_object(), so that klp_ftrace_handler() will see the
382 * func->transition updates before the handler is registered and the
383 * new funcs become visible to the handler.
387 klp_for_each_object(patch
, obj
) {
388 if (!klp_is_object_loaded(obj
))
391 ret
= klp_patch_object(obj
);
393 pr_warn("failed to enable patch '%s'\n",
396 klp_cancel_transition();
401 klp_start_transition();
402 klp_try_complete_transition();
403 patch
->enabled
= true;
409 * klp_enable_patch() - enables a registered patch
410 * @patch: The registered, disabled patch to be enabled
412 * Performs the needed symbol lookups and code relocations,
413 * then registers the patched functions with ftrace.
415 * Return: 0 on success, otherwise error
417 int klp_enable_patch(struct klp_patch
*patch
)
421 mutex_lock(&klp_mutex
);
423 if (!klp_is_patch_registered(patch
)) {
428 ret
= __klp_enable_patch(patch
);
431 mutex_unlock(&klp_mutex
);
434 EXPORT_SYMBOL_GPL(klp_enable_patch
);
439 * /sys/kernel/livepatch
440 * /sys/kernel/livepatch/<patch>
441 * /sys/kernel/livepatch/<patch>/enabled
442 * /sys/kernel/livepatch/<patch>/transition
443 * /sys/kernel/livepatch/<patch>/<object>
444 * /sys/kernel/livepatch/<patch>/<object>/<function,sympos>
447 static ssize_t
enabled_store(struct kobject
*kobj
, struct kobj_attribute
*attr
,
448 const char *buf
, size_t count
)
450 struct klp_patch
*patch
;
454 ret
= kstrtobool(buf
, &enabled
);
458 patch
= container_of(kobj
, struct klp_patch
, kobj
);
460 mutex_lock(&klp_mutex
);
462 if (!klp_is_patch_registered(patch
)) {
464 * Module with the patch could either disappear meanwhile or is
465 * not properly initialized yet.
471 if (patch
->enabled
== enabled
) {
472 /* already in requested state */
477 if (patch
== klp_transition_patch
) {
478 klp_reverse_transition();
479 } else if (enabled
) {
480 ret
= __klp_enable_patch(patch
);
484 ret
= __klp_disable_patch(patch
);
489 mutex_unlock(&klp_mutex
);
494 mutex_unlock(&klp_mutex
);
498 static ssize_t
enabled_show(struct kobject
*kobj
,
499 struct kobj_attribute
*attr
, char *buf
)
501 struct klp_patch
*patch
;
503 patch
= container_of(kobj
, struct klp_patch
, kobj
);
504 return snprintf(buf
, PAGE_SIZE
-1, "%d\n", patch
->enabled
);
507 static ssize_t
transition_show(struct kobject
*kobj
,
508 struct kobj_attribute
*attr
, char *buf
)
510 struct klp_patch
*patch
;
512 patch
= container_of(kobj
, struct klp_patch
, kobj
);
513 return snprintf(buf
, PAGE_SIZE
-1, "%d\n",
514 patch
== klp_transition_patch
);
517 static struct kobj_attribute enabled_kobj_attr
= __ATTR_RW(enabled
);
518 static struct kobj_attribute transition_kobj_attr
= __ATTR_RO(transition
);
519 static struct attribute
*klp_patch_attrs
[] = {
520 &enabled_kobj_attr
.attr
,
521 &transition_kobj_attr
.attr
,
525 static void klp_kobj_release_patch(struct kobject
*kobj
)
527 struct klp_patch
*patch
;
529 patch
= container_of(kobj
, struct klp_patch
, kobj
);
530 complete(&patch
->finish
);
533 static struct kobj_type klp_ktype_patch
= {
534 .release
= klp_kobj_release_patch
,
535 .sysfs_ops
= &kobj_sysfs_ops
,
536 .default_attrs
= klp_patch_attrs
,
539 static void klp_kobj_release_object(struct kobject
*kobj
)
543 static struct kobj_type klp_ktype_object
= {
544 .release
= klp_kobj_release_object
,
545 .sysfs_ops
= &kobj_sysfs_ops
,
548 static void klp_kobj_release_func(struct kobject
*kobj
)
552 static struct kobj_type klp_ktype_func
= {
553 .release
= klp_kobj_release_func
,
554 .sysfs_ops
= &kobj_sysfs_ops
,
558 * Free all functions' kobjects in the array up to some limit. When limit is
559 * NULL, all kobjects are freed.
561 static void klp_free_funcs_limited(struct klp_object
*obj
,
562 struct klp_func
*limit
)
564 struct klp_func
*func
;
566 for (func
= obj
->funcs
; func
->old_name
&& func
!= limit
; func
++)
567 kobject_put(&func
->kobj
);
570 /* Clean up when a patched object is unloaded */
571 static void klp_free_object_loaded(struct klp_object
*obj
)
573 struct klp_func
*func
;
577 klp_for_each_func(obj
, func
)
582 * Free all objects' kobjects in the array up to some limit. When limit is
583 * NULL, all kobjects are freed.
585 static void klp_free_objects_limited(struct klp_patch
*patch
,
586 struct klp_object
*limit
)
588 struct klp_object
*obj
;
590 for (obj
= patch
->objs
; obj
->funcs
&& obj
!= limit
; obj
++) {
591 klp_free_funcs_limited(obj
, NULL
);
592 kobject_put(&obj
->kobj
);
596 static void klp_free_patch(struct klp_patch
*patch
)
598 klp_free_objects_limited(patch
, NULL
);
599 if (!list_empty(&patch
->list
))
600 list_del(&patch
->list
);
603 static int klp_init_func(struct klp_object
*obj
, struct klp_func
*func
)
605 if (!func
->old_name
|| !func
->new_func
)
608 INIT_LIST_HEAD(&func
->stack_node
);
609 func
->patched
= false;
610 func
->transition
= false;
612 /* The format for the sysfs directory is <function,sympos> where sympos
613 * is the nth occurrence of this symbol in kallsyms for the patched
614 * object. If the user selects 0 for old_sympos, then 1 will be used
615 * since a unique symbol will be the first occurrence.
617 return kobject_init_and_add(&func
->kobj
, &klp_ktype_func
,
618 &obj
->kobj
, "%s,%lu", func
->old_name
,
619 func
->old_sympos
? func
->old_sympos
: 1);
622 /* Arches may override this to finish any remaining arch-specific tasks */
623 void __weak
arch_klp_init_object_loaded(struct klp_patch
*patch
,
624 struct klp_object
*obj
)
628 /* parts of the initialization that is done only when the object is loaded */
629 static int klp_init_object_loaded(struct klp_patch
*patch
,
630 struct klp_object
*obj
)
632 struct klp_func
*func
;
635 module_disable_ro(patch
->mod
);
636 ret
= klp_write_object_relocations(patch
->mod
, obj
);
638 module_enable_ro(patch
->mod
, true);
642 arch_klp_init_object_loaded(patch
, obj
);
643 module_enable_ro(patch
->mod
, true);
645 klp_for_each_func(obj
, func
) {
646 ret
= klp_find_object_symbol(obj
->name
, func
->old_name
,
652 ret
= kallsyms_lookup_size_offset(func
->old_addr
,
653 &func
->old_size
, NULL
);
655 pr_err("kallsyms size lookup failed for '%s'\n",
660 ret
= kallsyms_lookup_size_offset((unsigned long)func
->new_func
,
661 &func
->new_size
, NULL
);
663 pr_err("kallsyms size lookup failed for '%s' replacement\n",
672 static int klp_init_object(struct klp_patch
*patch
, struct klp_object
*obj
)
674 struct klp_func
*func
;
681 obj
->patched
= false;
684 klp_find_object_module(obj
);
686 name
= klp_is_module(obj
) ? obj
->name
: "vmlinux";
687 ret
= kobject_init_and_add(&obj
->kobj
, &klp_ktype_object
,
688 &patch
->kobj
, "%s", name
);
692 klp_for_each_func(obj
, func
) {
693 ret
= klp_init_func(obj
, func
);
698 if (klp_is_object_loaded(obj
)) {
699 ret
= klp_init_object_loaded(patch
, obj
);
707 klp_free_funcs_limited(obj
, func
);
708 kobject_put(&obj
->kobj
);
712 static int klp_init_patch(struct klp_patch
*patch
)
714 struct klp_object
*obj
;
720 mutex_lock(&klp_mutex
);
722 patch
->enabled
= false;
723 init_completion(&patch
->finish
);
725 ret
= kobject_init_and_add(&patch
->kobj
, &klp_ktype_patch
,
726 klp_root_kobj
, "%s", patch
->mod
->name
);
728 mutex_unlock(&klp_mutex
);
732 klp_for_each_object(patch
, obj
) {
733 ret
= klp_init_object(patch
, obj
);
738 list_add_tail(&patch
->list
, &klp_patches
);
740 mutex_unlock(&klp_mutex
);
745 klp_free_objects_limited(patch
, obj
);
747 mutex_unlock(&klp_mutex
);
749 kobject_put(&patch
->kobj
);
750 wait_for_completion(&patch
->finish
);
756 * klp_unregister_patch() - unregisters a patch
757 * @patch: Disabled patch to be unregistered
759 * Frees the data structures and removes the sysfs interface.
761 * Return: 0 on success, otherwise error
763 int klp_unregister_patch(struct klp_patch
*patch
)
767 mutex_lock(&klp_mutex
);
769 if (!klp_is_patch_registered(patch
)) {
774 if (patch
->enabled
) {
779 klp_free_patch(patch
);
781 mutex_unlock(&klp_mutex
);
783 kobject_put(&patch
->kobj
);
784 wait_for_completion(&patch
->finish
);
788 mutex_unlock(&klp_mutex
);
791 EXPORT_SYMBOL_GPL(klp_unregister_patch
);
794 * klp_register_patch() - registers a patch
795 * @patch: Patch to be registered
797 * Initializes the data structure associated with the patch and
798 * creates the sysfs interface.
800 * There is no need to take the reference on the patch module here. It is done
801 * later when the patch is enabled.
803 * Return: 0 on success, otherwise error
805 int klp_register_patch(struct klp_patch
*patch
)
807 if (!patch
|| !patch
->mod
)
810 if (!is_livepatch_module(patch
->mod
)) {
811 pr_err("module %s is not marked as a livepatch module\n",
816 if (!klp_initialized())
820 * Architectures without reliable stack traces have to set
821 * patch->immediate because there's currently no way to patch kthreads
822 * with the consistency model.
824 if (!klp_have_reliable_stack() && !patch
->immediate
) {
825 pr_err("This architecture doesn't have support for the livepatch consistency model.\n");
829 return klp_init_patch(patch
);
831 EXPORT_SYMBOL_GPL(klp_register_patch
);
834 * Remove parts of patches that touch a given kernel module. The list of
835 * patches processed might be limited. When limit is NULL, all patches
838 static void klp_cleanup_module_patches_limited(struct module
*mod
,
839 struct klp_patch
*limit
)
841 struct klp_patch
*patch
;
842 struct klp_object
*obj
;
844 list_for_each_entry(patch
, &klp_patches
, list
) {
848 klp_for_each_object(patch
, obj
) {
849 if (!klp_is_module(obj
) || strcmp(obj
->name
, mod
->name
))
853 * Only unpatch the module if the patch is enabled or
856 if (patch
->enabled
|| patch
== klp_transition_patch
) {
857 pr_notice("reverting patch '%s' on unloading module '%s'\n",
858 patch
->mod
->name
, obj
->mod
->name
);
859 klp_unpatch_object(obj
);
862 klp_free_object_loaded(obj
);
868 int klp_module_coming(struct module
*mod
)
871 struct klp_patch
*patch
;
872 struct klp_object
*obj
;
874 if (WARN_ON(mod
->state
!= MODULE_STATE_COMING
))
877 mutex_lock(&klp_mutex
);
879 * Each module has to know that klp_module_coming()
880 * has been called. We never know what module will
881 * get patched by a new patch.
883 mod
->klp_alive
= true;
885 list_for_each_entry(patch
, &klp_patches
, list
) {
886 klp_for_each_object(patch
, obj
) {
887 if (!klp_is_module(obj
) || strcmp(obj
->name
, mod
->name
))
892 ret
= klp_init_object_loaded(patch
, obj
);
894 pr_warn("failed to initialize patch '%s' for module '%s' (%d)\n",
895 patch
->mod
->name
, obj
->mod
->name
, ret
);
900 * Only patch the module if the patch is enabled or is
903 if (!patch
->enabled
&& patch
!= klp_transition_patch
)
906 pr_notice("applying patch '%s' to loading module '%s'\n",
907 patch
->mod
->name
, obj
->mod
->name
);
909 ret
= klp_patch_object(obj
);
911 pr_warn("failed to apply patch '%s' to module '%s' (%d)\n",
912 patch
->mod
->name
, obj
->mod
->name
, ret
);
920 mutex_unlock(&klp_mutex
);
926 * If a patch is unsuccessfully applied, return
927 * error to the module loader.
929 pr_warn("patch '%s' failed for module '%s', refusing to load module '%s'\n",
930 patch
->mod
->name
, obj
->mod
->name
, obj
->mod
->name
);
931 mod
->klp_alive
= false;
932 klp_cleanup_module_patches_limited(mod
, patch
);
933 mutex_unlock(&klp_mutex
);
938 void klp_module_going(struct module
*mod
)
940 if (WARN_ON(mod
->state
!= MODULE_STATE_GOING
&&
941 mod
->state
!= MODULE_STATE_COMING
))
944 mutex_lock(&klp_mutex
);
946 * Each module has to know that klp_module_going()
947 * has been called. We never know what module will
948 * get patched by a new patch.
950 mod
->klp_alive
= false;
952 klp_cleanup_module_patches_limited(mod
, NULL
);
954 mutex_unlock(&klp_mutex
);
957 static int __init
klp_init(void)
961 ret
= klp_check_compiler_support();
963 pr_info("Your compiler is too old; turning off.\n");
967 klp_root_kobj
= kobject_create_and_add("livepatch", kernel_kobj
);
974 module_init(klp_init
);