Skip to content

Commit

Permalink
[flang][re-apply] Fix seg fault CodeGenAction::executeAction() (#78672)
Browse files Browse the repository at this point in the history
If `generateLLVMIR()` fails, we still continue using the module we
failed to generate which causes a seg fault if LLVM code-gen failed for
some reason or another. This commit fixes this issue.

Re-applies PR #78269 and adds LLVM and MLIR dependencies that were
missed in the PR. The missing libs were: `LLVMCore` & `MLIRIR`.

This reverts commit 4fc7506.
  • Loading branch information
ergawy committed Jan 19, 2024
1 parent 4fc128f commit 10317da
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 0 deletions.
5 changes: 5 additions & 0 deletions flang/lib/Frontend/FrontendActions.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1202,6 +1202,11 @@ void CodeGenAction::executeAction() {
if (!llvmModule)
generateLLVMIR();

// If generating the LLVM module failed, abort! No need for further error
// reporting since generateLLVMIR() does this already.
if (!llvmModule)
return;

// Set the triple based on the targetmachine (this comes compiler invocation
// and the command-line target option if specified, or the default if not
// given on the command-line).
Expand Down
3 changes: 3 additions & 0 deletions flang/unittests/Frontend/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
set(LLVM_LINK_COMPONENTS
${LLVM_TARGETS_TO_BUILD}
TargetParser
Core
)

add_flang_unittest(FlangFrontendTests
CodeGenActionTest.cpp
CompilerInstanceTest.cpp
FrontendActionTest.cpp
)
Expand All @@ -18,4 +20,5 @@ target_link_libraries(FlangFrontendTests
FortranSemantics
FortranCommon
FortranEvaluate
MLIRIR
)
109 changes: 109 additions & 0 deletions flang/unittests/Frontend/CodeGenActionTest.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
//===- unittests/Frontend/CodeGenActionTest.cpp --- FrontendAction tests --===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Unit tests for CodeGenAction.
//
//===----------------------------------------------------------------------===//

#include "mlir/IR/Builders.h"
#include "flang/Frontend/CompilerInstance.h"
#include "flang/Frontend/FrontendActions.h"
#include "flang/Frontend/TextDiagnosticPrinter.h"

#include "gtest/gtest.h"

#include <memory>

using namespace Fortran::frontend;

namespace test {
class DummyDialect : public ::mlir::Dialect {
explicit DummyDialect(::mlir::MLIRContext *context)
: ::mlir::Dialect(getDialectNamespace(), context,
::mlir::TypeID::get<DummyDialect>()) {
initialize();
}

void initialize();
friend class ::mlir::MLIRContext;

public:
~DummyDialect() override = default;
static constexpr ::llvm::StringLiteral getDialectNamespace() {
return ::llvm::StringLiteral("dummy");
}
};

namespace dummy {
class FakeOp : public ::mlir::Op<FakeOp> {
public:
using Op::Op;

static llvm::StringRef getOperationName() { return "dummy.fake"; }

static ::llvm::ArrayRef<::llvm::StringRef> getAttributeNames() { return {}; }

static void build(
::mlir::OpBuilder &odsBuilder, ::mlir::OperationState &odsState) {}
};
} // namespace dummy
} // namespace test

MLIR_DECLARE_EXPLICIT_TYPE_ID(::test::DummyDialect)
MLIR_DEFINE_EXPLICIT_TYPE_ID(::test::DummyDialect)

namespace test {

void DummyDialect::initialize() { addOperations<::test::dummy::FakeOp>(); }
} // namespace test

// A test CodeGenAction to verify that we gracefully handle failure to convert
// from MLIR to LLVM IR.
class LLVMConversionFailureCodeGenAction : public CodeGenAction {
public:
LLVMConversionFailureCodeGenAction()
: CodeGenAction(BackendActionTy::Backend_EmitLL) {
mlirCtx = std::make_unique<mlir::MLIRContext>();
mlirCtx->loadDialect<test::DummyDialect>();

mlir::Location loc(mlir::UnknownLoc::get(mlirCtx.get()));
mlirModule =
std::make_unique<mlir::ModuleOp>(mlir::ModuleOp::create(loc, "mod"));

mlir::OpBuilder builder(mlirCtx.get());
builder.setInsertionPointToStart(&mlirModule->getRegion().front());
// Create a fake op to trip conversion to LLVM.
builder.create<test::dummy::FakeOp>(loc);

llvmCtx = std::make_unique<llvm::LLVMContext>();
}
};

TEST(CodeGenAction, GracefullyHandleLLVMConversionFailure) {
std::string diagnosticOutput;
llvm::raw_string_ostream diagnosticsOS(diagnosticOutput);
auto diagPrinter = std::make_unique<Fortran::frontend::TextDiagnosticPrinter>(
diagnosticsOS, new clang::DiagnosticOptions());

CompilerInstance ci;
ci.createDiagnostics(diagPrinter.get(), /*ShouldOwnClient=*/false);
ci.setInvocation(std::make_shared<CompilerInvocation>());
ci.setOutputStream(std::make_unique<llvm::raw_null_ostream>());
ci.getInvocation().getCodeGenOpts().OptimizationLevel = 0;

FrontendInputFile file("/dev/null", InputKind());

LLVMConversionFailureCodeGenAction action;
action.setInstance(&ci);
action.setCurrentInput(file);

consumeError(action.execute());
ASSERT_EQ(diagnosticsOS.str(),
"error: Lowering to LLVM IR failed\n"
"error: failed to create the LLVM module\n");
}

0 comments on commit 10317da

Please sign in to comment.