gnh1201/wasm-micro-runtime
1
0
Fork 0
mirror of https://github.com/bytecodealliance/wasm-micro-runtime.git synced 2025-07-15 16:58:34 +00:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

[dpgo] Add Debug location of Opcodes in LLVM IR (#2238)

Browse Source 
Since both DEBUG_AOT and DYNAMIC_PGO will append debug location
to LLVM IR, we can only enable one at the same time.
This commit is contained in:
liang.he 2023-06-09 14:01:44 +08:00 committed by GitHub
parent 0f46807316
commit b22f3800f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 137 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
build-scripts/config_common.cmake
View File

@ -135,6 +135,11 @@ if (NOT WAMR_BUILD_FAST_JIT EQUAL 1 OR NOT WAMR_BUILD_JIT EQUAL 1 OR NOT WAMR_BU
endif ()
endif()
# Conflict check for DEBUG_AOT and DYNAMIC_PGO. Both append DILocation to LLVM IR
if (WAMR_BUILD_DYNAMIC_PGO EQUAL 1 AND WAMR_BUILD_DEBUG_AOT EQUAL 1)
message (FATAL_ERROR "Cannot enable WAMR_BUILD_DYNAMIC_PGO and WAMR_BUILD_DEBUG_AOT at the same time")
endif ()
########################################
message ("-- Build Configurations:")

45
core/iwasm/compilation/aot_compiler.c
View File

@ -181,7 +181,7 @@ aot_compile_func(AOTCompContext *comp_ctx, uint32 func_index)
float32 f32_const;
float64 f64_const;
AOTFuncType *func_type = NULL;
#if WASM_ENABLE_DEBUG_AOT != 0
#if WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0
LLVMMetadataRef location;
#endif
@ -199,6 +199,17 @@ aot_compile_func(AOTCompContext *comp_ctx, uint32 func_index)
LLVMSetCurrentDebugLocation2(comp_ctx->builder, location);
#endif
#if WASM_ENABLE_DYNAMIC_PGO != 0
location = LLVMDIBuilderCreateDebugLocation(
comp_ctx->context, frame_ip - func_ctx->aot_func->code, 1,
func_ctx->debug_func, NULL);
if (!location) {
LOG_ERROR("Cannot create dubug loation");
goto fail;
}
LLVMSetCurrentDebugLocation2(comp_ctx->builder, location);
#endif
switch (opcode) {
case WASM_OP_UNREACHABLE:
if (!aot_compile_op_unreachable(comp_ctx, func_ctx, &frame_ip))
@ -2689,24 +2700,40 @@ aot_compile_wasm(AOTCompContext *comp_ctx)
if (!aot_compile_func(comp_ctx, i)) {
return false;
}
#if WASM_ENABLE_DYNAMIC_PGO != 0
/* resolve `!MD.isTemporary()` */
LLVMDIBuilderFinalizeSubprogram(comp_ctx->debug_builder,
comp_ctx->func_ctxes[i]->debug_func);
#endif
}
/*
* release IRBuilder as early as possible. Further, release IR generation
* resource
*/
if (comp_ctx->builder) {
LLVMDisposeBuilder(comp_ctx->builder);
comp_ctx->builder = NULL;
}
LLVMDisposeBuilder(comp_ctx->builder);
comp_ctx->builder = NULL;
#if WASM_ENABLE_DEBUG_AOT != 0
#if WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0
/* release DIBuilder as early as possible. */
LLVMDIBuilderFinalize(comp_ctx->debug_builder);
LLVMDisposeDIBuilder(comp_ctx->debug_builder);
comp_ctx->debug_builder = NULL;
#endif
/* Disable LLVM module verification for jit mode to speedup
the compilation process */
if (!comp_ctx->is_jit_mode) {
/*
* Disable LLVM module verification for jit mode to speedup
* the compilation process
*
* always want to verify the module to make sure DILocation
* related information are correct. If not, it may leads an
* exception very far away
*/
#if WASM_ENABLE_DYNAMIC_PGO == 0
if (!comp_ctx->is_jit_mode)
#endif
{
bh_print_time("Begin to verify LLVM module");
if (!verify_module(comp_ctx)) {
return false;

87
core/iwasm/compilation/aot_llvm.c
View File

@ -948,6 +948,33 @@ aot_create_func_context(AOTCompData *comp_data, AOTCompContext *comp_ctx,
func_ctx->debug_func = dwarf_gen_func_info(comp_ctx, func_ctx);
#endif
#if WASM_ENABLE_DYNAMIC_PGO != 0
/* TODO: create function type for real. DPGO doesn't need this type */
LLVMMetadataRef fake_func_ty = LLVMDIBuilderCreateSubroutineType(
comp_ctx->debug_builder, comp_ctx->debug_file, NULL, 0,
LLVMDIFlagZero | LLVMDIFlagNoReturn);
if (!fake_func_ty) {
LOG_ERROR("LLVMDIBuilderCreateSubroutineType failed");
goto fail;
}
size_t func_name_len;
const char *func_name = LLVMGetValueName2(func_ctx->func, &func_name_len);
/*
* expedient measures:
* - set the function index as the "LineNo* of the function
*/
func_ctx->debug_func = LLVMDIBuilderCreateFunction(
comp_ctx->debug_builder, comp_ctx->debug_file, func_name, func_name_len,
func_name, func_name_len, comp_ctx->debug_file, func_index,
fake_func_ty, true, true, 1, LLVMDIFlagZero, false);
if (!func_ctx->debug_func) {
LOG_ERROR("LLVMDIBuilderCreateFunction failed");
goto fail;
}
LLVMSetSubprogram(func_ctx->func, func_ctx->debug_func);
#endif
aot_block_stack_push(&func_ctx->block_stack, aot_block);
/* Add local variables */
@ -1506,7 +1533,12 @@ apply_prof_meta_and_opt(void *Ctx, LLVMModuleRef Mod)
}
// FIXME:
// aot_apply_llvm_new_pass_manger(comp_ctx, Mod);
// aot_apply_llvm_new_pass_manager(comp_ctx, Mod);
// os_printf("\n");
// LLVMDumpModule(Mod);
// os_printf("\n");
return LLVMErrorSuccess;
}
@ -1665,12 +1697,15 @@ aot_create_comp_context(AOTCompData *comp_data, aot_comp_option_t option)
goto fail;
}
#if WASM_ENABLE_DEBUG_AOT != 0
#if WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0
if (!(comp_ctx->debug_builder = LLVMCreateDIBuilder(comp_ctx->module))) {
aot_set_last_error("create LLVM Debug Infor builder failed.");
goto fail;
}
#if WASM_ENABLE_DEBUG_AOT != 0
/* Add a module flag named "Debug Info Version" */
/* llvm::DEBUG_METADATA_VERSION is 3 */
LLVMAddModuleFlag(
comp_ctx->module, LLVMModuleFlagBehaviorWarning, "Debug Info Version",
strlen("Debug Info Version"),
@ -1686,7 +1721,41 @@ aot_create_comp_context(AOTCompData *comp_data, aot_comp_option_t option)
aot_set_last_error("dwarf generate compile unit info failed");
goto fail;
}
#endif
#else
{
const char *file_name = "module.wasm";
const char *dir_name = ".";
/* Add a module flag named "Debug Info Version" */
const char *debug_ver_key = "Debug Info Version";
/* llvm::DEBUG_METADATA_VERSION is 3 */
LLVMMetadataRef debug_ver_val = LLVMValueAsMetadata(
LLVMConstInt(LLVMInt32TypeInContext(comp_ctx->context), 3, false));
LLVMAddModuleFlag(comp_ctx->module, LLVMModuleFlagBehaviorWarning,
debug_ver_key, strlen(debug_ver_key), debug_ver_val);
comp_ctx->debug_file = LLVMDIBuilderCreateFile(
comp_ctx->debug_builder, file_name, strlen(file_name), dir_name,
strlen(dir_name));
if (!comp_ctx->debug_file) {
aot_set_last_error("dwarf generate file info failed");
goto fail;
}
/* use LLVMDWARFSourceLanguageC for now */
comp_ctx->debug_comp_unit = LLVMDIBuilderCreateCompileUnit(
comp_ctx->debug_builder, LLVMDWARFSourceLanguageC,
comp_ctx->debug_file, NULL, 0, 0 /*isOptimized*/, NULL, 0,
1 /*RuntimeVer*/, NULL, 0, LLVMDWARFEmissionFull, 0 /*DWOId*/,
0 /*SplitDebugInlining*/, 0 /*DebugInfoForProfiling*/, NULL, 0,
NULL, 0);
if (!comp_ctx->debug_comp_unit) {
aot_set_last_error("dwarf generate compile unit info failed");
goto fail;
}
}
#endif /* WASM_ENABLE_DEBUG_AOT != 0 */
#endif /* WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0 */
if (option->enable_bulk_memory)
comp_ctx->enable_bulk_memory = true;
@ -2246,8 +2315,18 @@ aot_destroy_comp_context(AOTCompContext *comp_ctx)
if (comp_ctx->target_machine)
LLVMDisposeTargetMachine(comp_ctx->target_machine);
if (comp_ctx->builder)
if (comp_ctx->builder) {
LLVMDisposeBuilder(comp_ctx->builder);
comp_ctx->builder = NULL;
}
#if WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0
if (comp_ctx->debug_builder) {
LLVMDIBuilderFinalize(comp_ctx->debug_builder);
LLVMDisposeDIBuilder(comp_ctx->debug_builder);
comp_ctx->debug_builder = NULL;
}
#endif
if (comp_ctx->orc_thread_safe_context)
LLVMOrcDisposeThreadSafeContext(comp_ctx->orc_thread_safe_context);

16
core/iwasm/compilation/aot_llvm.h
View File

@ -26,7 +26,7 @@
#include "llvm-c/Initialization.h"
#include "llvm-c/TargetMachine.h"
#include "llvm-c/LLJIT.h"
#if WASM_ENABLE_DEBUG_AOT != 0
#if WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0
#include "llvm-c/DebugInfo.h"
#endif
@ -181,7 +181,7 @@ typedef struct AOTFuncContext {
LLVMBasicBlockRef func_return_block;
LLVMValueRef exception_id_phi;
LLVMValueRef func_type_indexes;
#if WASM_ENABLE_DEBUG_AOT != 0
#if WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0
LLVMMetadataRef debug_func;
#endif
LLVMValueRef locals[1];
@ -280,7 +280,7 @@ typedef struct AOTCompContext {
/* LLVM variables required to emit LLVM IR */
LLVMContextRef context;
LLVMBuilderRef builder;
#if WASM_ENABLE_DEBUG_AOT
#if WASM_ENABLE_DEBUG_AOT != 0 || WASM_ENABLE_DYNAMIC_PGO != 0
LLVMDIBuilderRef debug_builder;
LLVMMetadataRef debug_file;
LLVMMetadataRef debug_comp_unit;
@ -520,9 +520,19 @@ void
aot_handle_llvm_errmsg(const char *string, LLVMErrorRef err);
#if WASM_ENABLE_DYNAMIC_PGO != 0
void
wasm_dpgo_set_branch_weights(LLVMContextRef context, LLVMValueRef instruction,
uint32 *counts, uint32 counts_size);
void
wasm_dpgo_set_prof_meta(AOTCompContext *comp_ctx, LLVMValueRef function,
uint32 func_idx);
void
wasm_dpgo_unlike_true_branch(LLVMContextRef context, LLVMValueRef cond_br);
void
wasm_dpgo_unlike_false_branch(LLVMContextRef context, LLVMValueRef cond_br);
#endif
#ifdef __cplusplus