MLIR 22.0.0git
TranslateToCpp.cpp File Reference
#include "mlir/Dialect/ControlFlow/IR/ControlFlowOps.h"
#include "mlir/Dialect/EmitC/IR/EmitC.h"
#include "mlir/Dialect/Func/IR/FuncOps.h"
#include "mlir/IR/BuiltinOps.h"
#include "mlir/IR/BuiltinTypes.h"
#include "mlir/IR/Dialect.h"
#include "mlir/IR/Operation.h"
#include "mlir/IR/SymbolTable.h"
#include "mlir/IR/Value.h"
#include "mlir/Support/IndentedOstream.h"
#include "mlir/Support/LLVM.h"
#include "mlir/Target/Cpp/CppEmitter.h"
#include "llvm/ADT/ScopedHashTable.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/TypeSwitch.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/FormatVariadic.h"
#include <stack>

Go to the source code of this file.

Macros

#define DEBUG_TYPE   "translate-to-cpp"

Functions

template<typename ForwardIterator, typename UnaryFunctor, typename NullaryFunctor>
static LogicalResult interleaveWithError (ForwardIterator begin, ForwardIterator end, UnaryFunctor eachFn, NullaryFunctor betweenFn)
 Convenience functions to produce interleaved output with functions returning a LogicalResult.
template<typename Container, typename UnaryFunctor, typename NullaryFunctor>
static LogicalResult interleaveWithError (const Container &c, UnaryFunctor eachFn, NullaryFunctor betweenFn)
template<typename Container, typename UnaryFunctor>
static LogicalResult interleaveCommaWithError (const Container &c, raw_ostream &os, UnaryFunctor eachFn)
static FailureOr< int > getOperatorPrecedence (Operation *operation)
 Return the precedence of a operator as an integer, higher values imply higher precedence.
static bool shouldBeInlined (Operation *op)
 Determine whether operation op should be emitted inline, i.e.
static bool hasDeferredEmission (Operation *op)
 Determine whether expression op should be emitted in a deferred way.
static emitc::GlobalOp getConstGlobal (Value value, Operation *fromOp)
 Helper function to check if a value traces back to a const global.
static LogicalResult emitAddressOfWithConstCast (CppEmitter &emitter, Operation &op, Value operand)
 Emit address-of with a cast to strip const qualification.
static LogicalResult printOperation (CppEmitter &emitter, emitc::DereferenceOp dereferenceOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::GetFieldOp getFieldOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::GetGlobalOp getGlobalOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::LiteralOp literalOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::MemberOp memberOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::MemberOfPtrOp memberOfPtrOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::SubscriptOp subscriptOp)
static LogicalResult printConstantOp (CppEmitter &emitter, Operation *operation, Attribute value)
static LogicalResult printOperation (CppEmitter &emitter, emitc::AddressOfOp addressOfOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::ConstantOp constantOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::VariableOp variableOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::GlobalOp globalOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::AssignOp assignOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::LoadOp loadOp)
static LogicalResult printBinaryOperation (CppEmitter &emitter, Operation *operation, StringRef binaryOperator)
static LogicalResult printUnaryOperation (CppEmitter &emitter, Operation *operation, StringRef unaryOperator)
static LogicalResult printOperation (CppEmitter &emitter, emitc::AddOp addOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::DivOp divOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::MulOp mulOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::RemOp remOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::SubOp subOp)
static LogicalResult emitSwitchCase (CppEmitter &emitter, raw_indented_ostream &os, Region &region)
static LogicalResult printOperation (CppEmitter &emitter, emitc::SwitchOp switchOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::DoOp doOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::CmpOp cmpOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::ConditionalOp conditionalOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::VerbatimOp verbatimOp)
static LogicalResult printOperation (CppEmitter &emitter, cf::BranchOp branchOp)
static LogicalResult printOperation (CppEmitter &emitter, cf::CondBranchOp condBranchOp)
static LogicalResult printCallOperation (CppEmitter &emitter, Operation *callOp, StringRef callee)
static LogicalResult printOperation (CppEmitter &emitter, func::CallOp callOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::CallOp callOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::CallOpaqueOp callOpaqueOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::ApplyOp applyOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::BitwiseAndOp bitwiseAndOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::BitwiseLeftShiftOp bitwiseLeftShiftOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::BitwiseNotOp bitwiseNotOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::BitwiseOrOp bitwiseOrOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::BitwiseRightShiftOp bitwiseRightShiftOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::BitwiseXorOp bitwiseXorOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::UnaryPlusOp unaryPlusOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::UnaryMinusOp unaryMinusOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::CastOp castOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::ExpressionOp expressionOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::IncludeOp includeOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::LogicalAndOp logicalAndOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::LogicalNotOp logicalNotOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::LogicalOrOp logicalOrOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::ForOp forOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::IfOp ifOp)
static LogicalResult printOperation (CppEmitter &emitter, func::ReturnOp returnOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::ReturnOp returnOp)
static LogicalResult printOperation (CppEmitter &emitter, ModuleOp moduleOp)
static LogicalResult printOperation (CppEmitter &emitter, ClassOp classOp)
static LogicalResult printOperation (CppEmitter &emitter, FieldOp fieldOp)
static LogicalResult printOperation (CppEmitter &emitter, FileOp file)
static LogicalResult printFunctionArgs (CppEmitter &emitter, Operation *functionOp, ArrayRef< Type > arguments)
static LogicalResult printFunctionArgs (CppEmitter &emitter, Operation *functionOp, Region::BlockArgListType arguments)
static LogicalResult printFunctionBody (CppEmitter &emitter, Operation *functionOp, Region::BlockListType &blocks)
static LogicalResult printOperation (CppEmitter &emitter, func::FuncOp functionOp)
static LogicalResult printOperation (CppEmitter &emitter, emitc::FuncOp functionOp)
static LogicalResult printOperation (CppEmitter &emitter, DeclareFuncOp declareFuncOp)

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE   "translate-to-cpp"

Definition at line 28 of file TranslateToCpp.cpp.

Function Documentation

◆ emitAddressOfWithConstCast()

LogicalResult emitAddressOfWithConstCast ( CppEmitter & emitter,
Operation & op,
Value operand )
static

Emit address-of with a cast to strip const qualification.

Produces: (ResultType)(&operand)

Definition at line 431 of file TranslateToCpp.cpp.

References mlir::Operation::getLoc(), mlir::Operation::getResult(), mlir::Value::getType(), and success().

Referenced by printOperation(), and printOperation().

◆ emitSwitchCase()

LogicalResult emitSwitchCase ( CppEmitter & emitter,
raw_indented_ostream & os,
Region & region )
static

Definition at line 661 of file TranslateToCpp.cpp.

References mlir::Region::op_begin(), mlir::Region::op_end(), and success().

Referenced by printOperation().

◆ getConstGlobal()

emitc::GlobalOp getConstGlobal ( Value value,
Operation * fromOp )
static

Helper function to check if a value traces back to a const global.

Handles direct GetGlobalOp and GetGlobalOp through one or more SubscriptOps. Returns the GlobalOp if found and it has const_specifier, nullptr otherwise.

Definition at line 410 of file TranslateToCpp.cpp.

References mlir::Value::getDefiningOp(), and mlir::SymbolTable::lookupNearestSymbolFrom().

Referenced by printOperation(), and printOperation().

◆ getOperatorPrecedence()

FailureOr< int > getOperatorPrecedence ( Operation * operation)
static

Return the precedence of a operator as an integer, higher values imply higher precedence.

Definition at line 71 of file TranslateToCpp.cpp.

◆ hasDeferredEmission()

bool hasDeferredEmission ( Operation * op)
static

Determine whether expression op should be emitted in a deferred way.

Definition at line 335 of file TranslateToCpp.cpp.

Referenced by shouldBeInlined().

◆ interleaveCommaWithError()

template<typename Container, typename UnaryFunctor>
LogicalResult interleaveCommaWithError ( const Container & c,
raw_ostream & os,
UnaryFunctor eachFn )
inlinestatic

Definition at line 63 of file TranslateToCpp.cpp.

References interleaveWithError().

Referenced by printFunctionArgs(), printFunctionArgs(), and printOperation().

◆ interleaveWithError() [1/2]

template<typename Container, typename UnaryFunctor, typename NullaryFunctor>
LogicalResult interleaveWithError ( const Container & c,
UnaryFunctor eachFn,
NullaryFunctor betweenFn )
inlinestatic

Definition at line 56 of file TranslateToCpp.cpp.

References interleaveWithError().

◆ interleaveWithError() [2/2]

template<typename ForwardIterator, typename UnaryFunctor, typename NullaryFunctor>
LogicalResult interleaveWithError ( ForwardIterator begin,
ForwardIterator end,
UnaryFunctor eachFn,
NullaryFunctor betweenFn )
inlinestatic

Convenience functions to produce interleaved output with functions returning a LogicalResult.

This is different than those in STLExtras as functions used on each element doesn't return a string.

Definition at line 40 of file TranslateToCpp.cpp.

References success().

Referenced by interleaveCommaWithError(), and interleaveWithError().

◆ printBinaryOperation()

LogicalResult printBinaryOperation ( CppEmitter & emitter,
Operation * operation,
StringRef binaryOperator )
static

◆ printCallOperation()

LogicalResult printCallOperation ( CppEmitter & emitter,
Operation * callOp,
StringRef callee )
static

Definition at line 871 of file TranslateToCpp.cpp.

References success().

Referenced by printOperation(), and printOperation().

◆ printConstantOp()

LogicalResult printConstantOp ( CppEmitter & emitter,
Operation * operation,
Attribute value )
static

◆ printFunctionArgs() [1/2]

LogicalResult printFunctionArgs ( CppEmitter & emitter,
Operation * functionOp,
ArrayRef< Type > arguments )
static

◆ printFunctionArgs() [2/2]

LogicalResult printFunctionArgs ( CppEmitter & emitter,
Operation * functionOp,
Region::BlockArgListType arguments )
static

◆ printFunctionBody()

◆ printOperation() [1/54]

LogicalResult printOperation ( CppEmitter & emitter,
cf::BranchOp branchOp )
static

◆ printOperation() [2/54]

LogicalResult printOperation ( CppEmitter & emitter,
cf::CondBranchOp condBranchOp )
static

◆ printOperation() [3/54]

LogicalResult printOperation ( CppEmitter & emitter,
ClassOp classOp )
static

◆ printOperation() [4/54]

LogicalResult printOperation ( CppEmitter & emitter,
DeclareFuncOp declareFuncOp )
static

◆ printOperation() [5/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::AddOp addOp )
static

Definition at line 631 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [6/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::AddressOfOp addressOfOp )
static

Definition at line 536 of file TranslateToCpp.cpp.

References emitAddressOfWithConstCast(), and getConstGlobal().

◆ printOperation() [7/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::ApplyOp applyOp )
static

Definition at line 950 of file TranslateToCpp.cpp.

References emitAddressOfWithConstCast(), and getConstGlobal().

◆ printOperation() [8/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::AssignOp assignOp )
static

Definition at line 579 of file TranslateToCpp.cpp.

References result.

◆ printOperation() [9/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::BitwiseAndOp bitwiseAndOp )
static

Definition at line 969 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [10/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::BitwiseLeftShiftOp bitwiseLeftShiftOp )
static

Definition at line 976 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [11/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::BitwiseNotOp bitwiseNotOp )
static

Definition at line 982 of file TranslateToCpp.cpp.

References printUnaryOperation().

◆ printOperation() [12/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::BitwiseOrOp bitwiseOrOp )
static

Definition at line 988 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [13/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::BitwiseRightShiftOp bitwiseRightShiftOp )
static

Definition at line 995 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [14/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::BitwiseXorOp bitwiseXorOp )
static

Definition at line 1001 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [15/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::CallOp callOp )
static

Definition at line 891 of file TranslateToCpp.cpp.

References printCallOperation().

◆ printOperation() [16/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::CallOpaqueOp callOpaqueOp )
static

◆ printOperation() [17/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::CastOp castOp )
static

◆ printOperation() [18/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::CmpOp cmpOp )
static

Definition at line 725 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [19/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::ConditionalOp conditionalOp )
static

Definition at line 757 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [20/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::ConstantOp constantOp )
static

Definition at line 554 of file TranslateToCpp.cpp.

References mlir::Operation::getLoc(), and printConstantOp().

◆ printOperation() [21/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::DereferenceOp dereferenceOp )
static

Definition at line 444 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [22/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::DivOp divOp )
static

Definition at line 637 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [23/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::DoOp doOp )
static

◆ printOperation() [24/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::ExpressionOp expressionOp )
static

Definition at line 1032 of file TranslateToCpp.cpp.

References shouldBeInlined(), and success().

◆ printOperation() [25/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::ForOp forOp )
static

◆ printOperation() [26/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::FuncOp functionOp )
static

Definition at line 1384 of file TranslateToCpp.cpp.

References printFunctionArgs(), printFunctionBody(), and success().

◆ printOperation() [27/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::GetFieldOp getFieldOp )
static

Definition at line 453 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [28/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::GetGlobalOp getGlobalOp )
static

Definition at line 460 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [29/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::GlobalOp globalOp )
static

Definition at line 573 of file TranslateToCpp.cpp.

◆ printOperation() [30/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::IfOp ifOp )
static

◆ printOperation() [31/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::IncludeOp includeOp )
static

Definition at line 1045 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [32/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::LiteralOp literalOp )
static

Definition at line 466 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [33/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::LoadOp loadOp )
static

Definition at line 589 of file TranslateToCpp.cpp.

◆ printOperation() [34/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::LogicalAndOp logicalAndOp )
static

Definition at line 1058 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [35/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::LogicalNotOp logicalNotOp )
static

Definition at line 1064 of file TranslateToCpp.cpp.

References printUnaryOperation().

◆ printOperation() [36/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::LogicalOrOp logicalOrOp )
static

Definition at line 1070 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [37/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::MemberOfPtrOp memberOfPtrOp )
static

Definition at line 482 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [38/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::MemberOp memberOp )
static

Definition at line 472 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [39/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::MulOp mulOp )
static

Definition at line 643 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [40/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::RemOp remOp )
static

Definition at line 649 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [41/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::ReturnOp returnOp )
static

Definition at line 1191 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [42/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::SubOp subOp )
static

Definition at line 655 of file TranslateToCpp.cpp.

References printBinaryOperation().

◆ printOperation() [43/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::SubscriptOp subscriptOp )
static

Definition at line 492 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [44/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::SwitchOp switchOp )
static

◆ printOperation() [45/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::UnaryMinusOp unaryMinusOp )
static

Definition at line 1013 of file TranslateToCpp.cpp.

References printUnaryOperation().

◆ printOperation() [46/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::UnaryPlusOp unaryPlusOp )
static

Definition at line 1007 of file TranslateToCpp.cpp.

References printUnaryOperation().

◆ printOperation() [47/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::VariableOp variableOp )
static

Definition at line 565 of file TranslateToCpp.cpp.

References printConstantOp().

◆ printOperation() [48/54]

LogicalResult printOperation ( CppEmitter & emitter,
emitc::VerbatimOp verbatimOp )
static

Definition at line 780 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [49/54]

LogicalResult printOperation ( CppEmitter & emitter,
FieldOp fieldOp )
static

Definition at line 1230 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [50/54]

LogicalResult printOperation ( CppEmitter & emitter,
FileOp file )
static

Definition at line 1246 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [51/54]

LogicalResult printOperation ( CppEmitter & emitter,
func::CallOp callOp )
static

Definition at line 884 of file TranslateToCpp.cpp.

References printCallOperation().

◆ printOperation() [52/54]

LogicalResult printOperation ( CppEmitter & emitter,
func::FuncOp functionOp )
static

Definition at line 1347 of file TranslateToCpp.cpp.

References printFunctionArgs(), printFunctionBody(), and success().

◆ printOperation() [53/54]

LogicalResult printOperation ( CppEmitter & emitter,
func::ReturnOp returnOp )
static

Definition at line 1170 of file TranslateToCpp.cpp.

References success().

◆ printOperation() [54/54]

LogicalResult printOperation ( CppEmitter & emitter,
ModuleOp moduleOp )
static

Definition at line 1204 of file TranslateToCpp.cpp.

References success().

◆ printUnaryOperation()

LogicalResult printUnaryOperation ( CppEmitter & emitter,
Operation * operation,
StringRef unaryOperator )
static

◆ shouldBeInlined()

bool shouldBeInlined ( Operation * op)
static

Determine whether operation op should be emitted inline, i.e.

as part of its user. This function recommends inlining of any expressions that can be inlined unless it is used by another expression, under the assumption that any expression fusion/re-materialization was taken care of by transformations run by the backend.

Definition at line 347 of file TranslateToCpp.cpp.

References mlir::Operation::getParentOp(), hasDeferredEmission(), and result.

Referenced by printFunctionBody(), printOperation(), and printOperation().