IbisInlineSBlocksPass.cpp

Go to the documentation of this file.

//===- IbisInlineSBlocksPass.cpp ------------------------------------------===//
//
// 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 "PassDetails.h"
 
#include "circt/Dialect/Ibis/IbisDialect.h"
#include "circt/Dialect/Ibis/IbisOps.h"
#include "circt/Dialect/Ibis/IbisPasses.h"
#include "circt/Dialect/Ibis/IbisTypes.h"
#include "mlir/Transforms/GreedyPatternRewriteDriver.h"
 
#include "mlir/Dialect/ControlFlow/IR/ControlFlowOps.h"
 
#include "circt/Transforms/Passes.h"
#include "mlir/Transforms/DialectConversion.h"
 
#include <iterator>
 
using namespace mlir;
using namespace circt;
using namespace ibis;
 
namespace {
 
struct InlineSBlocksPass : public IbisInlineSBlocksBase<InlineSBlocksPass> {
  void runOnOperation() override;
};
 
class InlineSBlocksPattern : public OpConversionPattern<ibis::StaticBlockOp> {
public:
  using OpConversionPattern<ibis::StaticBlockOp>::OpConversionPattern;
  using OpAdaptor =
      typename OpConversionPattern<ibis::StaticBlockOp>::OpAdaptor;
 
  LogicalResult
  matchAndRewrite(ibis::StaticBlockOp op, OpAdaptor adaptor,
                  ConversionPatternRewriter &rewriter) const override {
    Location loc = op.getLoc();
 
    // We only create block markers in case the sblock has attributes.
    bool hasAttributes = !op->getAttrs().empty();
 
    if (hasAttributes) {
      // Start the inline block...
      auto inlineStart = rewriter.create<ibis::InlineStaticBlockBeginOp>(loc);
      inlineStart->setAttrs(op->getAttrs());
    }
 
    // Inline the sblock.
    Block *sblockBody = op.getBodyBlock();
    BlockReturnOp ret = cast<BlockReturnOp>(sblockBody->getTerminator());
    rewriter.inlineBlockBefore(sblockBody, op->getNextNode());
 
    // Replace the ibis.sblock return values with the values that were defined
    // (returned from) within the sblock body, and erase the return op.
    for (auto [res, val] : llvm::zip(op.getResults(), ret.getRetValues()))
      rewriter.replaceAllUsesWith(res, val);
 
    if (hasAttributes) {
      // Close the inline block
      rewriter.setInsertionPoint(ret);
      rewriter.create<ibis::InlineStaticBlockEndOp>(loc);
    }
 
    rewriter.eraseOp(ret);
    rewriter.eraseOp(op);
    return success();
  }
};
 
} // anonymous namespace
 
void InlineSBlocksPass::runOnOperation() {
  MethodOp parent = getOperation();
  ConversionTarget target(getContext());
  target.addIllegalOp<ibis::StaticBlockOp>();
  // Mark everything but `ibis.sblock` as legal - we need a legalization pattern
  // for any possible op that gets inlined from a block.
  target.markUnknownOpDynamicallyLegal([](Operation *op) { return true; });
  RewritePatternSet patterns(&getContext());
  patterns.add<InlineSBlocksPattern>(&getContext());
 
  if (failed(applyPartialConversion(parent, target, std::move(patterns))))
    return signalPassFailure();
}
 
std::unique_ptr<Pass> circt::ibis::createInlineSBlocksPass() {
  return std::make_unique<InlineSBlocksPass>();
}