27f8a4e806
This commit adds a framework to abstract runtime code patching. Components in the new framework can provide functions for either patching a named function or a function pointer. The later functionality is not being used but may provide a way to allow memory hooks when dlopen functionality is disabled. This commit adds two different flavors of code patching. The first is provided by the overwrite component. This component overwrites the first several instructions of the target function with code to jump to the provided hook function. The hook is expected to provide the full functionality of the hooked function. The linux patcher component is based on the memory hooks in ucx. It only works on linux and operates by overwriting function pointers in the symbol table. In this case the hook is free to call the original function using the function pointer returned by dlsym. Both components restore the original functions when the patcher framework closes. Changes had to be made to support Power/PowerPC with the Linux dynamic loader patcher. Some of the changes: - Move code necessary for powerpc/power support to the patcher base. The code is needed by both the overwrite and linux components. - Move patch structure down to base and move the patch list to mca_patcher_base_module_t. The structure has been modified to include a function pointer to the function that will unapply the patch. This allows the mixing of multiple different types of patches in the patch_list. - Update linux patching code to keep track of the matching between got entry and original (unpatched) address. This allows us to completely clean up the patch on finalize. All patchers keep track of the changes they made so that they can be reversed when the patcher framework is closed. At this time there are bugs in the Linux dynamic loader patcher so its priority is lower than the overwrite patcher. Signed-off-by: Nathan Hjelm <hjelmn@lanl.gov>
122 строки
3.8 KiB
C
122 строки
3.8 KiB
C
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
|
|
/*
|
|
* Copyright (c) 2016 Los Alamos National Security, LLC. All rights
|
|
* reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
|
|
#ifndef OPAL_MCA_PATCHER_PATCHER_H
|
|
#define OPAL_MCA_PATCHER_PATCHER_H
|
|
|
|
#include "opal_config.h"
|
|
|
|
#include "opal/mca/mca.h"
|
|
#include "opal/mca/base/base.h"
|
|
#include "opal/class/opal_list.h"
|
|
|
|
/* Any function being patched in as a hook must use SYMBOLPATCH_BEGIN at the top,
|
|
* and SYMBOLPATCH_END before it returns (this is just for PPC). */
|
|
|
|
#if (defined(__PPC64__) || defined(__powerpc64__) || defined(__PPC__)) && defined(OPAL_GCC_INLINE_ASSEMBLY)
|
|
|
|
/* special processing for ppc64 to save and restore TOC (r2)
|
|
* Reference: "64-bit PowerPC ELF Application Binary Interface Supplement 1.9" */
|
|
#define OPAL_PATCHER_BEGIN \
|
|
unsigned long toc_save; \
|
|
asm volatile ("std 2, %0" : "=m" (toc_save)); \
|
|
asm volatile ("nop; nop; nop; nop; nop");
|
|
#define OPAL_PATCHER_END \
|
|
asm volatile ("ld 2, %0" : : "m" (toc_save));
|
|
|
|
#else /* !__PPC64__ */
|
|
|
|
#define OPAL_PATCHER_BEGIN
|
|
#define OPAL_PATCHER_END
|
|
|
|
#endif
|
|
|
|
/**
|
|
* Make any calls to the named function redirect to a new function
|
|
*
|
|
* @param[in] func_symbol_name function to hook
|
|
* @param[in] func_new_addr function pointer of hook
|
|
* @param[out] func_old_addr address of func_symbol_name
|
|
*
|
|
* This function redirects all calls to the function func_symbol_name to
|
|
* the function pointer func_new_addr. If it is possible for the hook
|
|
* function to call the original function the patcher module will return
|
|
* the old function's address in func_old_addr.
|
|
*/
|
|
typedef int (*mca_patcher_base_patch_symbol_fn_t)(const char *func_symbol_name, uintptr_t func_new_addr,
|
|
uintptr_t *func_old_addr);
|
|
|
|
/**
|
|
* Make any calls to a function redirect to a new function
|
|
*
|
|
* @param[in] func_symbol_name function to hook
|
|
* @param[in] func_new_addr function pointer of hook
|
|
* @param[out] func_old_addr address of func_symbol_name
|
|
*
|
|
* This function redirects all calls to the function at func_addr to
|
|
* the function pointer func_new_addr.
|
|
*/
|
|
typedef int (*mca_patcher_base_patch_address_fn_t)(uintptr_t func_addr, uintptr_t func_new_addr);
|
|
|
|
/**
|
|
* Set up the patcher module
|
|
*/
|
|
typedef int (*mca_patcher_base_init_fn_t) (void);
|
|
|
|
/**
|
|
* Finalize the patcher module
|
|
*/
|
|
typedef int (*mca_patcher_base_fini_fn_t) (void);
|
|
|
|
/**
|
|
* Structure for patcher modules.
|
|
*/
|
|
typedef struct mca_patcher_base_module_t {
|
|
mca_base_module_t super;
|
|
/** list of patches */
|
|
opal_list_t patch_list;
|
|
/** lock for patch list */
|
|
opal_mutex_t patch_list_mutex;
|
|
/** function to call if the patcher module is used. can
|
|
* be NULL. */
|
|
mca_patcher_base_init_fn_t patch_init;
|
|
/** function to call when patcher is unloaded. this function
|
|
* MUST clean up all active patches. can be NULL. */
|
|
mca_patcher_base_fini_fn_t patch_fini;
|
|
/** hook a symbol. may be NULL */
|
|
mca_patcher_base_patch_symbol_fn_t patch_symbol;
|
|
/** hook a function pointer. may be NULL */
|
|
mca_patcher_base_patch_address_fn_t patch_address;
|
|
} mca_patcher_base_module_t;
|
|
|
|
|
|
OPAL_DECLSPEC extern mca_patcher_base_module_t *opal_patcher;
|
|
|
|
/**
|
|
* Structure for patcher components.
|
|
*/
|
|
typedef struct mca_patcher_base_component_1_0_0_t {
|
|
/** MCA base component */
|
|
mca_base_component_t patcherc_version;
|
|
/** MCA base data */
|
|
mca_base_component_data_t patcherc_data;
|
|
} mca_patcher_base_component_1_0_0_t;
|
|
|
|
typedef mca_patcher_base_component_1_0_0_t mca_patcher_base_component_t;
|
|
|
|
/*
|
|
* Macro for use in components that are of type patcher
|
|
*/
|
|
#define OPAL_PATCHER_BASE_VERSION_1_0_0 \
|
|
OPAL_MCA_BASE_VERSION_2_1_0("patcher", 1, 0, 0)
|
|
|
|
#endif /* OPAL_MCA_PATCHER_PATCHER_H */
|