blob: 47ed643a63623ccee3b7bd23a249d6eeddbf95cb [file] [log] [blame]
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001/*
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>
Jessica Yu425595a2016-03-22 20:03:18 -040031#include <linux/elf.h>
32#include <linux/moduleloader.h>
Josh Poimboeufb56b36e2015-12-03 16:33:26 -060033#include <asm/cacheflush.h>
Seth Jenningsb700e7f2014-12-16 11:58:19 -060034
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060035/**
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
Seth Jenningsb700e7f2014-12-16 11:58:19 -060047 */
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060048struct klp_ops {
49 struct list_head node;
50 struct list_head func_stack;
51 struct ftrace_ops fops;
52};
Seth Jenningsb700e7f2014-12-16 11:58:19 -060053
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060054/*
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 */
Seth Jenningsb700e7f2014-12-16 11:58:19 -060060static DEFINE_MUTEX(klp_mutex);
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060061
Seth Jenningsb700e7f2014-12-16 11:58:19 -060062static LIST_HEAD(klp_patches);
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060063static LIST_HEAD(klp_ops);
Seth Jenningsb700e7f2014-12-16 11:58:19 -060064
65static struct kobject *klp_root_kobj;
66
Josh Poimboeuf46c5a012017-02-13 19:42:30 -060067/* TODO: temporary stub */
68void klp_update_patch_state(struct task_struct *task) {}
69
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060070static 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
Seth Jenningsb700e7f2014-12-16 11:58:19 -060085static bool klp_is_module(struct klp_object *obj)
86{
87 return obj->name;
88}
89
90static 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 */
96static void klp_find_object_module(struct klp_object *obj)
97{
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010098 struct module *mod;
99
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600100 if (!klp_is_module(obj))
101 return;
102
103 mutex_lock(&module_mutex);
104 /*
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100105 * 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
Jessica Yu7e545d62016-03-16 20:55:39 -0400107 * klp_module_going() instead.
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600108 */
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100109 mod = find_module(obj->name);
110 /*
Jessica Yu7e545d62016-03-16 20:55:39 -0400111 * 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()
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100113 * 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.
116 */
117 if (mod && mod->klp_alive)
118 obj->mod = mod;
119
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600120 mutex_unlock(&module_mutex);
121}
122
123/* klp_mutex must be held by caller */
124static 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
135static bool klp_initialized(void)
136{
Nicholas Mc Guiree76ff062015-05-11 07:52:29 +0200137 return !!klp_root_kobj;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600138}
139
140struct klp_find_arg {
141 const char *objname;
142 const char *name;
143 unsigned long addr;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600144 unsigned long count;
Chris J Argesb2b018e2015-12-01 20:40:54 -0600145 unsigned long pos;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600146};
147
148static 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
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600162 args->addr = addr;
163 args->count++;
164
Chris J Argesb2b018e2015-12-01 20:40:54 -0600165 /*
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
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600173 return 0;
174}
175
176static int klp_find_object_symbol(const char *objname, const char *name,
Chris J Argesb2b018e2015-12-01 20:40:54 -0600177 unsigned long sympos, unsigned long *addr)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600178{
179 struct klp_find_arg args = {
180 .objname = objname,
181 .name = name,
182 .addr = 0,
Chris J Argesb2b018e2015-12-01 20:40:54 -0600183 .count = 0,
184 .pos = sympos,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600185 };
186
Miroslav Benes9a1bd632015-06-01 17:48:37 +0200187 mutex_lock(&module_mutex);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600188 kallsyms_on_each_symbol(klp_find_callback, &args);
Miroslav Benes9a1bd632015-06-01 17:48:37 +0200189 mutex_unlock(&module_mutex);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600190
Chris J Argesb2b018e2015-12-01 20:40:54 -0600191 /*
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)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600196 pr_err("symbol '%s' not found in symbol table\n", name);
Chris J Argesb2b018e2015-12-01 20:40:54 -0600197 else if (args.count > 1 && sympos == 0) {
Petr Mladekf995b5f2016-03-09 15:20:59 +0100198 pr_err("unresolvable ambiguity for symbol '%s' in object '%s'\n",
199 name, objname);
Chris J Argesb2b018e2015-12-01 20:40:54 -0600200 } 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 {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600204 *addr = args.addr;
205 return 0;
206 }
207
208 *addr = 0;
209 return -EINVAL;
210}
211
Jessica Yu425595a2016-03-22 20:03:18 -0400212static int klp_resolve_symbols(Elf_Shdr *relasec, struct module *pmod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600213{
Jessica Yu425595a2016-03-22 20:03:18 -0400214 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;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600221
Chris J Argesb2b018e2015-12-01 20:40:54 -0600222 /*
Jessica Yu425595a2016-03-22 20:03:18 -0400223 * 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.
Chris J Argesb2b018e2015-12-01 20:40:54 -0600231 */
Jessica Yu425595a2016-03-22 20:03:18 -0400232 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;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600265}
266
267static int klp_write_object_relocations(struct module *pmod,
268 struct klp_object *obj)
269{
Jessica Yu425595a2016-03-22 20:03:18 -0400270 int i, cnt, ret = 0;
271 const char *objname, *secname;
272 char sec_objname[MODULE_NAME_LEN];
273 Elf_Shdr *sec;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600274
275 if (WARN_ON(!klp_is_object_loaded(obj)))
276 return -EINVAL;
277
Jessica Yu425595a2016-03-22 20:03:18 -0400278 objname = klp_is_module(obj) ? obj->name : "vmlinux";
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600279
Jessica Yu425595a2016-03-22 20:03:18 -0400280 /* 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;
Josh Poimboeufb56b36e2015-12-03 16:33:26 -0600286
Jessica Yu425595a2016-03-22 20:03:18 -0400287 /*
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;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600298 }
Jessica Yu425595a2016-03-22 20:03:18 -0400299
300 if (strcmp(objname, sec_objname))
301 continue;
302
303 ret = klp_resolve_symbols(sec, pmod);
304 if (ret)
305 break;
306
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;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600312 }
313
Josh Poimboeufb56b36e2015-12-03 16:33:26 -0600314 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600315}
316
317static void notrace klp_ftrace_handler(unsigned long ip,
318 unsigned long parent_ip,
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600319 struct ftrace_ops *fops,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600320 struct pt_regs *regs)
321{
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600322 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);
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600330 if (WARN_ON_ONCE(!func))
Petr Mladekc4ce0da2015-02-18 18:02:13 +0100331 goto unlock;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600332
Li Binb5bfc512014-12-19 14:11:17 +0800333 klp_arch_set_pc(regs, (unsigned long)func->new_func);
Petr Mladekc4ce0da2015-02-18 18:02:13 +0100334unlock:
335 rcu_read_unlock();
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600336}
337
Michael Ellerman28e7cbd2016-03-24 22:04:02 +1100338/*
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
345static unsigned long klp_get_ftrace_location(unsigned long faddr)
346{
347 return faddr;
348}
349#endif
350
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600351static void klp_unpatch_func(struct klp_func *func)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600352{
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600353 struct klp_ops *ops;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600354
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600355 if (WARN_ON(!func->patched))
Minfei Huang225f58f2015-07-14 11:15:37 +0800356 return;
357 if (WARN_ON(!func->old_addr))
358 return;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600359
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600360 ops = klp_find_ops(func->old_addr);
361 if (WARN_ON(!ops))
Josh Poimboeuf0937e3b2015-02-09 11:31:13 -0600362 return;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600363
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600364 if (list_is_singular(&ops->func_stack)) {
Michael Ellerman28e7cbd2016-03-24 22:04:02 +1100365 unsigned long ftrace_loc;
366
367 ftrace_loc = klp_get_ftrace_location(func->old_addr);
368 if (WARN_ON(!ftrace_loc))
369 return;
370
Josh Poimboeuf0937e3b2015-02-09 11:31:13 -0600371 WARN_ON(unregister_ftrace_function(&ops->fops));
Michael Ellerman28e7cbd2016-03-24 22:04:02 +1100372 WARN_ON(ftrace_set_filter_ip(&ops->fops, ftrace_loc, 1, 0));
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600373
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 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600380
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600381 func->patched = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600382}
383
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600384static int klp_patch_func(struct klp_func *func)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600385{
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600386 struct klp_ops *ops;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600387 int ret;
388
389 if (WARN_ON(!func->old_addr))
390 return -EINVAL;
391
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600392 if (WARN_ON(func->patched))
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600393 return -EINVAL;
394
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600395 ops = klp_find_ops(func->old_addr);
396 if (!ops) {
Michael Ellerman28e7cbd2016-03-24 22:04:02 +1100397 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
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600406 ops = kzalloc(sizeof(*ops), GFP_KERNEL);
407 if (!ops)
408 return -ENOMEM;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600409
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600410 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
Michael Ellerman28e7cbd2016-03-24 22:04:02 +1100420 ret = ftrace_set_filter_ip(&ops->fops, ftrace_loc, 0, 0);
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600421 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);
Michael Ellerman28e7cbd2016-03-24 22:04:02 +1100431 ftrace_set_filter_ip(&ops->fops, ftrace_loc, 1, 0);
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600432 goto err;
433 }
434
435
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600436 } else {
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600437 list_add_rcu(&func->stack_node, &ops->func_stack);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600438 }
439
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600440 func->patched = true;
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600441
Josh Poimboeufdbed7dd2015-01-20 16:07:55 -0600442 return 0;
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600443
444err:
445 list_del_rcu(&func->stack_node);
446 list_del(&ops->node);
447 kfree(ops);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600448 return ret;
449}
450
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600451static void klp_unpatch_object(struct klp_object *obj)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600452{
453 struct klp_func *func;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600454
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200455 klp_for_each_func(obj, func)
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600456 if (func->patched)
457 klp_unpatch_func(func);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600458
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600459 obj->patched = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600460}
461
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600462static int klp_patch_object(struct klp_object *obj)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600463{
464 struct klp_func *func;
465 int ret;
466
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600467 if (WARN_ON(obj->patched))
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600468 return -EINVAL;
469
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200470 klp_for_each_func(obj, func) {
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600471 ret = klp_patch_func(func);
Josh Poimboeuf0937e3b2015-02-09 11:31:13 -0600472 if (ret) {
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600473 klp_unpatch_object(obj);
Josh Poimboeuf0937e3b2015-02-09 11:31:13 -0600474 return ret;
475 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600476 }
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600477 obj->patched = true;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600478
479 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600480}
481
482static int __klp_disable_patch(struct klp_patch *patch)
483{
484 struct klp_object *obj;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600485
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600486 /* enforce stacking: only the last enabled patch can be disabled */
487 if (!list_is_last(&patch->list, &klp_patches) &&
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600488 list_next_entry(patch, list)->enabled)
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600489 return -EBUSY;
490
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600491 pr_notice("disabling patch '%s'\n", patch->mod->name);
492
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200493 klp_for_each_object(patch, obj) {
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600494 if (obj->patched)
495 klp_unpatch_object(obj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600496 }
497
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600498 patch->enabled = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600499
500 return 0;
501}
502
503/**
504 * klp_disable_patch() - disables a registered patch
505 * @patch: The registered, enabled patch to be disabled
506 *
507 * Unregisters the patched functions from ftrace.
508 *
509 * Return: 0 on success, otherwise error
510 */
511int klp_disable_patch(struct klp_patch *patch)
512{
513 int ret;
514
515 mutex_lock(&klp_mutex);
516
517 if (!klp_is_patch_registered(patch)) {
518 ret = -EINVAL;
519 goto err;
520 }
521
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600522 if (!patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600523 ret = -EINVAL;
524 goto err;
525 }
526
527 ret = __klp_disable_patch(patch);
528
529err:
530 mutex_unlock(&klp_mutex);
531 return ret;
532}
533EXPORT_SYMBOL_GPL(klp_disable_patch);
534
535static int __klp_enable_patch(struct klp_patch *patch)
536{
537 struct klp_object *obj;
538 int ret;
539
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600540 if (WARN_ON(patch->enabled))
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600541 return -EINVAL;
542
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600543 /* enforce stacking: only the first disabled patch can be enabled */
544 if (patch->list.prev != &klp_patches &&
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600545 !list_prev_entry(patch, list)->enabled)
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600546 return -EBUSY;
547
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600548 pr_notice("enabling patch '%s'\n", patch->mod->name);
549
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200550 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600551 if (!klp_is_object_loaded(obj))
552 continue;
553
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600554 ret = klp_patch_object(obj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600555 if (ret)
556 goto unregister;
557 }
558
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600559 patch->enabled = true;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600560
561 return 0;
562
563unregister:
564 WARN_ON(__klp_disable_patch(patch));
565 return ret;
566}
567
568/**
569 * klp_enable_patch() - enables a registered patch
570 * @patch: The registered, disabled patch to be enabled
571 *
572 * Performs the needed symbol lookups and code relocations,
573 * then registers the patched functions with ftrace.
574 *
575 * Return: 0 on success, otherwise error
576 */
577int klp_enable_patch(struct klp_patch *patch)
578{
579 int ret;
580
581 mutex_lock(&klp_mutex);
582
583 if (!klp_is_patch_registered(patch)) {
584 ret = -EINVAL;
585 goto err;
586 }
587
588 ret = __klp_enable_patch(patch);
589
590err:
591 mutex_unlock(&klp_mutex);
592 return ret;
593}
594EXPORT_SYMBOL_GPL(klp_enable_patch);
595
596/*
597 * Sysfs Interface
598 *
599 * /sys/kernel/livepatch
600 * /sys/kernel/livepatch/<patch>
601 * /sys/kernel/livepatch/<patch>/enabled
602 * /sys/kernel/livepatch/<patch>/<object>
Chris J Arges444f9e92015-12-01 20:40:56 -0600603 * /sys/kernel/livepatch/<patch>/<object>/<function,sympos>
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600604 */
605
606static ssize_t enabled_store(struct kobject *kobj, struct kobj_attribute *attr,
607 const char *buf, size_t count)
608{
609 struct klp_patch *patch;
610 int ret;
611 unsigned long val;
612
613 ret = kstrtoul(buf, 10, &val);
614 if (ret)
615 return -EINVAL;
616
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600617 if (val > 1)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600618 return -EINVAL;
619
620 patch = container_of(kobj, struct klp_patch, kobj);
621
622 mutex_lock(&klp_mutex);
623
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600624 if (patch->enabled == val) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600625 /* already in requested state */
626 ret = -EINVAL;
627 goto err;
628 }
629
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600630 if (val) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600631 ret = __klp_enable_patch(patch);
632 if (ret)
633 goto err;
634 } else {
635 ret = __klp_disable_patch(patch);
636 if (ret)
637 goto err;
638 }
639
640 mutex_unlock(&klp_mutex);
641
642 return count;
643
644err:
645 mutex_unlock(&klp_mutex);
646 return ret;
647}
648
649static ssize_t enabled_show(struct kobject *kobj,
650 struct kobj_attribute *attr, char *buf)
651{
652 struct klp_patch *patch;
653
654 patch = container_of(kobj, struct klp_patch, kobj);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600655 return snprintf(buf, PAGE_SIZE-1, "%d\n", patch->enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600656}
657
658static struct kobj_attribute enabled_kobj_attr = __ATTR_RW(enabled);
659static struct attribute *klp_patch_attrs[] = {
660 &enabled_kobj_attr.attr,
661 NULL
662};
663
664static void klp_kobj_release_patch(struct kobject *kobj)
665{
666 /*
667 * Once we have a consistency model we'll need to module_put() the
668 * patch module here. See klp_register_patch() for more details.
669 */
670}
671
672static struct kobj_type klp_ktype_patch = {
673 .release = klp_kobj_release_patch,
674 .sysfs_ops = &kobj_sysfs_ops,
675 .default_attrs = klp_patch_attrs,
676};
677
Miroslav Benescad706d2015-05-19 12:01:18 +0200678static void klp_kobj_release_object(struct kobject *kobj)
679{
680}
681
682static struct kobj_type klp_ktype_object = {
683 .release = klp_kobj_release_object,
684 .sysfs_ops = &kobj_sysfs_ops,
685};
686
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600687static void klp_kobj_release_func(struct kobject *kobj)
688{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600689}
690
691static struct kobj_type klp_ktype_func = {
692 .release = klp_kobj_release_func,
693 .sysfs_ops = &kobj_sysfs_ops,
694};
695
696/*
697 * Free all functions' kobjects in the array up to some limit. When limit is
698 * NULL, all kobjects are freed.
699 */
700static void klp_free_funcs_limited(struct klp_object *obj,
701 struct klp_func *limit)
702{
703 struct klp_func *func;
704
705 for (func = obj->funcs; func->old_name && func != limit; func++)
706 kobject_put(&func->kobj);
707}
708
709/* Clean up when a patched object is unloaded */
710static void klp_free_object_loaded(struct klp_object *obj)
711{
712 struct klp_func *func;
713
714 obj->mod = NULL;
715
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200716 klp_for_each_func(obj, func)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600717 func->old_addr = 0;
718}
719
720/*
721 * Free all objects' kobjects in the array up to some limit. When limit is
722 * NULL, all kobjects are freed.
723 */
724static void klp_free_objects_limited(struct klp_patch *patch,
725 struct klp_object *limit)
726{
727 struct klp_object *obj;
728
729 for (obj = patch->objs; obj->funcs && obj != limit; obj++) {
730 klp_free_funcs_limited(obj, NULL);
Miroslav Benescad706d2015-05-19 12:01:18 +0200731 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600732 }
733}
734
735static void klp_free_patch(struct klp_patch *patch)
736{
737 klp_free_objects_limited(patch, NULL);
738 if (!list_empty(&patch->list))
739 list_del(&patch->list);
740 kobject_put(&patch->kobj);
741}
742
743static int klp_init_func(struct klp_object *obj, struct klp_func *func)
744{
Miroslav Benesf09d9082016-04-28 16:34:08 +0200745 if (!func->old_name || !func->new_func)
746 return -EINVAL;
747
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600748 INIT_LIST_HEAD(&func->stack_node);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600749 func->patched = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600750
Chris J Arges444f9e92015-12-01 20:40:56 -0600751 /* The format for the sysfs directory is <function,sympos> where sympos
752 * is the nth occurrence of this symbol in kallsyms for the patched
753 * object. If the user selects 0 for old_sympos, then 1 will be used
754 * since a unique symbol will be the first occurrence.
755 */
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600756 return kobject_init_and_add(&func->kobj, &klp_ktype_func,
Chris J Arges444f9e92015-12-01 20:40:56 -0600757 &obj->kobj, "%s,%lu", func->old_name,
758 func->old_sympos ? func->old_sympos : 1);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600759}
760
Jessica Yu255e7322016-08-17 20:58:28 -0400761/* Arches may override this to finish any remaining arch-specific tasks */
762void __weak arch_klp_init_object_loaded(struct klp_patch *patch,
763 struct klp_object *obj)
764{
765}
766
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600767/* parts of the initialization that is done only when the object is loaded */
768static int klp_init_object_loaded(struct klp_patch *patch,
769 struct klp_object *obj)
770{
771 struct klp_func *func;
772 int ret;
773
Jessica Yu255e7322016-08-17 20:58:28 -0400774 module_disable_ro(patch->mod);
Jessica Yu425595a2016-03-22 20:03:18 -0400775 ret = klp_write_object_relocations(patch->mod, obj);
Jessica Yu255e7322016-08-17 20:58:28 -0400776 if (ret) {
777 module_enable_ro(patch->mod, true);
Jessica Yu425595a2016-03-22 20:03:18 -0400778 return ret;
Jessica Yu255e7322016-08-17 20:58:28 -0400779 }
780
781 arch_klp_init_object_loaded(patch, obj);
782 module_enable_ro(patch->mod, true);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600783
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200784 klp_for_each_func(obj, func) {
Chris J Argesb2b018e2015-12-01 20:40:54 -0600785 ret = klp_find_object_symbol(obj->name, func->old_name,
786 func->old_sympos,
787 &func->old_addr);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600788 if (ret)
789 return ret;
790 }
791
792 return 0;
793}
794
795static int klp_init_object(struct klp_patch *patch, struct klp_object *obj)
796{
797 struct klp_func *func;
798 int ret;
799 const char *name;
800
801 if (!obj->funcs)
802 return -EINVAL;
803
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600804 obj->patched = false;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100805 obj->mod = NULL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600806
807 klp_find_object_module(obj);
808
809 name = klp_is_module(obj) ? obj->name : "vmlinux";
Miroslav Benescad706d2015-05-19 12:01:18 +0200810 ret = kobject_init_and_add(&obj->kobj, &klp_ktype_object,
811 &patch->kobj, "%s", name);
812 if (ret)
813 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600814
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200815 klp_for_each_func(obj, func) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600816 ret = klp_init_func(obj, func);
817 if (ret)
818 goto free;
819 }
820
821 if (klp_is_object_loaded(obj)) {
822 ret = klp_init_object_loaded(patch, obj);
823 if (ret)
824 goto free;
825 }
826
827 return 0;
828
829free:
830 klp_free_funcs_limited(obj, func);
Miroslav Benescad706d2015-05-19 12:01:18 +0200831 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600832 return ret;
833}
834
835static int klp_init_patch(struct klp_patch *patch)
836{
837 struct klp_object *obj;
838 int ret;
839
840 if (!patch->objs)
841 return -EINVAL;
842
843 mutex_lock(&klp_mutex);
844
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600845 patch->enabled = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600846
847 ret = kobject_init_and_add(&patch->kobj, &klp_ktype_patch,
Jiri Kosinae0b561e2015-02-15 10:03:20 +0100848 klp_root_kobj, "%s", patch->mod->name);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600849 if (ret)
850 goto unlock;
851
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200852 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600853 ret = klp_init_object(patch, obj);
854 if (ret)
855 goto free;
856 }
857
Josh Poimboeuf99590ba2015-01-09 14:03:04 -0600858 list_add_tail(&patch->list, &klp_patches);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600859
860 mutex_unlock(&klp_mutex);
861
862 return 0;
863
864free:
865 klp_free_objects_limited(patch, obj);
866 kobject_put(&patch->kobj);
867unlock:
868 mutex_unlock(&klp_mutex);
869 return ret;
870}
871
872/**
873 * klp_unregister_patch() - unregisters a patch
874 * @patch: Disabled patch to be unregistered
875 *
876 * Frees the data structures and removes the sysfs interface.
877 *
878 * Return: 0 on success, otherwise error
879 */
880int klp_unregister_patch(struct klp_patch *patch)
881{
882 int ret = 0;
883
884 mutex_lock(&klp_mutex);
885
886 if (!klp_is_patch_registered(patch)) {
887 ret = -EINVAL;
888 goto out;
889 }
890
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600891 if (patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600892 ret = -EBUSY;
893 goto out;
894 }
895
896 klp_free_patch(patch);
897
898out:
899 mutex_unlock(&klp_mutex);
900 return ret;
901}
902EXPORT_SYMBOL_GPL(klp_unregister_patch);
903
904/**
905 * klp_register_patch() - registers a patch
906 * @patch: Patch to be registered
907 *
908 * Initializes the data structure associated with the patch and
909 * creates the sysfs interface.
910 *
911 * Return: 0 on success, otherwise error
912 */
913int klp_register_patch(struct klp_patch *patch)
914{
915 int ret;
916
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600917 if (!patch || !patch->mod)
918 return -EINVAL;
919
Jessica Yu425595a2016-03-22 20:03:18 -0400920 if (!is_livepatch_module(patch->mod)) {
921 pr_err("module %s is not marked as a livepatch module",
922 patch->mod->name);
923 return -EINVAL;
924 }
925
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600926 if (!klp_initialized())
927 return -ENODEV;
928
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600929 /*
930 * A reference is taken on the patch module to prevent it from being
931 * unloaded. Right now, we don't allow patch modules to unload since
932 * there is currently no method to determine if a thread is still
933 * running in the patched code contained in the patch module once
934 * the ftrace registration is successful.
935 */
936 if (!try_module_get(patch->mod))
937 return -ENODEV;
938
939 ret = klp_init_patch(patch);
940 if (ret)
941 module_put(patch->mod);
942
943 return ret;
944}
945EXPORT_SYMBOL_GPL(klp_register_patch);
946
Jessica Yu7e545d62016-03-16 20:55:39 -0400947int klp_module_coming(struct module *mod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600948{
Minfei Huang36e505c2015-05-15 10:22:48 +0800949 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600950 struct klp_patch *patch;
951 struct klp_object *obj;
952
Jessica Yu7e545d62016-03-16 20:55:39 -0400953 if (WARN_ON(mod->state != MODULE_STATE_COMING))
954 return -EINVAL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600955
956 mutex_lock(&klp_mutex);
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100957 /*
Jessica Yu7e545d62016-03-16 20:55:39 -0400958 * Each module has to know that klp_module_coming()
959 * has been called. We never know what module will
960 * get patched by a new patch.
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100961 */
Jessica Yu7e545d62016-03-16 20:55:39 -0400962 mod->klp_alive = true;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100963
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600964 list_for_each_entry(patch, &klp_patches, list) {
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200965 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600966 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
967 continue;
968
Jessica Yu7e545d62016-03-16 20:55:39 -0400969 obj->mod = mod;
970
971 ret = klp_init_object_loaded(patch, obj);
972 if (ret) {
973 pr_warn("failed to initialize patch '%s' for module '%s' (%d)\n",
974 patch->mod->name, obj->mod->name, ret);
975 goto err;
976 }
977
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600978 if (!patch->enabled)
Jessica Yu7e545d62016-03-16 20:55:39 -0400979 break;
980
981 pr_notice("applying patch '%s' to loading module '%s'\n",
982 patch->mod->name, obj->mod->name);
983
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600984 ret = klp_patch_object(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400985 if (ret) {
986 pr_warn("failed to apply patch '%s' to module '%s' (%d)\n",
987 patch->mod->name, obj->mod->name, ret);
988 goto err;
989 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600990
991 break;
992 }
993 }
994
995 mutex_unlock(&klp_mutex);
996
997 return 0;
Jessica Yu7e545d62016-03-16 20:55:39 -0400998
999err:
1000 /*
1001 * If a patch is unsuccessfully applied, return
1002 * error to the module loader.
1003 */
1004 pr_warn("patch '%s' failed for module '%s', refusing to load module '%s'\n",
1005 patch->mod->name, obj->mod->name, obj->mod->name);
1006 mod->klp_alive = false;
1007 klp_free_object_loaded(obj);
1008 mutex_unlock(&klp_mutex);
1009
1010 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001011}
1012
Jessica Yu7e545d62016-03-16 20:55:39 -04001013void klp_module_going(struct module *mod)
1014{
1015 struct klp_patch *patch;
1016 struct klp_object *obj;
1017
1018 if (WARN_ON(mod->state != MODULE_STATE_GOING &&
1019 mod->state != MODULE_STATE_COMING))
1020 return;
1021
1022 mutex_lock(&klp_mutex);
1023 /*
1024 * Each module has to know that klp_module_going()
1025 * has been called. We never know what module will
1026 * get patched by a new patch.
1027 */
1028 mod->klp_alive = false;
1029
1030 list_for_each_entry(patch, &klp_patches, list) {
1031 klp_for_each_object(patch, obj) {
1032 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
1033 continue;
1034
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -06001035 if (patch->enabled) {
Jessica Yu7e545d62016-03-16 20:55:39 -04001036 pr_notice("reverting patch '%s' on unloading module '%s'\n",
1037 patch->mod->name, obj->mod->name);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -06001038 klp_unpatch_object(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -04001039 }
1040
1041 klp_free_object_loaded(obj);
1042 break;
1043 }
1044 }
1045
1046 mutex_unlock(&klp_mutex);
1047}
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001048
Minfei Huang26029d82015-05-22 22:26:29 +08001049static int __init klp_init(void)
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001050{
1051 int ret;
1052
Jiri Kosinab9dfe0b2015-01-09 10:53:21 +01001053 ret = klp_check_compiler_support();
1054 if (ret) {
1055 pr_info("Your compiler is too old; turning off.\n");
1056 return -EINVAL;
1057 }
1058
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001059 klp_root_kobj = kobject_create_and_add("livepatch", kernel_kobj);
Jessica Yu7e545d62016-03-16 20:55:39 -04001060 if (!klp_root_kobj)
1061 return -ENOMEM;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001062
1063 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001064}
1065
1066module_init(klp_init);