blob: b9628e43c78f60711f8a8c21693aef5c7041f2bb [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>
Seth Jenningsb700e7f2014-12-16 11:58:19 -060027#include <linux/list.h>
28#include <linux/kallsyms.h>
29#include <linux/livepatch.h>
Jessica Yu425595a2016-03-22 20:03:18 -040030#include <linux/elf.h>
31#include <linux/moduleloader.h>
Josh Poimboeuf3ec24772017-03-06 11:20:29 -060032#include <linux/completion.h>
Josh Poimboeufb56b36e2015-12-03 16:33:26 -060033#include <asm/cacheflush.h>
Jiri Kosina10517422017-03-08 14:27:05 +010034#include "core.h"
Josh Poimboeufc349cdc2017-02-13 19:42:37 -060035#include "patch.h"
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -060036#include "transition.h"
Seth Jenningsb700e7f2014-12-16 11:58:19 -060037
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060038/*
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -060039 * 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:
42 *
43 * - klp_ftrace_handler()
44 * - klp_update_patch_state()
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060045 */
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -060046DEFINE_MUTEX(klp_mutex);
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -060047
Seth Jenningsb700e7f2014-12-16 11:58:19 -060048static LIST_HEAD(klp_patches);
49
50static struct kobject *klp_root_kobj;
51
52static bool klp_is_module(struct klp_object *obj)
53{
54 return obj->name;
55}
56
57static bool klp_is_object_loaded(struct klp_object *obj)
58{
59 return !obj->name || obj->mod;
60}
61
62/* sets obj->mod if object is not vmlinux and module is found */
63static void klp_find_object_module(struct klp_object *obj)
64{
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010065 struct module *mod;
66
Seth Jenningsb700e7f2014-12-16 11:58:19 -060067 if (!klp_is_module(obj))
68 return;
69
70 mutex_lock(&module_mutex);
71 /*
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010072 * 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
Jessica Yu7e545d62016-03-16 20:55:39 -040074 * klp_module_going() instead.
Seth Jenningsb700e7f2014-12-16 11:58:19 -060075 */
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010076 mod = find_module(obj->name);
77 /*
Jessica Yu7e545d62016-03-16 20:55:39 -040078 * 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()
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010080 * 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.
83 */
84 if (mod && mod->klp_alive)
85 obj->mod = mod;
86
Seth Jenningsb700e7f2014-12-16 11:58:19 -060087 mutex_unlock(&module_mutex);
88}
89
Seth Jenningsb700e7f2014-12-16 11:58:19 -060090static bool klp_is_patch_registered(struct klp_patch *patch)
91{
92 struct klp_patch *mypatch;
93
94 list_for_each_entry(mypatch, &klp_patches, list)
95 if (mypatch == patch)
96 return true;
97
98 return false;
99}
100
101static bool klp_initialized(void)
102{
Nicholas Mc Guiree76ff062015-05-11 07:52:29 +0200103 return !!klp_root_kobj;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600104}
105
106struct klp_find_arg {
107 const char *objname;
108 const char *name;
109 unsigned long addr;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600110 unsigned long count;
Chris J Argesb2b018e2015-12-01 20:40:54 -0600111 unsigned long pos;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600112};
113
114static int klp_find_callback(void *data, const char *name,
115 struct module *mod, unsigned long addr)
116{
117 struct klp_find_arg *args = data;
118
119 if ((mod && !args->objname) || (!mod && args->objname))
120 return 0;
121
122 if (strcmp(args->name, name))
123 return 0;
124
125 if (args->objname && strcmp(args->objname, mod->name))
126 return 0;
127
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600128 args->addr = addr;
129 args->count++;
130
Chris J Argesb2b018e2015-12-01 20:40:54 -0600131 /*
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.
134 */
135 if ((args->pos && (args->count == args->pos)) ||
136 (!args->pos && (args->count > 1)))
137 return 1;
138
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600139 return 0;
140}
141
142static int klp_find_object_symbol(const char *objname, const char *name,
Chris J Argesb2b018e2015-12-01 20:40:54 -0600143 unsigned long sympos, unsigned long *addr)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600144{
145 struct klp_find_arg args = {
146 .objname = objname,
147 .name = name,
148 .addr = 0,
Chris J Argesb2b018e2015-12-01 20:40:54 -0600149 .count = 0,
150 .pos = sympos,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600151 };
152
Miroslav Benes9a1bd632015-06-01 17:48:37 +0200153 mutex_lock(&module_mutex);
Zhou Chengming72f04b52017-03-28 21:10:35 +0800154 if (objname)
155 module_kallsyms_on_each_symbol(klp_find_callback, &args);
156 else
157 kallsyms_on_each_symbol(klp_find_callback, &args);
Miroslav Benes9a1bd632015-06-01 17:48:37 +0200158 mutex_unlock(&module_mutex);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600159
Chris J Argesb2b018e2015-12-01 20:40:54 -0600160 /*
161 * Ensure an address was found. If sympos is 0, ensure symbol is unique;
162 * otherwise ensure the symbol position count matches sympos.
163 */
164 if (args.addr == 0)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600165 pr_err("symbol '%s' not found in symbol table\n", name);
Chris J Argesb2b018e2015-12-01 20:40:54 -0600166 else if (args.count > 1 && sympos == 0) {
Petr Mladekf995b5f2016-03-09 15:20:59 +0100167 pr_err("unresolvable ambiguity for symbol '%s' in object '%s'\n",
168 name, objname);
Chris J Argesb2b018e2015-12-01 20:40:54 -0600169 } 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");
172 } else {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600173 *addr = args.addr;
174 return 0;
175 }
176
177 *addr = 0;
178 return -EINVAL;
179}
180
Jessica Yu425595a2016-03-22 20:03:18 -0400181static int klp_resolve_symbols(Elf_Shdr *relasec, struct module *pmod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600182{
Jessica Yu425595a2016-03-22 20:03:18 -0400183 int i, cnt, vmlinux, ret;
184 char objname[MODULE_NAME_LEN];
185 char symname[KSYM_NAME_LEN];
186 char *strtab = pmod->core_kallsyms.strtab;
187 Elf_Rela *relas;
188 Elf_Sym *sym;
189 unsigned long sympos, addr;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600190
Chris J Argesb2b018e2015-12-01 20:40:54 -0600191 /*
Jessica Yu425595a2016-03-22 20:03:18 -0400192 * 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.
196 *
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.
Chris J Argesb2b018e2015-12-01 20:40:54 -0600200 */
Jessica Yu425595a2016-03-22 20:03:18 -0400201 BUILD_BUG_ON(MODULE_NAME_LEN < 56 || KSYM_NAME_LEN != 128);
202
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) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500208 pr_err("symbol %s is not marked as a livepatch symbol\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400209 strtab + sym->st_name);
210 return -EINVAL;
211 }
212
213 /* Format: .klp.sym.objname.symname,sympos */
214 cnt = sscanf(strtab + sym->st_name,
215 ".klp.sym.%55[^.].%127[^,],%lu",
216 objname, symname, &sympos);
217 if (cnt != 3) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500218 pr_err("symbol %s has an incorrectly formatted name\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400219 strtab + sym->st_name);
220 return -EINVAL;
221 }
222
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);
227 if (ret)
228 return ret;
229
230 sym->st_value = addr;
231 }
232
233 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600234}
235
236static int klp_write_object_relocations(struct module *pmod,
237 struct klp_object *obj)
238{
Jessica Yu425595a2016-03-22 20:03:18 -0400239 int i, cnt, ret = 0;
240 const char *objname, *secname;
241 char sec_objname[MODULE_NAME_LEN];
242 Elf_Shdr *sec;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600243
244 if (WARN_ON(!klp_is_object_loaded(obj)))
245 return -EINVAL;
246
Jessica Yu425595a2016-03-22 20:03:18 -0400247 objname = klp_is_module(obj) ? obj->name : "vmlinux";
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600248
Jessica Yu425595a2016-03-22 20:03:18 -0400249 /* 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))
254 continue;
Josh Poimboeufb56b36e2015-12-03 16:33:26 -0600255
Jessica Yu425595a2016-03-22 20:03:18 -0400256 /*
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.
260 */
261 cnt = sscanf(secname, ".klp.rela.%55[^.]", sec_objname);
262 if (cnt != 1) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500263 pr_err("section %s has an incorrectly formatted name\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400264 secname);
265 ret = -EINVAL;
266 break;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600267 }
Jessica Yu425595a2016-03-22 20:03:18 -0400268
269 if (strcmp(objname, sec_objname))
270 continue;
271
272 ret = klp_resolve_symbols(sec, pmod);
273 if (ret)
274 break;
275
276 ret = apply_relocate_add(pmod->klp_info->sechdrs,
277 pmod->core_kallsyms.strtab,
278 pmod->klp_info->symndx, i, pmod);
279 if (ret)
280 break;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600281 }
282
Josh Poimboeufb56b36e2015-12-03 16:33:26 -0600283 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600284}
285
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600286static int __klp_disable_patch(struct klp_patch *patch)
287{
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600288 if (klp_transition_patch)
289 return -EBUSY;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600290
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600291 /* enforce stacking: only the last enabled patch can be disabled */
292 if (!list_is_last(&patch->list, &klp_patches) &&
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600293 list_next_entry(patch, list)->enabled)
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600294 return -EBUSY;
295
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600296 klp_init_transition(patch, KLP_UNPATCHED);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600297
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600298 /*
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.
304 */
305 smp_wmb();
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600306
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600307 klp_start_transition();
308 klp_try_complete_transition();
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600309 patch->enabled = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600310
311 return 0;
312}
313
314/**
315 * klp_disable_patch() - disables a registered patch
316 * @patch: The registered, enabled patch to be disabled
317 *
318 * Unregisters the patched functions from ftrace.
319 *
320 * Return: 0 on success, otherwise error
321 */
322int klp_disable_patch(struct klp_patch *patch)
323{
324 int ret;
325
326 mutex_lock(&klp_mutex);
327
328 if (!klp_is_patch_registered(patch)) {
329 ret = -EINVAL;
330 goto err;
331 }
332
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600333 if (!patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600334 ret = -EINVAL;
335 goto err;
336 }
337
338 ret = __klp_disable_patch(patch);
339
340err:
341 mutex_unlock(&klp_mutex);
342 return ret;
343}
344EXPORT_SYMBOL_GPL(klp_disable_patch);
345
346static int __klp_enable_patch(struct klp_patch *patch)
347{
348 struct klp_object *obj;
349 int ret;
350
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600351 if (klp_transition_patch)
352 return -EBUSY;
353
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600354 if (WARN_ON(patch->enabled))
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600355 return -EINVAL;
356
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600357 /* enforce stacking: only the first disabled patch can be enabled */
358 if (patch->list.prev != &klp_patches &&
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600359 !list_prev_entry(patch, list)->enabled)
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600360 return -EBUSY;
361
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600362 /*
363 * A reference is taken on the patch module to prevent it from being
364 * unloaded.
365 *
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.
370 */
371 if (!try_module_get(patch->mod))
372 return -ENODEV;
373
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600374 pr_notice("enabling patch '%s'\n", patch->mod->name);
375
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600376 klp_init_transition(patch, KLP_PATCHED);
377
378 /*
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.
384 */
385 smp_wmb();
386
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200387 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600388 if (!klp_is_object_loaded(obj))
389 continue;
390
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600391 ret = klp_patch_object(obj);
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600392 if (ret) {
393 pr_warn("failed to enable patch '%s'\n",
394 patch->mod->name);
395
396 klp_cancel_transition();
397 return ret;
398 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600399 }
400
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600401 klp_start_transition();
402 klp_try_complete_transition();
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600403 patch->enabled = true;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600404
405 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600406}
407
408/**
409 * klp_enable_patch() - enables a registered patch
410 * @patch: The registered, disabled patch to be enabled
411 *
412 * Performs the needed symbol lookups and code relocations,
413 * then registers the patched functions with ftrace.
414 *
415 * Return: 0 on success, otherwise error
416 */
417int klp_enable_patch(struct klp_patch *patch)
418{
419 int ret;
420
421 mutex_lock(&klp_mutex);
422
423 if (!klp_is_patch_registered(patch)) {
424 ret = -EINVAL;
425 goto err;
426 }
427
428 ret = __klp_enable_patch(patch);
429
430err:
431 mutex_unlock(&klp_mutex);
432 return ret;
433}
434EXPORT_SYMBOL_GPL(klp_enable_patch);
435
436/*
437 * Sysfs Interface
438 *
439 * /sys/kernel/livepatch
440 * /sys/kernel/livepatch/<patch>
441 * /sys/kernel/livepatch/<patch>/enabled
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600442 * /sys/kernel/livepatch/<patch>/transition
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600443 * /sys/kernel/livepatch/<patch>/<object>
Chris J Arges444f9e92015-12-01 20:40:56 -0600444 * /sys/kernel/livepatch/<patch>/<object>/<function,sympos>
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600445 */
446
447static ssize_t enabled_store(struct kobject *kobj, struct kobj_attribute *attr,
448 const char *buf, size_t count)
449{
450 struct klp_patch *patch;
451 int ret;
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600452 bool enabled;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600453
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600454 ret = kstrtobool(buf, &enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600455 if (ret)
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600456 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600457
458 patch = container_of(kobj, struct klp_patch, kobj);
459
460 mutex_lock(&klp_mutex);
461
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600462 if (!klp_is_patch_registered(patch)) {
463 /*
464 * Module with the patch could either disappear meanwhile or is
465 * not properly initialized yet.
466 */
467 ret = -EINVAL;
468 goto err;
469 }
470
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600471 if (patch->enabled == enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600472 /* already in requested state */
473 ret = -EINVAL;
474 goto err;
475 }
476
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600477 if (patch == klp_transition_patch) {
478 klp_reverse_transition();
479 } else if (enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600480 ret = __klp_enable_patch(patch);
481 if (ret)
482 goto err;
483 } else {
484 ret = __klp_disable_patch(patch);
485 if (ret)
486 goto err;
487 }
488
489 mutex_unlock(&klp_mutex);
490
491 return count;
492
493err:
494 mutex_unlock(&klp_mutex);
495 return ret;
496}
497
498static ssize_t enabled_show(struct kobject *kobj,
499 struct kobj_attribute *attr, char *buf)
500{
501 struct klp_patch *patch;
502
503 patch = container_of(kobj, struct klp_patch, kobj);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600504 return snprintf(buf, PAGE_SIZE-1, "%d\n", patch->enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600505}
506
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600507static ssize_t transition_show(struct kobject *kobj,
508 struct kobj_attribute *attr, char *buf)
509{
510 struct klp_patch *patch;
511
512 patch = container_of(kobj, struct klp_patch, kobj);
513 return snprintf(buf, PAGE_SIZE-1, "%d\n",
514 patch == klp_transition_patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600515}
516
517static struct kobj_attribute enabled_kobj_attr = __ATTR_RW(enabled);
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600518static struct kobj_attribute transition_kobj_attr = __ATTR_RO(transition);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600519static struct attribute *klp_patch_attrs[] = {
520 &enabled_kobj_attr.attr,
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600521 &transition_kobj_attr.attr,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600522 NULL
523};
524
525static void klp_kobj_release_patch(struct kobject *kobj)
526{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600527 struct klp_patch *patch;
528
529 patch = container_of(kobj, struct klp_patch, kobj);
530 complete(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600531}
532
533static struct kobj_type klp_ktype_patch = {
534 .release = klp_kobj_release_patch,
535 .sysfs_ops = &kobj_sysfs_ops,
536 .default_attrs = klp_patch_attrs,
537};
538
Miroslav Benescad706d2015-05-19 12:01:18 +0200539static void klp_kobj_release_object(struct kobject *kobj)
540{
541}
542
543static struct kobj_type klp_ktype_object = {
544 .release = klp_kobj_release_object,
545 .sysfs_ops = &kobj_sysfs_ops,
546};
547
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600548static void klp_kobj_release_func(struct kobject *kobj)
549{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600550}
551
552static struct kobj_type klp_ktype_func = {
553 .release = klp_kobj_release_func,
554 .sysfs_ops = &kobj_sysfs_ops,
555};
556
557/*
558 * Free all functions' kobjects in the array up to some limit. When limit is
559 * NULL, all kobjects are freed.
560 */
561static void klp_free_funcs_limited(struct klp_object *obj,
562 struct klp_func *limit)
563{
564 struct klp_func *func;
565
566 for (func = obj->funcs; func->old_name && func != limit; func++)
567 kobject_put(&func->kobj);
568}
569
570/* Clean up when a patched object is unloaded */
571static void klp_free_object_loaded(struct klp_object *obj)
572{
573 struct klp_func *func;
574
575 obj->mod = NULL;
576
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200577 klp_for_each_func(obj, func)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600578 func->old_addr = 0;
579}
580
581/*
582 * Free all objects' kobjects in the array up to some limit. When limit is
583 * NULL, all kobjects are freed.
584 */
585static void klp_free_objects_limited(struct klp_patch *patch,
586 struct klp_object *limit)
587{
588 struct klp_object *obj;
589
590 for (obj = patch->objs; obj->funcs && obj != limit; obj++) {
591 klp_free_funcs_limited(obj, NULL);
Miroslav Benescad706d2015-05-19 12:01:18 +0200592 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600593 }
594}
595
596static void klp_free_patch(struct klp_patch *patch)
597{
598 klp_free_objects_limited(patch, NULL);
599 if (!list_empty(&patch->list))
600 list_del(&patch->list);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600601}
602
603static int klp_init_func(struct klp_object *obj, struct klp_func *func)
604{
Miroslav Benesf09d9082016-04-28 16:34:08 +0200605 if (!func->old_name || !func->new_func)
606 return -EINVAL;
607
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600608 INIT_LIST_HEAD(&func->stack_node);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600609 func->patched = false;
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600610 func->transition = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600611
Chris J Arges444f9e92015-12-01 20:40:56 -0600612 /* 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.
616 */
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600617 return kobject_init_and_add(&func->kobj, &klp_ktype_func,
Chris J Arges444f9e92015-12-01 20:40:56 -0600618 &obj->kobj, "%s,%lu", func->old_name,
619 func->old_sympos ? func->old_sympos : 1);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600620}
621
Jessica Yu255e7322016-08-17 20:58:28 -0400622/* Arches may override this to finish any remaining arch-specific tasks */
623void __weak arch_klp_init_object_loaded(struct klp_patch *patch,
624 struct klp_object *obj)
625{
626}
627
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600628/* parts of the initialization that is done only when the object is loaded */
629static int klp_init_object_loaded(struct klp_patch *patch,
630 struct klp_object *obj)
631{
632 struct klp_func *func;
633 int ret;
634
Jessica Yu255e7322016-08-17 20:58:28 -0400635 module_disable_ro(patch->mod);
Jessica Yu425595a2016-03-22 20:03:18 -0400636 ret = klp_write_object_relocations(patch->mod, obj);
Jessica Yu255e7322016-08-17 20:58:28 -0400637 if (ret) {
638 module_enable_ro(patch->mod, true);
Jessica Yu425595a2016-03-22 20:03:18 -0400639 return ret;
Jessica Yu255e7322016-08-17 20:58:28 -0400640 }
641
642 arch_klp_init_object_loaded(patch, obj);
643 module_enable_ro(patch->mod, true);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600644
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200645 klp_for_each_func(obj, func) {
Chris J Argesb2b018e2015-12-01 20:40:54 -0600646 ret = klp_find_object_symbol(obj->name, func->old_name,
647 func->old_sympos,
648 &func->old_addr);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600649 if (ret)
650 return ret;
Josh Poimboeuff5e547f2017-02-13 19:42:39 -0600651
652 ret = kallsyms_lookup_size_offset(func->old_addr,
653 &func->old_size, NULL);
654 if (!ret) {
655 pr_err("kallsyms size lookup failed for '%s'\n",
656 func->old_name);
657 return -ENOENT;
658 }
659
660 ret = kallsyms_lookup_size_offset((unsigned long)func->new_func,
661 &func->new_size, NULL);
662 if (!ret) {
663 pr_err("kallsyms size lookup failed for '%s' replacement\n",
664 func->old_name);
665 return -ENOENT;
666 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600667 }
668
669 return 0;
670}
671
672static int klp_init_object(struct klp_patch *patch, struct klp_object *obj)
673{
674 struct klp_func *func;
675 int ret;
676 const char *name;
677
678 if (!obj->funcs)
679 return -EINVAL;
680
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600681 obj->patched = false;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100682 obj->mod = NULL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600683
684 klp_find_object_module(obj);
685
686 name = klp_is_module(obj) ? obj->name : "vmlinux";
Miroslav Benescad706d2015-05-19 12:01:18 +0200687 ret = kobject_init_and_add(&obj->kobj, &klp_ktype_object,
688 &patch->kobj, "%s", name);
689 if (ret)
690 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600691
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200692 klp_for_each_func(obj, func) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600693 ret = klp_init_func(obj, func);
694 if (ret)
695 goto free;
696 }
697
698 if (klp_is_object_loaded(obj)) {
699 ret = klp_init_object_loaded(patch, obj);
700 if (ret)
701 goto free;
702 }
703
704 return 0;
705
706free:
707 klp_free_funcs_limited(obj, func);
Miroslav Benescad706d2015-05-19 12:01:18 +0200708 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600709 return ret;
710}
711
712static int klp_init_patch(struct klp_patch *patch)
713{
714 struct klp_object *obj;
715 int ret;
716
717 if (!patch->objs)
718 return -EINVAL;
719
720 mutex_lock(&klp_mutex);
721
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600722 patch->enabled = false;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600723 init_completion(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600724
725 ret = kobject_init_and_add(&patch->kobj, &klp_ktype_patch,
Jiri Kosinae0b561e2015-02-15 10:03:20 +0100726 klp_root_kobj, "%s", patch->mod->name);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600727 if (ret) {
728 mutex_unlock(&klp_mutex);
729 return ret;
730 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600731
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200732 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600733 ret = klp_init_object(patch, obj);
734 if (ret)
735 goto free;
736 }
737
Josh Poimboeuf99590ba2015-01-09 14:03:04 -0600738 list_add_tail(&patch->list, &klp_patches);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600739
740 mutex_unlock(&klp_mutex);
741
742 return 0;
743
744free:
745 klp_free_objects_limited(patch, obj);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600746
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600747 mutex_unlock(&klp_mutex);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600748
749 kobject_put(&patch->kobj);
750 wait_for_completion(&patch->finish);
751
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600752 return ret;
753}
754
755/**
756 * klp_unregister_patch() - unregisters a patch
757 * @patch: Disabled patch to be unregistered
758 *
759 * Frees the data structures and removes the sysfs interface.
760 *
761 * Return: 0 on success, otherwise error
762 */
763int klp_unregister_patch(struct klp_patch *patch)
764{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600765 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600766
767 mutex_lock(&klp_mutex);
768
769 if (!klp_is_patch_registered(patch)) {
770 ret = -EINVAL;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600771 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600772 }
773
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600774 if (patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600775 ret = -EBUSY;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600776 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600777 }
778
779 klp_free_patch(patch);
780
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600781 mutex_unlock(&klp_mutex);
782
783 kobject_put(&patch->kobj);
784 wait_for_completion(&patch->finish);
785
786 return 0;
787err:
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600788 mutex_unlock(&klp_mutex);
789 return ret;
790}
791EXPORT_SYMBOL_GPL(klp_unregister_patch);
792
793/**
794 * klp_register_patch() - registers a patch
795 * @patch: Patch to be registered
796 *
797 * Initializes the data structure associated with the patch and
798 * creates the sysfs interface.
799 *
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600800 * There is no need to take the reference on the patch module here. It is done
801 * later when the patch is enabled.
802 *
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600803 * Return: 0 on success, otherwise error
804 */
805int klp_register_patch(struct klp_patch *patch)
806{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600807 if (!patch || !patch->mod)
808 return -EINVAL;
809
Jessica Yu425595a2016-03-22 20:03:18 -0400810 if (!is_livepatch_module(patch->mod)) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500811 pr_err("module %s is not marked as a livepatch module\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400812 patch->mod->name);
813 return -EINVAL;
814 }
815
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600816 if (!klp_initialized())
817 return -ENODEV;
818
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600819 /*
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600820 * 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.
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600823 */
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600824 if (!klp_have_reliable_stack() && !patch->immediate) {
825 pr_err("This architecture doesn't have support for the livepatch consistency model.\n");
826 return -ENOSYS;
827 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600828
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600829 return klp_init_patch(patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600830}
831EXPORT_SYMBOL_GPL(klp_register_patch);
832
Jessica Yu7e545d62016-03-16 20:55:39 -0400833int klp_module_coming(struct module *mod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600834{
Minfei Huang36e505c2015-05-15 10:22:48 +0800835 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600836 struct klp_patch *patch;
837 struct klp_object *obj;
838
Jessica Yu7e545d62016-03-16 20:55:39 -0400839 if (WARN_ON(mod->state != MODULE_STATE_COMING))
840 return -EINVAL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600841
842 mutex_lock(&klp_mutex);
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100843 /*
Jessica Yu7e545d62016-03-16 20:55:39 -0400844 * Each module has to know that klp_module_coming()
845 * has been called. We never know what module will
846 * get patched by a new patch.
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100847 */
Jessica Yu7e545d62016-03-16 20:55:39 -0400848 mod->klp_alive = true;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100849
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600850 list_for_each_entry(patch, &klp_patches, list) {
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200851 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600852 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
853 continue;
854
Jessica Yu7e545d62016-03-16 20:55:39 -0400855 obj->mod = mod;
856
857 ret = klp_init_object_loaded(patch, obj);
858 if (ret) {
859 pr_warn("failed to initialize patch '%s' for module '%s' (%d)\n",
860 patch->mod->name, obj->mod->name, ret);
861 goto err;
862 }
863
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600864 /*
865 * Only patch the module if the patch is enabled or is
866 * in transition.
867 */
868 if (!patch->enabled && patch != klp_transition_patch)
Jessica Yu7e545d62016-03-16 20:55:39 -0400869 break;
870
871 pr_notice("applying patch '%s' to loading module '%s'\n",
872 patch->mod->name, obj->mod->name);
873
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600874 ret = klp_patch_object(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400875 if (ret) {
876 pr_warn("failed to apply patch '%s' to module '%s' (%d)\n",
877 patch->mod->name, obj->mod->name, ret);
878 goto err;
879 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600880
881 break;
882 }
883 }
884
885 mutex_unlock(&klp_mutex);
886
887 return 0;
Jessica Yu7e545d62016-03-16 20:55:39 -0400888
889err:
890 /*
891 * If a patch is unsuccessfully applied, return
892 * error to the module loader.
893 */
894 pr_warn("patch '%s' failed for module '%s', refusing to load module '%s'\n",
895 patch->mod->name, obj->mod->name, obj->mod->name);
896 mod->klp_alive = false;
897 klp_free_object_loaded(obj);
898 mutex_unlock(&klp_mutex);
899
900 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600901}
902
Jessica Yu7e545d62016-03-16 20:55:39 -0400903void klp_module_going(struct module *mod)
904{
905 struct klp_patch *patch;
906 struct klp_object *obj;
907
908 if (WARN_ON(mod->state != MODULE_STATE_GOING &&
909 mod->state != MODULE_STATE_COMING))
910 return;
911
912 mutex_lock(&klp_mutex);
913 /*
914 * Each module has to know that klp_module_going()
915 * has been called. We never know what module will
916 * get patched by a new patch.
917 */
918 mod->klp_alive = false;
919
920 list_for_each_entry(patch, &klp_patches, list) {
921 klp_for_each_object(patch, obj) {
922 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
923 continue;
924
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600925 /*
926 * Only unpatch the module if the patch is enabled or
927 * is in transition.
928 */
929 if (patch->enabled || patch == klp_transition_patch) {
Jessica Yu7e545d62016-03-16 20:55:39 -0400930 pr_notice("reverting patch '%s' on unloading module '%s'\n",
931 patch->mod->name, obj->mod->name);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600932 klp_unpatch_object(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400933 }
934
935 klp_free_object_loaded(obj);
936 break;
937 }
938 }
939
940 mutex_unlock(&klp_mutex);
941}
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600942
Minfei Huang26029d82015-05-22 22:26:29 +0800943static int __init klp_init(void)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600944{
945 int ret;
946
Jiri Kosinab9dfe0b2015-01-09 10:53:21 +0100947 ret = klp_check_compiler_support();
948 if (ret) {
949 pr_info("Your compiler is too old; turning off.\n");
950 return -EINVAL;
951 }
952
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600953 klp_root_kobj = kobject_create_and_add("livepatch", kernel_kobj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400954 if (!klp_root_kobj)
955 return -ENOMEM;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600956
957 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600958}
959
960module_init(klp_init);