kpatch/kmod/patch/kpatch-macros.h
Josh Poimboeuf 57b51d0bdc add KPATCH_WARN_*_LINE macros
WARN macros are problematic because they embed the line number in an
instruction.  As a result, when a function is changed higher in a file,
the line numbers for any WARN calls below that function in the file can
result in unnecessarily changed functions.

These macros allow a patch author to hard code the line numbers in WARN
macros to prevent functions from otherwise changing and getting pulled
into a patch module unnecessarily.
2014-07-09 10:39:07 -05:00

108 lines
3.6 KiB
C

#ifndef __KPATCH_MACROS_H_
#define __KPATCH_MACROS_H_
#include <linux/compiler.h>
#include <linux/bug.h>
typedef void (*kpatch_loadcall_t)(void);
typedef void (*kpatch_unloadcall_t)(void);
struct kpatch_load {
kpatch_loadcall_t fn;
char *objname; /* filled in by create-diff-object */
};
struct kpatch_unload {
kpatch_unloadcall_t fn;
char *objname; /* filled in by create-diff-object */
};
/*
* KPATCH_LOAD_HOOK macro
*
* The first line only ensures that the hook being registered has the required
* function signature. If not, there is compile error on this line.
*
* The section line declares a struct kpatch_load to be allocated in a new
* .kpatch.hook.load section. This kpatch_load_data symbol is later stripped
* by create-diff-object so that it can be declared in multiple objects that
* are later linked together, avoiding global symbol collision. Since multiple
* hooks can be registered, the .kpatch.hook.load section is a table of struct
* kpatch_load elements that will be executed in series by the kpatch core
* module at load time, assuming the kernel object (module) is currently
* loaded; otherwise, the hook is called when module to be patched is loaded
* via the module load notifier.
*/
#define KPATCH_LOAD_HOOK(_fn) \
static inline kpatch_loadcall_t __loadtest(void) { return _fn; } \
struct kpatch_load kpatch_load_data __section(.kpatch.hooks.load) = { \
.fn = _fn, \
.objname = NULL \
};
/*
* KPATCH_UNLOAD_HOOK macro
*
* Same as LOAD hook with s/load/unload/
*/
#define KPATCH_UNLOAD_HOOK(_fn) \
static inline kpatch_unloadcall_t __unloadtest(void) { return _fn; } \
struct kpatch_unload kpatch_unload_data __section(.kpatch.hooks.unload) = { \
.fn = _fn, \
.objname = NULL \
};
/*
* KPATCH_FORCE_UNSAFE macro
*
* USE WITH EXTREME CAUTION!
*
* Allows patch authors to bypass the activeness safety check at patch
* load time. Do this ONLY IF 1) the patch application will always/likely
* fail due to the function being on the stack of at least one thread at
* all times and 2) it is safe for both the original and patched versions
* of the function to run concurrently.
*/
#define KPATCH_FORCE_UNSAFE(_fn) \
void *__kpatch_force_func_##_fn __section(.kpatch.force) = _fn;
/*
* KPATCH_WARN_*_LINE macros
*
* WARN macros are problematic because they embed the line number in an
* instruction. As a result, when a function is changed higher in a file, the
* line numbers for any WARN calls below that function in the file can result
* in unnecessarily changed functions.
*
* These macros allow a patch author to hard code the line numbers in WARN
* macros to prevent functions from otherwise changing and getting pulled into
* a patch module unnecessarily.
*
* TODO: consider moving these __WARN_*_line variants upstream to bug.h
*/
#ifndef __WARN_TAINT
#define __WARN_line(line) warn_slowpath_null(__FILE__, line)
#define __WARN_printf_line(line, arg...) warn_slowpath_fmt(__FILE__, line, arg)
#define __WARN_printf_taint_line(line, taint, arg...) \
warn_slowpath_fmt_taint(__FILE__, line, taint, arg)
#else
#error __WARN_TAINT not yet supported
#endif
#define KPATCH_WARN_LINE(line, condition, format...) ({ \
int __ret_warn_on = !!(condition); \
if (unlikely(__ret_warn_on)) \
__WARN_printf_line(line, format); \
unlikely(__ret_warn_on); \
})
#define KPATCH_WARN_ON_LINE(line, condition) ({ \
int __ret_warn_on = !!(condition); \
if (unlikely(__ret_warn_on)) \
__WARN_line(line); \
unlikely(__ret_warn_on); \
})
#define KPATCH_WARN_ON_SMP_LINE(line, condition) \
KPATCH_WARN_ON_LINE(line, condition)
#endif /* __KPATCH_MACROS_H_ */