mirror of
https://github.com/intel/llvm.git
synced 2026-01-16 21:55:39 +08:00
159e6012be
Hey guys, I found that Flang's built-in ABORT function is incomplete when I was using it. Compared with gfortran's ABORT (which can both abort and print out a backtrace), flang's ABORT implementation lacks the function of printing out a backtrace. This feature is essential for debugging and understanding the call stack at the failure point. To solve this problem, I completed the "// TODO:" of the abort function, and then implemented an additional built-in function BACKTRACE for flang. After a brief reading of the relevant source code, I used backtrace and backtrace_symbols in "execinfo.h" to quickly implement this. But since I used the above two functions directly, my implementation is slightly different from gfortran's implementation (in the output, the function call stack before main is additionally output, and the function line number is missing). In addition, since I used the above two functions, I did not need to add -g to embed debug information into the ELF file, but needed -rdynamic to ensure that the symbols are added to the dynamic symbol table (so that the function name will be printed out). Here is a comparison of the output between gfortran 's backtrace and my implementation: gfortran's implemention output: ``` #0 0x557eb71f4184 in testfun2_ at /home/hunter/plct/fortran/test.f90:5 #1 0x557eb71f4165 in testfun1_ at /home/hunter/plct/fortran/test.f90:13 #2 0x557eb71f4192 in test_backtrace at /home/hunter/plct/fortran/test.f90:17 #3 0x557eb71f41ce in main at /home/hunter/plct/fortran/test.f90:18 ``` my impelmention output: ``` Backtrace: #0 ./test(_FortranABacktrace+0x32) [0x574f07efcf92] #1 ./test(testfun2_+0x14) [0x574f07efc7b4] #2 ./test(testfun1_+0xd) [0x574f07efc7cd] #3 ./test(_QQmain+0x9) [0x574f07efc7e9] #4 ./test(main+0x12) [0x574f07efc802] #5 /usr/lib/libc.so.6(+0x25e08) [0x76954694fe08] #6 /usr/lib/libc.so.6(__libc_start_main+0x8c) [0x76954694fecc] #7 ./test(_start+0x25) [0x574f07efc6c5] ``` test program is: ``` function testfun2() result(err) implicit none integer :: err err = 1 call backtrace end function testfun2 subroutine testfun1() implicit none integer :: err integer :: testfun2 err = testfun2() end subroutine testfun1 program test_backtrace call testfun1() end program test_backtrace ``` I am well aware of the importance of line numbers, so I am now working on implementing line numbers (by parsing DWARF information) and supporting cross-platform (Windows) support.
53 lines
2.3 KiB
C++
53 lines
2.3 KiB
C++
//===-- Stop.h - generate stop runtime API calls ----------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "flang/Optimizer/Builder/Runtime/Stop.h"
|
|
#include "flang/Optimizer/Builder/BoxValue.h"
|
|
#include "flang/Optimizer/Builder/FIRBuilder.h"
|
|
#include "flang/Optimizer/Builder/Runtime/RTBuilder.h"
|
|
#include "flang/Runtime/stop.h"
|
|
|
|
using namespace Fortran::runtime;
|
|
|
|
void fir::runtime::genExit(fir::FirOpBuilder &builder, mlir::Location loc,
|
|
mlir::Value status) {
|
|
auto exitFunc = fir::runtime::getRuntimeFunc<mkRTKey(Exit)>(loc, builder);
|
|
llvm::SmallVector<mlir::Value> args = fir::runtime::createArguments(
|
|
builder, loc, exitFunc.getFunctionType(), status);
|
|
builder.create<fir::CallOp>(loc, exitFunc, args);
|
|
}
|
|
|
|
void fir::runtime::genAbort(fir::FirOpBuilder &builder, mlir::Location loc) {
|
|
mlir::func::FuncOp abortFunc =
|
|
fir::runtime::getRuntimeFunc<mkRTKey(Abort)>(loc, builder);
|
|
builder.create<fir::CallOp>(loc, abortFunc, std::nullopt);
|
|
}
|
|
|
|
void fir::runtime::genBacktrace(fir::FirOpBuilder &builder,
|
|
mlir::Location loc) {
|
|
mlir::func::FuncOp backtraceFunc =
|
|
fir::runtime::getRuntimeFunc<mkRTKey(Backtrace)>(loc, builder);
|
|
builder.create<fir::CallOp>(loc, backtraceFunc, std::nullopt);
|
|
}
|
|
|
|
void fir::runtime::genReportFatalUserError(fir::FirOpBuilder &builder,
|
|
mlir::Location loc,
|
|
llvm::StringRef message) {
|
|
mlir::func::FuncOp crashFunc =
|
|
fir::runtime::getRuntimeFunc<mkRTKey(ReportFatalUserError)>(loc, builder);
|
|
mlir::FunctionType funcTy = crashFunc.getFunctionType();
|
|
mlir::Value msgVal = fir::getBase(
|
|
fir::factory::createStringLiteral(builder, loc, message.str() + '\0'));
|
|
mlir::Value sourceLine =
|
|
fir::factory::locationToLineNo(builder, loc, funcTy.getInput(2));
|
|
mlir::Value sourceFile = fir::factory::locationToFilename(builder, loc);
|
|
llvm::SmallVector<mlir::Value> args = fir::runtime::createArguments(
|
|
builder, loc, funcTy, msgVal, sourceFile, sourceLine);
|
|
builder.create<fir::CallOp>(loc, crashFunc, args);
|
|
}
|