klp: remove CONFIG_LIVEPATCH dependency from klp headers
[sfrench/cifs-2.6.git] / include / linux / livepatch.h
1 /*
2  * livepatch.h - 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 #ifndef _LINUX_LIVEPATCH_H_
22 #define _LINUX_LIVEPATCH_H_
23
24 #include <linux/module.h>
25 #include <linux/ftrace.h>
26
27 #include <asm/livepatch.h>
28
29 enum klp_state {
30         KLP_DISABLED,
31         KLP_ENABLED
32 };
33
34 /**
35  * struct klp_func - function structure for live patching
36  * @old_name:   name of the function to be patched
37  * @new_func:   pointer to the patched function code
38  * @old_sympos: a hint indicating which symbol position the old function
39  *              can be found (optional)
40  * @old_addr:   the address of the function being patched
41  * @kobj:       kobject for sysfs resources
42  * @state:      tracks function-level patch application state
43  * @stack_node: list node for klp_ops func_stack list
44  */
45 struct klp_func {
46         /* external */
47         const char *old_name;
48         void *new_func;
49         /*
50          * The old_sympos field is optional and can be used to resolve
51          * duplicate symbol names in livepatch objects. If this field is zero,
52          * it is expected the symbol is unique, otherwise patching fails. If
53          * this value is greater than zero then that occurrence of the symbol
54          * in kallsyms for the given object is used.
55          */
56         unsigned long old_sympos;
57
58         /* internal */
59         unsigned long old_addr;
60         struct kobject kobj;
61         enum klp_state state;
62         struct list_head stack_node;
63 };
64
65 /**
66  * struct klp_reloc - relocation structure for live patching
67  * @loc:        address where the relocation will be written
68  * @sympos:     position in kallsyms to disambiguate symbols (optional)
69  * @type:       ELF relocation type
70  * @name:       name of the referenced symbol (for lookup/verification)
71  * @addend:     offset from the referenced symbol
72  * @external:   symbol is either exported or within the live patch module itself
73  */
74 struct klp_reloc {
75         unsigned long loc;
76         unsigned long sympos;
77         unsigned long type;
78         const char *name;
79         int addend;
80         int external;
81 };
82
83 /**
84  * struct klp_object - kernel object structure for live patching
85  * @name:       module name (or NULL for vmlinux)
86  * @relocs:     relocation entries to be applied at load time
87  * @funcs:      function entries for functions to be patched in the object
88  * @kobj:       kobject for sysfs resources
89  * @mod:        kernel module associated with the patched object
90  *              (NULL for vmlinux)
91  * @state:      tracks object-level patch application state
92  */
93 struct klp_object {
94         /* external */
95         const char *name;
96         struct klp_reloc *relocs;
97         struct klp_func *funcs;
98
99         /* internal */
100         struct kobject kobj;
101         struct module *mod;
102         enum klp_state state;
103 };
104
105 /**
106  * struct klp_patch - patch structure for live patching
107  * @mod:        reference to the live patch module
108  * @objs:       object entries for kernel objects to be patched
109  * @list:       list node for global list of registered patches
110  * @kobj:       kobject for sysfs resources
111  * @state:      tracks patch-level application state
112  */
113 struct klp_patch {
114         /* external */
115         struct module *mod;
116         struct klp_object *objs;
117
118         /* internal */
119         struct list_head list;
120         struct kobject kobj;
121         enum klp_state state;
122 };
123
124 #define klp_for_each_object(patch, obj) \
125         for (obj = patch->objs; obj->funcs; obj++)
126
127 #define klp_for_each_func(obj, func) \
128         for (func = obj->funcs; func->old_name; func++)
129
130 int klp_register_patch(struct klp_patch *);
131 int klp_unregister_patch(struct klp_patch *);
132 int klp_enable_patch(struct klp_patch *);
133 int klp_disable_patch(struct klp_patch *);
134
135 #endif /* _LINUX_LIVEPATCH_H_ */