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 #include <linux/completion.h>
  27 #include <linux/list.h>
  28
  29 #if IS_ENABLED(CONFIG_LIVEPATCH)
  30
  31 #include <asm/livepatch.h>
  32
  33 /* task patch states */
  34 #define KLP_UNDEFINED   -1
  35 #define KLP_UNPATCHED    0
  36 #define KLP_PATCHED      1
  37
  38 /**
  39  * struct klp_func - function structure for live patching
  40  * @old_name:   name of the function to be patched
  41  * @new_func:   pointer to the patched function code
  42  * @old_sympos: a hint indicating which symbol position the old function
  43  *              can be found (optional)
  44  * @old_func:   pointer to the function being patched
  45  * @kobj:       kobject for sysfs resources
  46  * @node:       list node for klp_object func_list
  47  * @stack_node: list node for klp_ops func_stack list
  48  * @old_size:   size of the old function
  49  * @new_size:   size of the new function
  50  * @kobj_added: @kobj has been added and needs freeing
  51  * @nop:        temporary patch to use the original code again; dyn. allocated
  52  * @patched:    the func has been added to the klp_ops list
  53  * @transition: the func is currently being applied or reverted
  54  *
  55  * The patched and transition variables define the func's patching state.  When
  56  * patching, a func is always in one of the following states:
  57  *
  58  *   patched=0 transition=0: unpatched
  59  *   patched=0 transition=1: unpatched, temporary starting state
  60  *   patched=1 transition=1: patched, may be visible to some tasks
  61  *   patched=1 transition=0: patched, visible to all tasks
  62  *
  63  * And when unpatching, it goes in the reverse order:
  64  *
  65  *   patched=1 transition=0: patched, visible to all tasks
  66  *   patched=1 transition=1: patched, may be visible to some tasks
  67  *   patched=0 transition=1: unpatched, temporary ending state
  68  *   patched=0 transition=0: unpatched
  69  */
  70 struct klp_func {
  71         /* external */
  72         const char *old_name;
  73         void *new_func;
  74         /*
  75          * The old_sympos field is optional and can be used to resolve
  76          * duplicate symbol names in livepatch objects. If this field is zero,
  77          * it is expected the symbol is unique, otherwise patching fails. If
  78          * this value is greater than zero then that occurrence of the symbol
  79          * in kallsyms for the given object is used.
  80          */
  81         unsigned long old_sympos;
  82
  83         /* internal */
  84         void *old_func;
  85         struct kobject kobj;
  86         struct list_head node;
  87         struct list_head stack_node;
  88         unsigned long old_size, new_size;
  89         bool nop;
  90         bool patched;
  91         bool transition;
  92 };
  93
  94 struct klp_object;
  95
  96 /**
  97  * struct klp_callbacks - pre/post live-(un)patch callback structure
  98  * @pre_patch:          executed before code patching
  99  * @post_patch:         executed after code patching
 100  * @pre_unpatch:        executed before code unpatching
 101  * @post_unpatch:       executed after code unpatching
 102  * @post_unpatch_enabled:       flag indicating if post-unpatch callback
 103  *                              should run
 104  *
 105  * All callbacks are optional.  Only the pre-patch callback, if provided,
 106  * will be unconditionally executed.  If the parent klp_object fails to
 107  * patch for any reason, including a non-zero error status returned from
 108  * the pre-patch callback, no further callbacks will be executed.
 109  */
 110 struct klp_callbacks {
 111         int (*pre_patch)(struct klp_object *obj);
 112         void (*post_patch)(struct klp_object *obj);
 113         void (*pre_unpatch)(struct klp_object *obj);
 114         void (*post_unpatch)(struct klp_object *obj);
 115         bool post_unpatch_enabled;
 116 };
 117
 118 /**
 119  * struct klp_object - kernel object structure for live patching
 120  * @name:       module name (or NULL for vmlinux)
 121  * @funcs:      function entries for functions to be patched in the object
 122  * @callbacks:  functions to be executed pre/post (un)patching
 123  * @kobj:       kobject for sysfs resources
 124  * @func_list:  dynamic list of the function entries
 125  * @node:       list node for klp_patch obj_list
 126  * @mod:        kernel module associated with the patched object
 127  *              (NULL for vmlinux)
 128  * @kobj_added: @kobj has been added and needs freeing
 129  * @dynamic:    temporary object for nop functions; dynamically allocated
 130  * @patched:    the object's funcs have been added to the klp_ops list
 131  */
 132 struct klp_object {
 133         /* external */
 134         const char *name;
 135         struct klp_func *funcs;
 136         struct klp_callbacks callbacks;
 137
 138         /* internal */
 139         struct kobject kobj;
 140         struct list_head func_list;
 141         struct list_head node;
 142         struct module *mod;
 143         bool dynamic;
 144         bool patched;
 145 };
 146
 147 /**
 148  * struct klp_patch - patch structure for live patching
 149  * @mod:        reference to the live patch module
 150  * @objs:       object entries for kernel objects to be patched
 151  * @replace:    replace all actively used patches
 152  * @list:       list node for global list of actively used patches
 153  * @kobj:       kobject for sysfs resources
 154  * @obj_list:   dynamic list of the object entries
 155  * @kobj_added: @kobj has been added and needs freeing
 156  * @enabled:    the patch is enabled (but operation may be incomplete)
 157  * @forced:     was involved in a forced transition
 158  * @free_work:  patch cleanup from workqueue-context
 159  * @finish:     for waiting till it is safe to remove the patch module
 160  */
 161 struct klp_patch {
 162         /* external */
 163         struct module *mod;
 164         struct klp_object *objs;
 165         bool replace;
 166
 167         /* internal */
 168         struct list_head list;
 169         struct kobject kobj;
 170         struct list_head obj_list;
 171         bool enabled;
 172         bool forced;
 173         struct work_struct free_work;
 174         struct completion finish;
 175 };
 176
 177 #define klp_for_each_object_static(patch, obj) \
 178         for (obj = patch->objs; obj->funcs || obj->name; obj++)
 179
 180 #define klp_for_each_object_safe(patch, obj, tmp_obj)           \
 181         list_for_each_entry_safe(obj, tmp_obj, &patch->obj_list, node)
 182
 183 #define klp_for_each_object(patch, obj) \
 184         list_for_each_entry(obj, &patch->obj_list, node)
 185
 186 #define klp_for_each_func_static(obj, func) \
 187         for (func = obj->funcs; \
 188              func->old_name || func->new_func || func->old_sympos; \
 189              func++)
 190
 191 #define klp_for_each_func_safe(obj, func, tmp_func)                     \
 192         list_for_each_entry_safe(func, tmp_func, &obj->func_list, node)
 193
 194 #define klp_for_each_func(obj, func)    \
 195         list_for_each_entry(func, &obj->func_list, node)
 196
 197 int klp_enable_patch(struct klp_patch *);
 198
 199 void arch_klp_init_object_loaded(struct klp_patch *patch,
 200                                  struct klp_object *obj);
 201
 202 /* Called from the module loader during module coming/going states */
 203 int klp_module_coming(struct module *mod);
 204 void klp_module_going(struct module *mod);
 205
 206 void klp_copy_process(struct task_struct *child);
 207 void klp_update_patch_state(struct task_struct *task);
 208
 209 static inline bool klp_patch_pending(struct task_struct *task)
 210 {
 211         return test_tsk_thread_flag(task, TIF_PATCH_PENDING);
 212 }
 213
 214 static inline bool klp_have_reliable_stack(void)
 215 {
 216         return IS_ENABLED(CONFIG_STACKTRACE) &&
 217                IS_ENABLED(CONFIG_HAVE_RELIABLE_STACKTRACE);
 218 }
 219
 220 typedef int (*klp_shadow_ctor_t)(void *obj,
 221                                  void *shadow_data,
 222                                  void *ctor_data);
 223 typedef void (*klp_shadow_dtor_t)(void *obj, void *shadow_data);
 224
 225 void *klp_shadow_get(void *obj, unsigned long id);
 226 void *klp_shadow_alloc(void *obj, unsigned long id,
 227                        size_t size, gfp_t gfp_flags,
 228                        klp_shadow_ctor_t ctor, void *ctor_data);
 229 void *klp_shadow_get_or_alloc(void *obj, unsigned long id,
 230                               size_t size, gfp_t gfp_flags,
 231                               klp_shadow_ctor_t ctor, void *ctor_data);
 232 void klp_shadow_free(void *obj, unsigned long id, klp_shadow_dtor_t dtor);
 233 void klp_shadow_free_all(unsigned long id, klp_shadow_dtor_t dtor);
 234
 235 #else /* !CONFIG_LIVEPATCH */
 236
 237 static inline int klp_module_coming(struct module *mod) { return 0; }
 238 static inline void klp_module_going(struct module *mod) {}
 239 static inline bool klp_patch_pending(struct task_struct *task) { return false; }
 240 static inline void klp_update_patch_state(struct task_struct *task) {}
 241 static inline void klp_copy_process(struct task_struct *child) {}
 242
 243 #endif /* CONFIG_LIVEPATCH */
 244
 245 #endif /* _LINUX_LIVEPATCH_H_ */