blob: de9e45dca70f6887c50f08ad3d747540f96f50f1 [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 Poimboeufc349cdca2017-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
Seth Jenningsb700e7f2014-12-16 11:58:19 -060057/* sets obj->mod if object is not vmlinux and module is found */
58static void klp_find_object_module(struct klp_object *obj)
59{
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010060 struct module *mod;
61
Seth Jenningsb700e7f2014-12-16 11:58:19 -060062 if (!klp_is_module(obj))
63 return;
64
65 mutex_lock(&module_mutex);
66 /*
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010067 * We do not want to block removal of patched modules and therefore
68 * we do not take a reference here. The patches are removed by
Jessica Yu7e545d62016-03-16 20:55:39 -040069 * klp_module_going() instead.
Seth Jenningsb700e7f2014-12-16 11:58:19 -060070 */
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010071 mod = find_module(obj->name);
72 /*
Jessica Yu7e545d62016-03-16 20:55:39 -040073 * Do not mess work of klp_module_coming() and klp_module_going().
74 * Note that the patch might still be needed before klp_module_going()
Petr Mladek8cb2c2d2015-03-12 12:55:13 +010075 * is called. Module functions can be called even in the GOING state
76 * until mod->exit() finishes. This is especially important for
77 * patches that modify semantic of the functions.
78 */
79 if (mod && mod->klp_alive)
80 obj->mod = mod;
81
Seth Jenningsb700e7f2014-12-16 11:58:19 -060082 mutex_unlock(&module_mutex);
83}
84
Seth Jenningsb700e7f2014-12-16 11:58:19 -060085static bool klp_is_patch_registered(struct klp_patch *patch)
86{
87 struct klp_patch *mypatch;
88
89 list_for_each_entry(mypatch, &klp_patches, list)
90 if (mypatch == patch)
91 return true;
92
93 return false;
94}
95
96static bool klp_initialized(void)
97{
Nicholas Mc Guiree76ff062015-05-11 07:52:29 +020098 return !!klp_root_kobj;
Seth Jenningsb700e7f2014-12-16 11:58:19 -060099}
100
101struct klp_find_arg {
102 const char *objname;
103 const char *name;
104 unsigned long addr;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600105 unsigned long count;
Chris J Argesb2b018e2015-12-01 20:40:54 -0600106 unsigned long pos;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600107};
108
109static int klp_find_callback(void *data, const char *name,
110 struct module *mod, unsigned long addr)
111{
112 struct klp_find_arg *args = data;
113
114 if ((mod && !args->objname) || (!mod && args->objname))
115 return 0;
116
117 if (strcmp(args->name, name))
118 return 0;
119
120 if (args->objname && strcmp(args->objname, mod->name))
121 return 0;
122
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600123 args->addr = addr;
124 args->count++;
125
Chris J Argesb2b018e2015-12-01 20:40:54 -0600126 /*
127 * Finish the search when the symbol is found for the desired position
128 * or the position is not defined for a non-unique symbol.
129 */
130 if ((args->pos && (args->count == args->pos)) ||
131 (!args->pos && (args->count > 1)))
132 return 1;
133
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600134 return 0;
135}
136
137static int klp_find_object_symbol(const char *objname, const char *name,
Chris J Argesb2b018e2015-12-01 20:40:54 -0600138 unsigned long sympos, unsigned long *addr)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600139{
140 struct klp_find_arg args = {
141 .objname = objname,
142 .name = name,
143 .addr = 0,
Chris J Argesb2b018e2015-12-01 20:40:54 -0600144 .count = 0,
145 .pos = sympos,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600146 };
147
Miroslav Benes9a1bd632015-06-01 17:48:37 +0200148 mutex_lock(&module_mutex);
Zhou Chengming72f04b52017-03-28 21:10:35 +0800149 if (objname)
150 module_kallsyms_on_each_symbol(klp_find_callback, &args);
151 else
152 kallsyms_on_each_symbol(klp_find_callback, &args);
Miroslav Benes9a1bd632015-06-01 17:48:37 +0200153 mutex_unlock(&module_mutex);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600154
Chris J Argesb2b018e2015-12-01 20:40:54 -0600155 /*
156 * Ensure an address was found. If sympos is 0, ensure symbol is unique;
157 * otherwise ensure the symbol position count matches sympos.
158 */
159 if (args.addr == 0)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600160 pr_err("symbol '%s' not found in symbol table\n", name);
Chris J Argesb2b018e2015-12-01 20:40:54 -0600161 else if (args.count > 1 && sympos == 0) {
Petr Mladekf995b5f2016-03-09 15:20:59 +0100162 pr_err("unresolvable ambiguity for symbol '%s' in object '%s'\n",
163 name, objname);
Chris J Argesb2b018e2015-12-01 20:40:54 -0600164 } else if (sympos != args.count && sympos > 0) {
165 pr_err("symbol position %lu for symbol '%s' in object '%s' not found\n",
166 sympos, name, objname ? objname : "vmlinux");
167 } else {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600168 *addr = args.addr;
169 return 0;
170 }
171
172 *addr = 0;
173 return -EINVAL;
174}
175
Jessica Yu425595a2016-03-22 20:03:18 -0400176static int klp_resolve_symbols(Elf_Shdr *relasec, struct module *pmod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600177{
Jessica Yu425595a2016-03-22 20:03:18 -0400178 int i, cnt, vmlinux, ret;
179 char objname[MODULE_NAME_LEN];
180 char symname[KSYM_NAME_LEN];
181 char *strtab = pmod->core_kallsyms.strtab;
182 Elf_Rela *relas;
183 Elf_Sym *sym;
184 unsigned long sympos, addr;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600185
Chris J Argesb2b018e2015-12-01 20:40:54 -0600186 /*
Jessica Yu425595a2016-03-22 20:03:18 -0400187 * Since the field widths for objname and symname in the sscanf()
188 * call are hard-coded and correspond to MODULE_NAME_LEN and
189 * KSYM_NAME_LEN respectively, we must make sure that MODULE_NAME_LEN
190 * and KSYM_NAME_LEN have the values we expect them to have.
191 *
192 * Because the value of MODULE_NAME_LEN can differ among architectures,
193 * we use the smallest/strictest upper bound possible (56, based on
194 * the current definition of MODULE_NAME_LEN) to prevent overflows.
Chris J Argesb2b018e2015-12-01 20:40:54 -0600195 */
Jessica Yu425595a2016-03-22 20:03:18 -0400196 BUILD_BUG_ON(MODULE_NAME_LEN < 56 || KSYM_NAME_LEN != 128);
197
198 relas = (Elf_Rela *) relasec->sh_addr;
199 /* For each rela in this klp relocation section */
200 for (i = 0; i < relasec->sh_size / sizeof(Elf_Rela); i++) {
201 sym = pmod->core_kallsyms.symtab + ELF_R_SYM(relas[i].r_info);
202 if (sym->st_shndx != SHN_LIVEPATCH) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500203 pr_err("symbol %s is not marked as a livepatch symbol\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400204 strtab + sym->st_name);
205 return -EINVAL;
206 }
207
208 /* Format: .klp.sym.objname.symname,sympos */
209 cnt = sscanf(strtab + sym->st_name,
210 ".klp.sym.%55[^.].%127[^,],%lu",
211 objname, symname, &sympos);
212 if (cnt != 3) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500213 pr_err("symbol %s has an incorrectly formatted name\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400214 strtab + sym->st_name);
215 return -EINVAL;
216 }
217
218 /* klp_find_object_symbol() treats a NULL objname as vmlinux */
219 vmlinux = !strcmp(objname, "vmlinux");
220 ret = klp_find_object_symbol(vmlinux ? NULL : objname,
221 symname, sympos, &addr);
222 if (ret)
223 return ret;
224
225 sym->st_value = addr;
226 }
227
228 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600229}
230
231static int klp_write_object_relocations(struct module *pmod,
232 struct klp_object *obj)
233{
Jessica Yu425595a2016-03-22 20:03:18 -0400234 int i, cnt, ret = 0;
235 const char *objname, *secname;
236 char sec_objname[MODULE_NAME_LEN];
237 Elf_Shdr *sec;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600238
239 if (WARN_ON(!klp_is_object_loaded(obj)))
240 return -EINVAL;
241
Jessica Yu425595a2016-03-22 20:03:18 -0400242 objname = klp_is_module(obj) ? obj->name : "vmlinux";
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600243
Jessica Yu425595a2016-03-22 20:03:18 -0400244 /* For each klp relocation section */
245 for (i = 1; i < pmod->klp_info->hdr.e_shnum; i++) {
246 sec = pmod->klp_info->sechdrs + i;
247 secname = pmod->klp_info->secstrings + sec->sh_name;
248 if (!(sec->sh_flags & SHF_RELA_LIVEPATCH))
249 continue;
Josh Poimboeufb56b36e2015-12-03 16:33:26 -0600250
Jessica Yu425595a2016-03-22 20:03:18 -0400251 /*
252 * Format: .klp.rela.sec_objname.section_name
253 * See comment in klp_resolve_symbols() for an explanation
254 * of the selected field width value.
255 */
256 cnt = sscanf(secname, ".klp.rela.%55[^.]", sec_objname);
257 if (cnt != 1) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500258 pr_err("section %s has an incorrectly formatted name\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400259 secname);
260 ret = -EINVAL;
261 break;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600262 }
Jessica Yu425595a2016-03-22 20:03:18 -0400263
264 if (strcmp(objname, sec_objname))
265 continue;
266
267 ret = klp_resolve_symbols(sec, pmod);
268 if (ret)
269 break;
270
271 ret = apply_relocate_add(pmod->klp_info->sechdrs,
272 pmod->core_kallsyms.strtab,
273 pmod->klp_info->symndx, i, pmod);
274 if (ret)
275 break;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600276 }
277
Josh Poimboeufb56b36e2015-12-03 16:33:26 -0600278 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600279}
280
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600281static int __klp_disable_patch(struct klp_patch *patch)
282{
Joe Lawrence93862e32017-10-13 15:08:41 -0400283 struct klp_object *obj;
284
Petr Mladek89a9a1c2017-10-20 16:56:51 +0200285 if (WARN_ON(!patch->enabled))
286 return -EINVAL;
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
Joe Lawrence93862e32017-10-13 15:08:41 -0400298 klp_for_each_object(patch, obj)
Petr Mladek89a9a1c2017-10-20 16:56:51 +0200299 if (obj->patched)
Joe Lawrence93862e32017-10-13 15:08:41 -0400300 klp_pre_unpatch_callback(obj);
301
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600302 /*
303 * Enforce the order of the func->transition writes in
304 * klp_init_transition() and the TIF_PATCH_PENDING writes in
305 * klp_start_transition(). In the rare case where klp_ftrace_handler()
306 * is called shortly after klp_update_patch_state() switches the task,
307 * this ensures the handler sees that func->transition is set.
308 */
309 smp_wmb();
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600310
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600311 klp_start_transition();
312 klp_try_complete_transition();
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600313 patch->enabled = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600314
315 return 0;
316}
317
318/**
319 * klp_disable_patch() - disables a registered patch
320 * @patch: The registered, enabled patch to be disabled
321 *
322 * Unregisters the patched functions from ftrace.
323 *
324 * Return: 0 on success, otherwise error
325 */
326int klp_disable_patch(struct klp_patch *patch)
327{
328 int ret;
329
330 mutex_lock(&klp_mutex);
331
332 if (!klp_is_patch_registered(patch)) {
333 ret = -EINVAL;
334 goto err;
335 }
336
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600337 if (!patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600338 ret = -EINVAL;
339 goto err;
340 }
341
342 ret = __klp_disable_patch(patch);
343
344err:
345 mutex_unlock(&klp_mutex);
346 return ret;
347}
348EXPORT_SYMBOL_GPL(klp_disable_patch);
349
350static int __klp_enable_patch(struct klp_patch *patch)
351{
352 struct klp_object *obj;
353 int ret;
354
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600355 if (klp_transition_patch)
356 return -EBUSY;
357
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600358 if (WARN_ON(patch->enabled))
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600359 return -EINVAL;
360
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600361 /* enforce stacking: only the first disabled patch can be enabled */
362 if (patch->list.prev != &klp_patches &&
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600363 !list_prev_entry(patch, list)->enabled)
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600364 return -EBUSY;
365
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600366 /*
367 * A reference is taken on the patch module to prevent it from being
368 * unloaded.
369 *
370 * Note: For immediate (no consistency model) patches we don't allow
371 * patch modules to unload since there is no safe/sane method to
372 * determine if a thread is still running in the patched code contained
373 * in the patch module once the ftrace registration is successful.
374 */
375 if (!try_module_get(patch->mod))
376 return -ENODEV;
377
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600378 pr_notice("enabling patch '%s'\n", patch->mod->name);
379
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600380 klp_init_transition(patch, KLP_PATCHED);
381
382 /*
383 * Enforce the order of the func->transition writes in
384 * klp_init_transition() and the ops->func_stack writes in
385 * klp_patch_object(), so that klp_ftrace_handler() will see the
386 * func->transition updates before the handler is registered and the
387 * new funcs become visible to the handler.
388 */
389 smp_wmb();
390
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200391 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600392 if (!klp_is_object_loaded(obj))
393 continue;
394
Joe Lawrence93862e32017-10-13 15:08:41 -0400395 ret = klp_pre_patch_callback(obj);
396 if (ret) {
397 pr_warn("pre-patch callback failed for object '%s'\n",
398 klp_is_module(obj) ? obj->name : "vmlinux");
399 goto err;
400 }
401
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600402 ret = klp_patch_object(obj);
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600403 if (ret) {
Joe Lawrence93862e32017-10-13 15:08:41 -0400404 pr_warn("failed to patch object '%s'\n",
405 klp_is_module(obj) ? obj->name : "vmlinux");
406 goto err;
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600407 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600408 }
409
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600410 klp_start_transition();
411 klp_try_complete_transition();
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600412 patch->enabled = true;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600413
414 return 0;
Joe Lawrence93862e32017-10-13 15:08:41 -0400415err:
416 pr_warn("failed to enable patch '%s'\n", patch->mod->name);
417
418 klp_cancel_transition();
419 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600420}
421
422/**
423 * klp_enable_patch() - enables a registered patch
424 * @patch: The registered, disabled patch to be enabled
425 *
426 * Performs the needed symbol lookups and code relocations,
427 * then registers the patched functions with ftrace.
428 *
429 * Return: 0 on success, otherwise error
430 */
431int klp_enable_patch(struct klp_patch *patch)
432{
433 int ret;
434
435 mutex_lock(&klp_mutex);
436
437 if (!klp_is_patch_registered(patch)) {
438 ret = -EINVAL;
439 goto err;
440 }
441
442 ret = __klp_enable_patch(patch);
443
444err:
445 mutex_unlock(&klp_mutex);
446 return ret;
447}
448EXPORT_SYMBOL_GPL(klp_enable_patch);
449
450/*
451 * Sysfs Interface
452 *
453 * /sys/kernel/livepatch
454 * /sys/kernel/livepatch/<patch>
455 * /sys/kernel/livepatch/<patch>/enabled
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600456 * /sys/kernel/livepatch/<patch>/transition
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600457 * /sys/kernel/livepatch/<patch>/<object>
Chris J Arges444f9e92015-12-01 20:40:56 -0600458 * /sys/kernel/livepatch/<patch>/<object>/<function,sympos>
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600459 */
460
461static ssize_t enabled_store(struct kobject *kobj, struct kobj_attribute *attr,
462 const char *buf, size_t count)
463{
464 struct klp_patch *patch;
465 int ret;
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600466 bool enabled;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600467
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600468 ret = kstrtobool(buf, &enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600469 if (ret)
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600470 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600471
472 patch = container_of(kobj, struct klp_patch, kobj);
473
474 mutex_lock(&klp_mutex);
475
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600476 if (!klp_is_patch_registered(patch)) {
477 /*
478 * Module with the patch could either disappear meanwhile or is
479 * not properly initialized yet.
480 */
481 ret = -EINVAL;
482 goto err;
483 }
484
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600485 if (patch->enabled == enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600486 /* already in requested state */
487 ret = -EINVAL;
488 goto err;
489 }
490
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600491 if (patch == klp_transition_patch) {
492 klp_reverse_transition();
493 } else if (enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600494 ret = __klp_enable_patch(patch);
495 if (ret)
496 goto err;
497 } else {
498 ret = __klp_disable_patch(patch);
499 if (ret)
500 goto err;
501 }
502
503 mutex_unlock(&klp_mutex);
504
505 return count;
506
507err:
508 mutex_unlock(&klp_mutex);
509 return ret;
510}
511
512static ssize_t enabled_show(struct kobject *kobj,
513 struct kobj_attribute *attr, char *buf)
514{
515 struct klp_patch *patch;
516
517 patch = container_of(kobj, struct klp_patch, kobj);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600518 return snprintf(buf, PAGE_SIZE-1, "%d\n", patch->enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600519}
520
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600521static ssize_t transition_show(struct kobject *kobj,
522 struct kobj_attribute *attr, char *buf)
523{
524 struct klp_patch *patch;
525
526 patch = container_of(kobj, struct klp_patch, kobj);
527 return snprintf(buf, PAGE_SIZE-1, "%d\n",
528 patch == klp_transition_patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600529}
530
531static struct kobj_attribute enabled_kobj_attr = __ATTR_RW(enabled);
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600532static struct kobj_attribute transition_kobj_attr = __ATTR_RO(transition);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600533static struct attribute *klp_patch_attrs[] = {
534 &enabled_kobj_attr.attr,
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600535 &transition_kobj_attr.attr,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600536 NULL
537};
538
539static void klp_kobj_release_patch(struct kobject *kobj)
540{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600541 struct klp_patch *patch;
542
543 patch = container_of(kobj, struct klp_patch, kobj);
544 complete(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600545}
546
547static struct kobj_type klp_ktype_patch = {
548 .release = klp_kobj_release_patch,
549 .sysfs_ops = &kobj_sysfs_ops,
550 .default_attrs = klp_patch_attrs,
551};
552
Miroslav Benescad706d2015-05-19 12:01:18 +0200553static void klp_kobj_release_object(struct kobject *kobj)
554{
555}
556
557static struct kobj_type klp_ktype_object = {
558 .release = klp_kobj_release_object,
559 .sysfs_ops = &kobj_sysfs_ops,
560};
561
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600562static void klp_kobj_release_func(struct kobject *kobj)
563{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600564}
565
566static struct kobj_type klp_ktype_func = {
567 .release = klp_kobj_release_func,
568 .sysfs_ops = &kobj_sysfs_ops,
569};
570
571/*
572 * Free all functions' kobjects in the array up to some limit. When limit is
573 * NULL, all kobjects are freed.
574 */
575static void klp_free_funcs_limited(struct klp_object *obj,
576 struct klp_func *limit)
577{
578 struct klp_func *func;
579
580 for (func = obj->funcs; func->old_name && func != limit; func++)
581 kobject_put(&func->kobj);
582}
583
584/* Clean up when a patched object is unloaded */
585static void klp_free_object_loaded(struct klp_object *obj)
586{
587 struct klp_func *func;
588
589 obj->mod = NULL;
590
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200591 klp_for_each_func(obj, func)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600592 func->old_addr = 0;
593}
594
595/*
596 * Free all objects' kobjects in the array up to some limit. When limit is
597 * NULL, all kobjects are freed.
598 */
599static void klp_free_objects_limited(struct klp_patch *patch,
600 struct klp_object *limit)
601{
602 struct klp_object *obj;
603
604 for (obj = patch->objs; obj->funcs && obj != limit; obj++) {
605 klp_free_funcs_limited(obj, NULL);
Miroslav Benescad706d2015-05-19 12:01:18 +0200606 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600607 }
608}
609
610static void klp_free_patch(struct klp_patch *patch)
611{
612 klp_free_objects_limited(patch, NULL);
613 if (!list_empty(&patch->list))
614 list_del(&patch->list);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600615}
616
617static int klp_init_func(struct klp_object *obj, struct klp_func *func)
618{
Miroslav Benesf09d9082016-04-28 16:34:08 +0200619 if (!func->old_name || !func->new_func)
620 return -EINVAL;
621
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600622 INIT_LIST_HEAD(&func->stack_node);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600623 func->patched = false;
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600624 func->transition = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600625
Chris J Arges444f9e92015-12-01 20:40:56 -0600626 /* The format for the sysfs directory is <function,sympos> where sympos
627 * is the nth occurrence of this symbol in kallsyms for the patched
628 * object. If the user selects 0 for old_sympos, then 1 will be used
629 * since a unique symbol will be the first occurrence.
630 */
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600631 return kobject_init_and_add(&func->kobj, &klp_ktype_func,
Chris J Arges444f9e92015-12-01 20:40:56 -0600632 &obj->kobj, "%s,%lu", func->old_name,
633 func->old_sympos ? func->old_sympos : 1);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600634}
635
Jessica Yu255e7322016-08-17 20:58:28 -0400636/* Arches may override this to finish any remaining arch-specific tasks */
637void __weak arch_klp_init_object_loaded(struct klp_patch *patch,
638 struct klp_object *obj)
639{
640}
641
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600642/* parts of the initialization that is done only when the object is loaded */
643static int klp_init_object_loaded(struct klp_patch *patch,
644 struct klp_object *obj)
645{
646 struct klp_func *func;
647 int ret;
648
Jessica Yu255e7322016-08-17 20:58:28 -0400649 module_disable_ro(patch->mod);
Jessica Yu425595a2016-03-22 20:03:18 -0400650 ret = klp_write_object_relocations(patch->mod, obj);
Jessica Yu255e7322016-08-17 20:58:28 -0400651 if (ret) {
652 module_enable_ro(patch->mod, true);
Jessica Yu425595a2016-03-22 20:03:18 -0400653 return ret;
Jessica Yu255e7322016-08-17 20:58:28 -0400654 }
655
656 arch_klp_init_object_loaded(patch, obj);
657 module_enable_ro(patch->mod, true);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600658
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200659 klp_for_each_func(obj, func) {
Chris J Argesb2b018e2015-12-01 20:40:54 -0600660 ret = klp_find_object_symbol(obj->name, func->old_name,
661 func->old_sympos,
662 &func->old_addr);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600663 if (ret)
664 return ret;
Josh Poimboeuff5e547f2017-02-13 19:42:39 -0600665
666 ret = kallsyms_lookup_size_offset(func->old_addr,
667 &func->old_size, NULL);
668 if (!ret) {
669 pr_err("kallsyms size lookup failed for '%s'\n",
670 func->old_name);
671 return -ENOENT;
672 }
673
674 ret = kallsyms_lookup_size_offset((unsigned long)func->new_func,
675 &func->new_size, NULL);
676 if (!ret) {
677 pr_err("kallsyms size lookup failed for '%s' replacement\n",
678 func->old_name);
679 return -ENOENT;
680 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600681 }
682
683 return 0;
684}
685
686static int klp_init_object(struct klp_patch *patch, struct klp_object *obj)
687{
688 struct klp_func *func;
689 int ret;
690 const char *name;
691
692 if (!obj->funcs)
693 return -EINVAL;
694
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600695 obj->patched = false;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100696 obj->mod = NULL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600697
698 klp_find_object_module(obj);
699
700 name = klp_is_module(obj) ? obj->name : "vmlinux";
Miroslav Benescad706d2015-05-19 12:01:18 +0200701 ret = kobject_init_and_add(&obj->kobj, &klp_ktype_object,
702 &patch->kobj, "%s", name);
703 if (ret)
704 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600705
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200706 klp_for_each_func(obj, func) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600707 ret = klp_init_func(obj, func);
708 if (ret)
709 goto free;
710 }
711
712 if (klp_is_object_loaded(obj)) {
713 ret = klp_init_object_loaded(patch, obj);
714 if (ret)
715 goto free;
716 }
717
718 return 0;
719
720free:
721 klp_free_funcs_limited(obj, func);
Miroslav Benescad706d2015-05-19 12:01:18 +0200722 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600723 return ret;
724}
725
726static int klp_init_patch(struct klp_patch *patch)
727{
728 struct klp_object *obj;
729 int ret;
730
731 if (!patch->objs)
732 return -EINVAL;
733
734 mutex_lock(&klp_mutex);
735
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600736 patch->enabled = false;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600737 init_completion(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600738
739 ret = kobject_init_and_add(&patch->kobj, &klp_ktype_patch,
Jiri Kosinae0b561e2015-02-15 10:03:20 +0100740 klp_root_kobj, "%s", patch->mod->name);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600741 if (ret) {
742 mutex_unlock(&klp_mutex);
743 return ret;
744 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600745
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200746 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600747 ret = klp_init_object(patch, obj);
748 if (ret)
749 goto free;
750 }
751
Josh Poimboeuf99590ba2015-01-09 14:03:04 -0600752 list_add_tail(&patch->list, &klp_patches);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600753
754 mutex_unlock(&klp_mutex);
755
756 return 0;
757
758free:
759 klp_free_objects_limited(patch, obj);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600760
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600761 mutex_unlock(&klp_mutex);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600762
763 kobject_put(&patch->kobj);
764 wait_for_completion(&patch->finish);
765
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600766 return ret;
767}
768
769/**
770 * klp_unregister_patch() - unregisters a patch
771 * @patch: Disabled patch to be unregistered
772 *
773 * Frees the data structures and removes the sysfs interface.
774 *
775 * Return: 0 on success, otherwise error
776 */
777int klp_unregister_patch(struct klp_patch *patch)
778{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600779 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600780
781 mutex_lock(&klp_mutex);
782
783 if (!klp_is_patch_registered(patch)) {
784 ret = -EINVAL;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600785 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600786 }
787
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600788 if (patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600789 ret = -EBUSY;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600790 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600791 }
792
793 klp_free_patch(patch);
794
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600795 mutex_unlock(&klp_mutex);
796
797 kobject_put(&patch->kobj);
798 wait_for_completion(&patch->finish);
799
800 return 0;
801err:
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600802 mutex_unlock(&klp_mutex);
803 return ret;
804}
805EXPORT_SYMBOL_GPL(klp_unregister_patch);
806
807/**
808 * klp_register_patch() - registers a patch
809 * @patch: Patch to be registered
810 *
811 * Initializes the data structure associated with the patch and
812 * creates the sysfs interface.
813 *
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600814 * There is no need to take the reference on the patch module here. It is done
815 * later when the patch is enabled.
816 *
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600817 * Return: 0 on success, otherwise error
818 */
819int klp_register_patch(struct klp_patch *patch)
820{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600821 if (!patch || !patch->mod)
822 return -EINVAL;
823
Jessica Yu425595a2016-03-22 20:03:18 -0400824 if (!is_livepatch_module(patch->mod)) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500825 pr_err("module %s is not marked as a livepatch module\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400826 patch->mod->name);
827 return -EINVAL;
828 }
829
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600830 if (!klp_initialized())
831 return -ENODEV;
832
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600833 /*
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600834 * Architectures without reliable stack traces have to set
835 * patch->immediate because there's currently no way to patch kthreads
836 * with the consistency model.
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600837 */
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600838 if (!klp_have_reliable_stack() && !patch->immediate) {
839 pr_err("This architecture doesn't have support for the livepatch consistency model.\n");
840 return -ENOSYS;
841 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600842
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600843 return klp_init_patch(patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600844}
845EXPORT_SYMBOL_GPL(klp_register_patch);
846
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400847/*
848 * Remove parts of patches that touch a given kernel module. The list of
849 * patches processed might be limited. When limit is NULL, all patches
850 * will be handled.
851 */
852static void klp_cleanup_module_patches_limited(struct module *mod,
853 struct klp_patch *limit)
854{
855 struct klp_patch *patch;
856 struct klp_object *obj;
857
858 list_for_each_entry(patch, &klp_patches, list) {
859 if (patch == limit)
860 break;
861
862 klp_for_each_object(patch, obj) {
863 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
864 continue;
865
866 /*
867 * Only unpatch the module if the patch is enabled or
868 * is in transition.
869 */
870 if (patch->enabled || patch == klp_transition_patch) {
Jiri Kosinafc41efc182017-11-15 10:53:24 +0100871
872 if (patch != klp_transition_patch)
873 klp_pre_unpatch_callback(obj);
874
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400875 pr_notice("reverting patch '%s' on unloading module '%s'\n",
876 patch->mod->name, obj->mod->name);
877 klp_unpatch_object(obj);
Jiri Kosinafc41efc182017-11-15 10:53:24 +0100878
879 klp_post_unpatch_callback(obj);
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400880 }
881
882 klp_free_object_loaded(obj);
883 break;
884 }
885 }
886}
887
Jessica Yu7e545d62016-03-16 20:55:39 -0400888int klp_module_coming(struct module *mod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600889{
Minfei Huang36e505c2015-05-15 10:22:48 +0800890 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600891 struct klp_patch *patch;
892 struct klp_object *obj;
893
Jessica Yu7e545d62016-03-16 20:55:39 -0400894 if (WARN_ON(mod->state != MODULE_STATE_COMING))
895 return -EINVAL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600896
897 mutex_lock(&klp_mutex);
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100898 /*
Jessica Yu7e545d62016-03-16 20:55:39 -0400899 * Each module has to know that klp_module_coming()
900 * has been called. We never know what module will
901 * get patched by a new patch.
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100902 */
Jessica Yu7e545d62016-03-16 20:55:39 -0400903 mod->klp_alive = true;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100904
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600905 list_for_each_entry(patch, &klp_patches, list) {
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200906 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600907 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
908 continue;
909
Jessica Yu7e545d62016-03-16 20:55:39 -0400910 obj->mod = mod;
911
912 ret = klp_init_object_loaded(patch, obj);
913 if (ret) {
914 pr_warn("failed to initialize patch '%s' for module '%s' (%d)\n",
915 patch->mod->name, obj->mod->name, ret);
916 goto err;
917 }
918
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600919 /*
920 * Only patch the module if the patch is enabled or is
921 * in transition.
922 */
923 if (!patch->enabled && patch != klp_transition_patch)
Jessica Yu7e545d62016-03-16 20:55:39 -0400924 break;
925
926 pr_notice("applying patch '%s' to loading module '%s'\n",
927 patch->mod->name, obj->mod->name);
928
Joe Lawrence93862e32017-10-13 15:08:41 -0400929 ret = klp_pre_patch_callback(obj);
930 if (ret) {
931 pr_warn("pre-patch callback failed for object '%s'\n",
932 obj->name);
933 goto err;
934 }
935
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600936 ret = klp_patch_object(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400937 if (ret) {
938 pr_warn("failed to apply patch '%s' to module '%s' (%d)\n",
939 patch->mod->name, obj->mod->name, ret);
Joe Lawrence93862e32017-10-13 15:08:41 -0400940
Petr Mladek5aaf1ab2017-10-20 16:56:50 +0200941 klp_post_unpatch_callback(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400942 goto err;
943 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600944
Joe Lawrence93862e32017-10-13 15:08:41 -0400945 if (patch != klp_transition_patch)
946 klp_post_patch_callback(obj);
947
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600948 break;
949 }
950 }
951
952 mutex_unlock(&klp_mutex);
953
954 return 0;
Jessica Yu7e545d62016-03-16 20:55:39 -0400955
956err:
957 /*
958 * If a patch is unsuccessfully applied, return
959 * error to the module loader.
960 */
961 pr_warn("patch '%s' failed for module '%s', refusing to load module '%s'\n",
962 patch->mod->name, obj->mod->name, obj->mod->name);
963 mod->klp_alive = false;
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400964 klp_cleanup_module_patches_limited(mod, patch);
Jessica Yu7e545d62016-03-16 20:55:39 -0400965 mutex_unlock(&klp_mutex);
966
967 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600968}
969
Jessica Yu7e545d62016-03-16 20:55:39 -0400970void klp_module_going(struct module *mod)
971{
Jessica Yu7e545d62016-03-16 20:55:39 -0400972 if (WARN_ON(mod->state != MODULE_STATE_GOING &&
973 mod->state != MODULE_STATE_COMING))
974 return;
975
976 mutex_lock(&klp_mutex);
977 /*
978 * Each module has to know that klp_module_going()
979 * has been called. We never know what module will
980 * get patched by a new patch.
981 */
982 mod->klp_alive = false;
983
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400984 klp_cleanup_module_patches_limited(mod, NULL);
Jessica Yu7e545d62016-03-16 20:55:39 -0400985
986 mutex_unlock(&klp_mutex);
987}
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600988
Minfei Huang26029d82015-05-22 22:26:29 +0800989static int __init klp_init(void)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600990{
991 int ret;
992
Jiri Kosinab9dfe0b2015-01-09 10:53:21 +0100993 ret = klp_check_compiler_support();
994 if (ret) {
995 pr_info("Your compiler is too old; turning off.\n");
996 return -EINVAL;
997 }
998
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600999 klp_root_kobj = kobject_create_and_add("livepatch", kernel_kobj);
Jessica Yu7e545d62016-03-16 20:55:39 -04001000 if (!klp_root_kobj)
1001 return -ENOMEM;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001002
1003 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001004}
1005
1006module_init(klp_init);