xref: /linux-6.15/kernel/livepatch/core.c (revision 5d4351ba)
1b700e7f0SSeth Jennings /*
2b700e7f0SSeth Jennings  * core.c - Kernel Live Patching Core
3b700e7f0SSeth Jennings  *
4b700e7f0SSeth Jennings  * Copyright (C) 2014 Seth Jennings <[email protected]>
5b700e7f0SSeth Jennings  * Copyright (C) 2014 SUSE
6b700e7f0SSeth Jennings  *
7b700e7f0SSeth Jennings  * This program is free software; you can redistribute it and/or
8b700e7f0SSeth Jennings  * modify it under the terms of the GNU General Public License
9b700e7f0SSeth Jennings  * as published by the Free Software Foundation; either version 2
10b700e7f0SSeth Jennings  * of the License, or (at your option) any later version.
11b700e7f0SSeth Jennings  *
12b700e7f0SSeth Jennings  * This program is distributed in the hope that it will be useful,
13b700e7f0SSeth Jennings  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14b700e7f0SSeth Jennings  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15b700e7f0SSeth Jennings  * GNU General Public License for more details.
16b700e7f0SSeth Jennings  *
17b700e7f0SSeth Jennings  * You should have received a copy of the GNU General Public License
18b700e7f0SSeth Jennings  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19b700e7f0SSeth Jennings  */
20b700e7f0SSeth Jennings 
21b700e7f0SSeth Jennings #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22b700e7f0SSeth Jennings 
23b700e7f0SSeth Jennings #include <linux/module.h>
24b700e7f0SSeth Jennings #include <linux/kernel.h>
25b700e7f0SSeth Jennings #include <linux/mutex.h>
26b700e7f0SSeth Jennings #include <linux/slab.h>
27b700e7f0SSeth Jennings #include <linux/ftrace.h>
28b700e7f0SSeth Jennings #include <linux/list.h>
29b700e7f0SSeth Jennings #include <linux/kallsyms.h>
30b700e7f0SSeth Jennings #include <linux/livepatch.h>
31b700e7f0SSeth Jennings 
323c33f5b9SJosh Poimboeuf /**
333c33f5b9SJosh Poimboeuf  * struct klp_ops - structure for tracking registered ftrace ops structs
343c33f5b9SJosh Poimboeuf  *
353c33f5b9SJosh Poimboeuf  * A single ftrace_ops is shared between all enabled replacement functions
363c33f5b9SJosh Poimboeuf  * (klp_func structs) which have the same old_addr.  This allows the switch
373c33f5b9SJosh Poimboeuf  * between function versions to happen instantaneously by updating the klp_ops
383c33f5b9SJosh Poimboeuf  * struct's func_stack list.  The winner is the klp_func at the top of the
393c33f5b9SJosh Poimboeuf  * func_stack (front of the list).
403c33f5b9SJosh Poimboeuf  *
413c33f5b9SJosh Poimboeuf  * @node:	node for the global klp_ops list
423c33f5b9SJosh Poimboeuf  * @func_stack:	list head for the stack of klp_func's (active func is on top)
433c33f5b9SJosh Poimboeuf  * @fops:	registered ftrace ops struct
44b700e7f0SSeth Jennings  */
453c33f5b9SJosh Poimboeuf struct klp_ops {
463c33f5b9SJosh Poimboeuf 	struct list_head node;
473c33f5b9SJosh Poimboeuf 	struct list_head func_stack;
483c33f5b9SJosh Poimboeuf 	struct ftrace_ops fops;
493c33f5b9SJosh Poimboeuf };
50b700e7f0SSeth Jennings 
513c33f5b9SJosh Poimboeuf /*
523c33f5b9SJosh Poimboeuf  * The klp_mutex protects the global lists and state transitions of any
533c33f5b9SJosh Poimboeuf  * structure reachable from them.  References to any structure must be obtained
543c33f5b9SJosh Poimboeuf  * under mutex protection (except in klp_ftrace_handler(), which uses RCU to
553c33f5b9SJosh Poimboeuf  * ensure it gets consistent data).
563c33f5b9SJosh Poimboeuf  */
57b700e7f0SSeth Jennings static DEFINE_MUTEX(klp_mutex);
583c33f5b9SJosh Poimboeuf 
59b700e7f0SSeth Jennings static LIST_HEAD(klp_patches);
603c33f5b9SJosh Poimboeuf static LIST_HEAD(klp_ops);
61b700e7f0SSeth Jennings 
62b700e7f0SSeth Jennings static struct kobject *klp_root_kobj;
63b700e7f0SSeth Jennings 
643c33f5b9SJosh Poimboeuf static struct klp_ops *klp_find_ops(unsigned long old_addr)
653c33f5b9SJosh Poimboeuf {
663c33f5b9SJosh Poimboeuf 	struct klp_ops *ops;
673c33f5b9SJosh Poimboeuf 	struct klp_func *func;
683c33f5b9SJosh Poimboeuf 
693c33f5b9SJosh Poimboeuf 	list_for_each_entry(ops, &klp_ops, node) {
703c33f5b9SJosh Poimboeuf 		func = list_first_entry(&ops->func_stack, struct klp_func,
713c33f5b9SJosh Poimboeuf 					stack_node);
723c33f5b9SJosh Poimboeuf 		if (func->old_addr == old_addr)
733c33f5b9SJosh Poimboeuf 			return ops;
743c33f5b9SJosh Poimboeuf 	}
753c33f5b9SJosh Poimboeuf 
763c33f5b9SJosh Poimboeuf 	return NULL;
773c33f5b9SJosh Poimboeuf }
783c33f5b9SJosh Poimboeuf 
79b700e7f0SSeth Jennings static bool klp_is_module(struct klp_object *obj)
80b700e7f0SSeth Jennings {
81b700e7f0SSeth Jennings 	return obj->name;
82b700e7f0SSeth Jennings }
83b700e7f0SSeth Jennings 
84b700e7f0SSeth Jennings static bool klp_is_object_loaded(struct klp_object *obj)
85b700e7f0SSeth Jennings {
86b700e7f0SSeth Jennings 	return !obj->name || obj->mod;
87b700e7f0SSeth Jennings }
88b700e7f0SSeth Jennings 
89b700e7f0SSeth Jennings /* sets obj->mod if object is not vmlinux and module is found */
90b700e7f0SSeth Jennings static void klp_find_object_module(struct klp_object *obj)
91b700e7f0SSeth Jennings {
928cb2c2dcSPetr Mladek 	struct module *mod;
938cb2c2dcSPetr Mladek 
94b700e7f0SSeth Jennings 	if (!klp_is_module(obj))
95b700e7f0SSeth Jennings 		return;
96b700e7f0SSeth Jennings 
97b700e7f0SSeth Jennings 	mutex_lock(&module_mutex);
98b700e7f0SSeth Jennings 	/*
998cb2c2dcSPetr Mladek 	 * We do not want to block removal of patched modules and therefore
1008cb2c2dcSPetr Mladek 	 * we do not take a reference here. The patches are removed by
1018cb2c2dcSPetr Mladek 	 * a going module handler instead.
102b700e7f0SSeth Jennings 	 */
1038cb2c2dcSPetr Mladek 	mod = find_module(obj->name);
1048cb2c2dcSPetr Mladek 	/*
1058cb2c2dcSPetr Mladek 	 * Do not mess work of the module coming and going notifiers.
1068cb2c2dcSPetr Mladek 	 * Note that the patch might still be needed before the going handler
1078cb2c2dcSPetr Mladek 	 * is called. Module functions can be called even in the GOING state
1088cb2c2dcSPetr Mladek 	 * until mod->exit() finishes. This is especially important for
1098cb2c2dcSPetr Mladek 	 * patches that modify semantic of the functions.
1108cb2c2dcSPetr Mladek 	 */
1118cb2c2dcSPetr Mladek 	if (mod && mod->klp_alive)
1128cb2c2dcSPetr Mladek 		obj->mod = mod;
1138cb2c2dcSPetr Mladek 
114b700e7f0SSeth Jennings 	mutex_unlock(&module_mutex);
115b700e7f0SSeth Jennings }
116b700e7f0SSeth Jennings 
117b700e7f0SSeth Jennings /* klp_mutex must be held by caller */
118b700e7f0SSeth Jennings static bool klp_is_patch_registered(struct klp_patch *patch)
119b700e7f0SSeth Jennings {
120b700e7f0SSeth Jennings 	struct klp_patch *mypatch;
121b700e7f0SSeth Jennings 
122b700e7f0SSeth Jennings 	list_for_each_entry(mypatch, &klp_patches, list)
123b700e7f0SSeth Jennings 		if (mypatch == patch)
124b700e7f0SSeth Jennings 			return true;
125b700e7f0SSeth Jennings 
126b700e7f0SSeth Jennings 	return false;
127b700e7f0SSeth Jennings }
128b700e7f0SSeth Jennings 
129b700e7f0SSeth Jennings static bool klp_initialized(void)
130b700e7f0SSeth Jennings {
131b700e7f0SSeth Jennings 	return klp_root_kobj;
132b700e7f0SSeth Jennings }
133b700e7f0SSeth Jennings 
134b700e7f0SSeth Jennings struct klp_find_arg {
135b700e7f0SSeth Jennings 	const char *objname;
136b700e7f0SSeth Jennings 	const char *name;
137b700e7f0SSeth Jennings 	unsigned long addr;
138b700e7f0SSeth Jennings 	/*
139b700e7f0SSeth Jennings 	 * If count == 0, the symbol was not found. If count == 1, a unique
140b700e7f0SSeth Jennings 	 * match was found and addr is set.  If count > 1, there is
141b700e7f0SSeth Jennings 	 * unresolvable ambiguity among "count" number of symbols with the same
142b700e7f0SSeth Jennings 	 * name in the same object.
143b700e7f0SSeth Jennings 	 */
144b700e7f0SSeth Jennings 	unsigned long count;
145b700e7f0SSeth Jennings };
146b700e7f0SSeth Jennings 
147b700e7f0SSeth Jennings static int klp_find_callback(void *data, const char *name,
148b700e7f0SSeth Jennings 			     struct module *mod, unsigned long addr)
149b700e7f0SSeth Jennings {
150b700e7f0SSeth Jennings 	struct klp_find_arg *args = data;
151b700e7f0SSeth Jennings 
152b700e7f0SSeth Jennings 	if ((mod && !args->objname) || (!mod && args->objname))
153b700e7f0SSeth Jennings 		return 0;
154b700e7f0SSeth Jennings 
155b700e7f0SSeth Jennings 	if (strcmp(args->name, name))
156b700e7f0SSeth Jennings 		return 0;
157b700e7f0SSeth Jennings 
158b700e7f0SSeth Jennings 	if (args->objname && strcmp(args->objname, mod->name))
159b700e7f0SSeth Jennings 		return 0;
160b700e7f0SSeth Jennings 
161b700e7f0SSeth Jennings 	/*
162b700e7f0SSeth Jennings 	 * args->addr might be overwritten if another match is found
163b700e7f0SSeth Jennings 	 * but klp_find_object_symbol() handles this and only returns the
164b700e7f0SSeth Jennings 	 * addr if count == 1.
165b700e7f0SSeth Jennings 	 */
166b700e7f0SSeth Jennings 	args->addr = addr;
167b700e7f0SSeth Jennings 	args->count++;
168b700e7f0SSeth Jennings 
169b700e7f0SSeth Jennings 	return 0;
170b700e7f0SSeth Jennings }
171b700e7f0SSeth Jennings 
172b700e7f0SSeth Jennings static int klp_find_object_symbol(const char *objname, const char *name,
173b700e7f0SSeth Jennings 				  unsigned long *addr)
174b700e7f0SSeth Jennings {
175b700e7f0SSeth Jennings 	struct klp_find_arg args = {
176b700e7f0SSeth Jennings 		.objname = objname,
177b700e7f0SSeth Jennings 		.name = name,
178b700e7f0SSeth Jennings 		.addr = 0,
179b700e7f0SSeth Jennings 		.count = 0
180b700e7f0SSeth Jennings 	};
181b700e7f0SSeth Jennings 
182b700e7f0SSeth Jennings 	kallsyms_on_each_symbol(klp_find_callback, &args);
183b700e7f0SSeth Jennings 
184b700e7f0SSeth Jennings 	if (args.count == 0)
185b700e7f0SSeth Jennings 		pr_err("symbol '%s' not found in symbol table\n", name);
186b700e7f0SSeth Jennings 	else if (args.count > 1)
187b700e7f0SSeth Jennings 		pr_err("unresolvable ambiguity (%lu matches) on symbol '%s' in object '%s'\n",
188b700e7f0SSeth Jennings 		       args.count, name, objname);
189b700e7f0SSeth Jennings 	else {
190b700e7f0SSeth Jennings 		*addr = args.addr;
191b700e7f0SSeth Jennings 		return 0;
192b700e7f0SSeth Jennings 	}
193b700e7f0SSeth Jennings 
194b700e7f0SSeth Jennings 	*addr = 0;
195b700e7f0SSeth Jennings 	return -EINVAL;
196b700e7f0SSeth Jennings }
197b700e7f0SSeth Jennings 
198b700e7f0SSeth Jennings struct klp_verify_args {
199b700e7f0SSeth Jennings 	const char *name;
200b700e7f0SSeth Jennings 	const unsigned long addr;
201b700e7f0SSeth Jennings };
202b700e7f0SSeth Jennings 
203b700e7f0SSeth Jennings static int klp_verify_callback(void *data, const char *name,
204b700e7f0SSeth Jennings 			       struct module *mod, unsigned long addr)
205b700e7f0SSeth Jennings {
206b700e7f0SSeth Jennings 	struct klp_verify_args *args = data;
207b700e7f0SSeth Jennings 
208b700e7f0SSeth Jennings 	if (!mod &&
209b700e7f0SSeth Jennings 	    !strcmp(args->name, name) &&
210b700e7f0SSeth Jennings 	    args->addr == addr)
211b700e7f0SSeth Jennings 		return 1;
212b700e7f0SSeth Jennings 
213b700e7f0SSeth Jennings 	return 0;
214b700e7f0SSeth Jennings }
215b700e7f0SSeth Jennings 
216b700e7f0SSeth Jennings static int klp_verify_vmlinux_symbol(const char *name, unsigned long addr)
217b700e7f0SSeth Jennings {
218b700e7f0SSeth Jennings 	struct klp_verify_args args = {
219b700e7f0SSeth Jennings 		.name = name,
220b700e7f0SSeth Jennings 		.addr = addr,
221b700e7f0SSeth Jennings 	};
222b700e7f0SSeth Jennings 
223b700e7f0SSeth Jennings 	if (kallsyms_on_each_symbol(klp_verify_callback, &args))
224b700e7f0SSeth Jennings 		return 0;
225b700e7f0SSeth Jennings 
226f638f4dcSJosh Poimboeuf 	pr_err("symbol '%s' not found at specified address 0x%016lx, kernel mismatch?\n",
227b700e7f0SSeth Jennings 		name, addr);
228b700e7f0SSeth Jennings 	return -EINVAL;
229b700e7f0SSeth Jennings }
230b700e7f0SSeth Jennings 
231b700e7f0SSeth Jennings static int klp_find_verify_func_addr(struct klp_object *obj,
232b700e7f0SSeth Jennings 				     struct klp_func *func)
233b700e7f0SSeth Jennings {
234b700e7f0SSeth Jennings 	int ret;
235b700e7f0SSeth Jennings 
236b700e7f0SSeth Jennings #if defined(CONFIG_RANDOMIZE_BASE)
237*5d4351baSJiri Kosina 	/* If KASLR has been enabled, adjust old_addr accordingly */
238*5d4351baSJiri Kosina 	if (kaslr_enabled() && func->old_addr)
239*5d4351baSJiri Kosina 		func->old_addr += kaslr_offset();
240b700e7f0SSeth Jennings #endif
241b700e7f0SSeth Jennings 
242b700e7f0SSeth Jennings 	if (!func->old_addr || klp_is_module(obj))
243b700e7f0SSeth Jennings 		ret = klp_find_object_symbol(obj->name, func->old_name,
244b700e7f0SSeth Jennings 					     &func->old_addr);
245b700e7f0SSeth Jennings 	else
246b700e7f0SSeth Jennings 		ret = klp_verify_vmlinux_symbol(func->old_name,
247b700e7f0SSeth Jennings 						func->old_addr);
248b700e7f0SSeth Jennings 
249b700e7f0SSeth Jennings 	return ret;
250b700e7f0SSeth Jennings }
251b700e7f0SSeth Jennings 
252b700e7f0SSeth Jennings /*
253b700e7f0SSeth Jennings  * external symbols are located outside the parent object (where the parent
254b700e7f0SSeth Jennings  * object is either vmlinux or the kmod being patched).
255b700e7f0SSeth Jennings  */
256b700e7f0SSeth Jennings static int klp_find_external_symbol(struct module *pmod, const char *name,
257b700e7f0SSeth Jennings 				    unsigned long *addr)
258b700e7f0SSeth Jennings {
259b700e7f0SSeth Jennings 	const struct kernel_symbol *sym;
260b700e7f0SSeth Jennings 
261b700e7f0SSeth Jennings 	/* first, check if it's an exported symbol */
262b700e7f0SSeth Jennings 	preempt_disable();
263b700e7f0SSeth Jennings 	sym = find_symbol(name, NULL, NULL, true, true);
264b700e7f0SSeth Jennings 	if (sym) {
265b700e7f0SSeth Jennings 		*addr = sym->value;
266c064a0deSPeter Zijlstra 		preempt_enable();
267b700e7f0SSeth Jennings 		return 0;
268b700e7f0SSeth Jennings 	}
269c064a0deSPeter Zijlstra 	preempt_enable();
270b700e7f0SSeth Jennings 
271b700e7f0SSeth Jennings 	/* otherwise check if it's in another .o within the patch module */
272b700e7f0SSeth Jennings 	return klp_find_object_symbol(pmod->name, name, addr);
273b700e7f0SSeth Jennings }
274b700e7f0SSeth Jennings 
275b700e7f0SSeth Jennings static int klp_write_object_relocations(struct module *pmod,
276b700e7f0SSeth Jennings 					struct klp_object *obj)
277b700e7f0SSeth Jennings {
278b700e7f0SSeth Jennings 	int ret;
279b700e7f0SSeth Jennings 	struct klp_reloc *reloc;
280b700e7f0SSeth Jennings 
281b700e7f0SSeth Jennings 	if (WARN_ON(!klp_is_object_loaded(obj)))
282b700e7f0SSeth Jennings 		return -EINVAL;
283b700e7f0SSeth Jennings 
284b700e7f0SSeth Jennings 	if (WARN_ON(!obj->relocs))
285b700e7f0SSeth Jennings 		return -EINVAL;
286b700e7f0SSeth Jennings 
287b700e7f0SSeth Jennings 	for (reloc = obj->relocs; reloc->name; reloc++) {
288b700e7f0SSeth Jennings 		if (!klp_is_module(obj)) {
289b700e7f0SSeth Jennings 			ret = klp_verify_vmlinux_symbol(reloc->name,
290b700e7f0SSeth Jennings 							reloc->val);
291b700e7f0SSeth Jennings 			if (ret)
292b700e7f0SSeth Jennings 				return ret;
293b700e7f0SSeth Jennings 		} else {
294b700e7f0SSeth Jennings 			/* module, reloc->val needs to be discovered */
295b700e7f0SSeth Jennings 			if (reloc->external)
296b700e7f0SSeth Jennings 				ret = klp_find_external_symbol(pmod,
297b700e7f0SSeth Jennings 							       reloc->name,
298b700e7f0SSeth Jennings 							       &reloc->val);
299b700e7f0SSeth Jennings 			else
300b700e7f0SSeth Jennings 				ret = klp_find_object_symbol(obj->mod->name,
301b700e7f0SSeth Jennings 							     reloc->name,
302b700e7f0SSeth Jennings 							     &reloc->val);
303b700e7f0SSeth Jennings 			if (ret)
304b700e7f0SSeth Jennings 				return ret;
305b700e7f0SSeth Jennings 		}
306b700e7f0SSeth Jennings 		ret = klp_write_module_reloc(pmod, reloc->type, reloc->loc,
307b700e7f0SSeth Jennings 					     reloc->val + reloc->addend);
308b700e7f0SSeth Jennings 		if (ret) {
309b700e7f0SSeth Jennings 			pr_err("relocation failed for symbol '%s' at 0x%016lx (%d)\n",
310b700e7f0SSeth Jennings 			       reloc->name, reloc->val, ret);
311b700e7f0SSeth Jennings 			return ret;
312b700e7f0SSeth Jennings 		}
313b700e7f0SSeth Jennings 	}
314b700e7f0SSeth Jennings 
315b700e7f0SSeth Jennings 	return 0;
316b700e7f0SSeth Jennings }
317b700e7f0SSeth Jennings 
318b700e7f0SSeth Jennings static void notrace klp_ftrace_handler(unsigned long ip,
319b700e7f0SSeth Jennings 				       unsigned long parent_ip,
3203c33f5b9SJosh Poimboeuf 				       struct ftrace_ops *fops,
321b700e7f0SSeth Jennings 				       struct pt_regs *regs)
322b700e7f0SSeth Jennings {
3233c33f5b9SJosh Poimboeuf 	struct klp_ops *ops;
3243c33f5b9SJosh Poimboeuf 	struct klp_func *func;
3253c33f5b9SJosh Poimboeuf 
3263c33f5b9SJosh Poimboeuf 	ops = container_of(fops, struct klp_ops, fops);
3273c33f5b9SJosh Poimboeuf 
3283c33f5b9SJosh Poimboeuf 	rcu_read_lock();
3293c33f5b9SJosh Poimboeuf 	func = list_first_or_null_rcu(&ops->func_stack, struct klp_func,
3303c33f5b9SJosh Poimboeuf 				      stack_node);
3313c33f5b9SJosh Poimboeuf 	if (WARN_ON_ONCE(!func))
332c4ce0da8SPetr Mladek 		goto unlock;
333b700e7f0SSeth Jennings 
334b5bfc517SLi Bin 	klp_arch_set_pc(regs, (unsigned long)func->new_func);
335c4ce0da8SPetr Mladek unlock:
336c4ce0da8SPetr Mladek 	rcu_read_unlock();
337b700e7f0SSeth Jennings }
338b700e7f0SSeth Jennings 
3390937e3b0SJosh Poimboeuf static void klp_disable_func(struct klp_func *func)
340b700e7f0SSeth Jennings {
3413c33f5b9SJosh Poimboeuf 	struct klp_ops *ops;
342b700e7f0SSeth Jennings 
3430937e3b0SJosh Poimboeuf 	WARN_ON(func->state != KLP_ENABLED);
3440937e3b0SJosh Poimboeuf 	WARN_ON(!func->old_addr);
345b700e7f0SSeth Jennings 
3463c33f5b9SJosh Poimboeuf 	ops = klp_find_ops(func->old_addr);
3473c33f5b9SJosh Poimboeuf 	if (WARN_ON(!ops))
3480937e3b0SJosh Poimboeuf 		return;
3493c33f5b9SJosh Poimboeuf 
3503c33f5b9SJosh Poimboeuf 	if (list_is_singular(&ops->func_stack)) {
3510937e3b0SJosh Poimboeuf 		WARN_ON(unregister_ftrace_function(&ops->fops));
3520937e3b0SJosh Poimboeuf 		WARN_ON(ftrace_set_filter_ip(&ops->fops, func->old_addr, 1, 0));
353b700e7f0SSeth Jennings 
3543c33f5b9SJosh Poimboeuf 		list_del_rcu(&func->stack_node);
3553c33f5b9SJosh Poimboeuf 		list_del(&ops->node);
3563c33f5b9SJosh Poimboeuf 		kfree(ops);
3573c33f5b9SJosh Poimboeuf 	} else {
3583c33f5b9SJosh Poimboeuf 		list_del_rcu(&func->stack_node);
3593c33f5b9SJosh Poimboeuf 	}
3603c33f5b9SJosh Poimboeuf 
361b700e7f0SSeth Jennings 	func->state = KLP_DISABLED;
362b700e7f0SSeth Jennings }
363b700e7f0SSeth Jennings 
364b700e7f0SSeth Jennings static int klp_enable_func(struct klp_func *func)
365b700e7f0SSeth Jennings {
3663c33f5b9SJosh Poimboeuf 	struct klp_ops *ops;
367b700e7f0SSeth Jennings 	int ret;
368b700e7f0SSeth Jennings 
369b700e7f0SSeth Jennings 	if (WARN_ON(!func->old_addr))
370b700e7f0SSeth Jennings 		return -EINVAL;
371b700e7f0SSeth Jennings 
372b700e7f0SSeth Jennings 	if (WARN_ON(func->state != KLP_DISABLED))
373b700e7f0SSeth Jennings 		return -EINVAL;
374b700e7f0SSeth Jennings 
3753c33f5b9SJosh Poimboeuf 	ops = klp_find_ops(func->old_addr);
3763c33f5b9SJosh Poimboeuf 	if (!ops) {
3773c33f5b9SJosh Poimboeuf 		ops = kzalloc(sizeof(*ops), GFP_KERNEL);
3783c33f5b9SJosh Poimboeuf 		if (!ops)
3793c33f5b9SJosh Poimboeuf 			return -ENOMEM;
3803c33f5b9SJosh Poimboeuf 
3813c33f5b9SJosh Poimboeuf 		ops->fops.func = klp_ftrace_handler;
3823c33f5b9SJosh Poimboeuf 		ops->fops.flags = FTRACE_OPS_FL_SAVE_REGS |
3833c33f5b9SJosh Poimboeuf 				  FTRACE_OPS_FL_DYNAMIC |
3843c33f5b9SJosh Poimboeuf 				  FTRACE_OPS_FL_IPMODIFY;
3853c33f5b9SJosh Poimboeuf 
3863c33f5b9SJosh Poimboeuf 		list_add(&ops->node, &klp_ops);
3873c33f5b9SJosh Poimboeuf 
3883c33f5b9SJosh Poimboeuf 		INIT_LIST_HEAD(&ops->func_stack);
3893c33f5b9SJosh Poimboeuf 		list_add_rcu(&func->stack_node, &ops->func_stack);
3903c33f5b9SJosh Poimboeuf 
3913c33f5b9SJosh Poimboeuf 		ret = ftrace_set_filter_ip(&ops->fops, func->old_addr, 0, 0);
392b700e7f0SSeth Jennings 		if (ret) {
393b700e7f0SSeth Jennings 			pr_err("failed to set ftrace filter for function '%s' (%d)\n",
394b700e7f0SSeth Jennings 			       func->old_name, ret);
3953c33f5b9SJosh Poimboeuf 			goto err;
396b700e7f0SSeth Jennings 		}
397b700e7f0SSeth Jennings 
3983c33f5b9SJosh Poimboeuf 		ret = register_ftrace_function(&ops->fops);
399b700e7f0SSeth Jennings 		if (ret) {
400b700e7f0SSeth Jennings 			pr_err("failed to register ftrace handler for function '%s' (%d)\n",
401b700e7f0SSeth Jennings 			       func->old_name, ret);
4023c33f5b9SJosh Poimboeuf 			ftrace_set_filter_ip(&ops->fops, func->old_addr, 1, 0);
4033c33f5b9SJosh Poimboeuf 			goto err;
404b700e7f0SSeth Jennings 		}
405b700e7f0SSeth Jennings 
4063c33f5b9SJosh Poimboeuf 
4073c33f5b9SJosh Poimboeuf 	} else {
4083c33f5b9SJosh Poimboeuf 		list_add_rcu(&func->stack_node, &ops->func_stack);
4093c33f5b9SJosh Poimboeuf 	}
4103c33f5b9SJosh Poimboeuf 
4113c33f5b9SJosh Poimboeuf 	func->state = KLP_ENABLED;
4123c33f5b9SJosh Poimboeuf 
413dbed7ddaSJosh Poimboeuf 	return 0;
4143c33f5b9SJosh Poimboeuf 
4153c33f5b9SJosh Poimboeuf err:
4163c33f5b9SJosh Poimboeuf 	list_del_rcu(&func->stack_node);
4173c33f5b9SJosh Poimboeuf 	list_del(&ops->node);
4183c33f5b9SJosh Poimboeuf 	kfree(ops);
419b700e7f0SSeth Jennings 	return ret;
420b700e7f0SSeth Jennings }
421b700e7f0SSeth Jennings 
4220937e3b0SJosh Poimboeuf static void klp_disable_object(struct klp_object *obj)
423b700e7f0SSeth Jennings {
424b700e7f0SSeth Jennings 	struct klp_func *func;
425b700e7f0SSeth Jennings 
4260937e3b0SJosh Poimboeuf 	for (func = obj->funcs; func->old_name; func++)
4270937e3b0SJosh Poimboeuf 		if (func->state == KLP_ENABLED)
4280937e3b0SJosh Poimboeuf 			klp_disable_func(func);
429b700e7f0SSeth Jennings 
430b700e7f0SSeth Jennings 	obj->state = KLP_DISABLED;
431b700e7f0SSeth Jennings }
432b700e7f0SSeth Jennings 
433b700e7f0SSeth Jennings static int klp_enable_object(struct klp_object *obj)
434b700e7f0SSeth Jennings {
435b700e7f0SSeth Jennings 	struct klp_func *func;
436b700e7f0SSeth Jennings 	int ret;
437b700e7f0SSeth Jennings 
438b700e7f0SSeth Jennings 	if (WARN_ON(obj->state != KLP_DISABLED))
439b700e7f0SSeth Jennings 		return -EINVAL;
440b700e7f0SSeth Jennings 
441b700e7f0SSeth Jennings 	if (WARN_ON(!klp_is_object_loaded(obj)))
442b700e7f0SSeth Jennings 		return -EINVAL;
443b700e7f0SSeth Jennings 
444b700e7f0SSeth Jennings 	for (func = obj->funcs; func->old_name; func++) {
445b700e7f0SSeth Jennings 		ret = klp_enable_func(func);
4460937e3b0SJosh Poimboeuf 		if (ret) {
4470937e3b0SJosh Poimboeuf 			klp_disable_object(obj);
4480937e3b0SJosh Poimboeuf 			return ret;
4490937e3b0SJosh Poimboeuf 		}
450b700e7f0SSeth Jennings 	}
451b700e7f0SSeth Jennings 	obj->state = KLP_ENABLED;
452b700e7f0SSeth Jennings 
453b700e7f0SSeth Jennings 	return 0;
454b700e7f0SSeth Jennings }
455b700e7f0SSeth Jennings 
456b700e7f0SSeth Jennings static int __klp_disable_patch(struct klp_patch *patch)
457b700e7f0SSeth Jennings {
458b700e7f0SSeth Jennings 	struct klp_object *obj;
459b700e7f0SSeth Jennings 
46083a90bb1SJosh Poimboeuf 	/* enforce stacking: only the last enabled patch can be disabled */
46183a90bb1SJosh Poimboeuf 	if (!list_is_last(&patch->list, &klp_patches) &&
46283a90bb1SJosh Poimboeuf 	    list_next_entry(patch, list)->state == KLP_ENABLED)
46383a90bb1SJosh Poimboeuf 		return -EBUSY;
46483a90bb1SJosh Poimboeuf 
465b700e7f0SSeth Jennings 	pr_notice("disabling patch '%s'\n", patch->mod->name);
466b700e7f0SSeth Jennings 
467b700e7f0SSeth Jennings 	for (obj = patch->objs; obj->funcs; obj++) {
4680937e3b0SJosh Poimboeuf 		if (obj->state == KLP_ENABLED)
4690937e3b0SJosh Poimboeuf 			klp_disable_object(obj);
470b700e7f0SSeth Jennings 	}
471b700e7f0SSeth Jennings 
472b700e7f0SSeth Jennings 	patch->state = KLP_DISABLED;
473b700e7f0SSeth Jennings 
474b700e7f0SSeth Jennings 	return 0;
475b700e7f0SSeth Jennings }
476b700e7f0SSeth Jennings 
477b700e7f0SSeth Jennings /**
478b700e7f0SSeth Jennings  * klp_disable_patch() - disables a registered patch
479b700e7f0SSeth Jennings  * @patch:	The registered, enabled patch to be disabled
480b700e7f0SSeth Jennings  *
481b700e7f0SSeth Jennings  * Unregisters the patched functions from ftrace.
482b700e7f0SSeth Jennings  *
483b700e7f0SSeth Jennings  * Return: 0 on success, otherwise error
484b700e7f0SSeth Jennings  */
485b700e7f0SSeth Jennings int klp_disable_patch(struct klp_patch *patch)
486b700e7f0SSeth Jennings {
487b700e7f0SSeth Jennings 	int ret;
488b700e7f0SSeth Jennings 
489b700e7f0SSeth Jennings 	mutex_lock(&klp_mutex);
490b700e7f0SSeth Jennings 
491b700e7f0SSeth Jennings 	if (!klp_is_patch_registered(patch)) {
492b700e7f0SSeth Jennings 		ret = -EINVAL;
493b700e7f0SSeth Jennings 		goto err;
494b700e7f0SSeth Jennings 	}
495b700e7f0SSeth Jennings 
496b700e7f0SSeth Jennings 	if (patch->state == KLP_DISABLED) {
497b700e7f0SSeth Jennings 		ret = -EINVAL;
498b700e7f0SSeth Jennings 		goto err;
499b700e7f0SSeth Jennings 	}
500b700e7f0SSeth Jennings 
501b700e7f0SSeth Jennings 	ret = __klp_disable_patch(patch);
502b700e7f0SSeth Jennings 
503b700e7f0SSeth Jennings err:
504b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
505b700e7f0SSeth Jennings 	return ret;
506b700e7f0SSeth Jennings }
507b700e7f0SSeth Jennings EXPORT_SYMBOL_GPL(klp_disable_patch);
508b700e7f0SSeth Jennings 
509b700e7f0SSeth Jennings static int __klp_enable_patch(struct klp_patch *patch)
510b700e7f0SSeth Jennings {
511b700e7f0SSeth Jennings 	struct klp_object *obj;
512b700e7f0SSeth Jennings 	int ret;
513b700e7f0SSeth Jennings 
514b700e7f0SSeth Jennings 	if (WARN_ON(patch->state != KLP_DISABLED))
515b700e7f0SSeth Jennings 		return -EINVAL;
516b700e7f0SSeth Jennings 
51783a90bb1SJosh Poimboeuf 	/* enforce stacking: only the first disabled patch can be enabled */
51883a90bb1SJosh Poimboeuf 	if (patch->list.prev != &klp_patches &&
51983a90bb1SJosh Poimboeuf 	    list_prev_entry(patch, list)->state == KLP_DISABLED)
52083a90bb1SJosh Poimboeuf 		return -EBUSY;
52183a90bb1SJosh Poimboeuf 
522b700e7f0SSeth Jennings 	pr_notice_once("tainting kernel with TAINT_LIVEPATCH\n");
523b700e7f0SSeth Jennings 	add_taint(TAINT_LIVEPATCH, LOCKDEP_STILL_OK);
524b700e7f0SSeth Jennings 
525b700e7f0SSeth Jennings 	pr_notice("enabling patch '%s'\n", patch->mod->name);
526b700e7f0SSeth Jennings 
527b700e7f0SSeth Jennings 	for (obj = patch->objs; obj->funcs; obj++) {
528b700e7f0SSeth Jennings 		if (!klp_is_object_loaded(obj))
529b700e7f0SSeth Jennings 			continue;
530b700e7f0SSeth Jennings 
531b700e7f0SSeth Jennings 		ret = klp_enable_object(obj);
532b700e7f0SSeth Jennings 		if (ret)
533b700e7f0SSeth Jennings 			goto unregister;
534b700e7f0SSeth Jennings 	}
535b700e7f0SSeth Jennings 
536b700e7f0SSeth Jennings 	patch->state = KLP_ENABLED;
537b700e7f0SSeth Jennings 
538b700e7f0SSeth Jennings 	return 0;
539b700e7f0SSeth Jennings 
540b700e7f0SSeth Jennings unregister:
541b700e7f0SSeth Jennings 	WARN_ON(__klp_disable_patch(patch));
542b700e7f0SSeth Jennings 	return ret;
543b700e7f0SSeth Jennings }
544b700e7f0SSeth Jennings 
545b700e7f0SSeth Jennings /**
546b700e7f0SSeth Jennings  * klp_enable_patch() - enables a registered patch
547b700e7f0SSeth Jennings  * @patch:	The registered, disabled patch to be enabled
548b700e7f0SSeth Jennings  *
549b700e7f0SSeth Jennings  * Performs the needed symbol lookups and code relocations,
550b700e7f0SSeth Jennings  * then registers the patched functions with ftrace.
551b700e7f0SSeth Jennings  *
552b700e7f0SSeth Jennings  * Return: 0 on success, otherwise error
553b700e7f0SSeth Jennings  */
554b700e7f0SSeth Jennings int klp_enable_patch(struct klp_patch *patch)
555b700e7f0SSeth Jennings {
556b700e7f0SSeth Jennings 	int ret;
557b700e7f0SSeth Jennings 
558b700e7f0SSeth Jennings 	mutex_lock(&klp_mutex);
559b700e7f0SSeth Jennings 
560b700e7f0SSeth Jennings 	if (!klp_is_patch_registered(patch)) {
561b700e7f0SSeth Jennings 		ret = -EINVAL;
562b700e7f0SSeth Jennings 		goto err;
563b700e7f0SSeth Jennings 	}
564b700e7f0SSeth Jennings 
565b700e7f0SSeth Jennings 	ret = __klp_enable_patch(patch);
566b700e7f0SSeth Jennings 
567b700e7f0SSeth Jennings err:
568b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
569b700e7f0SSeth Jennings 	return ret;
570b700e7f0SSeth Jennings }
571b700e7f0SSeth Jennings EXPORT_SYMBOL_GPL(klp_enable_patch);
572b700e7f0SSeth Jennings 
573b700e7f0SSeth Jennings /*
574b700e7f0SSeth Jennings  * Sysfs Interface
575b700e7f0SSeth Jennings  *
576b700e7f0SSeth Jennings  * /sys/kernel/livepatch
577b700e7f0SSeth Jennings  * /sys/kernel/livepatch/<patch>
578b700e7f0SSeth Jennings  * /sys/kernel/livepatch/<patch>/enabled
579b700e7f0SSeth Jennings  * /sys/kernel/livepatch/<patch>/<object>
580b700e7f0SSeth Jennings  * /sys/kernel/livepatch/<patch>/<object>/<func>
581b700e7f0SSeth Jennings  */
582b700e7f0SSeth Jennings 
583b700e7f0SSeth Jennings static ssize_t enabled_store(struct kobject *kobj, struct kobj_attribute *attr,
584b700e7f0SSeth Jennings 			     const char *buf, size_t count)
585b700e7f0SSeth Jennings {
586b700e7f0SSeth Jennings 	struct klp_patch *patch;
587b700e7f0SSeth Jennings 	int ret;
588b700e7f0SSeth Jennings 	unsigned long val;
589b700e7f0SSeth Jennings 
590b700e7f0SSeth Jennings 	ret = kstrtoul(buf, 10, &val);
591b700e7f0SSeth Jennings 	if (ret)
592b700e7f0SSeth Jennings 		return -EINVAL;
593b700e7f0SSeth Jennings 
594b700e7f0SSeth Jennings 	if (val != KLP_DISABLED && val != KLP_ENABLED)
595b700e7f0SSeth Jennings 		return -EINVAL;
596b700e7f0SSeth Jennings 
597b700e7f0SSeth Jennings 	patch = container_of(kobj, struct klp_patch, kobj);
598b700e7f0SSeth Jennings 
599b700e7f0SSeth Jennings 	mutex_lock(&klp_mutex);
600b700e7f0SSeth Jennings 
601b700e7f0SSeth Jennings 	if (val == patch->state) {
602b700e7f0SSeth Jennings 		/* already in requested state */
603b700e7f0SSeth Jennings 		ret = -EINVAL;
604b700e7f0SSeth Jennings 		goto err;
605b700e7f0SSeth Jennings 	}
606b700e7f0SSeth Jennings 
607b700e7f0SSeth Jennings 	if (val == KLP_ENABLED) {
608b700e7f0SSeth Jennings 		ret = __klp_enable_patch(patch);
609b700e7f0SSeth Jennings 		if (ret)
610b700e7f0SSeth Jennings 			goto err;
611b700e7f0SSeth Jennings 	} else {
612b700e7f0SSeth Jennings 		ret = __klp_disable_patch(patch);
613b700e7f0SSeth Jennings 		if (ret)
614b700e7f0SSeth Jennings 			goto err;
615b700e7f0SSeth Jennings 	}
616b700e7f0SSeth Jennings 
617b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
618b700e7f0SSeth Jennings 
619b700e7f0SSeth Jennings 	return count;
620b700e7f0SSeth Jennings 
621b700e7f0SSeth Jennings err:
622b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
623b700e7f0SSeth Jennings 	return ret;
624b700e7f0SSeth Jennings }
625b700e7f0SSeth Jennings 
626b700e7f0SSeth Jennings static ssize_t enabled_show(struct kobject *kobj,
627b700e7f0SSeth Jennings 			    struct kobj_attribute *attr, char *buf)
628b700e7f0SSeth Jennings {
629b700e7f0SSeth Jennings 	struct klp_patch *patch;
630b700e7f0SSeth Jennings 
631b700e7f0SSeth Jennings 	patch = container_of(kobj, struct klp_patch, kobj);
632b700e7f0SSeth Jennings 	return snprintf(buf, PAGE_SIZE-1, "%d\n", patch->state);
633b700e7f0SSeth Jennings }
634b700e7f0SSeth Jennings 
635b700e7f0SSeth Jennings static struct kobj_attribute enabled_kobj_attr = __ATTR_RW(enabled);
636b700e7f0SSeth Jennings static struct attribute *klp_patch_attrs[] = {
637b700e7f0SSeth Jennings 	&enabled_kobj_attr.attr,
638b700e7f0SSeth Jennings 	NULL
639b700e7f0SSeth Jennings };
640b700e7f0SSeth Jennings 
641b700e7f0SSeth Jennings static void klp_kobj_release_patch(struct kobject *kobj)
642b700e7f0SSeth Jennings {
643b700e7f0SSeth Jennings 	/*
644b700e7f0SSeth Jennings 	 * Once we have a consistency model we'll need to module_put() the
645b700e7f0SSeth Jennings 	 * patch module here.  See klp_register_patch() for more details.
646b700e7f0SSeth Jennings 	 */
647b700e7f0SSeth Jennings }
648b700e7f0SSeth Jennings 
649b700e7f0SSeth Jennings static struct kobj_type klp_ktype_patch = {
650b700e7f0SSeth Jennings 	.release = klp_kobj_release_patch,
651b700e7f0SSeth Jennings 	.sysfs_ops = &kobj_sysfs_ops,
652b700e7f0SSeth Jennings 	.default_attrs = klp_patch_attrs,
653b700e7f0SSeth Jennings };
654b700e7f0SSeth Jennings 
655b700e7f0SSeth Jennings static void klp_kobj_release_func(struct kobject *kobj)
656b700e7f0SSeth Jennings {
657b700e7f0SSeth Jennings }
658b700e7f0SSeth Jennings 
659b700e7f0SSeth Jennings static struct kobj_type klp_ktype_func = {
660b700e7f0SSeth Jennings 	.release = klp_kobj_release_func,
661b700e7f0SSeth Jennings 	.sysfs_ops = &kobj_sysfs_ops,
662b700e7f0SSeth Jennings };
663b700e7f0SSeth Jennings 
664b700e7f0SSeth Jennings /*
665b700e7f0SSeth Jennings  * Free all functions' kobjects in the array up to some limit. When limit is
666b700e7f0SSeth Jennings  * NULL, all kobjects are freed.
667b700e7f0SSeth Jennings  */
668b700e7f0SSeth Jennings static void klp_free_funcs_limited(struct klp_object *obj,
669b700e7f0SSeth Jennings 				   struct klp_func *limit)
670b700e7f0SSeth Jennings {
671b700e7f0SSeth Jennings 	struct klp_func *func;
672b700e7f0SSeth Jennings 
673b700e7f0SSeth Jennings 	for (func = obj->funcs; func->old_name && func != limit; func++)
674b700e7f0SSeth Jennings 		kobject_put(&func->kobj);
675b700e7f0SSeth Jennings }
676b700e7f0SSeth Jennings 
677b700e7f0SSeth Jennings /* Clean up when a patched object is unloaded */
678b700e7f0SSeth Jennings static void klp_free_object_loaded(struct klp_object *obj)
679b700e7f0SSeth Jennings {
680b700e7f0SSeth Jennings 	struct klp_func *func;
681b700e7f0SSeth Jennings 
682b700e7f0SSeth Jennings 	obj->mod = NULL;
683b700e7f0SSeth Jennings 
684b700e7f0SSeth Jennings 	for (func = obj->funcs; func->old_name; func++)
685b700e7f0SSeth Jennings 		func->old_addr = 0;
686b700e7f0SSeth Jennings }
687b700e7f0SSeth Jennings 
688b700e7f0SSeth Jennings /*
689b700e7f0SSeth Jennings  * Free all objects' kobjects in the array up to some limit. When limit is
690b700e7f0SSeth Jennings  * NULL, all kobjects are freed.
691b700e7f0SSeth Jennings  */
692b700e7f0SSeth Jennings static void klp_free_objects_limited(struct klp_patch *patch,
693b700e7f0SSeth Jennings 				     struct klp_object *limit)
694b700e7f0SSeth Jennings {
695b700e7f0SSeth Jennings 	struct klp_object *obj;
696b700e7f0SSeth Jennings 
697b700e7f0SSeth Jennings 	for (obj = patch->objs; obj->funcs && obj != limit; obj++) {
698b700e7f0SSeth Jennings 		klp_free_funcs_limited(obj, NULL);
699b700e7f0SSeth Jennings 		kobject_put(obj->kobj);
700b700e7f0SSeth Jennings 	}
701b700e7f0SSeth Jennings }
702b700e7f0SSeth Jennings 
703b700e7f0SSeth Jennings static void klp_free_patch(struct klp_patch *patch)
704b700e7f0SSeth Jennings {
705b700e7f0SSeth Jennings 	klp_free_objects_limited(patch, NULL);
706b700e7f0SSeth Jennings 	if (!list_empty(&patch->list))
707b700e7f0SSeth Jennings 		list_del(&patch->list);
708b700e7f0SSeth Jennings 	kobject_put(&patch->kobj);
709b700e7f0SSeth Jennings }
710b700e7f0SSeth Jennings 
711b700e7f0SSeth Jennings static int klp_init_func(struct klp_object *obj, struct klp_func *func)
712b700e7f0SSeth Jennings {
7133c33f5b9SJosh Poimboeuf 	INIT_LIST_HEAD(&func->stack_node);
714b700e7f0SSeth Jennings 	func->state = KLP_DISABLED;
715b700e7f0SSeth Jennings 
7163c33f5b9SJosh Poimboeuf 	return kobject_init_and_add(&func->kobj, &klp_ktype_func,
717e0b561eeSJiri Kosina 				    obj->kobj, "%s", func->old_name);
718b700e7f0SSeth Jennings }
719b700e7f0SSeth Jennings 
720b700e7f0SSeth Jennings /* parts of the initialization that is done only when the object is loaded */
721b700e7f0SSeth Jennings static int klp_init_object_loaded(struct klp_patch *patch,
722b700e7f0SSeth Jennings 				  struct klp_object *obj)
723b700e7f0SSeth Jennings {
724b700e7f0SSeth Jennings 	struct klp_func *func;
725b700e7f0SSeth Jennings 	int ret;
726b700e7f0SSeth Jennings 
727b700e7f0SSeth Jennings 	if (obj->relocs) {
728b700e7f0SSeth Jennings 		ret = klp_write_object_relocations(patch->mod, obj);
729b700e7f0SSeth Jennings 		if (ret)
730b700e7f0SSeth Jennings 			return ret;
731b700e7f0SSeth Jennings 	}
732b700e7f0SSeth Jennings 
733b700e7f0SSeth Jennings 	for (func = obj->funcs; func->old_name; func++) {
734b700e7f0SSeth Jennings 		ret = klp_find_verify_func_addr(obj, func);
735b700e7f0SSeth Jennings 		if (ret)
736b700e7f0SSeth Jennings 			return ret;
737b700e7f0SSeth Jennings 	}
738b700e7f0SSeth Jennings 
739b700e7f0SSeth Jennings 	return 0;
740b700e7f0SSeth Jennings }
741b700e7f0SSeth Jennings 
742b700e7f0SSeth Jennings static int klp_init_object(struct klp_patch *patch, struct klp_object *obj)
743b700e7f0SSeth Jennings {
744b700e7f0SSeth Jennings 	struct klp_func *func;
745b700e7f0SSeth Jennings 	int ret;
746b700e7f0SSeth Jennings 	const char *name;
747b700e7f0SSeth Jennings 
748b700e7f0SSeth Jennings 	if (!obj->funcs)
749b700e7f0SSeth Jennings 		return -EINVAL;
750b700e7f0SSeth Jennings 
751b700e7f0SSeth Jennings 	obj->state = KLP_DISABLED;
7528cb2c2dcSPetr Mladek 	obj->mod = NULL;
753b700e7f0SSeth Jennings 
754b700e7f0SSeth Jennings 	klp_find_object_module(obj);
755b700e7f0SSeth Jennings 
756b700e7f0SSeth Jennings 	name = klp_is_module(obj) ? obj->name : "vmlinux";
757b700e7f0SSeth Jennings 	obj->kobj = kobject_create_and_add(name, &patch->kobj);
758b700e7f0SSeth Jennings 	if (!obj->kobj)
759b700e7f0SSeth Jennings 		return -ENOMEM;
760b700e7f0SSeth Jennings 
761b700e7f0SSeth Jennings 	for (func = obj->funcs; func->old_name; func++) {
762b700e7f0SSeth Jennings 		ret = klp_init_func(obj, func);
763b700e7f0SSeth Jennings 		if (ret)
764b700e7f0SSeth Jennings 			goto free;
765b700e7f0SSeth Jennings 	}
766b700e7f0SSeth Jennings 
767b700e7f0SSeth Jennings 	if (klp_is_object_loaded(obj)) {
768b700e7f0SSeth Jennings 		ret = klp_init_object_loaded(patch, obj);
769b700e7f0SSeth Jennings 		if (ret)
770b700e7f0SSeth Jennings 			goto free;
771b700e7f0SSeth Jennings 	}
772b700e7f0SSeth Jennings 
773b700e7f0SSeth Jennings 	return 0;
774b700e7f0SSeth Jennings 
775b700e7f0SSeth Jennings free:
776b700e7f0SSeth Jennings 	klp_free_funcs_limited(obj, func);
777b700e7f0SSeth Jennings 	kobject_put(obj->kobj);
778b700e7f0SSeth Jennings 	return ret;
779b700e7f0SSeth Jennings }
780b700e7f0SSeth Jennings 
781b700e7f0SSeth Jennings static int klp_init_patch(struct klp_patch *patch)
782b700e7f0SSeth Jennings {
783b700e7f0SSeth Jennings 	struct klp_object *obj;
784b700e7f0SSeth Jennings 	int ret;
785b700e7f0SSeth Jennings 
786b700e7f0SSeth Jennings 	if (!patch->objs)
787b700e7f0SSeth Jennings 		return -EINVAL;
788b700e7f0SSeth Jennings 
789b700e7f0SSeth Jennings 	mutex_lock(&klp_mutex);
790b700e7f0SSeth Jennings 
791b700e7f0SSeth Jennings 	patch->state = KLP_DISABLED;
792b700e7f0SSeth Jennings 
793b700e7f0SSeth Jennings 	ret = kobject_init_and_add(&patch->kobj, &klp_ktype_patch,
794e0b561eeSJiri Kosina 				   klp_root_kobj, "%s", patch->mod->name);
795b700e7f0SSeth Jennings 	if (ret)
796b700e7f0SSeth Jennings 		goto unlock;
797b700e7f0SSeth Jennings 
798b700e7f0SSeth Jennings 	for (obj = patch->objs; obj->funcs; obj++) {
799b700e7f0SSeth Jennings 		ret = klp_init_object(patch, obj);
800b700e7f0SSeth Jennings 		if (ret)
801b700e7f0SSeth Jennings 			goto free;
802b700e7f0SSeth Jennings 	}
803b700e7f0SSeth Jennings 
80499590ba5SJosh Poimboeuf 	list_add_tail(&patch->list, &klp_patches);
805b700e7f0SSeth Jennings 
806b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
807b700e7f0SSeth Jennings 
808b700e7f0SSeth Jennings 	return 0;
809b700e7f0SSeth Jennings 
810b700e7f0SSeth Jennings free:
811b700e7f0SSeth Jennings 	klp_free_objects_limited(patch, obj);
812b700e7f0SSeth Jennings 	kobject_put(&patch->kobj);
813b700e7f0SSeth Jennings unlock:
814b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
815b700e7f0SSeth Jennings 	return ret;
816b700e7f0SSeth Jennings }
817b700e7f0SSeth Jennings 
818b700e7f0SSeth Jennings /**
819b700e7f0SSeth Jennings  * klp_unregister_patch() - unregisters a patch
820b700e7f0SSeth Jennings  * @patch:	Disabled patch to be unregistered
821b700e7f0SSeth Jennings  *
822b700e7f0SSeth Jennings  * Frees the data structures and removes the sysfs interface.
823b700e7f0SSeth Jennings  *
824b700e7f0SSeth Jennings  * Return: 0 on success, otherwise error
825b700e7f0SSeth Jennings  */
826b700e7f0SSeth Jennings int klp_unregister_patch(struct klp_patch *patch)
827b700e7f0SSeth Jennings {
828b700e7f0SSeth Jennings 	int ret = 0;
829b700e7f0SSeth Jennings 
830b700e7f0SSeth Jennings 	mutex_lock(&klp_mutex);
831b700e7f0SSeth Jennings 
832b700e7f0SSeth Jennings 	if (!klp_is_patch_registered(patch)) {
833b700e7f0SSeth Jennings 		ret = -EINVAL;
834b700e7f0SSeth Jennings 		goto out;
835b700e7f0SSeth Jennings 	}
836b700e7f0SSeth Jennings 
837b700e7f0SSeth Jennings 	if (patch->state == KLP_ENABLED) {
838b700e7f0SSeth Jennings 		ret = -EBUSY;
839b700e7f0SSeth Jennings 		goto out;
840b700e7f0SSeth Jennings 	}
841b700e7f0SSeth Jennings 
842b700e7f0SSeth Jennings 	klp_free_patch(patch);
843b700e7f0SSeth Jennings 
844b700e7f0SSeth Jennings out:
845b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
846b700e7f0SSeth Jennings 	return ret;
847b700e7f0SSeth Jennings }
848b700e7f0SSeth Jennings EXPORT_SYMBOL_GPL(klp_unregister_patch);
849b700e7f0SSeth Jennings 
850b700e7f0SSeth Jennings /**
851b700e7f0SSeth Jennings  * klp_register_patch() - registers a patch
852b700e7f0SSeth Jennings  * @patch:	Patch to be registered
853b700e7f0SSeth Jennings  *
854b700e7f0SSeth Jennings  * Initializes the data structure associated with the patch and
855b700e7f0SSeth Jennings  * creates the sysfs interface.
856b700e7f0SSeth Jennings  *
857b700e7f0SSeth Jennings  * Return: 0 on success, otherwise error
858b700e7f0SSeth Jennings  */
859b700e7f0SSeth Jennings int klp_register_patch(struct klp_patch *patch)
860b700e7f0SSeth Jennings {
861b700e7f0SSeth Jennings 	int ret;
862b700e7f0SSeth Jennings 
863b700e7f0SSeth Jennings 	if (!klp_initialized())
864b700e7f0SSeth Jennings 		return -ENODEV;
865b700e7f0SSeth Jennings 
866b700e7f0SSeth Jennings 	if (!patch || !patch->mod)
867b700e7f0SSeth Jennings 		return -EINVAL;
868b700e7f0SSeth Jennings 
869b700e7f0SSeth Jennings 	/*
870b700e7f0SSeth Jennings 	 * A reference is taken on the patch module to prevent it from being
871b700e7f0SSeth Jennings 	 * unloaded.  Right now, we don't allow patch modules to unload since
872b700e7f0SSeth Jennings 	 * there is currently no method to determine if a thread is still
873b700e7f0SSeth Jennings 	 * running in the patched code contained in the patch module once
874b700e7f0SSeth Jennings 	 * the ftrace registration is successful.
875b700e7f0SSeth Jennings 	 */
876b700e7f0SSeth Jennings 	if (!try_module_get(patch->mod))
877b700e7f0SSeth Jennings 		return -ENODEV;
878b700e7f0SSeth Jennings 
879b700e7f0SSeth Jennings 	ret = klp_init_patch(patch);
880b700e7f0SSeth Jennings 	if (ret)
881b700e7f0SSeth Jennings 		module_put(patch->mod);
882b700e7f0SSeth Jennings 
883b700e7f0SSeth Jennings 	return ret;
884b700e7f0SSeth Jennings }
885b700e7f0SSeth Jennings EXPORT_SYMBOL_GPL(klp_register_patch);
886b700e7f0SSeth Jennings 
887b700e7f0SSeth Jennings static void klp_module_notify_coming(struct klp_patch *patch,
888b700e7f0SSeth Jennings 				     struct klp_object *obj)
889b700e7f0SSeth Jennings {
890b700e7f0SSeth Jennings 	struct module *pmod = patch->mod;
891b700e7f0SSeth Jennings 	struct module *mod = obj->mod;
892b700e7f0SSeth Jennings 	int ret;
893b700e7f0SSeth Jennings 
894b700e7f0SSeth Jennings 	ret = klp_init_object_loaded(patch, obj);
895b700e7f0SSeth Jennings 	if (ret)
896b700e7f0SSeth Jennings 		goto err;
897b700e7f0SSeth Jennings 
898b700e7f0SSeth Jennings 	if (patch->state == KLP_DISABLED)
899b700e7f0SSeth Jennings 		return;
900b700e7f0SSeth Jennings 
901b700e7f0SSeth Jennings 	pr_notice("applying patch '%s' to loading module '%s'\n",
902b700e7f0SSeth Jennings 		  pmod->name, mod->name);
903b700e7f0SSeth Jennings 
904b700e7f0SSeth Jennings 	ret = klp_enable_object(obj);
905b700e7f0SSeth Jennings 	if (!ret)
906b700e7f0SSeth Jennings 		return;
907b700e7f0SSeth Jennings 
908b700e7f0SSeth Jennings err:
909b700e7f0SSeth Jennings 	pr_warn("failed to apply patch '%s' to module '%s' (%d)\n",
910b700e7f0SSeth Jennings 		pmod->name, mod->name, ret);
911b700e7f0SSeth Jennings }
912b700e7f0SSeth Jennings 
913b700e7f0SSeth Jennings static void klp_module_notify_going(struct klp_patch *patch,
914b700e7f0SSeth Jennings 				    struct klp_object *obj)
915b700e7f0SSeth Jennings {
916b700e7f0SSeth Jennings 	struct module *pmod = patch->mod;
917b700e7f0SSeth Jennings 	struct module *mod = obj->mod;
918b700e7f0SSeth Jennings 
919b700e7f0SSeth Jennings 	if (patch->state == KLP_DISABLED)
920b700e7f0SSeth Jennings 		goto disabled;
921b700e7f0SSeth Jennings 
922b700e7f0SSeth Jennings 	pr_notice("reverting patch '%s' on unloading module '%s'\n",
923b700e7f0SSeth Jennings 		  pmod->name, mod->name);
924b700e7f0SSeth Jennings 
9250937e3b0SJosh Poimboeuf 	klp_disable_object(obj);
926b700e7f0SSeth Jennings 
927b700e7f0SSeth Jennings disabled:
928b700e7f0SSeth Jennings 	klp_free_object_loaded(obj);
929b700e7f0SSeth Jennings }
930b700e7f0SSeth Jennings 
931b700e7f0SSeth Jennings static int klp_module_notify(struct notifier_block *nb, unsigned long action,
932b700e7f0SSeth Jennings 			     void *data)
933b700e7f0SSeth Jennings {
934b700e7f0SSeth Jennings 	struct module *mod = data;
935b700e7f0SSeth Jennings 	struct klp_patch *patch;
936b700e7f0SSeth Jennings 	struct klp_object *obj;
937b700e7f0SSeth Jennings 
938b700e7f0SSeth Jennings 	if (action != MODULE_STATE_COMING && action != MODULE_STATE_GOING)
939b700e7f0SSeth Jennings 		return 0;
940b700e7f0SSeth Jennings 
941b700e7f0SSeth Jennings 	mutex_lock(&klp_mutex);
942b700e7f0SSeth Jennings 
9438cb2c2dcSPetr Mladek 	/*
9448cb2c2dcSPetr Mladek 	 * Each module has to know that the notifier has been called.
9458cb2c2dcSPetr Mladek 	 * We never know what module will get patched by a new patch.
9468cb2c2dcSPetr Mladek 	 */
9478cb2c2dcSPetr Mladek 	if (action == MODULE_STATE_COMING)
9488cb2c2dcSPetr Mladek 		mod->klp_alive = true;
9498cb2c2dcSPetr Mladek 	else /* MODULE_STATE_GOING */
9508cb2c2dcSPetr Mladek 		mod->klp_alive = false;
9518cb2c2dcSPetr Mladek 
952b700e7f0SSeth Jennings 	list_for_each_entry(patch, &klp_patches, list) {
953b700e7f0SSeth Jennings 		for (obj = patch->objs; obj->funcs; obj++) {
954b700e7f0SSeth Jennings 			if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
955b700e7f0SSeth Jennings 				continue;
956b700e7f0SSeth Jennings 
957b700e7f0SSeth Jennings 			if (action == MODULE_STATE_COMING) {
958b700e7f0SSeth Jennings 				obj->mod = mod;
959b700e7f0SSeth Jennings 				klp_module_notify_coming(patch, obj);
960b700e7f0SSeth Jennings 			} else /* MODULE_STATE_GOING */
961b700e7f0SSeth Jennings 				klp_module_notify_going(patch, obj);
962b700e7f0SSeth Jennings 
963b700e7f0SSeth Jennings 			break;
964b700e7f0SSeth Jennings 		}
965b700e7f0SSeth Jennings 	}
966b700e7f0SSeth Jennings 
967b700e7f0SSeth Jennings 	mutex_unlock(&klp_mutex);
968b700e7f0SSeth Jennings 
969b700e7f0SSeth Jennings 	return 0;
970b700e7f0SSeth Jennings }
971b700e7f0SSeth Jennings 
972b700e7f0SSeth Jennings static struct notifier_block klp_module_nb = {
973b700e7f0SSeth Jennings 	.notifier_call = klp_module_notify,
974b700e7f0SSeth Jennings 	.priority = INT_MIN+1, /* called late but before ftrace notifier */
975b700e7f0SSeth Jennings };
976b700e7f0SSeth Jennings 
977b700e7f0SSeth Jennings static int klp_init(void)
978b700e7f0SSeth Jennings {
979b700e7f0SSeth Jennings 	int ret;
980b700e7f0SSeth Jennings 
981b9dfe0beSJiri Kosina 	ret = klp_check_compiler_support();
982b9dfe0beSJiri Kosina 	if (ret) {
983b9dfe0beSJiri Kosina 		pr_info("Your compiler is too old; turning off.\n");
984b9dfe0beSJiri Kosina 		return -EINVAL;
985b9dfe0beSJiri Kosina 	}
986b9dfe0beSJiri Kosina 
987b700e7f0SSeth Jennings 	ret = register_module_notifier(&klp_module_nb);
988b700e7f0SSeth Jennings 	if (ret)
989b700e7f0SSeth Jennings 		return ret;
990b700e7f0SSeth Jennings 
991b700e7f0SSeth Jennings 	klp_root_kobj = kobject_create_and_add("livepatch", kernel_kobj);
992b700e7f0SSeth Jennings 	if (!klp_root_kobj) {
993b700e7f0SSeth Jennings 		ret = -ENOMEM;
994b700e7f0SSeth Jennings 		goto unregister;
995b700e7f0SSeth Jennings 	}
996b700e7f0SSeth Jennings 
997b700e7f0SSeth Jennings 	return 0;
998b700e7f0SSeth Jennings 
999b700e7f0SSeth Jennings unregister:
1000b700e7f0SSeth Jennings 	unregister_module_notifier(&klp_module_nb);
1001b700e7f0SSeth Jennings 	return ret;
1002b700e7f0SSeth Jennings }
1003b700e7f0SSeth Jennings 
1004b700e7f0SSeth Jennings module_init(klp_init);
1005