[MLIR][Target/Cpp] Natural induction variable naming. #136102
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changed naming of loop induction variables to follow natural naming (i, j, k, ...). This helps readability and locating positions referred to. Created new scopes to represent different behavior at function and loop level, to still enable re-using value names between different functions (as before). Removed unused scoping at other levels.
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
|
@llvm/pr-subscribers-mlir Author: Niklas Degener (ndegener-amd) ChangesChanged naming of loop induction variables to follow natural naming (i, j, k, ...). This helps readability and locating positions referred to. Created new scopes to represent different behavior at function and loop level, to still enable re-using value names between different functions (as before). Removed unused scoping at other levels. Full diff: https://github.com/llvm/llvm-project/pull/136102.diff 2 Files Affected:
diff --git a/mlir/lib/Target/Cpp/TranslateToCpp.cpp b/mlir/lib/Target/Cpp/TranslateToCpp.cpp
index 81016ed2e9a8d..43a820a3c7161 100644
--- a/mlir/lib/Target/Cpp/TranslateToCpp.cpp
+++ b/mlir/lib/Target/Cpp/TranslateToCpp.cpp
@@ -185,6 +185,10 @@ struct CppEmitter {
/// Return the existing or a new name for a Value.
StringRef getOrCreateName(Value val);
+ /// Return the existing or a new name for a loop induction variable of an
+ /// emitc::ForOp.
+ StringRef getOrCreateName(emitc::ForOp forOp);
+
// Returns the textual representation of a subscript operation.
std::string getSubscriptName(emitc::SubscriptOp op);
@@ -200,23 +204,39 @@ struct CppEmitter {
/// Whether to map an mlir integer to a unsigned integer in C++.
bool shouldMapToUnsigned(IntegerType::SignednessSemantics val);
- /// RAII helper function to manage entering/exiting C++ scopes.
+ /// Abstract RAII helper function to manage entering/exiting C++ scopes.
struct Scope {
+ ~Scope() { emitter.labelInScopeCount.pop(); }
+
+ private:
+ llvm::ScopedHashTableScope<Value, std::string> valueMapperScope;
+ llvm::ScopedHashTableScope<Block *, std::string> blockMapperScope;
+
+ protected:
Scope(CppEmitter &emitter)
: valueMapperScope(emitter.valueMapper),
blockMapperScope(emitter.blockMapper), emitter(emitter) {
- emitter.valueInScopeCount.push(emitter.valueInScopeCount.top());
emitter.labelInScopeCount.push(emitter.labelInScopeCount.top());
}
- ~Scope() {
- emitter.valueInScopeCount.pop();
- emitter.labelInScopeCount.pop();
+ CppEmitter &emitter;
+ };
+
+ /// RAII helper function to manage entering/exiting functions, while re-using
+ /// value names.
+ struct FunctionScope : Scope {
+ FunctionScope(CppEmitter &emitter) : Scope(emitter) {
+ // Re-use value names
+ emitter.resetValueCounter();
}
+ };
- private:
- llvm::ScopedHashTableScope<Value, std::string> valueMapperScope;
- llvm::ScopedHashTableScope<Block *, std::string> blockMapperScope;
- CppEmitter &emitter;
+ /// RAII helper function to manage entering/exiting emitc::forOp loops and
+ /// handle induction variable naming.
+ struct LoopScope : Scope {
+ LoopScope(CppEmitter &emitter) : Scope(emitter) {
+ emitter.increaseLoopNestingLevel();
+ }
+ ~LoopScope() { emitter.decreaseLoopNestingLevel(); }
};
/// Returns wether the Value is assigned to a C++ variable in the scope.
@@ -252,6 +272,15 @@ struct CppEmitter {
return operandExpression == emittedExpression;
};
+ // Resets the value counter to 0
+ void resetValueCounter();
+
+ // Increases the loop nesting level by 1
+ void increaseLoopNestingLevel();
+
+ // Decreases the loop nesting level by 1
+ void decreaseLoopNestingLevel();
+
private:
using ValueMapper = llvm::ScopedHashTable<Value, std::string>;
using BlockMapper = llvm::ScopedHashTable<Block *, std::string>;
@@ -273,11 +302,19 @@ struct CppEmitter {
/// Map from block to name of C++ label.
BlockMapper blockMapper;
- /// The number of values in the current scope. This is used to declare the
- /// names of values in a scope.
- std::stack<int64_t> valueInScopeCount;
+ /// Default values representing outermost scope
+ llvm::ScopedHashTableScope<Value, std::string> defaultValueMapperScope;
+ llvm::ScopedHashTableScope<Block *, std::string> defaultBlockMapperScope;
+
std::stack<int64_t> labelInScopeCount;
+ /// Keeps track of the amount of nested loops the emitter currently operates
+ /// in.
+ uint64_t loopNestingLevel{0};
+
+ /// Emitter-level count of created values to enable unique identifiers.
+ unsigned int valueCount{0};
+
/// State of the current expression being emitted.
ExpressionOp emittedExpression;
SmallVector<int> emittedExpressionPrecedence;
@@ -851,7 +888,6 @@ static LogicalResult printOperation(CppEmitter &emitter,
}
static LogicalResult printOperation(CppEmitter &emitter, emitc::ForOp forOp) {
-
raw_indented_ostream &os = emitter.ostream();
// Utility function to determine whether a value is an expression that will be
@@ -870,12 +906,12 @@ static LogicalResult printOperation(CppEmitter &emitter, emitc::ForOp forOp) {
emitter.emitType(forOp.getLoc(), forOp.getInductionVar().getType())))
return failure();
os << " ";
- os << emitter.getOrCreateName(forOp.getInductionVar());
+ os << emitter.getOrCreateName(forOp);
os << " = ";
if (failed(emitter.emitOperand(forOp.getLowerBound())))
return failure();
os << "; ";
- os << emitter.getOrCreateName(forOp.getInductionVar());
+ os << emitter.getOrCreateName(forOp);
os << " < ";
Value upperBound = forOp.getUpperBound();
bool upperBoundRequiresParentheses = requiresParentheses(upperBound);
@@ -886,13 +922,15 @@ static LogicalResult printOperation(CppEmitter &emitter, emitc::ForOp forOp) {
if (upperBoundRequiresParentheses)
os << ")";
os << "; ";
- os << emitter.getOrCreateName(forOp.getInductionVar());
+ os << emitter.getOrCreateName(forOp);
os << " += ";
if (failed(emitter.emitOperand(forOp.getStep())))
return failure();
os << ") {\n";
os.indent();
+ CppEmitter::LoopScope lScope(emitter);
+
Region &forRegion = forOp.getRegion();
auto regionOps = forRegion.getOps();
@@ -979,8 +1017,6 @@ static LogicalResult printOperation(CppEmitter &emitter,
}
static LogicalResult printOperation(CppEmitter &emitter, ModuleOp moduleOp) {
- CppEmitter::Scope scope(emitter);
-
for (Operation &op : moduleOp) {
if (failed(emitter.emitOperation(op, /*trailingSemicolon=*/false)))
return failure();
@@ -992,8 +1028,6 @@ static LogicalResult printOperation(CppEmitter &emitter, FileOp file) {
if (!emitter.shouldEmitFile(file))
return success();
- CppEmitter::Scope scope(emitter);
-
for (Operation &op : file) {
if (failed(emitter.emitOperation(op, /*trailingSemicolon=*/false)))
return failure();
@@ -1109,7 +1143,7 @@ static LogicalResult printOperation(CppEmitter &emitter,
return functionOp.emitOpError() << "cannot emit array type as result type";
}
- CppEmitter::Scope scope(emitter);
+ CppEmitter::FunctionScope scope(emitter);
raw_indented_ostream &os = emitter.ostream();
if (failed(emitter.emitTypes(functionOp.getLoc(),
functionOp.getFunctionType().getResults())))
@@ -1137,7 +1171,7 @@ static LogicalResult printOperation(CppEmitter &emitter,
"with multiple blocks needs variables declared at top");
}
- CppEmitter::Scope scope(emitter);
+ CppEmitter::FunctionScope scope(emitter);
raw_indented_ostream &os = emitter.ostream();
if (functionOp.getSpecifiers()) {
for (Attribute specifier : functionOp.getSpecifiersAttr()) {
@@ -1171,7 +1205,6 @@ static LogicalResult printOperation(CppEmitter &emitter,
static LogicalResult printOperation(CppEmitter &emitter,
DeclareFuncOp declareFuncOp) {
- CppEmitter::Scope scope(emitter);
raw_indented_ostream &os = emitter.ostream();
auto functionOp = SymbolTable::lookupNearestSymbolFrom<emitc::FuncOp>(
@@ -1203,8 +1236,8 @@ static LogicalResult printOperation(CppEmitter &emitter,
CppEmitter::CppEmitter(raw_ostream &os, bool declareVariablesAtTop,
StringRef fileId)
: os(os), declareVariablesAtTop(declareVariablesAtTop),
- fileId(fileId.str()) {
- valueInScopeCount.push(0);
+ fileId(fileId.str()), defaultValueMapperScope(valueMapper),
+ defaultBlockMapperScope(blockMapper) {
labelInScopeCount.push(0);
}
@@ -1245,7 +1278,29 @@ StringRef CppEmitter::getOrCreateName(Value val) {
assert(!hasDeferredEmission(val.getDefiningOp()) &&
"cacheDeferredOpResult should have been called on this value, "
"update the emitOperation function.");
- valueMapper.insert(val, formatv("v{0}", ++valueInScopeCount.top()));
+
+ valueMapper.insert(val, formatv("v{0}", ++valueCount));
+ }
+ return *valueMapper.begin(val);
+}
+
+/// Return the existing or a new name for a loop induction variable Value.
+/// Loop induction variables follow natural naming: i, j, k,...
+StringRef CppEmitter::getOrCreateName(emitc::ForOp forOp) {
+ Value val = forOp.getInductionVar();
+
+ if (!valueMapper.count(val)) {
+
+ int64_t identifier = 'i' + loopNestingLevel;
+
+ if (identifier >= 'i' && identifier <= 'z') {
+ valueMapper.insert(val,
+ formatv("{0}_{1}", (char)identifier, ++valueCount));
+ } else {
+ // If running out of letters, continue with zX
+ valueMapper.insert(
+ val, formatv("z{0}_{1}", identifier - 'z' - 1, ++valueCount));
+ }
}
return *valueMapper.begin(val);
}
@@ -1784,6 +1839,12 @@ LogicalResult CppEmitter::emitTupleType(Location loc, ArrayRef<Type> types) {
return success();
}
+void CppEmitter::resetValueCounter() { valueCount = 0; }
+
+void CppEmitter::increaseLoopNestingLevel() { loopNestingLevel++; }
+
+void CppEmitter::decreaseLoopNestingLevel() { loopNestingLevel--; }
+
LogicalResult emitc::translateToCpp(Operation *op, raw_ostream &os,
bool declareVariablesAtTop,
StringRef fileId) {
diff --git a/mlir/test/Target/Cpp/for_loop_induction_vars.mlir b/mlir/test/Target/Cpp/for_loop_induction_vars.mlir
new file mode 100644
index 0000000000000..3995a4a904ed4
--- /dev/null
+++ b/mlir/test/Target/Cpp/for_loop_induction_vars.mlir
@@ -0,0 +1,85 @@
+// RUN: mlir-translate -mlir-to-cpp %s | FileCheck %s
+
+// CHECK-LABEL: test_for_siblings
+func.func @test_for_siblings() {
+ %start = emitc.literal "0" : index
+ %stop = emitc.literal "10" : index
+ %step = emitc.literal "1" : index
+
+ %var1 = "emitc.variable"() <{value = 0 : index}> : () -> !emitc.lvalue<index>
+ %var2 = "emitc.variable"() <{value = 0 : index}> : () -> !emitc.lvalue<index>
+
+ // CHECK: for (size_t [[ITER0:i_[0-9]*]] = {{.*}}; [[ITER0]] < {{.*}}; [[ITER0]] += {{.*}}) {
+ emitc.for %i0 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITER1:j_[0-9]*]] = {{.*}}; [[ITER1]] < {{.*}}; [[ITER1]] += {{.*}}) {
+ emitc.for %i1 = %start to %stop step %step {
+ // CHECK: {{.*}} = [[ITER0]];
+ //"emitc.assign"(%var1,%i0) : (!emitc.lvalue<!emitc.size_t>, !emitc.size_t) -> ()
+ emitc.assign %i0 : index to %var1 : !emitc.lvalue<index>
+ // CHECK: {{.*}} = [[ITER1]];
+ //"emitc.assign"(%var2,%i1) : (!emitc.lvalue<!emitc.size_t>, !emitc.size_t) -> ()
+ emitc.assign %i1 : index to %var2 : !emitc.lvalue<index>
+ }
+ }
+ // CHECK: for (size_t [[ITER2:i_[0-9]*]] = {{.*}}; [[ITER2]] < {{.*}}; [[ITER2]] += {{.*}})
+ emitc.for %ki2 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITER3:j_[0-9]*]] = {{.*}}; [[ITER3]] < {{.*}}; [[ITER3]] += {{.*}})
+ emitc.for %i3 = %start to %stop step %step {
+ %1 = emitc.call_opaque "f"() : () -> i32
+ }
+ }
+ return
+}
+
+// CHECK-LABEL: test_for_nesting
+func.func @test_for_nesting() {
+ %start = emitc.literal "0" : index
+ %stop = emitc.literal "10" : index
+ %step = emitc.literal "1" : index
+
+ // CHECK-COUNT-18: for (size_t [[ITER:[i-z]_[0-9]*]] = {{.*}}; [[ITER]] < {{.*}}; [[ITER]] += {{.*}}) {
+ emitc.for %i0 = %start to %stop step %step {
+ emitc.for %i1 = %start to %stop step %step {
+ emitc.for %i2 = %start to %stop step %step {
+ emitc.for %i3 = %start to %stop step %step {
+ emitc.for %i4 = %start to %stop step %step {
+ emitc.for %i5 = %start to %stop step %step {
+ emitc.for %i6 = %start to %stop step %step {
+ emitc.for %i7 = %start to %stop step %step {
+ emitc.for %i8 = %start to %stop step %step {
+ emitc.for %i9 = %start to %stop step %step {
+ emitc.for %i10 = %start to %stop step %step {
+ emitc.for %i11 = %start to %stop step %step {
+ emitc.for %i12 = %start to %stop step %step {
+ emitc.for %i13 = %start to %stop step %step {
+ emitc.for %i14 = %start to %stop step %step {
+ emitc.for %i15 = %start to %stop step %step {
+ emitc.for %i16 = %start to %stop step %step {
+ emitc.for %i17 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITERz0:z0_[0-9]*]] = {{.*}}; [[ITERz0]] < {{.*}}; [[ITERz0]] += {{.*}}) {
+ emitc.for %i18 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITERz1:z1_[0-9]*]] = {{.*}}; [[ITERz1]] < {{.*}}; [[ITERz1]] += {{.*}}) {
+ emitc.for %i19 = %start to %stop step %step {
+ %0 = emitc.call_opaque "f"() : () -> i32
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ return
+}
|
|
@llvm/pr-subscribers-mlir-emitc Author: Niklas Degener (ndegener-amd) ChangesChanged naming of loop induction variables to follow natural naming (i, j, k, ...). This helps readability and locating positions referred to. Created new scopes to represent different behavior at function and loop level, to still enable re-using value names between different functions (as before). Removed unused scoping at other levels. Full diff: https://github.com/llvm/llvm-project/pull/136102.diff 2 Files Affected:
diff --git a/mlir/lib/Target/Cpp/TranslateToCpp.cpp b/mlir/lib/Target/Cpp/TranslateToCpp.cpp
index 81016ed2e9a8d..43a820a3c7161 100644
--- a/mlir/lib/Target/Cpp/TranslateToCpp.cpp
+++ b/mlir/lib/Target/Cpp/TranslateToCpp.cpp
@@ -185,6 +185,10 @@ struct CppEmitter {
/// Return the existing or a new name for a Value.
StringRef getOrCreateName(Value val);
+ /// Return the existing or a new name for a loop induction variable of an
+ /// emitc::ForOp.
+ StringRef getOrCreateName(emitc::ForOp forOp);
+
// Returns the textual representation of a subscript operation.
std::string getSubscriptName(emitc::SubscriptOp op);
@@ -200,23 +204,39 @@ struct CppEmitter {
/// Whether to map an mlir integer to a unsigned integer in C++.
bool shouldMapToUnsigned(IntegerType::SignednessSemantics val);
- /// RAII helper function to manage entering/exiting C++ scopes.
+ /// Abstract RAII helper function to manage entering/exiting C++ scopes.
struct Scope {
+ ~Scope() { emitter.labelInScopeCount.pop(); }
+
+ private:
+ llvm::ScopedHashTableScope<Value, std::string> valueMapperScope;
+ llvm::ScopedHashTableScope<Block *, std::string> blockMapperScope;
+
+ protected:
Scope(CppEmitter &emitter)
: valueMapperScope(emitter.valueMapper),
blockMapperScope(emitter.blockMapper), emitter(emitter) {
- emitter.valueInScopeCount.push(emitter.valueInScopeCount.top());
emitter.labelInScopeCount.push(emitter.labelInScopeCount.top());
}
- ~Scope() {
- emitter.valueInScopeCount.pop();
- emitter.labelInScopeCount.pop();
+ CppEmitter &emitter;
+ };
+
+ /// RAII helper function to manage entering/exiting functions, while re-using
+ /// value names.
+ struct FunctionScope : Scope {
+ FunctionScope(CppEmitter &emitter) : Scope(emitter) {
+ // Re-use value names
+ emitter.resetValueCounter();
}
+ };
- private:
- llvm::ScopedHashTableScope<Value, std::string> valueMapperScope;
- llvm::ScopedHashTableScope<Block *, std::string> blockMapperScope;
- CppEmitter &emitter;
+ /// RAII helper function to manage entering/exiting emitc::forOp loops and
+ /// handle induction variable naming.
+ struct LoopScope : Scope {
+ LoopScope(CppEmitter &emitter) : Scope(emitter) {
+ emitter.increaseLoopNestingLevel();
+ }
+ ~LoopScope() { emitter.decreaseLoopNestingLevel(); }
};
/// Returns wether the Value is assigned to a C++ variable in the scope.
@@ -252,6 +272,15 @@ struct CppEmitter {
return operandExpression == emittedExpression;
};
+ // Resets the value counter to 0
+ void resetValueCounter();
+
+ // Increases the loop nesting level by 1
+ void increaseLoopNestingLevel();
+
+ // Decreases the loop nesting level by 1
+ void decreaseLoopNestingLevel();
+
private:
using ValueMapper = llvm::ScopedHashTable<Value, std::string>;
using BlockMapper = llvm::ScopedHashTable<Block *, std::string>;
@@ -273,11 +302,19 @@ struct CppEmitter {
/// Map from block to name of C++ label.
BlockMapper blockMapper;
- /// The number of values in the current scope. This is used to declare the
- /// names of values in a scope.
- std::stack<int64_t> valueInScopeCount;
+ /// Default values representing outermost scope
+ llvm::ScopedHashTableScope<Value, std::string> defaultValueMapperScope;
+ llvm::ScopedHashTableScope<Block *, std::string> defaultBlockMapperScope;
+
std::stack<int64_t> labelInScopeCount;
+ /// Keeps track of the amount of nested loops the emitter currently operates
+ /// in.
+ uint64_t loopNestingLevel{0};
+
+ /// Emitter-level count of created values to enable unique identifiers.
+ unsigned int valueCount{0};
+
/// State of the current expression being emitted.
ExpressionOp emittedExpression;
SmallVector<int> emittedExpressionPrecedence;
@@ -851,7 +888,6 @@ static LogicalResult printOperation(CppEmitter &emitter,
}
static LogicalResult printOperation(CppEmitter &emitter, emitc::ForOp forOp) {
-
raw_indented_ostream &os = emitter.ostream();
// Utility function to determine whether a value is an expression that will be
@@ -870,12 +906,12 @@ static LogicalResult printOperation(CppEmitter &emitter, emitc::ForOp forOp) {
emitter.emitType(forOp.getLoc(), forOp.getInductionVar().getType())))
return failure();
os << " ";
- os << emitter.getOrCreateName(forOp.getInductionVar());
+ os << emitter.getOrCreateName(forOp);
os << " = ";
if (failed(emitter.emitOperand(forOp.getLowerBound())))
return failure();
os << "; ";
- os << emitter.getOrCreateName(forOp.getInductionVar());
+ os << emitter.getOrCreateName(forOp);
os << " < ";
Value upperBound = forOp.getUpperBound();
bool upperBoundRequiresParentheses = requiresParentheses(upperBound);
@@ -886,13 +922,15 @@ static LogicalResult printOperation(CppEmitter &emitter, emitc::ForOp forOp) {
if (upperBoundRequiresParentheses)
os << ")";
os << "; ";
- os << emitter.getOrCreateName(forOp.getInductionVar());
+ os << emitter.getOrCreateName(forOp);
os << " += ";
if (failed(emitter.emitOperand(forOp.getStep())))
return failure();
os << ") {\n";
os.indent();
+ CppEmitter::LoopScope lScope(emitter);
+
Region &forRegion = forOp.getRegion();
auto regionOps = forRegion.getOps();
@@ -979,8 +1017,6 @@ static LogicalResult printOperation(CppEmitter &emitter,
}
static LogicalResult printOperation(CppEmitter &emitter, ModuleOp moduleOp) {
- CppEmitter::Scope scope(emitter);
-
for (Operation &op : moduleOp) {
if (failed(emitter.emitOperation(op, /*trailingSemicolon=*/false)))
return failure();
@@ -992,8 +1028,6 @@ static LogicalResult printOperation(CppEmitter &emitter, FileOp file) {
if (!emitter.shouldEmitFile(file))
return success();
- CppEmitter::Scope scope(emitter);
-
for (Operation &op : file) {
if (failed(emitter.emitOperation(op, /*trailingSemicolon=*/false)))
return failure();
@@ -1109,7 +1143,7 @@ static LogicalResult printOperation(CppEmitter &emitter,
return functionOp.emitOpError() << "cannot emit array type as result type";
}
- CppEmitter::Scope scope(emitter);
+ CppEmitter::FunctionScope scope(emitter);
raw_indented_ostream &os = emitter.ostream();
if (failed(emitter.emitTypes(functionOp.getLoc(),
functionOp.getFunctionType().getResults())))
@@ -1137,7 +1171,7 @@ static LogicalResult printOperation(CppEmitter &emitter,
"with multiple blocks needs variables declared at top");
}
- CppEmitter::Scope scope(emitter);
+ CppEmitter::FunctionScope scope(emitter);
raw_indented_ostream &os = emitter.ostream();
if (functionOp.getSpecifiers()) {
for (Attribute specifier : functionOp.getSpecifiersAttr()) {
@@ -1171,7 +1205,6 @@ static LogicalResult printOperation(CppEmitter &emitter,
static LogicalResult printOperation(CppEmitter &emitter,
DeclareFuncOp declareFuncOp) {
- CppEmitter::Scope scope(emitter);
raw_indented_ostream &os = emitter.ostream();
auto functionOp = SymbolTable::lookupNearestSymbolFrom<emitc::FuncOp>(
@@ -1203,8 +1236,8 @@ static LogicalResult printOperation(CppEmitter &emitter,
CppEmitter::CppEmitter(raw_ostream &os, bool declareVariablesAtTop,
StringRef fileId)
: os(os), declareVariablesAtTop(declareVariablesAtTop),
- fileId(fileId.str()) {
- valueInScopeCount.push(0);
+ fileId(fileId.str()), defaultValueMapperScope(valueMapper),
+ defaultBlockMapperScope(blockMapper) {
labelInScopeCount.push(0);
}
@@ -1245,7 +1278,29 @@ StringRef CppEmitter::getOrCreateName(Value val) {
assert(!hasDeferredEmission(val.getDefiningOp()) &&
"cacheDeferredOpResult should have been called on this value, "
"update the emitOperation function.");
- valueMapper.insert(val, formatv("v{0}", ++valueInScopeCount.top()));
+
+ valueMapper.insert(val, formatv("v{0}", ++valueCount));
+ }
+ return *valueMapper.begin(val);
+}
+
+/// Return the existing or a new name for a loop induction variable Value.
+/// Loop induction variables follow natural naming: i, j, k,...
+StringRef CppEmitter::getOrCreateName(emitc::ForOp forOp) {
+ Value val = forOp.getInductionVar();
+
+ if (!valueMapper.count(val)) {
+
+ int64_t identifier = 'i' + loopNestingLevel;
+
+ if (identifier >= 'i' && identifier <= 'z') {
+ valueMapper.insert(val,
+ formatv("{0}_{1}", (char)identifier, ++valueCount));
+ } else {
+ // If running out of letters, continue with zX
+ valueMapper.insert(
+ val, formatv("z{0}_{1}", identifier - 'z' - 1, ++valueCount));
+ }
}
return *valueMapper.begin(val);
}
@@ -1784,6 +1839,12 @@ LogicalResult CppEmitter::emitTupleType(Location loc, ArrayRef<Type> types) {
return success();
}
+void CppEmitter::resetValueCounter() { valueCount = 0; }
+
+void CppEmitter::increaseLoopNestingLevel() { loopNestingLevel++; }
+
+void CppEmitter::decreaseLoopNestingLevel() { loopNestingLevel--; }
+
LogicalResult emitc::translateToCpp(Operation *op, raw_ostream &os,
bool declareVariablesAtTop,
StringRef fileId) {
diff --git a/mlir/test/Target/Cpp/for_loop_induction_vars.mlir b/mlir/test/Target/Cpp/for_loop_induction_vars.mlir
new file mode 100644
index 0000000000000..3995a4a904ed4
--- /dev/null
+++ b/mlir/test/Target/Cpp/for_loop_induction_vars.mlir
@@ -0,0 +1,85 @@
+// RUN: mlir-translate -mlir-to-cpp %s | FileCheck %s
+
+// CHECK-LABEL: test_for_siblings
+func.func @test_for_siblings() {
+ %start = emitc.literal "0" : index
+ %stop = emitc.literal "10" : index
+ %step = emitc.literal "1" : index
+
+ %var1 = "emitc.variable"() <{value = 0 : index}> : () -> !emitc.lvalue<index>
+ %var2 = "emitc.variable"() <{value = 0 : index}> : () -> !emitc.lvalue<index>
+
+ // CHECK: for (size_t [[ITER0:i_[0-9]*]] = {{.*}}; [[ITER0]] < {{.*}}; [[ITER0]] += {{.*}}) {
+ emitc.for %i0 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITER1:j_[0-9]*]] = {{.*}}; [[ITER1]] < {{.*}}; [[ITER1]] += {{.*}}) {
+ emitc.for %i1 = %start to %stop step %step {
+ // CHECK: {{.*}} = [[ITER0]];
+ //"emitc.assign"(%var1,%i0) : (!emitc.lvalue<!emitc.size_t>, !emitc.size_t) -> ()
+ emitc.assign %i0 : index to %var1 : !emitc.lvalue<index>
+ // CHECK: {{.*}} = [[ITER1]];
+ //"emitc.assign"(%var2,%i1) : (!emitc.lvalue<!emitc.size_t>, !emitc.size_t) -> ()
+ emitc.assign %i1 : index to %var2 : !emitc.lvalue<index>
+ }
+ }
+ // CHECK: for (size_t [[ITER2:i_[0-9]*]] = {{.*}}; [[ITER2]] < {{.*}}; [[ITER2]] += {{.*}})
+ emitc.for %ki2 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITER3:j_[0-9]*]] = {{.*}}; [[ITER3]] < {{.*}}; [[ITER3]] += {{.*}})
+ emitc.for %i3 = %start to %stop step %step {
+ %1 = emitc.call_opaque "f"() : () -> i32
+ }
+ }
+ return
+}
+
+// CHECK-LABEL: test_for_nesting
+func.func @test_for_nesting() {
+ %start = emitc.literal "0" : index
+ %stop = emitc.literal "10" : index
+ %step = emitc.literal "1" : index
+
+ // CHECK-COUNT-18: for (size_t [[ITER:[i-z]_[0-9]*]] = {{.*}}; [[ITER]] < {{.*}}; [[ITER]] += {{.*}}) {
+ emitc.for %i0 = %start to %stop step %step {
+ emitc.for %i1 = %start to %stop step %step {
+ emitc.for %i2 = %start to %stop step %step {
+ emitc.for %i3 = %start to %stop step %step {
+ emitc.for %i4 = %start to %stop step %step {
+ emitc.for %i5 = %start to %stop step %step {
+ emitc.for %i6 = %start to %stop step %step {
+ emitc.for %i7 = %start to %stop step %step {
+ emitc.for %i8 = %start to %stop step %step {
+ emitc.for %i9 = %start to %stop step %step {
+ emitc.for %i10 = %start to %stop step %step {
+ emitc.for %i11 = %start to %stop step %step {
+ emitc.for %i12 = %start to %stop step %step {
+ emitc.for %i13 = %start to %stop step %step {
+ emitc.for %i14 = %start to %stop step %step {
+ emitc.for %i15 = %start to %stop step %step {
+ emitc.for %i16 = %start to %stop step %step {
+ emitc.for %i17 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITERz0:z0_[0-9]*]] = {{.*}}; [[ITERz0]] < {{.*}}; [[ITERz0]] += {{.*}}) {
+ emitc.for %i18 = %start to %stop step %step {
+ // CHECK: for (size_t [[ITERz1:z1_[0-9]*]] = {{.*}}; [[ITERz1]] < {{.*}}; [[ITERz1]] += {{.*}}) {
+ emitc.for %i19 = %start to %stop step %step {
+ %0 = emitc.call_opaque "f"() : () -> i32
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ return
+}
|
|
Requesting review from @simon-camp @marbre . |
Thanks for your PR @ndegener-amd. I unfortunately cannot spend too much time on reviews. @mgehre-amd do you mind to take a look as well to move this forward? Happy to spend some time next week on my side. |
@ndegener-amd is in my team and I already reviewed internally. That's why I think some external opinion would be nice. |
|
I will take a look next week. |
aniragil
reviewed
Apr 26, 2025
simon-camp
approved these changes
May 2, 2025
|
@marbre will you be able to find some time to review in the next few weeks? |
I was out of office last week but I think as Simon and Gil already approved this should be fine to land. If you like to get another approval before landing, I can review this week. |
marbre
approved these changes
Jun 6, 2025
|
@ndegener-amd, @mgehre-amd anything I can help with to get this landed? |
Sorry, I didn't see your feedback on this. But thanks! I'll integrate your suggestions. |
|
Anything I can help with? |
|
@ndegener-amd Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
mgehre-amd
pushed a commit
that referenced
this pull request
Jul 10, 2025
…ions (#147927) This is a fix for #136102. It missed scoping for `DeclareFuncOps`. In scenarios with multiple function declarations, the `valueMapper` wasn't updated and later uses of values in other functions still used the assigned names in prior functions. This is visible in the reproducer here iree-org/iree#21303: Although the counter for variable enumeration was reset, as it is visible for the local vars, the function arguments were mapped to old names. Due to this mapping, the counter was never increased, and the local variables conflicted with the arguments. This fix adds proper scoping for declarations and a test-case to cover the scenario with multiple `DeclareFuncOps`.
llvm-sync bot
pushed a commit
to arm/arm-toolchain
that referenced
this pull request
Jul 10, 2025
…on declarations (#147927) This is a fix for llvm/llvm-project#136102. It missed scoping for `DeclareFuncOps`. In scenarios with multiple function declarations, the `valueMapper` wasn't updated and later uses of values in other functions still used the assigned names in prior functions. This is visible in the reproducer here iree-org/iree#21303: Although the counter for variable enumeration was reset, as it is visible for the local vars, the function arguments were mapped to old names. Due to this mapping, the counter was never increased, and the local variables conflicted with the arguments. This fix adds proper scoping for declarations and a test-case to cover the scenario with multiple `DeclareFuncOps`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed naming of loop induction variables to follow natural naming (i, j, k, ...). This helps readability and locating positions referred to. Created new scopes to represent different behavior at function and loop level, to still enable re-using value names between different functions (as before). Removed unused scoping at other levels.