1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
//===- ExternalNameConversion.cpp -- convert name with external convention ===//
//
// 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/Dialect/FIRDialect.h"
#include "flang/Optimizer/Dialect/FIROps.h"
#include "flang/Optimizer/Dialect/FIROpsSupport.h"
#include "flang/Optimizer/Support/InternalNames.h"
#include "flang/Optimizer/Transforms/Passes.h"
#include "flang/Support/Fortran.h"
#include "mlir/Dialect/GPU/IR/GPUDialect.h"
#include "mlir/IR/Attributes.h"
#include "mlir/IR/SymbolTable.h"
#include "mlir/Pass/Pass.h"
namespace fir {
#define GEN_PASS_DEF_EXTERNALNAMECONVERSION
#include "flang/Optimizer/Transforms/Passes.h.inc"
} // namespace fir
using namespace mlir;
//===----------------------------------------------------------------------===//
// Helper functions
//===----------------------------------------------------------------------===//
/// Mangle the name with gfortran convention.
std::string
mangleExternalName(const std::pair<fir::NameUniquer::NameKind,
fir::NameUniquer::DeconstructedName>
result,
bool appendUnderscore) {
if (result.first == fir::NameUniquer::NameKind::COMMON &&
result.second.name.empty())
return Fortran::common::blankCommonObjectName;
return Fortran::common::GetExternalAssemblyName(result.second.name,
appendUnderscore);
}
/// Process a symbol reference and return the updated symbol reference if
/// needed.
std::optional<mlir::SymbolRefAttr>
processSymbolRef(mlir::SymbolRefAttr symRef, mlir::Operation *nestedOp,
const llvm::DenseMap<mlir::StringAttr, mlir::FlatSymbolRefAttr>
&remappings) {
if (auto remap = remappings.find(symRef.getLeafReference());
remap != remappings.end()) {
mlir::SymbolRefAttr symAttr = mlir::FlatSymbolRefAttr(remap->second);
if (mlir::isa<mlir::gpu::LaunchFuncOp>(nestedOp))
symAttr = mlir::SymbolRefAttr::get(
symRef.getRootReference(), {mlir::FlatSymbolRefAttr(remap->second)});
return symAttr;
}
return std::nullopt;
}
namespace {
class ExternalNameConversionPass
: public fir::impl::ExternalNameConversionBase<ExternalNameConversionPass> {
public:
using ExternalNameConversionBase<
ExternalNameConversionPass>::ExternalNameConversionBase;
mlir::ModuleOp getModule() { return getOperation(); }
void runOnOperation() override;
};
} // namespace
void ExternalNameConversionPass::runOnOperation() {
auto op = getOperation();
auto *context = &getContext();
llvm::DenseMap<mlir::StringAttr, mlir::FlatSymbolRefAttr> remappings;
mlir::SymbolTable symbolTable(op);
auto processFctOrGlobal = [&](mlir::Operation &funcOrGlobal) {
auto symName = funcOrGlobal.getAttrOfType<mlir::StringAttr>(
mlir::SymbolTable::getSymbolAttrName());
auto deconstructedName = fir::NameUniquer::deconstruct(symName);
if (fir::NameUniquer::isExternalFacingUniquedName(deconstructedName)) {
// Check if this is a private function that would conflict with a common
// block and get its mangled name.
if (auto funcOp = llvm::dyn_cast<mlir::func::FuncOp>(funcOrGlobal)) {
if (funcOp.isPrivate()) {
std::string mangledName =
mangleExternalName(deconstructedName, appendUnderscoreOpt);
auto mod = funcOp->getParentOfType<mlir::ModuleOp>();
bool hasConflictingCommonBlock = false;
// Check if any existing global has the same mangled name.
if (symbolTable.lookup<fir::GlobalOp>(mangledName))
hasConflictingCommonBlock = true;
// Skip externalization if the function has a conflicting common block
// and is not directly called (i.e. procedure pointers or type
// specifications)
if (hasConflictingCommonBlock) {
bool isDirectlyCalled = false;
std::optional<SymbolTable::UseRange> uses =
funcOp.getSymbolUses(mod);
if (uses.has_value()) {
for (auto use : *uses) {
mlir::Operation *user = use.getUser();
if (mlir::isa<fir::CallOp>(user) ||
mlir::isa<mlir::func::CallOp>(user)) {
isDirectlyCalled = true;
break;
}
}
}
if (!isDirectlyCalled)
return;
}
}
}
auto newName = mangleExternalName(deconstructedName, appendUnderscoreOpt);
auto newAttr = mlir::StringAttr::get(context, newName);
mlir::SymbolTable::setSymbolName(&funcOrGlobal, newAttr);
auto newSymRef = mlir::FlatSymbolRefAttr::get(newAttr);
remappings.try_emplace(symName, newSymRef);
if (llvm::isa<mlir::func::FuncOp>(funcOrGlobal))
funcOrGlobal.setAttr(fir::getInternalFuncNameAttrName(), symName);
}
};
auto renameFuncOrGlobalInModule = [&](mlir::Operation *module) {
for (auto &op : module->getRegion(0).front()) {
if (mlir::isa<mlir::func::FuncOp, fir::GlobalOp>(op)) {
processFctOrGlobal(op);
} else if (auto gpuMod = mlir::dyn_cast<mlir::gpu::GPUModuleOp>(op)) {
for (auto &gpuOp : gpuMod.getBodyRegion().front())
if (mlir::isa<mlir::func::FuncOp, fir::GlobalOp,
mlir::gpu::GPUFuncOp>(gpuOp))
processFctOrGlobal(gpuOp);
}
}
};
// Update names of external Fortran functions and names of Common Block
// globals.
renameFuncOrGlobalInModule(op);
if (remappings.empty())
return;
// Update all uses of the functions and globals that have been renamed.
op.walk([&remappings](mlir::Operation *nestedOp) {
llvm::SmallVector<std::pair<mlir::StringAttr, mlir::SymbolRefAttr>>
symRefUpdates;
llvm::SmallVector<std::pair<mlir::StringAttr, mlir::ArrayAttr>>
arrayUpdates;
for (const mlir::NamedAttribute &attr : nestedOp->getAttrDictionary())
if (auto symRef = llvm::dyn_cast<mlir::SymbolRefAttr>(attr.getValue())) {
if (auto newSymRef = processSymbolRef(symRef, nestedOp, remappings))
symRefUpdates.emplace_back(
std::pair<mlir::StringAttr, mlir::SymbolRefAttr>{attr.getName(),
*newSymRef});
} else if (auto arrayAttr =
llvm::dyn_cast<mlir::ArrayAttr>(attr.getValue())) {
llvm::SmallVector<mlir::Attribute> symbolRefs;
for (auto element : arrayAttr) {
if (!element) {
symbolRefs.push_back(element);
continue;
}
auto symRef = llvm::dyn_cast<mlir::SymbolRefAttr>(element);
std::optional<mlir::SymbolRefAttr> updatedSymRef;
if (symRef)
updatedSymRef = processSymbolRef(symRef, nestedOp, remappings);
if (!symRef || !updatedSymRef)
symbolRefs.push_back(element);
else
symbolRefs.push_back(*updatedSymRef);
}
arrayUpdates.push_back(std::make_pair(
attr.getName(),
mlir::ArrayAttr::get(nestedOp->getContext(), symbolRefs)));
}
for (auto update : symRefUpdates)
nestedOp->setAttr(update.first, update.second);
for (auto update : arrayUpdates)
nestedOp->setAttr(update.first, update.second);
});
}
|
