blob: eb134479c3944e676a2cc6f4be905dc6590269e0 [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
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600285 if (klp_transition_patch)
286 return -EBUSY;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600287
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600288 /* enforce stacking: only the last enabled patch can be disabled */
289 if (!list_is_last(&patch->list, &klp_patches) &&
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600290 list_next_entry(patch, list)->enabled)
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600291 return -EBUSY;
292
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600293 klp_init_transition(patch, KLP_UNPATCHED);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600294
Joe Lawrence93862e32017-10-13 15:08:41 -0400295 klp_for_each_object(patch, obj)
296 if (patch->enabled && obj->patched)
297 klp_pre_unpatch_callback(obj);
298
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600299 /*
300 * Enforce the order of the func->transition writes in
301 * klp_init_transition() and the TIF_PATCH_PENDING writes in
302 * klp_start_transition(). In the rare case where klp_ftrace_handler()
303 * is called shortly after klp_update_patch_state() switches the task,
304 * this ensures the handler sees that func->transition is set.
305 */
306 smp_wmb();
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600307
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600308 klp_start_transition();
309 klp_try_complete_transition();
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600310 patch->enabled = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600311
312 return 0;
313}
314
315/**
316 * klp_disable_patch() - disables a registered patch
317 * @patch: The registered, enabled patch to be disabled
318 *
319 * Unregisters the patched functions from ftrace.
320 *
321 * Return: 0 on success, otherwise error
322 */
323int klp_disable_patch(struct klp_patch *patch)
324{
325 int ret;
326
327 mutex_lock(&klp_mutex);
328
329 if (!klp_is_patch_registered(patch)) {
330 ret = -EINVAL;
331 goto err;
332 }
333
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600334 if (!patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600335 ret = -EINVAL;
336 goto err;
337 }
338
339 ret = __klp_disable_patch(patch);
340
341err:
342 mutex_unlock(&klp_mutex);
343 return ret;
344}
345EXPORT_SYMBOL_GPL(klp_disable_patch);
346
347static int __klp_enable_patch(struct klp_patch *patch)
348{
349 struct klp_object *obj;
350 int ret;
351
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600352 if (klp_transition_patch)
353 return -EBUSY;
354
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600355 if (WARN_ON(patch->enabled))
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600356 return -EINVAL;
357
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600358 /* enforce stacking: only the first disabled patch can be enabled */
359 if (patch->list.prev != &klp_patches &&
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600360 !list_prev_entry(patch, list)->enabled)
Josh Poimboeuf83a90bb2015-01-20 09:26:18 -0600361 return -EBUSY;
362
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600363 /*
364 * A reference is taken on the patch module to prevent it from being
365 * unloaded.
366 *
367 * Note: For immediate (no consistency model) patches we don't allow
368 * patch modules to unload since there is no safe/sane method to
369 * determine if a thread is still running in the patched code contained
370 * in the patch module once the ftrace registration is successful.
371 */
372 if (!try_module_get(patch->mod))
373 return -ENODEV;
374
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600375 pr_notice("enabling patch '%s'\n", patch->mod->name);
376
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600377 klp_init_transition(patch, KLP_PATCHED);
378
379 /*
380 * Enforce the order of the func->transition writes in
381 * klp_init_transition() and the ops->func_stack writes in
382 * klp_patch_object(), so that klp_ftrace_handler() will see the
383 * func->transition updates before the handler is registered and the
384 * new funcs become visible to the handler.
385 */
386 smp_wmb();
387
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200388 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600389 if (!klp_is_object_loaded(obj))
390 continue;
391
Joe Lawrence93862e32017-10-13 15:08:41 -0400392 ret = klp_pre_patch_callback(obj);
393 if (ret) {
394 pr_warn("pre-patch callback failed for object '%s'\n",
395 klp_is_module(obj) ? obj->name : "vmlinux");
396 goto err;
397 }
398
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600399 ret = klp_patch_object(obj);
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600400 if (ret) {
Joe Lawrence93862e32017-10-13 15:08:41 -0400401 pr_warn("failed to patch object '%s'\n",
402 klp_is_module(obj) ? obj->name : "vmlinux");
403 goto err;
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600404 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600405 }
406
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600407 klp_start_transition();
408 klp_try_complete_transition();
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600409 patch->enabled = true;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600410
411 return 0;
Joe Lawrence93862e32017-10-13 15:08:41 -0400412err:
413 pr_warn("failed to enable patch '%s'\n", patch->mod->name);
414
415 klp_cancel_transition();
416 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600417}
418
419/**
420 * klp_enable_patch() - enables a registered patch
421 * @patch: The registered, disabled patch to be enabled
422 *
423 * Performs the needed symbol lookups and code relocations,
424 * then registers the patched functions with ftrace.
425 *
426 * Return: 0 on success, otherwise error
427 */
428int klp_enable_patch(struct klp_patch *patch)
429{
430 int ret;
431
432 mutex_lock(&klp_mutex);
433
434 if (!klp_is_patch_registered(patch)) {
435 ret = -EINVAL;
436 goto err;
437 }
438
439 ret = __klp_enable_patch(patch);
440
441err:
442 mutex_unlock(&klp_mutex);
443 return ret;
444}
445EXPORT_SYMBOL_GPL(klp_enable_patch);
446
447/*
448 * Sysfs Interface
449 *
450 * /sys/kernel/livepatch
451 * /sys/kernel/livepatch/<patch>
452 * /sys/kernel/livepatch/<patch>/enabled
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600453 * /sys/kernel/livepatch/<patch>/transition
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600454 * /sys/kernel/livepatch/<patch>/<object>
Chris J Arges444f9e92015-12-01 20:40:56 -0600455 * /sys/kernel/livepatch/<patch>/<object>/<function,sympos>
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600456 */
457
458static ssize_t enabled_store(struct kobject *kobj, struct kobj_attribute *attr,
459 const char *buf, size_t count)
460{
461 struct klp_patch *patch;
462 int ret;
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600463 bool enabled;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600464
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600465 ret = kstrtobool(buf, &enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600466 if (ret)
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600467 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600468
469 patch = container_of(kobj, struct klp_patch, kobj);
470
471 mutex_lock(&klp_mutex);
472
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600473 if (!klp_is_patch_registered(patch)) {
474 /*
475 * Module with the patch could either disappear meanwhile or is
476 * not properly initialized yet.
477 */
478 ret = -EINVAL;
479 goto err;
480 }
481
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600482 if (patch->enabled == enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600483 /* already in requested state */
484 ret = -EINVAL;
485 goto err;
486 }
487
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600488 if (patch == klp_transition_patch) {
489 klp_reverse_transition();
490 } else if (enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600491 ret = __klp_enable_patch(patch);
492 if (ret)
493 goto err;
494 } else {
495 ret = __klp_disable_patch(patch);
496 if (ret)
497 goto err;
498 }
499
500 mutex_unlock(&klp_mutex);
501
502 return count;
503
504err:
505 mutex_unlock(&klp_mutex);
506 return ret;
507}
508
509static ssize_t enabled_show(struct kobject *kobj,
510 struct kobj_attribute *attr, char *buf)
511{
512 struct klp_patch *patch;
513
514 patch = container_of(kobj, struct klp_patch, kobj);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600515 return snprintf(buf, PAGE_SIZE-1, "%d\n", patch->enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600516}
517
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600518static ssize_t transition_show(struct kobject *kobj,
519 struct kobj_attribute *attr, char *buf)
520{
521 struct klp_patch *patch;
522
523 patch = container_of(kobj, struct klp_patch, kobj);
524 return snprintf(buf, PAGE_SIZE-1, "%d\n",
525 patch == klp_transition_patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600526}
527
528static struct kobj_attribute enabled_kobj_attr = __ATTR_RW(enabled);
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600529static struct kobj_attribute transition_kobj_attr = __ATTR_RO(transition);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600530static struct attribute *klp_patch_attrs[] = {
531 &enabled_kobj_attr.attr,
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600532 &transition_kobj_attr.attr,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600533 NULL
534};
535
536static void klp_kobj_release_patch(struct kobject *kobj)
537{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600538 struct klp_patch *patch;
539
540 patch = container_of(kobj, struct klp_patch, kobj);
541 complete(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600542}
543
544static struct kobj_type klp_ktype_patch = {
545 .release = klp_kobj_release_patch,
546 .sysfs_ops = &kobj_sysfs_ops,
547 .default_attrs = klp_patch_attrs,
548};
549
Miroslav Benescad706d2015-05-19 12:01:18 +0200550static void klp_kobj_release_object(struct kobject *kobj)
551{
552}
553
554static struct kobj_type klp_ktype_object = {
555 .release = klp_kobj_release_object,
556 .sysfs_ops = &kobj_sysfs_ops,
557};
558
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600559static void klp_kobj_release_func(struct kobject *kobj)
560{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600561}
562
563static struct kobj_type klp_ktype_func = {
564 .release = klp_kobj_release_func,
565 .sysfs_ops = &kobj_sysfs_ops,
566};
567
568/*
569 * Free all functions' kobjects in the array up to some limit. When limit is
570 * NULL, all kobjects are freed.
571 */
572static void klp_free_funcs_limited(struct klp_object *obj,
573 struct klp_func *limit)
574{
575 struct klp_func *func;
576
577 for (func = obj->funcs; func->old_name && func != limit; func++)
578 kobject_put(&func->kobj);
579}
580
581/* Clean up when a patched object is unloaded */
582static void klp_free_object_loaded(struct klp_object *obj)
583{
584 struct klp_func *func;
585
586 obj->mod = NULL;
587
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200588 klp_for_each_func(obj, func)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600589 func->old_addr = 0;
590}
591
592/*
593 * Free all objects' kobjects in the array up to some limit. When limit is
594 * NULL, all kobjects are freed.
595 */
596static void klp_free_objects_limited(struct klp_patch *patch,
597 struct klp_object *limit)
598{
599 struct klp_object *obj;
600
601 for (obj = patch->objs; obj->funcs && obj != limit; obj++) {
602 klp_free_funcs_limited(obj, NULL);
Miroslav Benescad706d2015-05-19 12:01:18 +0200603 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600604 }
605}
606
607static void klp_free_patch(struct klp_patch *patch)
608{
609 klp_free_objects_limited(patch, NULL);
610 if (!list_empty(&patch->list))
611 list_del(&patch->list);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600612}
613
614static int klp_init_func(struct klp_object *obj, struct klp_func *func)
615{
Miroslav Benesf09d9082016-04-28 16:34:08 +0200616 if (!func->old_name || !func->new_func)
617 return -EINVAL;
618
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600619 INIT_LIST_HEAD(&func->stack_node);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600620 func->patched = false;
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600621 func->transition = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600622
Chris J Arges444f9e92015-12-01 20:40:56 -0600623 /* The format for the sysfs directory is <function,sympos> where sympos
624 * is the nth occurrence of this symbol in kallsyms for the patched
625 * object. If the user selects 0 for old_sympos, then 1 will be used
626 * since a unique symbol will be the first occurrence.
627 */
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600628 return kobject_init_and_add(&func->kobj, &klp_ktype_func,
Chris J Arges444f9e92015-12-01 20:40:56 -0600629 &obj->kobj, "%s,%lu", func->old_name,
630 func->old_sympos ? func->old_sympos : 1);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600631}
632
Jessica Yu255e7322016-08-17 20:58:28 -0400633/* Arches may override this to finish any remaining arch-specific tasks */
634void __weak arch_klp_init_object_loaded(struct klp_patch *patch,
635 struct klp_object *obj)
636{
637}
638
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600639/* parts of the initialization that is done only when the object is loaded */
640static int klp_init_object_loaded(struct klp_patch *patch,
641 struct klp_object *obj)
642{
643 struct klp_func *func;
644 int ret;
645
Jessica Yu255e7322016-08-17 20:58:28 -0400646 module_disable_ro(patch->mod);
Jessica Yu425595a2016-03-22 20:03:18 -0400647 ret = klp_write_object_relocations(patch->mod, obj);
Jessica Yu255e7322016-08-17 20:58:28 -0400648 if (ret) {
649 module_enable_ro(patch->mod, true);
Jessica Yu425595a2016-03-22 20:03:18 -0400650 return ret;
Jessica Yu255e7322016-08-17 20:58:28 -0400651 }
652
653 arch_klp_init_object_loaded(patch, obj);
654 module_enable_ro(patch->mod, true);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600655
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200656 klp_for_each_func(obj, func) {
Chris J Argesb2b018e2015-12-01 20:40:54 -0600657 ret = klp_find_object_symbol(obj->name, func->old_name,
658 func->old_sympos,
659 &func->old_addr);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600660 if (ret)
661 return ret;
Josh Poimboeuff5e547f2017-02-13 19:42:39 -0600662
663 ret = kallsyms_lookup_size_offset(func->old_addr,
664 &func->old_size, NULL);
665 if (!ret) {
666 pr_err("kallsyms size lookup failed for '%s'\n",
667 func->old_name);
668 return -ENOENT;
669 }
670
671 ret = kallsyms_lookup_size_offset((unsigned long)func->new_func,
672 &func->new_size, NULL);
673 if (!ret) {
674 pr_err("kallsyms size lookup failed for '%s' replacement\n",
675 func->old_name);
676 return -ENOENT;
677 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600678 }
679
680 return 0;
681}
682
683static int klp_init_object(struct klp_patch *patch, struct klp_object *obj)
684{
685 struct klp_func *func;
686 int ret;
687 const char *name;
688
689 if (!obj->funcs)
690 return -EINVAL;
691
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600692 obj->patched = false;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100693 obj->mod = NULL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600694
695 klp_find_object_module(obj);
696
697 name = klp_is_module(obj) ? obj->name : "vmlinux";
Miroslav Benescad706d2015-05-19 12:01:18 +0200698 ret = kobject_init_and_add(&obj->kobj, &klp_ktype_object,
699 &patch->kobj, "%s", name);
700 if (ret)
701 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600702
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200703 klp_for_each_func(obj, func) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600704 ret = klp_init_func(obj, func);
705 if (ret)
706 goto free;
707 }
708
709 if (klp_is_object_loaded(obj)) {
710 ret = klp_init_object_loaded(patch, obj);
711 if (ret)
712 goto free;
713 }
714
715 return 0;
716
717free:
718 klp_free_funcs_limited(obj, func);
Miroslav Benescad706d2015-05-19 12:01:18 +0200719 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600720 return ret;
721}
722
723static int klp_init_patch(struct klp_patch *patch)
724{
725 struct klp_object *obj;
726 int ret;
727
728 if (!patch->objs)
729 return -EINVAL;
730
731 mutex_lock(&klp_mutex);
732
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600733 patch->enabled = false;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600734 init_completion(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600735
736 ret = kobject_init_and_add(&patch->kobj, &klp_ktype_patch,
Jiri Kosinae0b561e2015-02-15 10:03:20 +0100737 klp_root_kobj, "%s", patch->mod->name);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600738 if (ret) {
739 mutex_unlock(&klp_mutex);
740 return ret;
741 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600742
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200743 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600744 ret = klp_init_object(patch, obj);
745 if (ret)
746 goto free;
747 }
748
Josh Poimboeuf99590ba2015-01-09 14:03:04 -0600749 list_add_tail(&patch->list, &klp_patches);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600750
751 mutex_unlock(&klp_mutex);
752
753 return 0;
754
755free:
756 klp_free_objects_limited(patch, obj);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600757
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600758 mutex_unlock(&klp_mutex);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600759
760 kobject_put(&patch->kobj);
761 wait_for_completion(&patch->finish);
762
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600763 return ret;
764}
765
766/**
767 * klp_unregister_patch() - unregisters a patch
768 * @patch: Disabled patch to be unregistered
769 *
770 * Frees the data structures and removes the sysfs interface.
771 *
772 * Return: 0 on success, otherwise error
773 */
774int klp_unregister_patch(struct klp_patch *patch)
775{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600776 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600777
778 mutex_lock(&klp_mutex);
779
780 if (!klp_is_patch_registered(patch)) {
781 ret = -EINVAL;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600782 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600783 }
784
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600785 if (patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600786 ret = -EBUSY;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600787 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600788 }
789
790 klp_free_patch(patch);
791
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600792 mutex_unlock(&klp_mutex);
793
794 kobject_put(&patch->kobj);
795 wait_for_completion(&patch->finish);
796
797 return 0;
798err:
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600799 mutex_unlock(&klp_mutex);
800 return ret;
801}
802EXPORT_SYMBOL_GPL(klp_unregister_patch);
803
804/**
805 * klp_register_patch() - registers a patch
806 * @patch: Patch to be registered
807 *
808 * Initializes the data structure associated with the patch and
809 * creates the sysfs interface.
810 *
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600811 * There is no need to take the reference on the patch module here. It is done
812 * later when the patch is enabled.
813 *
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600814 * Return: 0 on success, otherwise error
815 */
816int klp_register_patch(struct klp_patch *patch)
817{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600818 if (!patch || !patch->mod)
819 return -EINVAL;
820
Jessica Yu425595a2016-03-22 20:03:18 -0400821 if (!is_livepatch_module(patch->mod)) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500822 pr_err("module %s is not marked as a livepatch module\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400823 patch->mod->name);
824 return -EINVAL;
825 }
826
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600827 if (!klp_initialized())
828 return -ENODEV;
829
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600830 /*
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600831 * Architectures without reliable stack traces have to set
832 * patch->immediate because there's currently no way to patch kthreads
833 * with the consistency model.
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600834 */
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600835 if (!klp_have_reliable_stack() && !patch->immediate) {
836 pr_err("This architecture doesn't have support for the livepatch consistency model.\n");
837 return -ENOSYS;
838 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600839
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600840 return klp_init_patch(patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600841}
842EXPORT_SYMBOL_GPL(klp_register_patch);
843
Jessica Yu7e545d62016-03-16 20:55:39 -0400844int klp_module_coming(struct module *mod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600845{
Minfei Huang36e505c2015-05-15 10:22:48 +0800846 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600847 struct klp_patch *patch;
848 struct klp_object *obj;
849
Jessica Yu7e545d62016-03-16 20:55:39 -0400850 if (WARN_ON(mod->state != MODULE_STATE_COMING))
851 return -EINVAL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600852
853 mutex_lock(&klp_mutex);
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100854 /*
Jessica Yu7e545d62016-03-16 20:55:39 -0400855 * Each module has to know that klp_module_coming()
856 * has been called. We never know what module will
857 * get patched by a new patch.
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100858 */
Jessica Yu7e545d62016-03-16 20:55:39 -0400859 mod->klp_alive = true;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100860
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600861 list_for_each_entry(patch, &klp_patches, list) {
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200862 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600863 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
864 continue;
865
Jessica Yu7e545d62016-03-16 20:55:39 -0400866 obj->mod = mod;
867
868 ret = klp_init_object_loaded(patch, obj);
869 if (ret) {
870 pr_warn("failed to initialize patch '%s' for module '%s' (%d)\n",
871 patch->mod->name, obj->mod->name, ret);
872 goto err;
873 }
874
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600875 /*
876 * Only patch the module if the patch is enabled or is
877 * in transition.
878 */
879 if (!patch->enabled && patch != klp_transition_patch)
Jessica Yu7e545d62016-03-16 20:55:39 -0400880 break;
881
882 pr_notice("applying patch '%s' to loading module '%s'\n",
883 patch->mod->name, obj->mod->name);
884
Joe Lawrence93862e32017-10-13 15:08:41 -0400885 ret = klp_pre_patch_callback(obj);
886 if (ret) {
887 pr_warn("pre-patch callback failed for object '%s'\n",
888 obj->name);
889 goto err;
890 }
891
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600892 ret = klp_patch_object(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400893 if (ret) {
894 pr_warn("failed to apply patch '%s' to module '%s' (%d)\n",
895 patch->mod->name, obj->mod->name, ret);
Joe Lawrence93862e32017-10-13 15:08:41 -0400896
Petr Mladek5aaf1ab2017-10-20 16:56:50 +0200897 klp_post_unpatch_callback(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400898 goto err;
899 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600900
Joe Lawrence93862e32017-10-13 15:08:41 -0400901 if (patch != klp_transition_patch)
902 klp_post_patch_callback(obj);
903
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600904 break;
905 }
906 }
907
908 mutex_unlock(&klp_mutex);
909
910 return 0;
Jessica Yu7e545d62016-03-16 20:55:39 -0400911
912err:
913 /*
914 * If a patch is unsuccessfully applied, return
915 * error to the module loader.
916 */
917 pr_warn("patch '%s' failed for module '%s', refusing to load module '%s'\n",
918 patch->mod->name, obj->mod->name, obj->mod->name);
919 mod->klp_alive = false;
920 klp_free_object_loaded(obj);
921 mutex_unlock(&klp_mutex);
922
923 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600924}
925
Jessica Yu7e545d62016-03-16 20:55:39 -0400926void klp_module_going(struct module *mod)
927{
928 struct klp_patch *patch;
929 struct klp_object *obj;
930
931 if (WARN_ON(mod->state != MODULE_STATE_GOING &&
932 mod->state != MODULE_STATE_COMING))
933 return;
934
935 mutex_lock(&klp_mutex);
936 /*
937 * Each module has to know that klp_module_going()
938 * has been called. We never know what module will
939 * get patched by a new patch.
940 */
941 mod->klp_alive = false;
942
943 list_for_each_entry(patch, &klp_patches, list) {
944 klp_for_each_object(patch, obj) {
945 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
946 continue;
947
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600948 /*
949 * Only unpatch the module if the patch is enabled or
950 * is in transition.
951 */
952 if (patch->enabled || patch == klp_transition_patch) {
Joe Lawrence93862e32017-10-13 15:08:41 -0400953
954 if (patch != klp_transition_patch)
955 klp_pre_unpatch_callback(obj);
956
Jessica Yu7e545d62016-03-16 20:55:39 -0400957 pr_notice("reverting patch '%s' on unloading module '%s'\n",
958 patch->mod->name, obj->mod->name);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600959 klp_unpatch_object(obj);
Joe Lawrence93862e32017-10-13 15:08:41 -0400960
961 klp_post_unpatch_callback(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400962 }
963
964 klp_free_object_loaded(obj);
965 break;
966 }
967 }
968
969 mutex_unlock(&klp_mutex);
970}
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600971
Minfei Huang26029d82015-05-22 22:26:29 +0800972static int __init klp_init(void)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600973{
974 int ret;
975
Jiri Kosinab9dfe0b2015-01-09 10:53:21 +0100976 ret = klp_check_compiler_support();
977 if (ret) {
978 pr_info("Your compiler is too old; turning off.\n");
979 return -EINVAL;
980 }
981
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600982 klp_root_kobj = kobject_create_and_add("livepatch", kernel_kobj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400983 if (!klp_root_kobj)
984 return -ENOMEM;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600985
986 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600987}
988
989module_init(klp_init);