blob: 20589da351948f5f9d005ec2087999eb09dca6ca [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 -0600281/*
282 * Sysfs Interface
283 *
284 * /sys/kernel/livepatch
285 * /sys/kernel/livepatch/<patch>
286 * /sys/kernel/livepatch/<patch>/enabled
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600287 * /sys/kernel/livepatch/<patch>/transition
Miroslav Benes43347d52017-11-15 14:50:13 +0100288 * /sys/kernel/livepatch/<patch>/signal
Miroslav Benesc99a2be2017-11-22 11:29:21 +0100289 * /sys/kernel/livepatch/<patch>/force
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600290 * /sys/kernel/livepatch/<patch>/<object>
Chris J Arges444f9e92015-12-01 20:40:56 -0600291 * /sys/kernel/livepatch/<patch>/<object>/<function,sympos>
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600292 */
Petr Mladek26c3e98e2019-01-09 13:43:20 +0100293static int __klp_disable_patch(struct klp_patch *patch);
294static int __klp_enable_patch(struct klp_patch *patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600295
296static ssize_t enabled_store(struct kobject *kobj, struct kobj_attribute *attr,
297 const char *buf, size_t count)
298{
299 struct klp_patch *patch;
300 int ret;
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600301 bool enabled;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600302
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600303 ret = kstrtobool(buf, &enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600304 if (ret)
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600305 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600306
307 patch = container_of(kobj, struct klp_patch, kobj);
308
309 mutex_lock(&klp_mutex);
310
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600311 if (!klp_is_patch_registered(patch)) {
312 /*
313 * Module with the patch could either disappear meanwhile or is
314 * not properly initialized yet.
315 */
316 ret = -EINVAL;
317 goto err;
318 }
319
Josh Poimboeuf68ae4b22017-02-13 19:42:38 -0600320 if (patch->enabled == enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600321 /* already in requested state */
322 ret = -EINVAL;
323 goto err;
324 }
325
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600326 if (patch == klp_transition_patch) {
327 klp_reverse_transition();
328 } else if (enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600329 ret = __klp_enable_patch(patch);
330 if (ret)
331 goto err;
332 } else {
333 ret = __klp_disable_patch(patch);
334 if (ret)
335 goto err;
336 }
337
338 mutex_unlock(&klp_mutex);
339
340 return count;
341
342err:
343 mutex_unlock(&klp_mutex);
344 return ret;
345}
346
347static ssize_t enabled_show(struct kobject *kobj,
348 struct kobj_attribute *attr, char *buf)
349{
350 struct klp_patch *patch;
351
352 patch = container_of(kobj, struct klp_patch, kobj);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600353 return snprintf(buf, PAGE_SIZE-1, "%d\n", patch->enabled);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600354}
355
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600356static ssize_t transition_show(struct kobject *kobj,
357 struct kobj_attribute *attr, char *buf)
358{
359 struct klp_patch *patch;
360
361 patch = container_of(kobj, struct klp_patch, kobj);
362 return snprintf(buf, PAGE_SIZE-1, "%d\n",
363 patch == klp_transition_patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600364}
365
Miroslav Benes43347d52017-11-15 14:50:13 +0100366static ssize_t signal_store(struct kobject *kobj, struct kobj_attribute *attr,
367 const char *buf, size_t count)
368{
369 struct klp_patch *patch;
370 int ret;
371 bool val;
372
Miroslav Benes43347d52017-11-15 14:50:13 +0100373 ret = kstrtobool(buf, &val);
374 if (ret)
375 return ret;
376
Miroslav Benes88690162017-12-21 14:40:43 +0100377 if (!val)
378 return count;
379
380 mutex_lock(&klp_mutex);
381
382 patch = container_of(kobj, struct klp_patch, kobj);
383 if (patch != klp_transition_patch) {
384 mutex_unlock(&klp_mutex);
385 return -EINVAL;
386 }
387
388 klp_send_signals();
389
390 mutex_unlock(&klp_mutex);
Miroslav Benes43347d52017-11-15 14:50:13 +0100391
392 return count;
393}
394
Miroslav Benesc99a2be2017-11-22 11:29:21 +0100395static ssize_t force_store(struct kobject *kobj, struct kobj_attribute *attr,
396 const char *buf, size_t count)
397{
398 struct klp_patch *patch;
399 int ret;
400 bool val;
401
Miroslav Benesc99a2be2017-11-22 11:29:21 +0100402 ret = kstrtobool(buf, &val);
403 if (ret)
404 return ret;
405
Miroslav Benes88690162017-12-21 14:40:43 +0100406 if (!val)
407 return count;
408
409 mutex_lock(&klp_mutex);
410
411 patch = container_of(kobj, struct klp_patch, kobj);
412 if (patch != klp_transition_patch) {
413 mutex_unlock(&klp_mutex);
414 return -EINVAL;
415 }
416
417 klp_force_transition();
418
419 mutex_unlock(&klp_mutex);
Miroslav Benesc99a2be2017-11-22 11:29:21 +0100420
421 return count;
422}
423
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600424static struct kobj_attribute enabled_kobj_attr = __ATTR_RW(enabled);
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600425static struct kobj_attribute transition_kobj_attr = __ATTR_RO(transition);
Miroslav Benes43347d52017-11-15 14:50:13 +0100426static struct kobj_attribute signal_kobj_attr = __ATTR_WO(signal);
Miroslav Benesc99a2be2017-11-22 11:29:21 +0100427static struct kobj_attribute force_kobj_attr = __ATTR_WO(force);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600428static struct attribute *klp_patch_attrs[] = {
429 &enabled_kobj_attr.attr,
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600430 &transition_kobj_attr.attr,
Miroslav Benes43347d52017-11-15 14:50:13 +0100431 &signal_kobj_attr.attr,
Miroslav Benesc99a2be2017-11-22 11:29:21 +0100432 &force_kobj_attr.attr,
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600433 NULL
434};
435
436static void klp_kobj_release_patch(struct kobject *kobj)
437{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600438 struct klp_patch *patch;
439
440 patch = container_of(kobj, struct klp_patch, kobj);
441 complete(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600442}
443
444static struct kobj_type klp_ktype_patch = {
445 .release = klp_kobj_release_patch,
446 .sysfs_ops = &kobj_sysfs_ops,
447 .default_attrs = klp_patch_attrs,
448};
449
Miroslav Benescad706d2015-05-19 12:01:18 +0200450static void klp_kobj_release_object(struct kobject *kobj)
451{
452}
453
454static struct kobj_type klp_ktype_object = {
455 .release = klp_kobj_release_object,
456 .sysfs_ops = &kobj_sysfs_ops,
457};
458
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600459static void klp_kobj_release_func(struct kobject *kobj)
460{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600461}
462
463static struct kobj_type klp_ktype_func = {
464 .release = klp_kobj_release_func,
465 .sysfs_ops = &kobj_sysfs_ops,
466};
467
468/*
469 * Free all functions' kobjects in the array up to some limit. When limit is
470 * NULL, all kobjects are freed.
471 */
472static void klp_free_funcs_limited(struct klp_object *obj,
473 struct klp_func *limit)
474{
475 struct klp_func *func;
476
477 for (func = obj->funcs; func->old_name && func != limit; func++)
478 kobject_put(&func->kobj);
479}
480
481/* Clean up when a patched object is unloaded */
482static void klp_free_object_loaded(struct klp_object *obj)
483{
484 struct klp_func *func;
485
486 obj->mod = NULL;
487
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200488 klp_for_each_func(obj, func)
Petr Mladek19514912019-01-09 13:43:19 +0100489 func->old_func = NULL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600490}
491
492/*
493 * Free all objects' kobjects in the array up to some limit. When limit is
494 * NULL, all kobjects are freed.
495 */
496static void klp_free_objects_limited(struct klp_patch *patch,
497 struct klp_object *limit)
498{
499 struct klp_object *obj;
500
501 for (obj = patch->objs; obj->funcs && obj != limit; obj++) {
502 klp_free_funcs_limited(obj, NULL);
Miroslav Benescad706d2015-05-19 12:01:18 +0200503 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600504 }
505}
506
507static void klp_free_patch(struct klp_patch *patch)
508{
509 klp_free_objects_limited(patch, NULL);
510 if (!list_empty(&patch->list))
511 list_del(&patch->list);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600512}
513
514static int klp_init_func(struct klp_object *obj, struct klp_func *func)
515{
Miroslav Benesf09d9082016-04-28 16:34:08 +0200516 if (!func->old_name || !func->new_func)
517 return -EINVAL;
518
Kamalesh Babulal6e9df952018-07-20 15:16:42 +0530519 if (strlen(func->old_name) >= KSYM_NAME_LEN)
520 return -EINVAL;
521
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600522 INIT_LIST_HEAD(&func->stack_node);
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600523 func->patched = false;
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600524 func->transition = false;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600525
Chris J Arges444f9e92015-12-01 20:40:56 -0600526 /* The format for the sysfs directory is <function,sympos> where sympos
527 * is the nth occurrence of this symbol in kallsyms for the patched
528 * object. If the user selects 0 for old_sympos, then 1 will be used
529 * since a unique symbol will be the first occurrence.
530 */
Josh Poimboeuf3c33f5b2015-01-20 09:26:19 -0600531 return kobject_init_and_add(&func->kobj, &klp_ktype_func,
Chris J Arges444f9e92015-12-01 20:40:56 -0600532 &obj->kobj, "%s,%lu", func->old_name,
533 func->old_sympos ? func->old_sympos : 1);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600534}
535
Jessica Yu255e7322016-08-17 20:58:28 -0400536/* Arches may override this to finish any remaining arch-specific tasks */
537void __weak arch_klp_init_object_loaded(struct klp_patch *patch,
538 struct klp_object *obj)
539{
540}
541
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600542/* parts of the initialization that is done only when the object is loaded */
543static int klp_init_object_loaded(struct klp_patch *patch,
544 struct klp_object *obj)
545{
546 struct klp_func *func;
547 int ret;
548
Jessica Yu255e7322016-08-17 20:58:28 -0400549 module_disable_ro(patch->mod);
Jessica Yu425595a2016-03-22 20:03:18 -0400550 ret = klp_write_object_relocations(patch->mod, obj);
Jessica Yu255e7322016-08-17 20:58:28 -0400551 if (ret) {
552 module_enable_ro(patch->mod, true);
Jessica Yu425595a2016-03-22 20:03:18 -0400553 return ret;
Jessica Yu255e7322016-08-17 20:58:28 -0400554 }
555
556 arch_klp_init_object_loaded(patch, obj);
557 module_enable_ro(patch->mod, true);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600558
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200559 klp_for_each_func(obj, func) {
Chris J Argesb2b018e2015-12-01 20:40:54 -0600560 ret = klp_find_object_symbol(obj->name, func->old_name,
561 func->old_sympos,
Petr Mladek19514912019-01-09 13:43:19 +0100562 (unsigned long *)&func->old_func);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600563 if (ret)
564 return ret;
Josh Poimboeuff5e547f2017-02-13 19:42:39 -0600565
Petr Mladek19514912019-01-09 13:43:19 +0100566 ret = kallsyms_lookup_size_offset((unsigned long)func->old_func,
Josh Poimboeuff5e547f2017-02-13 19:42:39 -0600567 &func->old_size, NULL);
568 if (!ret) {
569 pr_err("kallsyms size lookup failed for '%s'\n",
570 func->old_name);
571 return -ENOENT;
572 }
573
574 ret = kallsyms_lookup_size_offset((unsigned long)func->new_func,
575 &func->new_size, NULL);
576 if (!ret) {
577 pr_err("kallsyms size lookup failed for '%s' replacement\n",
578 func->old_name);
579 return -ENOENT;
580 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600581 }
582
583 return 0;
584}
585
586static int klp_init_object(struct klp_patch *patch, struct klp_object *obj)
587{
588 struct klp_func *func;
589 int ret;
590 const char *name;
591
592 if (!obj->funcs)
593 return -EINVAL;
594
Kamalesh Babulal6e9df952018-07-20 15:16:42 +0530595 if (klp_is_module(obj) && strlen(obj->name) >= MODULE_NAME_LEN)
596 return -EINVAL;
597
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600598 obj->patched = false;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100599 obj->mod = NULL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600600
601 klp_find_object_module(obj);
602
603 name = klp_is_module(obj) ? obj->name : "vmlinux";
Miroslav Benescad706d2015-05-19 12:01:18 +0200604 ret = kobject_init_and_add(&obj->kobj, &klp_ktype_object,
605 &patch->kobj, "%s", name);
606 if (ret)
607 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600608
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200609 klp_for_each_func(obj, func) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600610 ret = klp_init_func(obj, func);
611 if (ret)
612 goto free;
613 }
614
615 if (klp_is_object_loaded(obj)) {
616 ret = klp_init_object_loaded(patch, obj);
617 if (ret)
618 goto free;
619 }
620
621 return 0;
622
623free:
624 klp_free_funcs_limited(obj, func);
Miroslav Benescad706d2015-05-19 12:01:18 +0200625 kobject_put(&obj->kobj);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600626 return ret;
627}
628
629static int klp_init_patch(struct klp_patch *patch)
630{
631 struct klp_object *obj;
632 int ret;
633
634 if (!patch->objs)
635 return -EINVAL;
636
637 mutex_lock(&klp_mutex);
638
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600639 patch->enabled = false;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600640 init_completion(&patch->finish);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600641
642 ret = kobject_init_and_add(&patch->kobj, &klp_ktype_patch,
Jiri Kosinae0b561e2015-02-15 10:03:20 +0100643 klp_root_kobj, "%s", patch->mod->name);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600644 if (ret) {
645 mutex_unlock(&klp_mutex);
646 return ret;
647 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600648
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200649 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600650 ret = klp_init_object(patch, obj);
651 if (ret)
652 goto free;
653 }
654
Josh Poimboeuf99590ba2015-01-09 14:03:04 -0600655 list_add_tail(&patch->list, &klp_patches);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600656
657 mutex_unlock(&klp_mutex);
658
659 return 0;
660
661free:
662 klp_free_objects_limited(patch, obj);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600663
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600664 mutex_unlock(&klp_mutex);
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600665
666 kobject_put(&patch->kobj);
667 wait_for_completion(&patch->finish);
668
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600669 return ret;
670}
671
672/**
673 * klp_unregister_patch() - unregisters a patch
674 * @patch: Disabled patch to be unregistered
675 *
676 * Frees the data structures and removes the sysfs interface.
677 *
678 * Return: 0 on success, otherwise error
679 */
680int klp_unregister_patch(struct klp_patch *patch)
681{
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600682 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600683
684 mutex_lock(&klp_mutex);
685
686 if (!klp_is_patch_registered(patch)) {
687 ret = -EINVAL;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600688 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600689 }
690
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600691 if (patch->enabled) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600692 ret = -EBUSY;
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600693 goto err;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600694 }
695
696 klp_free_patch(patch);
697
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600698 mutex_unlock(&klp_mutex);
699
700 kobject_put(&patch->kobj);
701 wait_for_completion(&patch->finish);
702
703 return 0;
704err:
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600705 mutex_unlock(&klp_mutex);
706 return ret;
707}
708EXPORT_SYMBOL_GPL(klp_unregister_patch);
709
710/**
711 * klp_register_patch() - registers a patch
712 * @patch: Patch to be registered
713 *
714 * Initializes the data structure associated with the patch and
715 * creates the sysfs interface.
716 *
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600717 * There is no need to take the reference on the patch module here. It is done
718 * later when the patch is enabled.
719 *
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600720 * Return: 0 on success, otherwise error
721 */
722int klp_register_patch(struct klp_patch *patch)
723{
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600724 if (!patch || !patch->mod)
725 return -EINVAL;
726
Jessica Yu425595a2016-03-22 20:03:18 -0400727 if (!is_livepatch_module(patch->mod)) {
Josh Poimboeuf77f8f392017-04-13 17:59:15 -0500728 pr_err("module %s is not marked as a livepatch module\n",
Jessica Yu425595a2016-03-22 20:03:18 -0400729 patch->mod->name);
730 return -EINVAL;
731 }
732
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600733 if (!klp_initialized())
734 return -ENODEV;
735
Miroslav Benesd0807da2018-01-10 11:01:28 +0100736 if (!klp_have_reliable_stack()) {
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600737 pr_err("This architecture doesn't have support for the livepatch consistency model.\n");
738 return -ENOSYS;
739 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600740
Josh Poimboeuf3ec24772017-03-06 11:20:29 -0600741 return klp_init_patch(patch);
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600742}
743EXPORT_SYMBOL_GPL(klp_register_patch);
744
Petr Mladek26c3e98e2019-01-09 13:43:20 +0100745static int __klp_disable_patch(struct klp_patch *patch)
746{
747 struct klp_object *obj;
748
749 if (WARN_ON(!patch->enabled))
750 return -EINVAL;
751
752 if (klp_transition_patch)
753 return -EBUSY;
754
755 /* enforce stacking: only the last enabled patch can be disabled */
756 if (!list_is_last(&patch->list, &klp_patches) &&
757 list_next_entry(patch, list)->enabled)
758 return -EBUSY;
759
760 klp_init_transition(patch, KLP_UNPATCHED);
761
762 klp_for_each_object(patch, obj)
763 if (obj->patched)
764 klp_pre_unpatch_callback(obj);
765
766 /*
767 * Enforce the order of the func->transition writes in
768 * klp_init_transition() and the TIF_PATCH_PENDING writes in
769 * klp_start_transition(). In the rare case where klp_ftrace_handler()
770 * is called shortly after klp_update_patch_state() switches the task,
771 * this ensures the handler sees that func->transition is set.
772 */
773 smp_wmb();
774
775 klp_start_transition();
776 klp_try_complete_transition();
777 patch->enabled = false;
778
779 return 0;
780}
781
782/**
783 * klp_disable_patch() - disables a registered patch
784 * @patch: The registered, enabled patch to be disabled
785 *
786 * Unregisters the patched functions from ftrace.
787 *
788 * Return: 0 on success, otherwise error
789 */
790int klp_disable_patch(struct klp_patch *patch)
791{
792 int ret;
793
794 mutex_lock(&klp_mutex);
795
796 if (!klp_is_patch_registered(patch)) {
797 ret = -EINVAL;
798 goto err;
799 }
800
801 if (!patch->enabled) {
802 ret = -EINVAL;
803 goto err;
804 }
805
806 ret = __klp_disable_patch(patch);
807
808err:
809 mutex_unlock(&klp_mutex);
810 return ret;
811}
812EXPORT_SYMBOL_GPL(klp_disable_patch);
813
814static int __klp_enable_patch(struct klp_patch *patch)
815{
816 struct klp_object *obj;
817 int ret;
818
819 if (klp_transition_patch)
820 return -EBUSY;
821
822 if (WARN_ON(patch->enabled))
823 return -EINVAL;
824
825 /* enforce stacking: only the first disabled patch can be enabled */
826 if (patch->list.prev != &klp_patches &&
827 !list_prev_entry(patch, list)->enabled)
828 return -EBUSY;
829
830 /*
831 * A reference is taken on the patch module to prevent it from being
832 * unloaded.
833 */
834 if (!try_module_get(patch->mod))
835 return -ENODEV;
836
837 pr_notice("enabling patch '%s'\n", patch->mod->name);
838
839 klp_init_transition(patch, KLP_PATCHED);
840
841 /*
842 * Enforce the order of the func->transition writes in
843 * klp_init_transition() and the ops->func_stack writes in
844 * klp_patch_object(), so that klp_ftrace_handler() will see the
845 * func->transition updates before the handler is registered and the
846 * new funcs become visible to the handler.
847 */
848 smp_wmb();
849
850 klp_for_each_object(patch, obj) {
851 if (!klp_is_object_loaded(obj))
852 continue;
853
854 ret = klp_pre_patch_callback(obj);
855 if (ret) {
856 pr_warn("pre-patch callback failed for object '%s'\n",
857 klp_is_module(obj) ? obj->name : "vmlinux");
858 goto err;
859 }
860
861 ret = klp_patch_object(obj);
862 if (ret) {
863 pr_warn("failed to patch object '%s'\n",
864 klp_is_module(obj) ? obj->name : "vmlinux");
865 goto err;
866 }
867 }
868
869 klp_start_transition();
870 klp_try_complete_transition();
871 patch->enabled = true;
872
873 return 0;
874err:
875 pr_warn("failed to enable patch '%s'\n", patch->mod->name);
876
877 klp_cancel_transition();
878 return ret;
879}
880
881/**
882 * klp_enable_patch() - enables a registered patch
883 * @patch: The registered, disabled patch to be enabled
884 *
885 * Performs the needed symbol lookups and code relocations,
886 * then registers the patched functions with ftrace.
887 *
888 * Return: 0 on success, otherwise error
889 */
890int klp_enable_patch(struct klp_patch *patch)
891{
892 int ret;
893
894 mutex_lock(&klp_mutex);
895
896 if (!klp_is_patch_registered(patch)) {
897 ret = -EINVAL;
898 goto err;
899 }
900
901 ret = __klp_enable_patch(patch);
902
903err:
904 mutex_unlock(&klp_mutex);
905 return ret;
906}
907EXPORT_SYMBOL_GPL(klp_enable_patch);
908
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400909/*
910 * Remove parts of patches that touch a given kernel module. The list of
911 * patches processed might be limited. When limit is NULL, all patches
912 * will be handled.
913 */
914static void klp_cleanup_module_patches_limited(struct module *mod,
915 struct klp_patch *limit)
916{
917 struct klp_patch *patch;
918 struct klp_object *obj;
919
920 list_for_each_entry(patch, &klp_patches, list) {
921 if (patch == limit)
922 break;
923
924 klp_for_each_object(patch, obj) {
925 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
926 continue;
927
928 /*
929 * Only unpatch the module if the patch is enabled or
930 * is in transition.
931 */
932 if (patch->enabled || patch == klp_transition_patch) {
Jiri Kosinafc41efc182017-11-15 10:53:24 +0100933
934 if (patch != klp_transition_patch)
935 klp_pre_unpatch_callback(obj);
936
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400937 pr_notice("reverting patch '%s' on unloading module '%s'\n",
938 patch->mod->name, obj->mod->name);
939 klp_unpatch_object(obj);
Jiri Kosinafc41efc182017-11-15 10:53:24 +0100940
941 klp_post_unpatch_callback(obj);
Joe Lawrenceef8daf82017-10-02 11:56:48 -0400942 }
943
944 klp_free_object_loaded(obj);
945 break;
946 }
947 }
948}
949
Jessica Yu7e545d62016-03-16 20:55:39 -0400950int klp_module_coming(struct module *mod)
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600951{
Minfei Huang36e505c2015-05-15 10:22:48 +0800952 int ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600953 struct klp_patch *patch;
954 struct klp_object *obj;
955
Jessica Yu7e545d62016-03-16 20:55:39 -0400956 if (WARN_ON(mod->state != MODULE_STATE_COMING))
957 return -EINVAL;
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600958
959 mutex_lock(&klp_mutex);
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100960 /*
Jessica Yu7e545d62016-03-16 20:55:39 -0400961 * Each module has to know that klp_module_coming()
962 * has been called. We never know what module will
963 * get patched by a new patch.
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100964 */
Jessica Yu7e545d62016-03-16 20:55:39 -0400965 mod->klp_alive = true;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100966
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600967 list_for_each_entry(patch, &klp_patches, list) {
Jiri Slaby8cdd0432015-05-19 12:01:19 +0200968 klp_for_each_object(patch, obj) {
Seth Jenningsb700e7f2014-12-16 11:58:19 -0600969 if (!klp_is_module(obj) || strcmp(obj->name, mod->name))
970 continue;
971
Jessica Yu7e545d62016-03-16 20:55:39 -0400972 obj->mod = mod;
973
974 ret = klp_init_object_loaded(patch, obj);
975 if (ret) {
976 pr_warn("failed to initialize patch '%s' for module '%s' (%d)\n",
977 patch->mod->name, obj->mod->name, ret);
978 goto err;
979 }
980
Josh Poimboeufd83a7cb2017-02-13 19:42:40 -0600981 /*
982 * Only patch the module if the patch is enabled or is
983 * in transition.
984 */
985 if (!patch->enabled && patch != klp_transition_patch)
Jessica Yu7e545d62016-03-16 20:55:39 -0400986 break;
987
988 pr_notice("applying patch '%s' to loading module '%s'\n",
989 patch->mod->name, obj->mod->name);
990
Joe Lawrence93862e32017-10-13 15:08:41 -0400991 ret = klp_pre_patch_callback(obj);
992 if (ret) {
993 pr_warn("pre-patch callback failed for object '%s'\n",
994 obj->name);
995 goto err;
996 }
997
Josh Poimboeuf0dade9f2017-02-13 19:42:35 -0600998 ret = klp_patch_object(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -0400999 if (ret) {
1000 pr_warn("failed to apply patch '%s' to module '%s' (%d)\n",
1001 patch->mod->name, obj->mod->name, ret);
Joe Lawrence93862e32017-10-13 15:08:41 -04001002
Petr Mladek5aaf1ab2017-10-20 16:56:50 +02001003 klp_post_unpatch_callback(obj);
Jessica Yu7e545d62016-03-16 20:55:39 -04001004 goto err;
1005 }
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001006
Joe Lawrence93862e32017-10-13 15:08:41 -04001007 if (patch != klp_transition_patch)
1008 klp_post_patch_callback(obj);
1009
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001010 break;
1011 }
1012 }
1013
1014 mutex_unlock(&klp_mutex);
1015
1016 return 0;
Jessica Yu7e545d62016-03-16 20:55:39 -04001017
1018err:
1019 /*
1020 * If a patch is unsuccessfully applied, return
1021 * error to the module loader.
1022 */
1023 pr_warn("patch '%s' failed for module '%s', refusing to load module '%s'\n",
1024 patch->mod->name, obj->mod->name, obj->mod->name);
1025 mod->klp_alive = false;
Joe Lawrenceef8daf82017-10-02 11:56:48 -04001026 klp_cleanup_module_patches_limited(mod, patch);
Jessica Yu7e545d62016-03-16 20:55:39 -04001027 mutex_unlock(&klp_mutex);
1028
1029 return ret;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001030}
1031
Jessica Yu7e545d62016-03-16 20:55:39 -04001032void klp_module_going(struct module *mod)
1033{
Jessica Yu7e545d62016-03-16 20:55:39 -04001034 if (WARN_ON(mod->state != MODULE_STATE_GOING &&
1035 mod->state != MODULE_STATE_COMING))
1036 return;
1037
1038 mutex_lock(&klp_mutex);
1039 /*
1040 * Each module has to know that klp_module_going()
1041 * has been called. We never know what module will
1042 * get patched by a new patch.
1043 */
1044 mod->klp_alive = false;
1045
Joe Lawrenceef8daf82017-10-02 11:56:48 -04001046 klp_cleanup_module_patches_limited(mod, NULL);
Jessica Yu7e545d62016-03-16 20:55:39 -04001047
1048 mutex_unlock(&klp_mutex);
1049}
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001050
Minfei Huang26029d82015-05-22 22:26:29 +08001051static int __init klp_init(void)
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001052{
1053 int ret;
1054
Jiri Kosinab9dfe0b2015-01-09 10:53:21 +01001055 ret = klp_check_compiler_support();
1056 if (ret) {
1057 pr_info("Your compiler is too old; turning off.\n");
1058 return -EINVAL;
1059 }
1060
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001061 klp_root_kobj = kobject_create_and_add("livepatch", kernel_kobj);
Jessica Yu7e545d62016-03-16 20:55:39 -04001062 if (!klp_root_kobj)
1063 return -ENOMEM;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001064
1065 return 0;
Seth Jenningsb700e7f2014-12-16 11:58:19 -06001066}
1067
1068module_init(klp_init);