1 //===-- ConvertExpr.cpp ---------------------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/ 10 // 11 //===----------------------------------------------------------------------===// 12 13 #include "flang/Lower/ConvertExpr.h" 14 #include "flang/Evaluate/fold.h" 15 #include "flang/Evaluate/traverse.h" 16 #include "flang/Lower/AbstractConverter.h" 17 #include "flang/Lower/Allocatable.h" 18 #include "flang/Lower/BuiltinModules.h" 19 #include "flang/Lower/CallInterface.h" 20 #include "flang/Lower/ComponentPath.h" 21 #include "flang/Lower/ConvertType.h" 22 #include "flang/Lower/ConvertVariable.h" 23 #include "flang/Lower/CustomIntrinsicCall.h" 24 #include "flang/Lower/DumpEvaluateExpr.h" 25 #include "flang/Lower/IntrinsicCall.h" 26 #include "flang/Lower/Mangler.h" 27 #include "flang/Lower/StatementContext.h" 28 #include "flang/Lower/SymbolMap.h" 29 #include "flang/Lower/Todo.h" 30 #include "flang/Optimizer/Builder/Character.h" 31 #include "flang/Optimizer/Builder/Complex.h" 32 #include "flang/Optimizer/Builder/Factory.h" 33 #include "flang/Optimizer/Builder/LowLevelIntrinsics.h" 34 #include "flang/Optimizer/Builder/MutableBox.h" 35 #include "flang/Optimizer/Builder/Runtime/Character.h" 36 #include "flang/Optimizer/Builder/Runtime/RTBuilder.h" 37 #include "flang/Optimizer/Builder/Runtime/Ragged.h" 38 #include "flang/Optimizer/Dialect/FIROpsSupport.h" 39 #include "flang/Optimizer/Support/Matcher.h" 40 #include "flang/Semantics/expression.h" 41 #include "flang/Semantics/symbol.h" 42 #include "flang/Semantics/tools.h" 43 #include "flang/Semantics/type.h" 44 #include "mlir/Dialect/Func/IR/FuncOps.h" 45 #include "llvm/Support/CommandLine.h" 46 #include "llvm/Support/Debug.h" 47 48 #define DEBUG_TYPE "flang-lower-expr" 49 50 //===----------------------------------------------------------------------===// 51 // The composition and structure of Fortran::evaluate::Expr is defined in 52 // the various header files in include/flang/Evaluate. You are referred 53 // there for more information on these data structures. Generally speaking, 54 // these data structures are a strongly typed family of abstract data types 55 // that, composed as trees, describe the syntax of Fortran expressions. 56 // 57 // This part of the bridge can traverse these tree structures and lower them 58 // to the correct FIR representation in SSA form. 59 //===----------------------------------------------------------------------===// 60 61 static llvm::cl::opt<bool> generateArrayCoordinate( 62 "gen-array-coor", 63 llvm::cl::desc("in lowering create ArrayCoorOp instead of CoordinateOp"), 64 llvm::cl::init(false)); 65 66 // The default attempts to balance a modest allocation size with expected user 67 // input to minimize bounds checks and reallocations during dynamic array 68 // construction. Some user codes may have very large array constructors for 69 // which the default can be increased. 70 static llvm::cl::opt<unsigned> clInitialBufferSize( 71 "array-constructor-initial-buffer-size", 72 llvm::cl::desc( 73 "set the incremental array construction buffer size (default=32)"), 74 llvm::cl::init(32u)); 75 76 /// The various semantics of a program constituent (or a part thereof) as it may 77 /// appear in an expression. 78 /// 79 /// Given the following Fortran declarations. 80 /// ```fortran 81 /// REAL :: v1, v2, v3 82 /// REAL, POINTER :: vp1 83 /// REAL :: a1(c), a2(c) 84 /// REAL ELEMENTAL FUNCTION f1(arg) ! array -> array 85 /// FUNCTION f2(arg) ! array -> array 86 /// vp1 => v3 ! 1 87 /// v1 = v2 * vp1 ! 2 88 /// a1 = a1 + a2 ! 3 89 /// a1 = f1(a2) ! 4 90 /// a1 = f2(a2) ! 5 91 /// ``` 92 /// 93 /// In line 1, `vp1` is a BoxAddr to copy a box value into. The box value is 94 /// constructed from the DataAddr of `v3`. 95 /// In line 2, `v1` is a DataAddr to copy a value into. The value is constructed 96 /// from the DataValue of `v2` and `vp1`. DataValue is implicitly a double 97 /// dereference in the `vp1` case. 98 /// In line 3, `a1` and `a2` on the rhs are RefTransparent. The `a1` on the lhs 99 /// is CopyInCopyOut as `a1` is replaced elementally by the additions. 100 /// In line 4, `a2` can be RefTransparent, ByValueArg, RefOpaque, or BoxAddr if 101 /// `arg` is declared as C-like pass-by-value, VALUE, INTENT(?), or ALLOCATABLE/ 102 /// POINTER, respectively. `a1` on the lhs is CopyInCopyOut. 103 /// In line 5, `a2` may be DataAddr or BoxAddr assuming f2 is transformational. 104 /// `a1` on the lhs is again CopyInCopyOut. 105 enum class ConstituentSemantics { 106 // Scalar data reference semantics. 107 // 108 // For these let `v` be the location in memory of a variable with value `x` 109 DataValue, // refers to the value `x` 110 DataAddr, // refers to the address `v` 111 BoxValue, // refers to a box value containing `v` 112 BoxAddr, // refers to the address of a box value containing `v` 113 114 // Array data reference semantics. 115 // 116 // For these let `a` be the location in memory of a sequence of value `[xs]`. 117 // Let `x_i` be the `i`-th value in the sequence `[xs]`. 118 119 // Referentially transparent. Refers to the array's value, `[xs]`. 120 RefTransparent, 121 // Refers to an ephemeral address `tmp` containing value `x_i` (15.5.2.3.p7 122 // note 2). (Passing a copy by reference to simulate pass-by-value.) 123 ByValueArg, 124 // Refers to the merge of array value `[xs]` with another array value `[ys]`. 125 // This merged array value will be written into memory location `a`. 126 CopyInCopyOut, 127 // Similar to CopyInCopyOut but `a` may be a transient projection (rather than 128 // a whole array). 129 ProjectedCopyInCopyOut, 130 // Similar to ProjectedCopyInCopyOut, except the merge value is not assigned 131 // automatically by the framework. Instead, and address for `[xs]` is made 132 // accessible so that custom assignments to `[xs]` can be implemented. 133 CustomCopyInCopyOut, 134 // Referentially opaque. Refers to the address of `x_i`. 135 RefOpaque 136 }; 137 138 /// Convert parser's INTEGER relational operators to MLIR. TODO: using 139 /// unordered, but we may want to cons ordered in certain situation. 140 static mlir::arith::CmpIPredicate 141 translateRelational(Fortran::common::RelationalOperator rop) { 142 switch (rop) { 143 case Fortran::common::RelationalOperator::LT: 144 return mlir::arith::CmpIPredicate::slt; 145 case Fortran::common::RelationalOperator::LE: 146 return mlir::arith::CmpIPredicate::sle; 147 case Fortran::common::RelationalOperator::EQ: 148 return mlir::arith::CmpIPredicate::eq; 149 case Fortran::common::RelationalOperator::NE: 150 return mlir::arith::CmpIPredicate::ne; 151 case Fortran::common::RelationalOperator::GT: 152 return mlir::arith::CmpIPredicate::sgt; 153 case Fortran::common::RelationalOperator::GE: 154 return mlir::arith::CmpIPredicate::sge; 155 } 156 llvm_unreachable("unhandled INTEGER relational operator"); 157 } 158 159 /// Convert parser's REAL relational operators to MLIR. 160 /// The choice of order (O prefix) vs unorder (U prefix) follows Fortran 2018 161 /// requirements in the IEEE context (table 17.1 of F2018). This choice is 162 /// also applied in other contexts because it is easier and in line with 163 /// other Fortran compilers. 164 /// FIXME: The signaling/quiet aspect of the table 17.1 requirement is not 165 /// fully enforced. FIR and LLVM `fcmp` instructions do not give any guarantee 166 /// whether the comparison will signal or not in case of quiet NaN argument. 167 static mlir::arith::CmpFPredicate 168 translateFloatRelational(Fortran::common::RelationalOperator rop) { 169 switch (rop) { 170 case Fortran::common::RelationalOperator::LT: 171 return mlir::arith::CmpFPredicate::OLT; 172 case Fortran::common::RelationalOperator::LE: 173 return mlir::arith::CmpFPredicate::OLE; 174 case Fortran::common::RelationalOperator::EQ: 175 return mlir::arith::CmpFPredicate::OEQ; 176 case Fortran::common::RelationalOperator::NE: 177 return mlir::arith::CmpFPredicate::UNE; 178 case Fortran::common::RelationalOperator::GT: 179 return mlir::arith::CmpFPredicate::OGT; 180 case Fortran::common::RelationalOperator::GE: 181 return mlir::arith::CmpFPredicate::OGE; 182 } 183 llvm_unreachable("unhandled REAL relational operator"); 184 } 185 186 static mlir::Value genActualIsPresentTest(fir::FirOpBuilder &builder, 187 mlir::Location loc, 188 fir::ExtendedValue actual) { 189 if (const auto *ptrOrAlloc = actual.getBoxOf<fir::MutableBoxValue>()) 190 return fir::factory::genIsAllocatedOrAssociatedTest(builder, loc, 191 *ptrOrAlloc); 192 // Optional case (not that optional allocatable/pointer cannot be absent 193 // when passed to CMPLX as per 15.5.2.12 point 3 (7) and (8)). It is 194 // therefore possible to catch them in the `then` case above. 195 return builder.create<fir::IsPresentOp>(loc, builder.getI1Type(), 196 fir::getBase(actual)); 197 } 198 199 /// Convert the array_load, `load`, to an extended value. If `path` is not 200 /// empty, then traverse through the components designated. The base value is 201 /// `newBase`. This does not accept an array_load with a slice operand. 202 static fir::ExtendedValue 203 arrayLoadExtValue(fir::FirOpBuilder &builder, mlir::Location loc, 204 fir::ArrayLoadOp load, llvm::ArrayRef<mlir::Value> path, 205 mlir::Value newBase, mlir::Value newLen = {}) { 206 // Recover the extended value from the load. 207 assert(!load.getSlice() && "slice is not allowed"); 208 mlir::Type arrTy = load.getType(); 209 if (!path.empty()) { 210 mlir::Type ty = fir::applyPathToType(arrTy, path); 211 if (!ty) 212 fir::emitFatalError(loc, "path does not apply to type"); 213 if (!ty.isa<fir::SequenceType>()) { 214 if (fir::isa_char(ty)) { 215 mlir::Value len = newLen; 216 if (!len) 217 len = fir::factory::CharacterExprHelper{builder, loc}.getLength( 218 load.getMemref()); 219 if (!len) { 220 assert(load.getTypeparams().size() == 1 && 221 "length must be in array_load"); 222 len = load.getTypeparams()[0]; 223 } 224 return fir::CharBoxValue{newBase, len}; 225 } 226 return newBase; 227 } 228 arrTy = ty.cast<fir::SequenceType>(); 229 } 230 231 // Use the shape op, if there is one. 232 mlir::Value shapeVal = load.getShape(); 233 if (shapeVal) { 234 if (!mlir::isa<fir::ShiftOp>(shapeVal.getDefiningOp())) { 235 mlir::Type eleTy = fir::unwrapSequenceType(arrTy); 236 std::vector<mlir::Value> extents = fir::factory::getExtents(shapeVal); 237 std::vector<mlir::Value> origins = fir::factory::getOrigins(shapeVal); 238 if (fir::isa_char(eleTy)) { 239 mlir::Value len = newLen; 240 if (!len) 241 len = fir::factory::CharacterExprHelper{builder, loc}.getLength( 242 load.getMemref()); 243 if (!len) { 244 assert(load.getTypeparams().size() == 1 && 245 "length must be in array_load"); 246 len = load.getTypeparams()[0]; 247 } 248 return fir::CharArrayBoxValue(newBase, len, extents, origins); 249 } 250 return fir::ArrayBoxValue(newBase, extents, origins); 251 } 252 if (!fir::isa_box_type(load.getMemref().getType())) 253 fir::emitFatalError(loc, "shift op is invalid in this context"); 254 } 255 256 // There is no shape or the array is in a box. Extents and lower bounds must 257 // be read at runtime. 258 if (path.empty() && !shapeVal) { 259 fir::ExtendedValue exv = 260 fir::factory::readBoxValue(builder, loc, load.getMemref()); 261 return fir::substBase(exv, newBase); 262 } 263 TODO(loc, "component is boxed, retreive its type parameters"); 264 } 265 266 /// Place \p exv in memory if it is not already a memory reference. If 267 /// \p forceValueType is provided, the value is first casted to the provided 268 /// type before being stored (this is mainly intended for logicals whose value 269 /// may be `i1` but needed to be stored as Fortran logicals). 270 static fir::ExtendedValue 271 placeScalarValueInMemory(fir::FirOpBuilder &builder, mlir::Location loc, 272 const fir::ExtendedValue &exv, 273 mlir::Type storageType) { 274 mlir::Value valBase = fir::getBase(exv); 275 if (fir::conformsWithPassByRef(valBase.getType())) 276 return exv; 277 278 assert(!fir::hasDynamicSize(storageType) && 279 "only expect statically sized scalars to be by value"); 280 281 // Since `a` is not itself a valid referent, determine its value and 282 // create a temporary location at the beginning of the function for 283 // referencing. 284 mlir::Value val = builder.createConvert(loc, storageType, valBase); 285 mlir::Value temp = builder.createTemporary( 286 loc, storageType, 287 llvm::ArrayRef<mlir::NamedAttribute>{ 288 Fortran::lower::getAdaptToByRefAttr(builder)}); 289 builder.create<fir::StoreOp>(loc, val, temp); 290 return fir::substBase(exv, temp); 291 } 292 293 // Copy a copy of scalar \p exv in a new temporary. 294 static fir::ExtendedValue 295 createInMemoryScalarCopy(fir::FirOpBuilder &builder, mlir::Location loc, 296 const fir::ExtendedValue &exv) { 297 assert(exv.rank() == 0 && "input to scalar memory copy must be a scalar"); 298 if (exv.getCharBox() != nullptr) 299 return fir::factory::CharacterExprHelper{builder, loc}.createTempFrom(exv); 300 if (fir::isDerivedWithLengthParameters(exv)) 301 TODO(loc, "copy derived type with length parameters"); 302 mlir::Type type = fir::unwrapPassByRefType(fir::getBase(exv).getType()); 303 fir::ExtendedValue temp = builder.createTemporary(loc, type); 304 fir::factory::genScalarAssignment(builder, loc, temp, exv); 305 return temp; 306 } 307 308 // An expression with non-zero rank is an array expression. 309 template <typename A> 310 static bool isArray(const A &x) { 311 return x.Rank() != 0; 312 } 313 314 /// Is this a variable wrapped in parentheses? 315 template <typename A> 316 static bool isParenthesizedVariable(const A &) { 317 return false; 318 } 319 template <typename T> 320 static bool isParenthesizedVariable(const Fortran::evaluate::Expr<T> &expr) { 321 using ExprVariant = decltype(Fortran::evaluate::Expr<T>::u); 322 using Parentheses = Fortran::evaluate::Parentheses<T>; 323 if constexpr (Fortran::common::HasMember<Parentheses, ExprVariant>) { 324 if (const auto *parentheses = std::get_if<Parentheses>(&expr.u)) 325 return Fortran::evaluate::IsVariable(parentheses->left()); 326 return false; 327 } else { 328 return std::visit([&](const auto &x) { return isParenthesizedVariable(x); }, 329 expr.u); 330 } 331 } 332 333 /// Generate a load of a value from an address. Beware that this will lose 334 /// any dynamic type information for polymorphic entities (note that unlimited 335 /// polymorphic cannot be loaded and must not be provided here). 336 static fir::ExtendedValue genLoad(fir::FirOpBuilder &builder, 337 mlir::Location loc, 338 const fir::ExtendedValue &addr) { 339 return addr.match( 340 [](const fir::CharBoxValue &box) -> fir::ExtendedValue { return box; }, 341 [&](const fir::UnboxedValue &v) -> fir::ExtendedValue { 342 if (fir::unwrapRefType(fir::getBase(v).getType()) 343 .isa<fir::RecordType>()) 344 return v; 345 return builder.create<fir::LoadOp>(loc, fir::getBase(v)); 346 }, 347 [&](const fir::MutableBoxValue &box) -> fir::ExtendedValue { 348 TODO(loc, "genLoad for MutableBoxValue"); 349 }, 350 [&](const fir::BoxValue &box) -> fir::ExtendedValue { 351 TODO(loc, "genLoad for BoxValue"); 352 }, 353 [&](const auto &) -> fir::ExtendedValue { 354 fir::emitFatalError( 355 loc, "attempting to load whole array or procedure address"); 356 }); 357 } 358 359 /// Create an optional dummy argument value from entity \p exv that may be 360 /// absent. This can only be called with numerical or logical scalar \p exv. 361 /// If \p exv is considered absent according to 15.5.2.12 point 1., the returned 362 /// value is zero (or false), otherwise it is the value of \p exv. 363 static fir::ExtendedValue genOptionalValue(fir::FirOpBuilder &builder, 364 mlir::Location loc, 365 const fir::ExtendedValue &exv, 366 mlir::Value isPresent) { 367 mlir::Type eleType = fir::getBaseTypeOf(exv); 368 assert(exv.rank() == 0 && fir::isa_trivial(eleType) && 369 "must be a numerical or logical scalar"); 370 return builder 371 .genIfOp(loc, {eleType}, isPresent, 372 /*withElseRegion=*/true) 373 .genThen([&]() { 374 mlir::Value val = fir::getBase(genLoad(builder, loc, exv)); 375 builder.create<fir::ResultOp>(loc, val); 376 }) 377 .genElse([&]() { 378 mlir::Value zero = fir::factory::createZeroValue(builder, loc, eleType); 379 builder.create<fir::ResultOp>(loc, zero); 380 }) 381 .getResults()[0]; 382 } 383 384 /// Create an optional dummy argument address from entity \p exv that may be 385 /// absent. If \p exv is considered absent according to 15.5.2.12 point 1., the 386 /// returned value is a null pointer, otherwise it is the address of \p exv. 387 static fir::ExtendedValue genOptionalAddr(fir::FirOpBuilder &builder, 388 mlir::Location loc, 389 const fir::ExtendedValue &exv, 390 mlir::Value isPresent) { 391 // If it is an exv pointer/allocatable, then it cannot be absent 392 // because it is passed to a non-pointer/non-allocatable. 393 if (const auto *box = exv.getBoxOf<fir::MutableBoxValue>()) 394 return fir::factory::genMutableBoxRead(builder, loc, *box); 395 // If this is not a POINTER or ALLOCATABLE, then it is already an OPTIONAL 396 // address and can be passed directly. 397 return exv; 398 } 399 400 /// Create an optional dummy argument address from entity \p exv that may be 401 /// absent. If \p exv is considered absent according to 15.5.2.12 point 1., the 402 /// returned value is an absent fir.box, otherwise it is a fir.box describing \p 403 /// exv. 404 static fir::ExtendedValue genOptionalBox(fir::FirOpBuilder &builder, 405 mlir::Location loc, 406 const fir::ExtendedValue &exv, 407 mlir::Value isPresent) { 408 // Non allocatable/pointer optional box -> simply forward 409 if (exv.getBoxOf<fir::BoxValue>()) 410 return exv; 411 412 fir::ExtendedValue newExv = exv; 413 // Optional allocatable/pointer -> Cannot be absent, but need to translate 414 // unallocated/diassociated into absent fir.box. 415 if (const auto *box = exv.getBoxOf<fir::MutableBoxValue>()) 416 newExv = fir::factory::genMutableBoxRead(builder, loc, *box); 417 418 // createBox will not do create any invalid memory dereferences if exv is 419 // absent. The created fir.box will not be usable, but the SelectOp below 420 // ensures it won't be. 421 mlir::Value box = builder.createBox(loc, newExv); 422 mlir::Type boxType = box.getType(); 423 auto absent = builder.create<fir::AbsentOp>(loc, boxType); 424 auto boxOrAbsent = builder.create<mlir::arith::SelectOp>( 425 loc, boxType, isPresent, box, absent); 426 return fir::BoxValue(boxOrAbsent); 427 } 428 429 /// Is this a call to an elemental procedure with at least one array argument? 430 static bool 431 isElementalProcWithArrayArgs(const Fortran::evaluate::ProcedureRef &procRef) { 432 if (procRef.IsElemental()) 433 for (const std::optional<Fortran::evaluate::ActualArgument> &arg : 434 procRef.arguments()) 435 if (arg && arg->Rank() != 0) 436 return true; 437 return false; 438 } 439 template <typename T> 440 static bool isElementalProcWithArrayArgs(const Fortran::evaluate::Expr<T> &) { 441 return false; 442 } 443 template <> 444 bool isElementalProcWithArrayArgs(const Fortran::lower::SomeExpr &x) { 445 if (const auto *procRef = std::get_if<Fortran::evaluate::ProcedureRef>(&x.u)) 446 return isElementalProcWithArrayArgs(*procRef); 447 return false; 448 } 449 450 /// Some auxiliary data for processing initialization in ScalarExprLowering 451 /// below. This is currently used for generating dense attributed global 452 /// arrays. 453 struct InitializerData { 454 explicit InitializerData(bool getRawVals = false) : genRawVals{getRawVals} {} 455 llvm::SmallVector<mlir::Attribute> rawVals; // initialization raw values 456 mlir::Type rawType; // Type of elements processed for rawVals vector. 457 bool genRawVals; // generate the rawVals vector if set. 458 }; 459 460 /// If \p arg is the address of a function with a denoted host-association tuple 461 /// argument, then return the host-associations tuple value of the current 462 /// procedure. Otherwise, return nullptr. 463 static mlir::Value 464 argumentHostAssocs(Fortran::lower::AbstractConverter &converter, 465 mlir::Value arg) { 466 if (auto addr = mlir::dyn_cast_or_null<fir::AddrOfOp>(arg.getDefiningOp())) { 467 auto &builder = converter.getFirOpBuilder(); 468 if (auto funcOp = builder.getNamedFunction(addr.getSymbol())) 469 if (fir::anyFuncArgsHaveAttr(funcOp, fir::getHostAssocAttrName())) 470 return converter.hostAssocTupleValue(); 471 } 472 return {}; 473 } 474 475 /// \p argTy must be a tuple (pair) of boxproc and integral types. Convert the 476 /// \p funcAddr argument to a boxproc value, with the host-association as 477 /// required. Call the factory function to finish creating the tuple value. 478 static mlir::Value 479 createBoxProcCharTuple(Fortran::lower::AbstractConverter &converter, 480 mlir::Type argTy, mlir::Value funcAddr, 481 mlir::Value charLen) { 482 auto boxTy = 483 argTy.cast<mlir::TupleType>().getType(0).cast<fir::BoxProcType>(); 484 mlir::Location loc = converter.getCurrentLocation(); 485 auto &builder = converter.getFirOpBuilder(); 486 auto boxProc = [&]() -> mlir::Value { 487 if (auto host = argumentHostAssocs(converter, funcAddr)) 488 return builder.create<fir::EmboxProcOp>( 489 loc, boxTy, llvm::ArrayRef<mlir::Value>{funcAddr, host}); 490 return builder.create<fir::EmboxProcOp>(loc, boxTy, funcAddr); 491 }(); 492 return fir::factory::createCharacterProcedureTuple(builder, loc, argTy, 493 boxProc, charLen); 494 } 495 496 // Helper to get the ultimate first symbol. This works around the fact that 497 // symbol resolution in the front end doesn't always resolve a symbol to its 498 // ultimate symbol but may leave placeholder indirections for use and host 499 // associations. 500 template <typename A> 501 const Fortran::semantics::Symbol &getFirstSym(const A &obj) { 502 return obj.GetFirstSymbol().GetUltimate(); 503 } 504 505 // Helper to get the ultimate last symbol. 506 template <typename A> 507 const Fortran::semantics::Symbol &getLastSym(const A &obj) { 508 return obj.GetLastSymbol().GetUltimate(); 509 } 510 511 namespace { 512 513 /// Lowering of Fortran::evaluate::Expr<T> expressions 514 class ScalarExprLowering { 515 public: 516 using ExtValue = fir::ExtendedValue; 517 518 explicit ScalarExprLowering(mlir::Location loc, 519 Fortran::lower::AbstractConverter &converter, 520 Fortran::lower::SymMap &symMap, 521 Fortran::lower::StatementContext &stmtCtx, 522 InitializerData *initializer = nullptr) 523 : location{loc}, converter{converter}, 524 builder{converter.getFirOpBuilder()}, stmtCtx{stmtCtx}, symMap{symMap}, 525 inInitializer{initializer} {} 526 527 ExtValue genExtAddr(const Fortran::lower::SomeExpr &expr) { 528 return gen(expr); 529 } 530 531 /// Lower `expr` to be passed as a fir.box argument. Do not create a temp 532 /// for the expr if it is a variable that can be described as a fir.box. 533 ExtValue genBoxArg(const Fortran::lower::SomeExpr &expr) { 534 bool saveUseBoxArg = useBoxArg; 535 useBoxArg = true; 536 ExtValue result = gen(expr); 537 useBoxArg = saveUseBoxArg; 538 return result; 539 } 540 541 ExtValue genExtValue(const Fortran::lower::SomeExpr &expr) { 542 return genval(expr); 543 } 544 545 /// Lower an expression that is a pointer or an allocatable to a 546 /// MutableBoxValue. 547 fir::MutableBoxValue 548 genMutableBoxValue(const Fortran::lower::SomeExpr &expr) { 549 // Pointers and allocatables can only be: 550 // - a simple designator "x" 551 // - a component designator "a%b(i,j)%x" 552 // - a function reference "foo()" 553 // - result of NULL() or NULL(MOLD) intrinsic. 554 // NULL() requires some context to be lowered, so it is not handled 555 // here and must be lowered according to the context where it appears. 556 ExtValue exv = std::visit( 557 [&](const auto &x) { return genMutableBoxValueImpl(x); }, expr.u); 558 const fir::MutableBoxValue *mutableBox = 559 exv.getBoxOf<fir::MutableBoxValue>(); 560 if (!mutableBox) 561 fir::emitFatalError(getLoc(), "expr was not lowered to MutableBoxValue"); 562 return *mutableBox; 563 } 564 565 template <typename T> 566 ExtValue genMutableBoxValueImpl(const T &) { 567 // NULL() case should not be handled here. 568 fir::emitFatalError(getLoc(), "NULL() must be lowered in its context"); 569 } 570 571 template <typename T> 572 ExtValue 573 genMutableBoxValueImpl(const Fortran::evaluate::FunctionRef<T> &funRef) { 574 return genRawProcedureRef(funRef, converter.genType(toEvExpr(funRef))); 575 } 576 577 template <typename T> 578 ExtValue 579 genMutableBoxValueImpl(const Fortran::evaluate::Designator<T> &designator) { 580 return std::visit( 581 Fortran::common::visitors{ 582 [&](const Fortran::evaluate::SymbolRef &sym) -> ExtValue { 583 return symMap.lookupSymbol(*sym).toExtendedValue(); 584 }, 585 [&](const Fortran::evaluate::Component &comp) -> ExtValue { 586 return genComponent(comp); 587 }, 588 [&](const auto &) -> ExtValue { 589 fir::emitFatalError(getLoc(), 590 "not an allocatable or pointer designator"); 591 }}, 592 designator.u); 593 } 594 595 template <typename T> 596 ExtValue genMutableBoxValueImpl(const Fortran::evaluate::Expr<T> &expr) { 597 return std::visit([&](const auto &x) { return genMutableBoxValueImpl(x); }, 598 expr.u); 599 } 600 601 mlir::Location getLoc() { return location; } 602 603 template <typename A> 604 mlir::Value genunbox(const A &expr) { 605 ExtValue e = genval(expr); 606 if (const fir::UnboxedValue *r = e.getUnboxed()) 607 return *r; 608 fir::emitFatalError(getLoc(), "unboxed expression expected"); 609 } 610 611 /// Generate an integral constant of `value` 612 template <int KIND> 613 mlir::Value genIntegerConstant(mlir::MLIRContext *context, 614 std::int64_t value) { 615 mlir::Type type = 616 converter.genType(Fortran::common::TypeCategory::Integer, KIND); 617 return builder.createIntegerConstant(getLoc(), type, value); 618 } 619 620 /// Generate a logical/boolean constant of `value` 621 mlir::Value genBoolConstant(bool value) { 622 return builder.createBool(getLoc(), value); 623 } 624 625 /// Generate a real constant with a value `value`. 626 template <int KIND> 627 mlir::Value genRealConstant(mlir::MLIRContext *context, 628 const llvm::APFloat &value) { 629 mlir::Type fltTy = Fortran::lower::convertReal(context, KIND); 630 return builder.createRealConstant(getLoc(), fltTy, value); 631 } 632 633 template <typename OpTy> 634 mlir::Value createCompareOp(mlir::arith::CmpIPredicate pred, 635 const ExtValue &left, const ExtValue &right) { 636 if (const fir::UnboxedValue *lhs = left.getUnboxed()) 637 if (const fir::UnboxedValue *rhs = right.getUnboxed()) 638 return builder.create<OpTy>(getLoc(), pred, *lhs, *rhs); 639 fir::emitFatalError(getLoc(), "array compare should be handled in genarr"); 640 } 641 template <typename OpTy, typename A> 642 mlir::Value createCompareOp(const A &ex, mlir::arith::CmpIPredicate pred) { 643 ExtValue left = genval(ex.left()); 644 return createCompareOp<OpTy>(pred, left, genval(ex.right())); 645 } 646 647 template <typename OpTy> 648 mlir::Value createFltCmpOp(mlir::arith::CmpFPredicate pred, 649 const ExtValue &left, const ExtValue &right) { 650 if (const fir::UnboxedValue *lhs = left.getUnboxed()) 651 if (const fir::UnboxedValue *rhs = right.getUnboxed()) 652 return builder.create<OpTy>(getLoc(), pred, *lhs, *rhs); 653 fir::emitFatalError(getLoc(), "array compare should be handled in genarr"); 654 } 655 template <typename OpTy, typename A> 656 mlir::Value createFltCmpOp(const A &ex, mlir::arith::CmpFPredicate pred) { 657 ExtValue left = genval(ex.left()); 658 return createFltCmpOp<OpTy>(pred, left, genval(ex.right())); 659 } 660 661 /// Create a call to the runtime to compare two CHARACTER values. 662 /// Precondition: This assumes that the two values have `fir.boxchar` type. 663 mlir::Value createCharCompare(mlir::arith::CmpIPredicate pred, 664 const ExtValue &left, const ExtValue &right) { 665 return fir::runtime::genCharCompare(builder, getLoc(), pred, left, right); 666 } 667 668 template <typename A> 669 mlir::Value createCharCompare(const A &ex, mlir::arith::CmpIPredicate pred) { 670 ExtValue left = genval(ex.left()); 671 return createCharCompare(pred, left, genval(ex.right())); 672 } 673 674 /// Returns a reference to a symbol or its box/boxChar descriptor if it has 675 /// one. 676 ExtValue gen(Fortran::semantics::SymbolRef sym) { 677 if (Fortran::lower::SymbolBox val = symMap.lookupSymbol(sym)) 678 return val.match( 679 [&](const Fortran::lower::SymbolBox::PointerOrAllocatable &boxAddr) { 680 return fir::factory::genMutableBoxRead(builder, getLoc(), boxAddr); 681 }, 682 [&val](auto &) { return val.toExtendedValue(); }); 683 LLVM_DEBUG(llvm::dbgs() 684 << "unknown symbol: " << sym << "\nmap: " << symMap << '\n'); 685 fir::emitFatalError(getLoc(), "symbol is not mapped to any IR value"); 686 } 687 688 ExtValue genLoad(const ExtValue &exv) { 689 return ::genLoad(builder, getLoc(), exv); 690 } 691 692 ExtValue genval(Fortran::semantics::SymbolRef sym) { 693 mlir::Location loc = getLoc(); 694 ExtValue var = gen(sym); 695 if (const fir::UnboxedValue *s = var.getUnboxed()) 696 if (fir::isReferenceLike(s->getType())) { 697 // A function with multiple entry points returning different types 698 // tags all result variables with one of the largest types to allow 699 // them to share the same storage. A reference to a result variable 700 // of one of the other types requires conversion to the actual type. 701 fir::UnboxedValue addr = *s; 702 if (Fortran::semantics::IsFunctionResult(sym)) { 703 mlir::Type resultType = converter.genType(*sym); 704 if (addr.getType() != resultType) 705 addr = builder.createConvert(loc, builder.getRefType(resultType), 706 addr); 707 } 708 return genLoad(addr); 709 } 710 return var; 711 } 712 713 ExtValue genval(const Fortran::evaluate::BOZLiteralConstant &) { 714 TODO(getLoc(), "genval BOZ"); 715 } 716 717 /// Return indirection to function designated in ProcedureDesignator. 718 /// The type of the function indirection is not guaranteed to match the one 719 /// of the ProcedureDesignator due to Fortran implicit typing rules. 720 ExtValue genval(const Fortran::evaluate::ProcedureDesignator &proc) { 721 TODO(getLoc(), "genval ProcedureDesignator"); 722 } 723 724 ExtValue genval(const Fortran::evaluate::NullPointer &) { 725 TODO(getLoc(), "genval NullPointer"); 726 } 727 728 static bool 729 isDerivedTypeWithLengthParameters(const Fortran::semantics::Symbol &sym) { 730 if (const Fortran::semantics::DeclTypeSpec *declTy = sym.GetType()) 731 if (const Fortran::semantics::DerivedTypeSpec *derived = 732 declTy->AsDerived()) 733 return Fortran::semantics::CountLenParameters(*derived) > 0; 734 return false; 735 } 736 737 static bool isBuiltinCPtr(const Fortran::semantics::Symbol &sym) { 738 if (const Fortran::semantics::DeclTypeSpec *declType = sym.GetType()) 739 if (const Fortran::semantics::DerivedTypeSpec *derived = 740 declType->AsDerived()) 741 return Fortran::semantics::IsIsoCType(derived); 742 return false; 743 } 744 745 /// Lower structure constructor without a temporary. This can be used in 746 /// fir::GloablOp, and assumes that the structure component is a constant. 747 ExtValue genStructComponentInInitializer( 748 const Fortran::evaluate::StructureConstructor &ctor) { 749 mlir::Location loc = getLoc(); 750 mlir::Type ty = translateSomeExprToFIRType(converter, toEvExpr(ctor)); 751 auto recTy = ty.cast<fir::RecordType>(); 752 auto fieldTy = fir::FieldType::get(ty.getContext()); 753 mlir::Value res = builder.create<fir::UndefOp>(loc, recTy); 754 755 for (const auto &[sym, expr] : ctor.values()) { 756 // Parent components need more work because they do not appear in the 757 // fir.rec type. 758 if (sym->test(Fortran::semantics::Symbol::Flag::ParentComp)) 759 TODO(loc, "parent component in structure constructor"); 760 761 llvm::StringRef name = toStringRef(sym->name()); 762 mlir::Type componentTy = recTy.getType(name); 763 // FIXME: type parameters must come from the derived-type-spec 764 auto field = builder.create<fir::FieldIndexOp>( 765 loc, fieldTy, name, ty, 766 /*typeParams=*/mlir::ValueRange{} /*TODO*/); 767 768 if (Fortran::semantics::IsAllocatable(sym)) 769 TODO(loc, "allocatable component in structure constructor"); 770 771 if (Fortran::semantics::IsPointer(sym)) { 772 mlir::Value initialTarget = Fortran::lower::genInitialDataTarget( 773 converter, loc, componentTy, expr.value()); 774 res = builder.create<fir::InsertValueOp>( 775 loc, recTy, res, initialTarget, 776 builder.getArrayAttr(field.getAttributes())); 777 continue; 778 } 779 780 if (isDerivedTypeWithLengthParameters(sym)) 781 TODO(loc, "component with length parameters in structure constructor"); 782 783 if (isBuiltinCPtr(sym)) { 784 // Builtin c_ptr and c_funptr have special handling because initial 785 // value are handled for them as an extension. 786 mlir::Value addr = fir::getBase(Fortran::lower::genExtAddrInInitializer( 787 converter, loc, expr.value())); 788 if (addr.getType() == componentTy) { 789 // Do nothing. The Ev::Expr was returned as a value that can be 790 // inserted directly to the component without an intermediary. 791 } else { 792 // The Ev::Expr returned is an initializer that is a pointer (e.g., 793 // null) that must be inserted into an intermediate cptr record 794 // value's address field, which ought to be an intptr_t on the target. 795 assert((fir::isa_ref_type(addr.getType()) || 796 addr.getType().isa<mlir::FunctionType>()) && 797 "expect reference type for address field"); 798 assert(fir::isa_derived(componentTy) && 799 "expect C_PTR, C_FUNPTR to be a record"); 800 auto cPtrRecTy = componentTy.cast<fir::RecordType>(); 801 llvm::StringRef addrFieldName = 802 Fortran::lower::builtin::cptrFieldName; 803 mlir::Type addrFieldTy = cPtrRecTy.getType(addrFieldName); 804 auto addrField = builder.create<fir::FieldIndexOp>( 805 loc, fieldTy, addrFieldName, componentTy, 806 /*typeParams=*/mlir::ValueRange{}); 807 mlir::Value castAddr = builder.createConvert(loc, addrFieldTy, addr); 808 auto undef = builder.create<fir::UndefOp>(loc, componentTy); 809 addr = builder.create<fir::InsertValueOp>( 810 loc, componentTy, undef, castAddr, 811 builder.getArrayAttr(addrField.getAttributes())); 812 } 813 res = builder.create<fir::InsertValueOp>( 814 loc, recTy, res, addr, builder.getArrayAttr(field.getAttributes())); 815 continue; 816 } 817 818 mlir::Value val = fir::getBase(genval(expr.value())); 819 assert(!fir::isa_ref_type(val.getType()) && "expecting a constant value"); 820 mlir::Value castVal = builder.createConvert(loc, componentTy, val); 821 res = builder.create<fir::InsertValueOp>( 822 loc, recTy, res, castVal, 823 builder.getArrayAttr(field.getAttributes())); 824 } 825 return res; 826 } 827 828 /// A structure constructor is lowered two ways. In an initializer context, 829 /// the entire structure must be constant, so the aggregate value is 830 /// constructed inline. This allows it to be the body of a GlobalOp. 831 /// Otherwise, the structure constructor is in an expression. In that case, a 832 /// temporary object is constructed in the stack frame of the procedure. 833 ExtValue genval(const Fortran::evaluate::StructureConstructor &ctor) { 834 if (inInitializer) 835 return genStructComponentInInitializer(ctor); 836 mlir::Location loc = getLoc(); 837 mlir::Type ty = translateSomeExprToFIRType(converter, toEvExpr(ctor)); 838 auto recTy = ty.cast<fir::RecordType>(); 839 auto fieldTy = fir::FieldType::get(ty.getContext()); 840 mlir::Value res = builder.createTemporary(loc, recTy); 841 842 for (const auto &value : ctor.values()) { 843 const Fortran::semantics::Symbol &sym = *value.first; 844 const Fortran::lower::SomeExpr &expr = value.second.value(); 845 // Parent components need more work because they do not appear in the 846 // fir.rec type. 847 if (sym.test(Fortran::semantics::Symbol::Flag::ParentComp)) 848 TODO(loc, "parent component in structure constructor"); 849 850 if (isDerivedTypeWithLengthParameters(sym)) 851 TODO(loc, "component with length parameters in structure constructor"); 852 853 llvm::StringRef name = toStringRef(sym.name()); 854 // FIXME: type parameters must come from the derived-type-spec 855 mlir::Value field = builder.create<fir::FieldIndexOp>( 856 loc, fieldTy, name, ty, 857 /*typeParams=*/mlir::ValueRange{} /*TODO*/); 858 mlir::Type coorTy = builder.getRefType(recTy.getType(name)); 859 auto coor = builder.create<fir::CoordinateOp>(loc, coorTy, 860 fir::getBase(res), field); 861 ExtValue to = fir::factory::componentToExtendedValue(builder, loc, coor); 862 to.match( 863 [&](const fir::UnboxedValue &toPtr) { 864 ExtValue value = genval(expr); 865 fir::factory::genScalarAssignment(builder, loc, to, value); 866 }, 867 [&](const fir::CharBoxValue &) { 868 ExtValue value = genval(expr); 869 fir::factory::genScalarAssignment(builder, loc, to, value); 870 }, 871 [&](const fir::ArrayBoxValue &) { 872 Fortran::lower::createSomeArrayAssignment(converter, to, expr, 873 symMap, stmtCtx); 874 }, 875 [&](const fir::CharArrayBoxValue &) { 876 Fortran::lower::createSomeArrayAssignment(converter, to, expr, 877 symMap, stmtCtx); 878 }, 879 [&](const fir::BoxValue &toBox) { 880 fir::emitFatalError(loc, "derived type components must not be " 881 "represented by fir::BoxValue"); 882 }, 883 [&](const fir::MutableBoxValue &toBox) { 884 if (toBox.isPointer()) { 885 Fortran::lower::associateMutableBox( 886 converter, loc, toBox, expr, /*lbounds=*/llvm::None, stmtCtx); 887 return; 888 } 889 // For allocatable components, a deep copy is needed. 890 TODO(loc, "allocatable components in derived type assignment"); 891 }, 892 [&](const fir::ProcBoxValue &toBox) { 893 TODO(loc, "procedure pointer component in derived type assignment"); 894 }); 895 } 896 return res; 897 } 898 899 /// Lowering of an <i>ac-do-variable</i>, which is not a Symbol. 900 ExtValue genval(const Fortran::evaluate::ImpliedDoIndex &var) { 901 return converter.impliedDoBinding(toStringRef(var.name)); 902 } 903 904 ExtValue genval(const Fortran::evaluate::DescriptorInquiry &desc) { 905 ExtValue exv = desc.base().IsSymbol() ? gen(getLastSym(desc.base())) 906 : gen(desc.base().GetComponent()); 907 mlir::IndexType idxTy = builder.getIndexType(); 908 mlir::Location loc = getLoc(); 909 auto castResult = [&](mlir::Value v) { 910 using ResTy = Fortran::evaluate::DescriptorInquiry::Result; 911 return builder.createConvert( 912 loc, converter.genType(ResTy::category, ResTy::kind), v); 913 }; 914 switch (desc.field()) { 915 case Fortran::evaluate::DescriptorInquiry::Field::Len: 916 return castResult(fir::factory::readCharLen(builder, loc, exv)); 917 case Fortran::evaluate::DescriptorInquiry::Field::LowerBound: 918 return castResult(fir::factory::readLowerBound( 919 builder, loc, exv, desc.dimension(), 920 builder.createIntegerConstant(loc, idxTy, 1))); 921 case Fortran::evaluate::DescriptorInquiry::Field::Extent: 922 return castResult( 923 fir::factory::readExtent(builder, loc, exv, desc.dimension())); 924 case Fortran::evaluate::DescriptorInquiry::Field::Rank: 925 TODO(loc, "rank inquiry on assumed rank"); 926 case Fortran::evaluate::DescriptorInquiry::Field::Stride: 927 // So far the front end does not generate this inquiry. 928 TODO(loc, "Stride inquiry"); 929 } 930 llvm_unreachable("unknown descriptor inquiry"); 931 } 932 933 ExtValue genval(const Fortran::evaluate::TypeParamInquiry &) { 934 TODO(getLoc(), "genval TypeParamInquiry"); 935 } 936 937 template <int KIND> 938 ExtValue genval(const Fortran::evaluate::ComplexComponent<KIND> &part) { 939 TODO(getLoc(), "genval ComplexComponent"); 940 } 941 942 template <int KIND> 943 ExtValue genval(const Fortran::evaluate::Negate<Fortran::evaluate::Type< 944 Fortran::common::TypeCategory::Integer, KIND>> &op) { 945 mlir::Value input = genunbox(op.left()); 946 // Like LLVM, integer negation is the binary op "0 - value" 947 mlir::Value zero = genIntegerConstant<KIND>(builder.getContext(), 0); 948 return builder.create<mlir::arith::SubIOp>(getLoc(), zero, input); 949 } 950 951 template <int KIND> 952 ExtValue genval(const Fortran::evaluate::Negate<Fortran::evaluate::Type< 953 Fortran::common::TypeCategory::Real, KIND>> &op) { 954 return builder.create<mlir::arith::NegFOp>(getLoc(), genunbox(op.left())); 955 } 956 template <int KIND> 957 ExtValue genval(const Fortran::evaluate::Negate<Fortran::evaluate::Type< 958 Fortran::common::TypeCategory::Complex, KIND>> &op) { 959 return builder.create<fir::NegcOp>(getLoc(), genunbox(op.left())); 960 } 961 962 template <typename OpTy> 963 mlir::Value createBinaryOp(const ExtValue &left, const ExtValue &right) { 964 assert(fir::isUnboxedValue(left) && fir::isUnboxedValue(right)); 965 mlir::Value lhs = fir::getBase(left); 966 mlir::Value rhs = fir::getBase(right); 967 assert(lhs.getType() == rhs.getType() && "types must be the same"); 968 return builder.create<OpTy>(getLoc(), lhs, rhs); 969 } 970 971 template <typename OpTy, typename A> 972 mlir::Value createBinaryOp(const A &ex) { 973 ExtValue left = genval(ex.left()); 974 return createBinaryOp<OpTy>(left, genval(ex.right())); 975 } 976 977 #undef GENBIN 978 #define GENBIN(GenBinEvOp, GenBinTyCat, GenBinFirOp) \ 979 template <int KIND> \ 980 ExtValue genval(const Fortran::evaluate::GenBinEvOp<Fortran::evaluate::Type< \ 981 Fortran::common::TypeCategory::GenBinTyCat, KIND>> &x) { \ 982 return createBinaryOp<GenBinFirOp>(x); \ 983 } 984 985 GENBIN(Add, Integer, mlir::arith::AddIOp) 986 GENBIN(Add, Real, mlir::arith::AddFOp) 987 GENBIN(Add, Complex, fir::AddcOp) 988 GENBIN(Subtract, Integer, mlir::arith::SubIOp) 989 GENBIN(Subtract, Real, mlir::arith::SubFOp) 990 GENBIN(Subtract, Complex, fir::SubcOp) 991 GENBIN(Multiply, Integer, mlir::arith::MulIOp) 992 GENBIN(Multiply, Real, mlir::arith::MulFOp) 993 GENBIN(Multiply, Complex, fir::MulcOp) 994 GENBIN(Divide, Integer, mlir::arith::DivSIOp) 995 GENBIN(Divide, Real, mlir::arith::DivFOp) 996 GENBIN(Divide, Complex, fir::DivcOp) 997 998 template <Fortran::common::TypeCategory TC, int KIND> 999 ExtValue genval( 1000 const Fortran::evaluate::Power<Fortran::evaluate::Type<TC, KIND>> &op) { 1001 mlir::Type ty = converter.genType(TC, KIND); 1002 mlir::Value lhs = genunbox(op.left()); 1003 mlir::Value rhs = genunbox(op.right()); 1004 return Fortran::lower::genPow(builder, getLoc(), ty, lhs, rhs); 1005 } 1006 1007 template <Fortran::common::TypeCategory TC, int KIND> 1008 ExtValue genval( 1009 const Fortran::evaluate::RealToIntPower<Fortran::evaluate::Type<TC, KIND>> 1010 &op) { 1011 mlir::Type ty = converter.genType(TC, KIND); 1012 mlir::Value lhs = genunbox(op.left()); 1013 mlir::Value rhs = genunbox(op.right()); 1014 return Fortran::lower::genPow(builder, getLoc(), ty, lhs, rhs); 1015 } 1016 1017 template <int KIND> 1018 ExtValue genval(const Fortran::evaluate::ComplexConstructor<KIND> &op) { 1019 mlir::Value realPartValue = genunbox(op.left()); 1020 return fir::factory::Complex{builder, getLoc()}.createComplex( 1021 KIND, realPartValue, genunbox(op.right())); 1022 } 1023 1024 template <int KIND> 1025 ExtValue genval(const Fortran::evaluate::Concat<KIND> &op) { 1026 ExtValue lhs = genval(op.left()); 1027 ExtValue rhs = genval(op.right()); 1028 const fir::CharBoxValue *lhsChar = lhs.getCharBox(); 1029 const fir::CharBoxValue *rhsChar = rhs.getCharBox(); 1030 if (lhsChar && rhsChar) 1031 return fir::factory::CharacterExprHelper{builder, getLoc()} 1032 .createConcatenate(*lhsChar, *rhsChar); 1033 TODO(getLoc(), "character array concatenate"); 1034 } 1035 1036 /// MIN and MAX operations 1037 template <Fortran::common::TypeCategory TC, int KIND> 1038 ExtValue 1039 genval(const Fortran::evaluate::Extremum<Fortran::evaluate::Type<TC, KIND>> 1040 &op) { 1041 TODO(getLoc(), "genval Extremum<TC, KIND>"); 1042 } 1043 1044 // Change the dynamic length information without actually changing the 1045 // underlying character storage. 1046 fir::ExtendedValue 1047 replaceScalarCharacterLength(const fir::ExtendedValue &scalarChar, 1048 mlir::Value newLenValue) { 1049 mlir::Location loc = getLoc(); 1050 const fir::CharBoxValue *charBox = scalarChar.getCharBox(); 1051 if (!charBox) 1052 fir::emitFatalError(loc, "expected scalar character"); 1053 mlir::Value charAddr = charBox->getAddr(); 1054 auto charType = 1055 fir::unwrapPassByRefType(charAddr.getType()).cast<fir::CharacterType>(); 1056 if (charType.hasConstantLen()) { 1057 // Erase previous constant length from the base type. 1058 fir::CharacterType::LenType newLen = fir::CharacterType::unknownLen(); 1059 mlir::Type newCharTy = fir::CharacterType::get( 1060 builder.getContext(), charType.getFKind(), newLen); 1061 mlir::Type newType = fir::ReferenceType::get(newCharTy); 1062 charAddr = builder.createConvert(loc, newType, charAddr); 1063 return fir::CharBoxValue{charAddr, newLenValue}; 1064 } 1065 return fir::CharBoxValue{charAddr, newLenValue}; 1066 } 1067 1068 template <int KIND> 1069 ExtValue genval(const Fortran::evaluate::SetLength<KIND> &x) { 1070 TODO(getLoc(), "genval SetLength<KIND>"); 1071 } 1072 1073 template <int KIND> 1074 ExtValue genval(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 1075 Fortran::common::TypeCategory::Integer, KIND>> &op) { 1076 return createCompareOp<mlir::arith::CmpIOp>(op, 1077 translateRelational(op.opr)); 1078 } 1079 template <int KIND> 1080 ExtValue genval(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 1081 Fortran::common::TypeCategory::Real, KIND>> &op) { 1082 return createFltCmpOp<mlir::arith::CmpFOp>( 1083 op, translateFloatRelational(op.opr)); 1084 } 1085 template <int KIND> 1086 ExtValue genval(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 1087 Fortran::common::TypeCategory::Complex, KIND>> &op) { 1088 TODO(getLoc(), "genval complex comparison"); 1089 } 1090 template <int KIND> 1091 ExtValue genval(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 1092 Fortran::common::TypeCategory::Character, KIND>> &op) { 1093 return createCharCompare(op, translateRelational(op.opr)); 1094 } 1095 1096 ExtValue 1097 genval(const Fortran::evaluate::Relational<Fortran::evaluate::SomeType> &op) { 1098 return std::visit([&](const auto &x) { return genval(x); }, op.u); 1099 } 1100 1101 template <Fortran::common::TypeCategory TC1, int KIND, 1102 Fortran::common::TypeCategory TC2> 1103 ExtValue 1104 genval(const Fortran::evaluate::Convert<Fortran::evaluate::Type<TC1, KIND>, 1105 TC2> &convert) { 1106 mlir::Type ty = converter.genType(TC1, KIND); 1107 mlir::Value operand = genunbox(convert.left()); 1108 return builder.convertWithSemantics(getLoc(), ty, operand); 1109 } 1110 1111 template <typename A> 1112 ExtValue genval(const Fortran::evaluate::Parentheses<A> &op) { 1113 TODO(getLoc(), "genval parentheses<A>"); 1114 } 1115 1116 template <int KIND> 1117 ExtValue genval(const Fortran::evaluate::Not<KIND> &op) { 1118 mlir::Value logical = genunbox(op.left()); 1119 mlir::Value one = genBoolConstant(true); 1120 mlir::Value val = 1121 builder.createConvert(getLoc(), builder.getI1Type(), logical); 1122 return builder.create<mlir::arith::XOrIOp>(getLoc(), val, one); 1123 } 1124 1125 template <int KIND> 1126 ExtValue genval(const Fortran::evaluate::LogicalOperation<KIND> &op) { 1127 mlir::IntegerType i1Type = builder.getI1Type(); 1128 mlir::Value slhs = genunbox(op.left()); 1129 mlir::Value srhs = genunbox(op.right()); 1130 mlir::Value lhs = builder.createConvert(getLoc(), i1Type, slhs); 1131 mlir::Value rhs = builder.createConvert(getLoc(), i1Type, srhs); 1132 switch (op.logicalOperator) { 1133 case Fortran::evaluate::LogicalOperator::And: 1134 return createBinaryOp<mlir::arith::AndIOp>(lhs, rhs); 1135 case Fortran::evaluate::LogicalOperator::Or: 1136 return createBinaryOp<mlir::arith::OrIOp>(lhs, rhs); 1137 case Fortran::evaluate::LogicalOperator::Eqv: 1138 return createCompareOp<mlir::arith::CmpIOp>( 1139 mlir::arith::CmpIPredicate::eq, lhs, rhs); 1140 case Fortran::evaluate::LogicalOperator::Neqv: 1141 return createCompareOp<mlir::arith::CmpIOp>( 1142 mlir::arith::CmpIPredicate::ne, lhs, rhs); 1143 case Fortran::evaluate::LogicalOperator::Not: 1144 // lib/evaluate expression for .NOT. is Fortran::evaluate::Not<KIND>. 1145 llvm_unreachable(".NOT. is not a binary operator"); 1146 } 1147 llvm_unreachable("unhandled logical operation"); 1148 } 1149 1150 /// Convert a scalar literal constant to IR. 1151 template <Fortran::common::TypeCategory TC, int KIND> 1152 ExtValue genScalarLit( 1153 const Fortran::evaluate::Scalar<Fortran::evaluate::Type<TC, KIND>> 1154 &value) { 1155 if constexpr (TC == Fortran::common::TypeCategory::Integer) { 1156 return genIntegerConstant<KIND>(builder.getContext(), value.ToInt64()); 1157 } else if constexpr (TC == Fortran::common::TypeCategory::Logical) { 1158 return genBoolConstant(value.IsTrue()); 1159 } else if constexpr (TC == Fortran::common::TypeCategory::Real) { 1160 std::string str = value.DumpHexadecimal(); 1161 if constexpr (KIND == 2) { 1162 llvm::APFloat floatVal{llvm::APFloatBase::IEEEhalf(), str}; 1163 return genRealConstant<KIND>(builder.getContext(), floatVal); 1164 } else if constexpr (KIND == 3) { 1165 llvm::APFloat floatVal{llvm::APFloatBase::BFloat(), str}; 1166 return genRealConstant<KIND>(builder.getContext(), floatVal); 1167 } else if constexpr (KIND == 4) { 1168 llvm::APFloat floatVal{llvm::APFloatBase::IEEEsingle(), str}; 1169 return genRealConstant<KIND>(builder.getContext(), floatVal); 1170 } else if constexpr (KIND == 10) { 1171 llvm::APFloat floatVal{llvm::APFloatBase::x87DoubleExtended(), str}; 1172 return genRealConstant<KIND>(builder.getContext(), floatVal); 1173 } else if constexpr (KIND == 16) { 1174 llvm::APFloat floatVal{llvm::APFloatBase::IEEEquad(), str}; 1175 return genRealConstant<KIND>(builder.getContext(), floatVal); 1176 } else { 1177 // convert everything else to double 1178 llvm::APFloat floatVal{llvm::APFloatBase::IEEEdouble(), str}; 1179 return genRealConstant<KIND>(builder.getContext(), floatVal); 1180 } 1181 } else if constexpr (TC == Fortran::common::TypeCategory::Complex) { 1182 using TR = 1183 Fortran::evaluate::Type<Fortran::common::TypeCategory::Real, KIND>; 1184 Fortran::evaluate::ComplexConstructor<KIND> ctor( 1185 Fortran::evaluate::Expr<TR>{ 1186 Fortran::evaluate::Constant<TR>{value.REAL()}}, 1187 Fortran::evaluate::Expr<TR>{ 1188 Fortran::evaluate::Constant<TR>{value.AIMAG()}}); 1189 return genunbox(ctor); 1190 } else /*constexpr*/ { 1191 llvm_unreachable("unhandled constant"); 1192 } 1193 } 1194 1195 /// Generate a raw literal value and store it in the rawVals vector. 1196 template <Fortran::common::TypeCategory TC, int KIND> 1197 void 1198 genRawLit(const Fortran::evaluate::Scalar<Fortran::evaluate::Type<TC, KIND>> 1199 &value) { 1200 mlir::Attribute val; 1201 assert(inInitializer != nullptr); 1202 if constexpr (TC == Fortran::common::TypeCategory::Integer) { 1203 inInitializer->rawType = converter.genType(TC, KIND); 1204 val = builder.getIntegerAttr(inInitializer->rawType, value.ToInt64()); 1205 } else if constexpr (TC == Fortran::common::TypeCategory::Logical) { 1206 inInitializer->rawType = 1207 converter.genType(Fortran::common::TypeCategory::Integer, KIND); 1208 val = builder.getIntegerAttr(inInitializer->rawType, value.IsTrue()); 1209 } else if constexpr (TC == Fortran::common::TypeCategory::Real) { 1210 std::string str = value.DumpHexadecimal(); 1211 inInitializer->rawType = converter.genType(TC, KIND); 1212 llvm::APFloat floatVal{builder.getKindMap().getFloatSemantics(KIND), str}; 1213 val = builder.getFloatAttr(inInitializer->rawType, floatVal); 1214 } else if constexpr (TC == Fortran::common::TypeCategory::Complex) { 1215 std::string strReal = value.REAL().DumpHexadecimal(); 1216 std::string strImg = value.AIMAG().DumpHexadecimal(); 1217 inInitializer->rawType = converter.genType(TC, KIND); 1218 llvm::APFloat realVal{builder.getKindMap().getFloatSemantics(KIND), 1219 strReal}; 1220 val = builder.getFloatAttr(inInitializer->rawType, realVal); 1221 inInitializer->rawVals.push_back(val); 1222 llvm::APFloat imgVal{builder.getKindMap().getFloatSemantics(KIND), 1223 strImg}; 1224 val = builder.getFloatAttr(inInitializer->rawType, imgVal); 1225 } 1226 inInitializer->rawVals.push_back(val); 1227 } 1228 1229 /// Convert a scalar literal CHARACTER to IR. 1230 template <int KIND> 1231 ExtValue 1232 genScalarLit(const Fortran::evaluate::Scalar<Fortran::evaluate::Type< 1233 Fortran::common::TypeCategory::Character, KIND>> &value, 1234 int64_t len) { 1235 using ET = typename std::decay_t<decltype(value)>::value_type; 1236 if constexpr (KIND == 1) { 1237 assert(value.size() == static_cast<std::uint64_t>(len)); 1238 // Outline character constant in ro data if it is not in an initializer. 1239 if (!inInitializer) 1240 return fir::factory::createStringLiteral(builder, getLoc(), value); 1241 // When in an initializer context, construct the literal op itself and do 1242 // not construct another constant object in rodata. 1243 fir::StringLitOp stringLit = builder.createStringLitOp(getLoc(), value); 1244 mlir::Value lenp = builder.createIntegerConstant( 1245 getLoc(), builder.getCharacterLengthType(), len); 1246 return fir::CharBoxValue{stringLit.getResult(), lenp}; 1247 } 1248 fir::CharacterType type = 1249 fir::CharacterType::get(builder.getContext(), KIND, len); 1250 auto consLit = [&]() -> fir::StringLitOp { 1251 mlir::MLIRContext *context = builder.getContext(); 1252 std::int64_t size = static_cast<std::int64_t>(value.size()); 1253 mlir::ShapedType shape = mlir::RankedTensorType::get( 1254 llvm::ArrayRef<std::int64_t>{size}, 1255 mlir::IntegerType::get(builder.getContext(), sizeof(ET) * 8)); 1256 auto denseAttr = mlir::DenseElementsAttr::get( 1257 shape, llvm::ArrayRef<ET>{value.data(), value.size()}); 1258 auto denseTag = mlir::StringAttr::get(context, fir::StringLitOp::xlist()); 1259 mlir::NamedAttribute dataAttr(denseTag, denseAttr); 1260 auto sizeTag = mlir::StringAttr::get(context, fir::StringLitOp::size()); 1261 mlir::NamedAttribute sizeAttr(sizeTag, builder.getI64IntegerAttr(len)); 1262 llvm::SmallVector<mlir::NamedAttribute> attrs = {dataAttr, sizeAttr}; 1263 return builder.create<fir::StringLitOp>( 1264 getLoc(), llvm::ArrayRef<mlir::Type>{type}, llvm::None, attrs); 1265 }; 1266 1267 mlir::Value lenp = builder.createIntegerConstant( 1268 getLoc(), builder.getCharacterLengthType(), len); 1269 // When in an initializer context, construct the literal op itself and do 1270 // not construct another constant object in rodata. 1271 if (inInitializer) 1272 return fir::CharBoxValue{consLit().getResult(), lenp}; 1273 1274 // Otherwise, the string is in a plain old expression so "outline" the value 1275 // by hashconsing it to a constant literal object. 1276 1277 std::string globalName = 1278 fir::factory::uniqueCGIdent("cl", (const char *)value.c_str()); 1279 fir::GlobalOp global = builder.getNamedGlobal(globalName); 1280 if (!global) 1281 global = builder.createGlobalConstant( 1282 getLoc(), type, globalName, 1283 [&](fir::FirOpBuilder &builder) { 1284 fir::StringLitOp str = consLit(); 1285 builder.create<fir::HasValueOp>(getLoc(), str); 1286 }, 1287 builder.createLinkOnceLinkage()); 1288 auto addr = builder.create<fir::AddrOfOp>(getLoc(), global.resultType(), 1289 global.getSymbol()); 1290 return fir::CharBoxValue{addr, lenp}; 1291 } 1292 1293 template <Fortran::common::TypeCategory TC, int KIND> 1294 ExtValue genArrayLit( 1295 const Fortran::evaluate::Constant<Fortran::evaluate::Type<TC, KIND>> 1296 &con) { 1297 mlir::Location loc = getLoc(); 1298 mlir::IndexType idxTy = builder.getIndexType(); 1299 Fortran::evaluate::ConstantSubscript size = 1300 Fortran::evaluate::GetSize(con.shape()); 1301 fir::SequenceType::Shape shape(con.shape().begin(), con.shape().end()); 1302 mlir::Type eleTy; 1303 if constexpr (TC == Fortran::common::TypeCategory::Character) 1304 eleTy = converter.genType(TC, KIND, {con.LEN()}); 1305 else 1306 eleTy = converter.genType(TC, KIND); 1307 auto arrayTy = fir::SequenceType::get(shape, eleTy); 1308 mlir::Value array; 1309 llvm::SmallVector<mlir::Value> lbounds; 1310 llvm::SmallVector<mlir::Value> extents; 1311 if (!inInitializer || !inInitializer->genRawVals) { 1312 array = builder.create<fir::UndefOp>(loc, arrayTy); 1313 for (auto [lb, extent] : llvm::zip(con.lbounds(), shape)) { 1314 lbounds.push_back(builder.createIntegerConstant(loc, idxTy, lb - 1)); 1315 extents.push_back(builder.createIntegerConstant(loc, idxTy, extent)); 1316 } 1317 } 1318 if (size == 0) { 1319 if constexpr (TC == Fortran::common::TypeCategory::Character) { 1320 mlir::Value len = builder.createIntegerConstant(loc, idxTy, con.LEN()); 1321 return fir::CharArrayBoxValue{array, len, extents, lbounds}; 1322 } else { 1323 return fir::ArrayBoxValue{array, extents, lbounds}; 1324 } 1325 } 1326 Fortran::evaluate::ConstantSubscripts subscripts = con.lbounds(); 1327 auto createIdx = [&]() { 1328 llvm::SmallVector<mlir::Attribute> idx; 1329 for (size_t i = 0; i < subscripts.size(); ++i) 1330 idx.push_back( 1331 builder.getIntegerAttr(idxTy, subscripts[i] - con.lbounds()[i])); 1332 return idx; 1333 }; 1334 if constexpr (TC == Fortran::common::TypeCategory::Character) { 1335 assert(array && "array must not be nullptr"); 1336 do { 1337 mlir::Value elementVal = 1338 fir::getBase(genScalarLit<KIND>(con.At(subscripts), con.LEN())); 1339 array = builder.create<fir::InsertValueOp>( 1340 loc, arrayTy, array, elementVal, builder.getArrayAttr(createIdx())); 1341 } while (con.IncrementSubscripts(subscripts)); 1342 mlir::Value len = builder.createIntegerConstant(loc, idxTy, con.LEN()); 1343 return fir::CharArrayBoxValue{array, len, extents, lbounds}; 1344 } else { 1345 llvm::SmallVector<mlir::Attribute> rangeStartIdx; 1346 uint64_t rangeSize = 0; 1347 do { 1348 if (inInitializer && inInitializer->genRawVals) { 1349 genRawLit<TC, KIND>(con.At(subscripts)); 1350 continue; 1351 } 1352 auto getElementVal = [&]() { 1353 return builder.createConvert( 1354 loc, eleTy, 1355 fir::getBase(genScalarLit<TC, KIND>(con.At(subscripts)))); 1356 }; 1357 Fortran::evaluate::ConstantSubscripts nextSubscripts = subscripts; 1358 bool nextIsSame = con.IncrementSubscripts(nextSubscripts) && 1359 con.At(subscripts) == con.At(nextSubscripts); 1360 if (!rangeSize && !nextIsSame) { // single (non-range) value 1361 array = builder.create<fir::InsertValueOp>( 1362 loc, arrayTy, array, getElementVal(), 1363 builder.getArrayAttr(createIdx())); 1364 } else if (!rangeSize) { // start a range 1365 rangeStartIdx = createIdx(); 1366 rangeSize = 1; 1367 } else if (nextIsSame) { // expand a range 1368 ++rangeSize; 1369 } else { // end a range 1370 llvm::SmallVector<int64_t> rangeBounds; 1371 llvm::SmallVector<mlir::Attribute> idx = createIdx(); 1372 for (size_t i = 0; i < idx.size(); ++i) { 1373 rangeBounds.push_back(rangeStartIdx[i] 1374 .cast<mlir::IntegerAttr>() 1375 .getValue() 1376 .getSExtValue()); 1377 rangeBounds.push_back( 1378 idx[i].cast<mlir::IntegerAttr>().getValue().getSExtValue()); 1379 } 1380 array = builder.create<fir::InsertOnRangeOp>( 1381 loc, arrayTy, array, getElementVal(), 1382 builder.getIndexVectorAttr(rangeBounds)); 1383 rangeSize = 0; 1384 } 1385 } while (con.IncrementSubscripts(subscripts)); 1386 return fir::ArrayBoxValue{array, extents, lbounds}; 1387 } 1388 } 1389 1390 fir::ExtendedValue genArrayLit( 1391 const Fortran::evaluate::Constant<Fortran::evaluate::SomeDerived> &con) { 1392 mlir::Location loc = getLoc(); 1393 mlir::IndexType idxTy = builder.getIndexType(); 1394 Fortran::evaluate::ConstantSubscript size = 1395 Fortran::evaluate::GetSize(con.shape()); 1396 fir::SequenceType::Shape shape(con.shape().begin(), con.shape().end()); 1397 mlir::Type eleTy = converter.genType(con.GetType().GetDerivedTypeSpec()); 1398 auto arrayTy = fir::SequenceType::get(shape, eleTy); 1399 mlir::Value array = builder.create<fir::UndefOp>(loc, arrayTy); 1400 llvm::SmallVector<mlir::Value> lbounds; 1401 llvm::SmallVector<mlir::Value> extents; 1402 for (auto [lb, extent] : llvm::zip(con.lbounds(), con.shape())) { 1403 lbounds.push_back(builder.createIntegerConstant(loc, idxTy, lb - 1)); 1404 extents.push_back(builder.createIntegerConstant(loc, idxTy, extent)); 1405 } 1406 if (size == 0) 1407 return fir::ArrayBoxValue{array, extents, lbounds}; 1408 Fortran::evaluate::ConstantSubscripts subscripts = con.lbounds(); 1409 do { 1410 mlir::Value derivedVal = fir::getBase(genval(con.At(subscripts))); 1411 llvm::SmallVector<mlir::Attribute> idx; 1412 for (auto [dim, lb] : llvm::zip(subscripts, con.lbounds())) 1413 idx.push_back(builder.getIntegerAttr(idxTy, dim - lb)); 1414 array = builder.create<fir::InsertValueOp>( 1415 loc, arrayTy, array, derivedVal, builder.getArrayAttr(idx)); 1416 } while (con.IncrementSubscripts(subscripts)); 1417 return fir::ArrayBoxValue{array, extents, lbounds}; 1418 } 1419 1420 template <Fortran::common::TypeCategory TC, int KIND> 1421 ExtValue 1422 genval(const Fortran::evaluate::Constant<Fortran::evaluate::Type<TC, KIND>> 1423 &con) { 1424 if (con.Rank() > 0) 1425 return genArrayLit(con); 1426 std::optional<Fortran::evaluate::Scalar<Fortran::evaluate::Type<TC, KIND>>> 1427 opt = con.GetScalarValue(); 1428 assert(opt.has_value() && "constant has no value"); 1429 if constexpr (TC == Fortran::common::TypeCategory::Character) { 1430 return genScalarLit<KIND>(opt.value(), con.LEN()); 1431 } else { 1432 return genScalarLit<TC, KIND>(opt.value()); 1433 } 1434 } 1435 1436 fir::ExtendedValue genval( 1437 const Fortran::evaluate::Constant<Fortran::evaluate::SomeDerived> &con) { 1438 if (con.Rank() > 0) 1439 return genArrayLit(con); 1440 if (auto ctor = con.GetScalarValue()) 1441 return genval(ctor.value()); 1442 fir::emitFatalError(getLoc(), 1443 "constant of derived type has no constructor"); 1444 } 1445 1446 template <typename A> 1447 ExtValue genval(const Fortran::evaluate::ArrayConstructor<A> &) { 1448 TODO(getLoc(), "genval ArrayConstructor<A>"); 1449 } 1450 1451 ExtValue gen(const Fortran::evaluate::ComplexPart &x) { 1452 TODO(getLoc(), "gen ComplexPart"); 1453 } 1454 ExtValue genval(const Fortran::evaluate::ComplexPart &x) { 1455 TODO(getLoc(), "genval ComplexPart"); 1456 } 1457 1458 /// Reference to a substring. 1459 ExtValue gen(const Fortran::evaluate::Substring &s) { 1460 // Get base string 1461 auto baseString = std::visit( 1462 Fortran::common::visitors{ 1463 [&](const Fortran::evaluate::DataRef &x) { return gen(x); }, 1464 [&](const Fortran::evaluate::StaticDataObject::Pointer &p) 1465 -> ExtValue { 1466 if (std::optional<std::string> str = p->AsString()) 1467 return fir::factory::createStringLiteral(builder, getLoc(), 1468 *str); 1469 // TODO: convert StaticDataObject to Constant<T> and use normal 1470 // constant path. Beware that StaticDataObject data() takes into 1471 // account build machine endianness. 1472 TODO(getLoc(), 1473 "StaticDataObject::Pointer substring with kind > 1"); 1474 }, 1475 }, 1476 s.parent()); 1477 llvm::SmallVector<mlir::Value> bounds; 1478 mlir::Value lower = genunbox(s.lower()); 1479 bounds.push_back(lower); 1480 if (Fortran::evaluate::MaybeExtentExpr upperBound = s.upper()) { 1481 mlir::Value upper = genunbox(*upperBound); 1482 bounds.push_back(upper); 1483 } 1484 fir::factory::CharacterExprHelper charHelper{builder, getLoc()}; 1485 return baseString.match( 1486 [&](const fir::CharBoxValue &x) -> ExtValue { 1487 return charHelper.createSubstring(x, bounds); 1488 }, 1489 [&](const fir::CharArrayBoxValue &) -> ExtValue { 1490 fir::emitFatalError( 1491 getLoc(), 1492 "array substring should be handled in array expression"); 1493 }, 1494 [&](const auto &) -> ExtValue { 1495 fir::emitFatalError(getLoc(), "substring base is not a CharBox"); 1496 }); 1497 } 1498 1499 /// The value of a substring. 1500 ExtValue genval(const Fortran::evaluate::Substring &ss) { 1501 // FIXME: why is the value of a substring being lowered the same as the 1502 // address of a substring? 1503 return gen(ss); 1504 } 1505 1506 ExtValue genval(const Fortran::evaluate::Subscript &subs) { 1507 if (auto *s = std::get_if<Fortran::evaluate::IndirectSubscriptIntegerExpr>( 1508 &subs.u)) { 1509 if (s->value().Rank() > 0) 1510 fir::emitFatalError(getLoc(), "vector subscript is not scalar"); 1511 return {genval(s->value())}; 1512 } 1513 fir::emitFatalError(getLoc(), "subscript triple notation is not scalar"); 1514 } 1515 1516 ExtValue genSubscript(const Fortran::evaluate::Subscript &subs) { 1517 return genval(subs); 1518 } 1519 1520 ExtValue gen(const Fortran::evaluate::DataRef &dref) { 1521 return std::visit([&](const auto &x) { return gen(x); }, dref.u); 1522 } 1523 ExtValue genval(const Fortran::evaluate::DataRef &dref) { 1524 return std::visit([&](const auto &x) { return genval(x); }, dref.u); 1525 } 1526 1527 // Helper function to turn the Component structure into a list of nested 1528 // components, ordered from largest/leftmost to smallest/rightmost: 1529 // - where only the smallest/rightmost item may be allocatable or a pointer 1530 // (nested allocatable/pointer components require nested coordinate_of ops) 1531 // - that does not contain any parent components 1532 // (the front end places parent components directly in the object) 1533 // Return the object used as the base coordinate for the component chain. 1534 static Fortran::evaluate::DataRef const * 1535 reverseComponents(const Fortran::evaluate::Component &cmpt, 1536 std::list<const Fortran::evaluate::Component *> &list) { 1537 if (!cmpt.GetLastSymbol().test( 1538 Fortran::semantics::Symbol::Flag::ParentComp)) 1539 list.push_front(&cmpt); 1540 return std::visit( 1541 Fortran::common::visitors{ 1542 [&](const Fortran::evaluate::Component &x) { 1543 if (Fortran::semantics::IsAllocatableOrPointer(x.GetLastSymbol())) 1544 return &cmpt.base(); 1545 return reverseComponents(x, list); 1546 }, 1547 [&](auto &) { return &cmpt.base(); }, 1548 }, 1549 cmpt.base().u); 1550 } 1551 1552 // Return the coordinate of the component reference 1553 ExtValue genComponent(const Fortran::evaluate::Component &cmpt) { 1554 std::list<const Fortran::evaluate::Component *> list; 1555 const Fortran::evaluate::DataRef *base = reverseComponents(cmpt, list); 1556 llvm::SmallVector<mlir::Value> coorArgs; 1557 ExtValue obj = gen(*base); 1558 mlir::Type ty = fir::dyn_cast_ptrOrBoxEleTy(fir::getBase(obj).getType()); 1559 mlir::Location loc = getLoc(); 1560 auto fldTy = fir::FieldType::get(&converter.getMLIRContext()); 1561 // FIXME: need to thread the LEN type parameters here. 1562 for (const Fortran::evaluate::Component *field : list) { 1563 auto recTy = ty.cast<fir::RecordType>(); 1564 const Fortran::semantics::Symbol &sym = field->GetLastSymbol(); 1565 llvm::StringRef name = toStringRef(sym.name()); 1566 coorArgs.push_back(builder.create<fir::FieldIndexOp>( 1567 loc, fldTy, name, recTy, fir::getTypeParams(obj))); 1568 ty = recTy.getType(name); 1569 } 1570 ty = builder.getRefType(ty); 1571 return fir::factory::componentToExtendedValue( 1572 builder, loc, 1573 builder.create<fir::CoordinateOp>(loc, ty, fir::getBase(obj), 1574 coorArgs)); 1575 } 1576 1577 ExtValue gen(const Fortran::evaluate::Component &cmpt) { 1578 // Components may be pointer or allocatable. In the gen() path, the mutable 1579 // aspect is lost to simplify handling on the client side. To retain the 1580 // mutable aspect, genMutableBoxValue should be used. 1581 return genComponent(cmpt).match( 1582 [&](const fir::MutableBoxValue &mutableBox) { 1583 return fir::factory::genMutableBoxRead(builder, getLoc(), mutableBox); 1584 }, 1585 [](auto &box) -> ExtValue { return box; }); 1586 } 1587 1588 ExtValue genval(const Fortran::evaluate::Component &cmpt) { 1589 return genLoad(gen(cmpt)); 1590 } 1591 1592 ExtValue genval(const Fortran::semantics::Bound &bound) { 1593 TODO(getLoc(), "genval Bound"); 1594 } 1595 1596 /// Return lower bounds of \p box in dimension \p dim. The returned value 1597 /// has type \ty. 1598 mlir::Value getLBound(const ExtValue &box, unsigned dim, mlir::Type ty) { 1599 assert(box.rank() > 0 && "must be an array"); 1600 mlir::Location loc = getLoc(); 1601 mlir::Value one = builder.createIntegerConstant(loc, ty, 1); 1602 mlir::Value lb = fir::factory::readLowerBound(builder, loc, box, dim, one); 1603 return builder.createConvert(loc, ty, lb); 1604 } 1605 1606 static bool isSlice(const Fortran::evaluate::ArrayRef &aref) { 1607 for (const Fortran::evaluate::Subscript &sub : aref.subscript()) 1608 if (std::holds_alternative<Fortran::evaluate::Triplet>(sub.u)) 1609 return true; 1610 return false; 1611 } 1612 1613 /// Lower an ArrayRef to a fir.coordinate_of given its lowered base. 1614 ExtValue genCoordinateOp(const ExtValue &array, 1615 const Fortran::evaluate::ArrayRef &aref) { 1616 mlir::Location loc = getLoc(); 1617 // References to array of rank > 1 with non constant shape that are not 1618 // fir.box must be collapsed into an offset computation in lowering already. 1619 // The same is needed with dynamic length character arrays of all ranks. 1620 mlir::Type baseType = 1621 fir::dyn_cast_ptrOrBoxEleTy(fir::getBase(array).getType()); 1622 if ((array.rank() > 1 && fir::hasDynamicSize(baseType)) || 1623 fir::characterWithDynamicLen(fir::unwrapSequenceType(baseType))) 1624 if (!array.getBoxOf<fir::BoxValue>()) 1625 return genOffsetAndCoordinateOp(array, aref); 1626 // Generate a fir.coordinate_of with zero based array indexes. 1627 llvm::SmallVector<mlir::Value> args; 1628 for (const auto &subsc : llvm::enumerate(aref.subscript())) { 1629 ExtValue subVal = genSubscript(subsc.value()); 1630 assert(fir::isUnboxedValue(subVal) && "subscript must be simple scalar"); 1631 mlir::Value val = fir::getBase(subVal); 1632 mlir::Type ty = val.getType(); 1633 mlir::Value lb = getLBound(array, subsc.index(), ty); 1634 args.push_back(builder.create<mlir::arith::SubIOp>(loc, ty, val, lb)); 1635 } 1636 1637 mlir::Value base = fir::getBase(array); 1638 auto seqTy = 1639 fir::dyn_cast_ptrOrBoxEleTy(base.getType()).cast<fir::SequenceType>(); 1640 assert(args.size() == seqTy.getDimension()); 1641 mlir::Type ty = builder.getRefType(seqTy.getEleTy()); 1642 auto addr = builder.create<fir::CoordinateOp>(loc, ty, base, args); 1643 return fir::factory::arrayElementToExtendedValue(builder, loc, array, addr); 1644 } 1645 1646 /// Lower an ArrayRef to a fir.coordinate_of using an element offset instead 1647 /// of array indexes. 1648 /// This generates offset computation from the indexes and length parameters, 1649 /// and use the offset to access the element with a fir.coordinate_of. This 1650 /// must only be used if it is not possible to generate a normal 1651 /// fir.coordinate_of using array indexes (i.e. when the shape information is 1652 /// unavailable in the IR). 1653 ExtValue genOffsetAndCoordinateOp(const ExtValue &array, 1654 const Fortran::evaluate::ArrayRef &aref) { 1655 mlir::Location loc = getLoc(); 1656 mlir::Value addr = fir::getBase(array); 1657 mlir::Type arrTy = fir::dyn_cast_ptrEleTy(addr.getType()); 1658 auto eleTy = arrTy.cast<fir::SequenceType>().getEleTy(); 1659 mlir::Type seqTy = builder.getRefType(builder.getVarLenSeqTy(eleTy)); 1660 mlir::Type refTy = builder.getRefType(eleTy); 1661 mlir::Value base = builder.createConvert(loc, seqTy, addr); 1662 mlir::IndexType idxTy = builder.getIndexType(); 1663 mlir::Value one = builder.createIntegerConstant(loc, idxTy, 1); 1664 mlir::Value zero = builder.createIntegerConstant(loc, idxTy, 0); 1665 auto getLB = [&](const auto &arr, unsigned dim) -> mlir::Value { 1666 return arr.getLBounds().empty() ? one : arr.getLBounds()[dim]; 1667 }; 1668 auto genFullDim = [&](const auto &arr, mlir::Value delta) -> mlir::Value { 1669 mlir::Value total = zero; 1670 assert(arr.getExtents().size() == aref.subscript().size()); 1671 delta = builder.createConvert(loc, idxTy, delta); 1672 unsigned dim = 0; 1673 for (auto [ext, sub] : llvm::zip(arr.getExtents(), aref.subscript())) { 1674 ExtValue subVal = genSubscript(sub); 1675 assert(fir::isUnboxedValue(subVal)); 1676 mlir::Value val = 1677 builder.createConvert(loc, idxTy, fir::getBase(subVal)); 1678 mlir::Value lb = builder.createConvert(loc, idxTy, getLB(arr, dim)); 1679 mlir::Value diff = builder.create<mlir::arith::SubIOp>(loc, val, lb); 1680 mlir::Value prod = 1681 builder.create<mlir::arith::MulIOp>(loc, delta, diff); 1682 total = builder.create<mlir::arith::AddIOp>(loc, prod, total); 1683 if (ext) 1684 delta = builder.create<mlir::arith::MulIOp>(loc, delta, ext); 1685 ++dim; 1686 } 1687 mlir::Type origRefTy = refTy; 1688 if (fir::factory::CharacterExprHelper::isCharacterScalar(refTy)) { 1689 fir::CharacterType chTy = 1690 fir::factory::CharacterExprHelper::getCharacterType(refTy); 1691 if (fir::characterWithDynamicLen(chTy)) { 1692 mlir::MLIRContext *ctx = builder.getContext(); 1693 fir::KindTy kind = 1694 fir::factory::CharacterExprHelper::getCharacterKind(chTy); 1695 fir::CharacterType singleTy = 1696 fir::CharacterType::getSingleton(ctx, kind); 1697 refTy = builder.getRefType(singleTy); 1698 mlir::Type seqRefTy = 1699 builder.getRefType(builder.getVarLenSeqTy(singleTy)); 1700 base = builder.createConvert(loc, seqRefTy, base); 1701 } 1702 } 1703 auto coor = builder.create<fir::CoordinateOp>( 1704 loc, refTy, base, llvm::ArrayRef<mlir::Value>{total}); 1705 // Convert to expected, original type after address arithmetic. 1706 return builder.createConvert(loc, origRefTy, coor); 1707 }; 1708 return array.match( 1709 [&](const fir::ArrayBoxValue &arr) -> ExtValue { 1710 // FIXME: this check can be removed when slicing is implemented 1711 if (isSlice(aref)) 1712 fir::emitFatalError( 1713 getLoc(), 1714 "slice should be handled in array expression context"); 1715 return genFullDim(arr, one); 1716 }, 1717 [&](const fir::CharArrayBoxValue &arr) -> ExtValue { 1718 mlir::Value delta = arr.getLen(); 1719 // If the length is known in the type, fir.coordinate_of will 1720 // already take the length into account. 1721 if (fir::factory::CharacterExprHelper::hasConstantLengthInType(arr)) 1722 delta = one; 1723 return fir::CharBoxValue(genFullDim(arr, delta), arr.getLen()); 1724 }, 1725 [&](const fir::BoxValue &arr) -> ExtValue { 1726 // CoordinateOp for BoxValue is not generated here. The dimensions 1727 // must be kept in the fir.coordinate_op so that potential fir.box 1728 // strides can be applied by codegen. 1729 fir::emitFatalError( 1730 loc, "internal: BoxValue in dim-collapsed fir.coordinate_of"); 1731 }, 1732 [&](const auto &) -> ExtValue { 1733 fir::emitFatalError(loc, "internal: array lowering failed"); 1734 }); 1735 } 1736 1737 /// Lower an ArrayRef to a fir.array_coor. 1738 ExtValue genArrayCoorOp(const ExtValue &exv, 1739 const Fortran::evaluate::ArrayRef &aref) { 1740 mlir::Location loc = getLoc(); 1741 mlir::Value addr = fir::getBase(exv); 1742 mlir::Type arrTy = fir::dyn_cast_ptrOrBoxEleTy(addr.getType()); 1743 mlir::Type eleTy = arrTy.cast<fir::SequenceType>().getEleTy(); 1744 mlir::Type refTy = builder.getRefType(eleTy); 1745 mlir::IndexType idxTy = builder.getIndexType(); 1746 llvm::SmallVector<mlir::Value> arrayCoorArgs; 1747 // The ArrayRef is expected to be scalar here, arrays are handled in array 1748 // expression lowering. So no vector subscript or triplet is expected here. 1749 for (const auto &sub : aref.subscript()) { 1750 ExtValue subVal = genSubscript(sub); 1751 assert(fir::isUnboxedValue(subVal)); 1752 arrayCoorArgs.push_back( 1753 builder.createConvert(loc, idxTy, fir::getBase(subVal))); 1754 } 1755 mlir::Value shape = builder.createShape(loc, exv); 1756 mlir::Value elementAddr = builder.create<fir::ArrayCoorOp>( 1757 loc, refTy, addr, shape, /*slice=*/mlir::Value{}, arrayCoorArgs, 1758 fir::getTypeParams(exv)); 1759 return fir::factory::arrayElementToExtendedValue(builder, loc, exv, 1760 elementAddr); 1761 } 1762 1763 /// Return the coordinate of the array reference. 1764 ExtValue gen(const Fortran::evaluate::ArrayRef &aref) { 1765 ExtValue base = aref.base().IsSymbol() ? gen(getFirstSym(aref.base())) 1766 : gen(aref.base().GetComponent()); 1767 // Check for command-line override to use array_coor op. 1768 if (generateArrayCoordinate) 1769 return genArrayCoorOp(base, aref); 1770 // Otherwise, use coordinate_of op. 1771 return genCoordinateOp(base, aref); 1772 } 1773 1774 ExtValue genval(const Fortran::evaluate::ArrayRef &aref) { 1775 return genLoad(gen(aref)); 1776 } 1777 1778 ExtValue gen(const Fortran::evaluate::CoarrayRef &coref) { 1779 TODO(getLoc(), "gen CoarrayRef"); 1780 } 1781 ExtValue genval(const Fortran::evaluate::CoarrayRef &coref) { 1782 TODO(getLoc(), "genval CoarrayRef"); 1783 } 1784 1785 template <typename A> 1786 ExtValue gen(const Fortran::evaluate::Designator<A> &des) { 1787 return std::visit([&](const auto &x) { return gen(x); }, des.u); 1788 } 1789 template <typename A> 1790 ExtValue genval(const Fortran::evaluate::Designator<A> &des) { 1791 return std::visit([&](const auto &x) { return genval(x); }, des.u); 1792 } 1793 1794 mlir::Type genType(const Fortran::evaluate::DynamicType &dt) { 1795 if (dt.category() != Fortran::common::TypeCategory::Derived) 1796 return converter.genType(dt.category(), dt.kind()); 1797 return converter.genType(dt.GetDerivedTypeSpec()); 1798 } 1799 1800 /// Lower a function reference 1801 template <typename A> 1802 ExtValue genFunctionRef(const Fortran::evaluate::FunctionRef<A> &funcRef) { 1803 if (!funcRef.GetType().has_value()) 1804 fir::emitFatalError(getLoc(), "internal: a function must have a type"); 1805 mlir::Type resTy = genType(*funcRef.GetType()); 1806 return genProcedureRef(funcRef, {resTy}); 1807 } 1808 1809 /// Lower function call `funcRef` and return a reference to the resultant 1810 /// value. This is required for lowering expressions such as `f1(f2(v))`. 1811 template <typename A> 1812 ExtValue gen(const Fortran::evaluate::FunctionRef<A> &funcRef) { 1813 ExtValue retVal = genFunctionRef(funcRef); 1814 mlir::Value retValBase = fir::getBase(retVal); 1815 if (fir::conformsWithPassByRef(retValBase.getType())) 1816 return retVal; 1817 auto mem = builder.create<fir::AllocaOp>(getLoc(), retValBase.getType()); 1818 builder.create<fir::StoreOp>(getLoc(), retValBase, mem); 1819 return fir::substBase(retVal, mem.getResult()); 1820 } 1821 1822 /// helper to detect statement functions 1823 static bool 1824 isStatementFunctionCall(const Fortran::evaluate::ProcedureRef &procRef) { 1825 if (const Fortran::semantics::Symbol *symbol = procRef.proc().GetSymbol()) 1826 if (const auto *details = 1827 symbol->detailsIf<Fortran::semantics::SubprogramDetails>()) 1828 return details->stmtFunction().has_value(); 1829 return false; 1830 } 1831 /// Generate Statement function calls 1832 ExtValue genStmtFunctionRef(const Fortran::evaluate::ProcedureRef &procRef) { 1833 const Fortran::semantics::Symbol *symbol = procRef.proc().GetSymbol(); 1834 assert(symbol && "expected symbol in ProcedureRef of statement functions"); 1835 const auto &details = symbol->get<Fortran::semantics::SubprogramDetails>(); 1836 1837 // Statement functions have their own scope, we just need to associate 1838 // the dummy symbols to argument expressions. They are no 1839 // optional/alternate return arguments. Statement functions cannot be 1840 // recursive (directly or indirectly) so it is safe to add dummy symbols to 1841 // the local map here. 1842 symMap.pushScope(); 1843 for (auto [arg, bind] : 1844 llvm::zip(details.dummyArgs(), procRef.arguments())) { 1845 assert(arg && "alternate return in statement function"); 1846 assert(bind && "optional argument in statement function"); 1847 const auto *expr = bind->UnwrapExpr(); 1848 // TODO: assumed type in statement function, that surprisingly seems 1849 // allowed, probably because nobody thought of restricting this usage. 1850 // gfortran/ifort compiles this. 1851 assert(expr && "assumed type used as statement function argument"); 1852 // As per Fortran 2018 C1580, statement function arguments can only be 1853 // scalars, so just pass the box with the address. The only care is to 1854 // to use the dummy character explicit length if any instead of the 1855 // actual argument length (that can be bigger). 1856 if (const Fortran::semantics::DeclTypeSpec *type = arg->GetType()) 1857 if (type->category() == Fortran::semantics::DeclTypeSpec::Character) 1858 if (const Fortran::semantics::MaybeIntExpr &lenExpr = 1859 type->characterTypeSpec().length().GetExplicit()) { 1860 mlir::Value len = fir::getBase(genval(*lenExpr)); 1861 // F2018 7.4.4.2 point 5. 1862 len = Fortran::lower::genMaxWithZero(builder, getLoc(), len); 1863 symMap.addSymbol(*arg, 1864 replaceScalarCharacterLength(gen(*expr), len)); 1865 continue; 1866 } 1867 symMap.addSymbol(*arg, gen(*expr)); 1868 } 1869 1870 // Explicitly map statement function host associated symbols to their 1871 // parent scope lowered symbol box. 1872 for (const Fortran::semantics::SymbolRef &sym : 1873 Fortran::evaluate::CollectSymbols(*details.stmtFunction())) 1874 if (const auto *details = 1875 sym->detailsIf<Fortran::semantics::HostAssocDetails>()) 1876 if (!symMap.lookupSymbol(*sym)) 1877 symMap.addSymbol(*sym, gen(details->symbol())); 1878 1879 ExtValue result = genval(details.stmtFunction().value()); 1880 LLVM_DEBUG(llvm::dbgs() << "stmt-function: " << result << '\n'); 1881 symMap.popScope(); 1882 return result; 1883 } 1884 1885 /// Helper to package a Value and its properties into an ExtendedValue. 1886 static ExtValue toExtendedValue(mlir::Location loc, mlir::Value base, 1887 llvm::ArrayRef<mlir::Value> extents, 1888 llvm::ArrayRef<mlir::Value> lengths) { 1889 mlir::Type type = base.getType(); 1890 if (type.isa<fir::BoxType>()) 1891 return fir::BoxValue(base, /*lbounds=*/{}, lengths, extents); 1892 type = fir::unwrapRefType(type); 1893 if (type.isa<fir::BoxType>()) 1894 return fir::MutableBoxValue(base, lengths, /*mutableProperties*/ {}); 1895 if (auto seqTy = type.dyn_cast<fir::SequenceType>()) { 1896 if (seqTy.getDimension() != extents.size()) 1897 fir::emitFatalError(loc, "incorrect number of extents for array"); 1898 if (seqTy.getEleTy().isa<fir::CharacterType>()) { 1899 if (lengths.empty()) 1900 fir::emitFatalError(loc, "missing length for character"); 1901 assert(lengths.size() == 1); 1902 return fir::CharArrayBoxValue(base, lengths[0], extents); 1903 } 1904 return fir::ArrayBoxValue(base, extents); 1905 } 1906 if (type.isa<fir::CharacterType>()) { 1907 if (lengths.empty()) 1908 fir::emitFatalError(loc, "missing length for character"); 1909 assert(lengths.size() == 1); 1910 return fir::CharBoxValue(base, lengths[0]); 1911 } 1912 return base; 1913 } 1914 1915 // Find the argument that corresponds to the host associations. 1916 // Verify some assumptions about how the signature was built here. 1917 [[maybe_unused]] static unsigned findHostAssocTuplePos(mlir::FuncOp fn) { 1918 // Scan the argument list from last to first as the host associations are 1919 // appended for now. 1920 for (unsigned i = fn.getNumArguments(); i > 0; --i) 1921 if (fn.getArgAttr(i - 1, fir::getHostAssocAttrName())) { 1922 // Host assoc tuple must be last argument (for now). 1923 assert(i == fn.getNumArguments() && "tuple must be last"); 1924 return i - 1; 1925 } 1926 llvm_unreachable("anyFuncArgsHaveAttr failed"); 1927 } 1928 1929 /// Create a contiguous temporary array with the same shape, 1930 /// length parameters and type as mold. It is up to the caller to deallocate 1931 /// the temporary. 1932 ExtValue genArrayTempFromMold(const ExtValue &mold, 1933 llvm::StringRef tempName) { 1934 mlir::Type type = fir::dyn_cast_ptrOrBoxEleTy(fir::getBase(mold).getType()); 1935 assert(type && "expected descriptor or memory type"); 1936 mlir::Location loc = getLoc(); 1937 llvm::SmallVector<mlir::Value> extents = 1938 fir::factory::getExtents(builder, loc, mold); 1939 llvm::SmallVector<mlir::Value> allocMemTypeParams = 1940 fir::getTypeParams(mold); 1941 mlir::Value charLen; 1942 mlir::Type elementType = fir::unwrapSequenceType(type); 1943 if (auto charType = elementType.dyn_cast<fir::CharacterType>()) { 1944 charLen = allocMemTypeParams.empty() 1945 ? fir::factory::readCharLen(builder, loc, mold) 1946 : allocMemTypeParams[0]; 1947 if (charType.hasDynamicLen() && allocMemTypeParams.empty()) 1948 allocMemTypeParams.push_back(charLen); 1949 } else if (fir::hasDynamicSize(elementType)) { 1950 TODO(loc, "Creating temporary for derived type with length parameters"); 1951 } 1952 1953 mlir::Value temp = builder.create<fir::AllocMemOp>( 1954 loc, type, tempName, allocMemTypeParams, extents); 1955 if (fir::unwrapSequenceType(type).isa<fir::CharacterType>()) 1956 return fir::CharArrayBoxValue{temp, charLen, extents}; 1957 return fir::ArrayBoxValue{temp, extents}; 1958 } 1959 1960 /// Copy \p source array into \p dest array. Both arrays must be 1961 /// conforming, but neither array must be contiguous. 1962 void genArrayCopy(ExtValue dest, ExtValue source) { 1963 return createSomeArrayAssignment(converter, dest, source, symMap, stmtCtx); 1964 } 1965 1966 /// Lower a non-elemental procedure reference and read allocatable and pointer 1967 /// results into normal values. 1968 ExtValue genProcedureRef(const Fortran::evaluate::ProcedureRef &procRef, 1969 llvm::Optional<mlir::Type> resultType) { 1970 ExtValue res = genRawProcedureRef(procRef, resultType); 1971 // In most contexts, pointers and allocatable do not appear as allocatable 1972 // or pointer variable on the caller side (see 8.5.3 note 1 for 1973 // allocatables). The few context where this can happen must call 1974 // genRawProcedureRef directly. 1975 if (const auto *box = res.getBoxOf<fir::MutableBoxValue>()) 1976 return fir::factory::genMutableBoxRead(builder, getLoc(), *box); 1977 return res; 1978 } 1979 1980 /// Given a call site for which the arguments were already lowered, generate 1981 /// the call and return the result. This function deals with explicit result 1982 /// allocation and lowering if needed. It also deals with passing the host 1983 /// link to internal procedures. 1984 ExtValue genCallOpAndResult(Fortran::lower::CallerInterface &caller, 1985 mlir::FunctionType callSiteType, 1986 llvm::Optional<mlir::Type> resultType) { 1987 mlir::Location loc = getLoc(); 1988 using PassBy = Fortran::lower::CallerInterface::PassEntityBy; 1989 // Handle cases where caller must allocate the result or a fir.box for it. 1990 bool mustPopSymMap = false; 1991 if (caller.mustMapInterfaceSymbols()) { 1992 symMap.pushScope(); 1993 mustPopSymMap = true; 1994 Fortran::lower::mapCallInterfaceSymbols(converter, caller, symMap); 1995 } 1996 // If this is an indirect call, retrieve the function address. Also retrieve 1997 // the result length if this is a character function (note that this length 1998 // will be used only if there is no explicit length in the local interface). 1999 mlir::Value funcPointer; 2000 mlir::Value charFuncPointerLength; 2001 if (const Fortran::semantics::Symbol *sym = 2002 caller.getIfIndirectCallSymbol()) { 2003 funcPointer = symMap.lookupSymbol(*sym).getAddr(); 2004 if (!funcPointer) 2005 fir::emitFatalError(loc, "failed to find indirect call symbol address"); 2006 if (fir::isCharacterProcedureTuple(funcPointer.getType(), 2007 /*acceptRawFunc=*/false)) 2008 std::tie(funcPointer, charFuncPointerLength) = 2009 fir::factory::extractCharacterProcedureTuple(builder, loc, 2010 funcPointer); 2011 } 2012 2013 mlir::IndexType idxTy = builder.getIndexType(); 2014 auto lowerSpecExpr = [&](const auto &expr) -> mlir::Value { 2015 return builder.createConvert( 2016 loc, idxTy, fir::getBase(converter.genExprValue(expr, stmtCtx))); 2017 }; 2018 llvm::SmallVector<mlir::Value> resultLengths; 2019 auto allocatedResult = [&]() -> llvm::Optional<ExtValue> { 2020 llvm::SmallVector<mlir::Value> extents; 2021 llvm::SmallVector<mlir::Value> lengths; 2022 if (!caller.callerAllocateResult()) 2023 return {}; 2024 mlir::Type type = caller.getResultStorageType(); 2025 if (type.isa<fir::SequenceType>()) 2026 caller.walkResultExtents([&](const Fortran::lower::SomeExpr &e) { 2027 extents.emplace_back(lowerSpecExpr(e)); 2028 }); 2029 caller.walkResultLengths([&](const Fortran::lower::SomeExpr &e) { 2030 lengths.emplace_back(lowerSpecExpr(e)); 2031 }); 2032 2033 // Result length parameters should not be provided to box storage 2034 // allocation and save_results, but they are still useful information to 2035 // keep in the ExtendedValue if non-deferred. 2036 if (!type.isa<fir::BoxType>()) { 2037 if (fir::isa_char(fir::unwrapSequenceType(type)) && lengths.empty()) { 2038 // Calling an assumed length function. This is only possible if this 2039 // is a call to a character dummy procedure. 2040 if (!charFuncPointerLength) 2041 fir::emitFatalError(loc, "failed to retrieve character function " 2042 "length while calling it"); 2043 lengths.push_back(charFuncPointerLength); 2044 } 2045 resultLengths = lengths; 2046 } 2047 2048 if (!extents.empty() || !lengths.empty()) { 2049 auto *bldr = &converter.getFirOpBuilder(); 2050 auto stackSaveFn = fir::factory::getLlvmStackSave(builder); 2051 auto stackSaveSymbol = bldr->getSymbolRefAttr(stackSaveFn.getName()); 2052 mlir::Value sp = 2053 bldr->create<fir::CallOp>(loc, stackSaveFn.getType().getResults(), 2054 stackSaveSymbol, mlir::ValueRange{}) 2055 .getResult(0); 2056 stmtCtx.attachCleanup([bldr, loc, sp]() { 2057 auto stackRestoreFn = fir::factory::getLlvmStackRestore(*bldr); 2058 auto stackRestoreSymbol = 2059 bldr->getSymbolRefAttr(stackRestoreFn.getName()); 2060 bldr->create<fir::CallOp>(loc, stackRestoreFn.getType().getResults(), 2061 stackRestoreSymbol, mlir::ValueRange{sp}); 2062 }); 2063 } 2064 mlir::Value temp = 2065 builder.createTemporary(loc, type, ".result", extents, resultLengths); 2066 return toExtendedValue(loc, temp, extents, lengths); 2067 }(); 2068 2069 if (mustPopSymMap) 2070 symMap.popScope(); 2071 2072 // Place allocated result or prepare the fir.save_result arguments. 2073 mlir::Value arrayResultShape; 2074 if (allocatedResult) { 2075 if (std::optional<Fortran::lower::CallInterface< 2076 Fortran::lower::CallerInterface>::PassedEntity> 2077 resultArg = caller.getPassedResult()) { 2078 if (resultArg->passBy == PassBy::AddressAndLength) 2079 caller.placeAddressAndLengthInput(*resultArg, 2080 fir::getBase(*allocatedResult), 2081 fir::getLen(*allocatedResult)); 2082 else if (resultArg->passBy == PassBy::BaseAddress) 2083 caller.placeInput(*resultArg, fir::getBase(*allocatedResult)); 2084 else 2085 fir::emitFatalError( 2086 loc, "only expect character scalar result to be passed by ref"); 2087 } else { 2088 assert(caller.mustSaveResult()); 2089 arrayResultShape = allocatedResult->match( 2090 [&](const fir::CharArrayBoxValue &) { 2091 return builder.createShape(loc, *allocatedResult); 2092 }, 2093 [&](const fir::ArrayBoxValue &) { 2094 return builder.createShape(loc, *allocatedResult); 2095 }, 2096 [&](const auto &) { return mlir::Value{}; }); 2097 } 2098 } 2099 2100 // In older Fortran, procedure argument types are inferred. This may lead 2101 // different view of what the function signature is in different locations. 2102 // Casts are inserted as needed below to accommodate this. 2103 2104 // The mlir::FuncOp type prevails, unless it has a different number of 2105 // arguments which can happen in legal program if it was passed as a dummy 2106 // procedure argument earlier with no further type information. 2107 mlir::SymbolRefAttr funcSymbolAttr; 2108 bool addHostAssociations = false; 2109 if (!funcPointer) { 2110 mlir::FunctionType funcOpType = caller.getFuncOp().getType(); 2111 mlir::SymbolRefAttr symbolAttr = 2112 builder.getSymbolRefAttr(caller.getMangledName()); 2113 if (callSiteType.getNumResults() == funcOpType.getNumResults() && 2114 callSiteType.getNumInputs() + 1 == funcOpType.getNumInputs() && 2115 fir::anyFuncArgsHaveAttr(caller.getFuncOp(), 2116 fir::getHostAssocAttrName())) { 2117 // The number of arguments is off by one, and we're lowering a function 2118 // with host associations. Modify call to include host associations 2119 // argument by appending the value at the end of the operands. 2120 assert(funcOpType.getInput(findHostAssocTuplePos(caller.getFuncOp())) == 2121 converter.hostAssocTupleValue().getType()); 2122 addHostAssociations = true; 2123 } 2124 if (!addHostAssociations && 2125 (callSiteType.getNumResults() != funcOpType.getNumResults() || 2126 callSiteType.getNumInputs() != funcOpType.getNumInputs())) { 2127 // Deal with argument number mismatch by making a function pointer so 2128 // that function type cast can be inserted. Do not emit a warning here 2129 // because this can happen in legal program if the function is not 2130 // defined here and it was first passed as an argument without any more 2131 // information. 2132 funcPointer = 2133 builder.create<fir::AddrOfOp>(loc, funcOpType, symbolAttr); 2134 } else if (callSiteType.getResults() != funcOpType.getResults()) { 2135 // Implicit interface result type mismatch are not standard Fortran, but 2136 // some compilers are not complaining about it. The front end is not 2137 // protecting lowering from this currently. Support this with a 2138 // discouraging warning. 2139 LLVM_DEBUG(mlir::emitWarning( 2140 loc, "a return type mismatch is not standard compliant and may " 2141 "lead to undefined behavior.")); 2142 // Cast the actual function to the current caller implicit type because 2143 // that is the behavior we would get if we could not see the definition. 2144 funcPointer = 2145 builder.create<fir::AddrOfOp>(loc, funcOpType, symbolAttr); 2146 } else { 2147 funcSymbolAttr = symbolAttr; 2148 } 2149 } 2150 2151 mlir::FunctionType funcType = 2152 funcPointer ? callSiteType : caller.getFuncOp().getType(); 2153 llvm::SmallVector<mlir::Value> operands; 2154 // First operand of indirect call is the function pointer. Cast it to 2155 // required function type for the call to handle procedures that have a 2156 // compatible interface in Fortran, but that have different signatures in 2157 // FIR. 2158 if (funcPointer) { 2159 operands.push_back( 2160 funcPointer.getType().isa<fir::BoxProcType>() 2161 ? builder.create<fir::BoxAddrOp>(loc, funcType, funcPointer) 2162 : builder.createConvert(loc, funcType, funcPointer)); 2163 } 2164 2165 // Deal with potential mismatches in arguments types. Passing an array to a 2166 // scalar argument should for instance be tolerated here. 2167 bool callingImplicitInterface = caller.canBeCalledViaImplicitInterface(); 2168 for (auto [fst, snd] : 2169 llvm::zip(caller.getInputs(), funcType.getInputs())) { 2170 // When passing arguments to a procedure that can be called an implicit 2171 // interface, allow character actual arguments to be passed to dummy 2172 // arguments of any type and vice versa 2173 mlir::Value cast; 2174 auto *context = builder.getContext(); 2175 if (snd.isa<fir::BoxProcType>() && 2176 fst.getType().isa<mlir::FunctionType>()) { 2177 auto funcTy = mlir::FunctionType::get(context, llvm::None, llvm::None); 2178 auto boxProcTy = builder.getBoxProcType(funcTy); 2179 if (mlir::Value host = argumentHostAssocs(converter, fst)) { 2180 cast = builder.create<fir::EmboxProcOp>( 2181 loc, boxProcTy, llvm::ArrayRef<mlir::Value>{fst, host}); 2182 } else { 2183 cast = builder.create<fir::EmboxProcOp>(loc, boxProcTy, fst); 2184 } 2185 } else { 2186 cast = builder.convertWithSemantics(loc, snd, fst, 2187 callingImplicitInterface); 2188 } 2189 operands.push_back(cast); 2190 } 2191 2192 // Add host associations as necessary. 2193 if (addHostAssociations) 2194 operands.push_back(converter.hostAssocTupleValue()); 2195 2196 auto call = builder.create<fir::CallOp>(loc, funcType.getResults(), 2197 funcSymbolAttr, operands); 2198 2199 if (caller.mustSaveResult()) 2200 builder.create<fir::SaveResultOp>( 2201 loc, call.getResult(0), fir::getBase(allocatedResult.getValue()), 2202 arrayResultShape, resultLengths); 2203 2204 if (allocatedResult) { 2205 allocatedResult->match( 2206 [&](const fir::MutableBoxValue &box) { 2207 if (box.isAllocatable()) { 2208 // 9.7.3.2 point 4. Finalize allocatables. 2209 fir::FirOpBuilder *bldr = &converter.getFirOpBuilder(); 2210 stmtCtx.attachCleanup([bldr, loc, box]() { 2211 fir::factory::genFinalization(*bldr, loc, box); 2212 }); 2213 } 2214 }, 2215 [](const auto &) {}); 2216 return *allocatedResult; 2217 } 2218 2219 if (!resultType.hasValue()) 2220 return mlir::Value{}; // subroutine call 2221 // For now, Fortran return values are implemented with a single MLIR 2222 // function return value. 2223 assert(call.getNumResults() == 1 && 2224 "Expected exactly one result in FUNCTION call"); 2225 return call.getResult(0); 2226 } 2227 2228 /// Like genExtAddr, but ensure the address returned is a temporary even if \p 2229 /// expr is variable inside parentheses. 2230 ExtValue genTempExtAddr(const Fortran::lower::SomeExpr &expr) { 2231 // In general, genExtAddr might not create a temp for variable inside 2232 // parentheses to avoid creating array temporary in sub-expressions. It only 2233 // ensures the sub-expression is not re-associated with other parts of the 2234 // expression. In the call semantics, there is a difference between expr and 2235 // variable (see R1524). For expressions, a variable storage must not be 2236 // argument associated since it could be modified inside the call, or the 2237 // variable could also be modified by other means during the call. 2238 if (!isParenthesizedVariable(expr)) 2239 return genExtAddr(expr); 2240 mlir::Location loc = getLoc(); 2241 if (expr.Rank() > 0) 2242 TODO(loc, "genTempExtAddr array"); 2243 return genExtValue(expr).match( 2244 [&](const fir::CharBoxValue &boxChar) -> ExtValue { 2245 TODO(loc, "genTempExtAddr CharBoxValue"); 2246 }, 2247 [&](const fir::UnboxedValue &v) -> ExtValue { 2248 mlir::Type type = v.getType(); 2249 mlir::Value value = v; 2250 if (fir::isa_ref_type(type)) 2251 value = builder.create<fir::LoadOp>(loc, value); 2252 mlir::Value temp = builder.createTemporary(loc, value.getType()); 2253 builder.create<fir::StoreOp>(loc, value, temp); 2254 return temp; 2255 }, 2256 [&](const fir::BoxValue &x) -> ExtValue { 2257 // Derived type scalar that may be polymorphic. 2258 assert(!x.hasRank() && x.isDerived()); 2259 if (x.isDerivedWithLengthParameters()) 2260 fir::emitFatalError( 2261 loc, "making temps for derived type with length parameters"); 2262 // TODO: polymorphic aspects should be kept but for now the temp 2263 // created always has the declared type. 2264 mlir::Value var = 2265 fir::getBase(fir::factory::readBoxValue(builder, loc, x)); 2266 auto value = builder.create<fir::LoadOp>(loc, var); 2267 mlir::Value temp = builder.createTemporary(loc, value.getType()); 2268 builder.create<fir::StoreOp>(loc, value, temp); 2269 return temp; 2270 }, 2271 [&](const auto &) -> ExtValue { 2272 fir::emitFatalError(loc, "expr is not a scalar value"); 2273 }); 2274 } 2275 2276 /// Helper structure to track potential copy-in of non contiguous variable 2277 /// argument into a contiguous temp. It is used to deallocate the temp that 2278 /// may have been created as well as to the copy-out from the temp to the 2279 /// variable after the call. 2280 struct CopyOutPair { 2281 ExtValue var; 2282 ExtValue temp; 2283 // Flag to indicate if the argument may have been modified by the 2284 // callee, in which case it must be copied-out to the variable. 2285 bool argMayBeModifiedByCall; 2286 // Optional boolean value that, if present and false, prevents 2287 // the copy-out and temp deallocation. 2288 llvm::Optional<mlir::Value> restrictCopyAndFreeAtRuntime; 2289 }; 2290 using CopyOutPairs = llvm::SmallVector<CopyOutPair, 4>; 2291 2292 /// Helper to read any fir::BoxValue into other fir::ExtendedValue categories 2293 /// not based on fir.box. 2294 /// This will lose any non contiguous stride information and dynamic type and 2295 /// should only be called if \p exv is known to be contiguous or if its base 2296 /// address will be replaced by a contiguous one. If \p exv is not a 2297 /// fir::BoxValue, this is a no-op. 2298 ExtValue readIfBoxValue(const ExtValue &exv) { 2299 if (const auto *box = exv.getBoxOf<fir::BoxValue>()) 2300 return fir::factory::readBoxValue(builder, getLoc(), *box); 2301 return exv; 2302 } 2303 2304 /// Generate a contiguous temp to pass \p actualArg as argument \p arg. The 2305 /// creation of the temp and copy-in can be made conditional at runtime by 2306 /// providing a runtime boolean flag \p restrictCopyAtRuntime (in which case 2307 /// the temp and copy will only be made if the value is true at runtime). 2308 ExtValue genCopyIn(const ExtValue &actualArg, 2309 const Fortran::lower::CallerInterface::PassedEntity &arg, 2310 CopyOutPairs ©OutPairs, 2311 llvm::Optional<mlir::Value> restrictCopyAtRuntime) { 2312 if (!restrictCopyAtRuntime) { 2313 ExtValue temp = genArrayTempFromMold(actualArg, ".copyinout"); 2314 if (arg.mayBeReadByCall()) 2315 genArrayCopy(temp, actualArg); 2316 copyOutPairs.emplace_back(CopyOutPair{ 2317 actualArg, temp, arg.mayBeModifiedByCall(), restrictCopyAtRuntime}); 2318 return temp; 2319 } 2320 // Otherwise, need to be careful to only copy-in if allowed at runtime. 2321 mlir::Location loc = getLoc(); 2322 auto addrType = fir::HeapType::get( 2323 fir::unwrapPassByRefType(fir::getBase(actualArg).getType())); 2324 mlir::Value addr = 2325 builder 2326 .genIfOp(loc, {addrType}, *restrictCopyAtRuntime, 2327 /*withElseRegion=*/true) 2328 .genThen([&]() { 2329 auto temp = genArrayTempFromMold(actualArg, ".copyinout"); 2330 if (arg.mayBeReadByCall()) 2331 genArrayCopy(temp, actualArg); 2332 builder.create<fir::ResultOp>(loc, fir::getBase(temp)); 2333 }) 2334 .genElse([&]() { 2335 auto nullPtr = builder.createNullConstant(loc, addrType); 2336 builder.create<fir::ResultOp>(loc, nullPtr); 2337 }) 2338 .getResults()[0]; 2339 // Associate the temp address with actualArg lengths and extents. 2340 fir::ExtendedValue temp = fir::substBase(readIfBoxValue(actualArg), addr); 2341 copyOutPairs.emplace_back(CopyOutPair{ 2342 actualArg, temp, arg.mayBeModifiedByCall(), restrictCopyAtRuntime}); 2343 return temp; 2344 } 2345 2346 /// Generate copy-out if needed and free the temporary for an argument that 2347 /// has been copied-in into a contiguous temp. 2348 void genCopyOut(const CopyOutPair ©OutPair) { 2349 mlir::Location loc = getLoc(); 2350 if (!copyOutPair.restrictCopyAndFreeAtRuntime) { 2351 if (copyOutPair.argMayBeModifiedByCall) 2352 genArrayCopy(copyOutPair.var, copyOutPair.temp); 2353 builder.create<fir::FreeMemOp>(loc, fir::getBase(copyOutPair.temp)); 2354 return; 2355 } 2356 builder.genIfThen(loc, *copyOutPair.restrictCopyAndFreeAtRuntime) 2357 .genThen([&]() { 2358 if (copyOutPair.argMayBeModifiedByCall) 2359 genArrayCopy(copyOutPair.var, copyOutPair.temp); 2360 builder.create<fir::FreeMemOp>(loc, fir::getBase(copyOutPair.temp)); 2361 }) 2362 .end(); 2363 } 2364 2365 /// Lower a non-elemental procedure reference. 2366 ExtValue genRawProcedureRef(const Fortran::evaluate::ProcedureRef &procRef, 2367 llvm::Optional<mlir::Type> resultType) { 2368 mlir::Location loc = getLoc(); 2369 if (isElementalProcWithArrayArgs(procRef)) 2370 fir::emitFatalError(loc, "trying to lower elemental procedure with array " 2371 "arguments as normal procedure"); 2372 if (const Fortran::evaluate::SpecificIntrinsic *intrinsic = 2373 procRef.proc().GetSpecificIntrinsic()) 2374 return genIntrinsicRef(procRef, *intrinsic, resultType); 2375 2376 if (isStatementFunctionCall(procRef)) 2377 return genStmtFunctionRef(procRef); 2378 2379 Fortran::lower::CallerInterface caller(procRef, converter); 2380 using PassBy = Fortran::lower::CallerInterface::PassEntityBy; 2381 2382 llvm::SmallVector<fir::MutableBoxValue> mutableModifiedByCall; 2383 // List of <var, temp> where temp must be copied into var after the call. 2384 CopyOutPairs copyOutPairs; 2385 2386 mlir::FunctionType callSiteType = caller.genFunctionType(); 2387 2388 // Lower the actual arguments and map the lowered values to the dummy 2389 // arguments. 2390 for (const Fortran::lower::CallInterface< 2391 Fortran::lower::CallerInterface>::PassedEntity &arg : 2392 caller.getPassedArguments()) { 2393 const auto *actual = arg.entity; 2394 mlir::Type argTy = callSiteType.getInput(arg.firArgument); 2395 if (!actual) { 2396 // Optional dummy argument for which there is no actual argument. 2397 caller.placeInput(arg, builder.create<fir::AbsentOp>(loc, argTy)); 2398 continue; 2399 } 2400 const auto *expr = actual->UnwrapExpr(); 2401 if (!expr) 2402 TODO(loc, "assumed type actual argument lowering"); 2403 2404 if (arg.passBy == PassBy::Value) { 2405 ExtValue argVal = genval(*expr); 2406 if (!fir::isUnboxedValue(argVal)) 2407 fir::emitFatalError( 2408 loc, "internal error: passing non trivial value by value"); 2409 caller.placeInput(arg, fir::getBase(argVal)); 2410 continue; 2411 } 2412 2413 if (arg.passBy == PassBy::MutableBox) { 2414 if (Fortran::evaluate::UnwrapExpr<Fortran::evaluate::NullPointer>( 2415 *expr)) { 2416 // If expr is NULL(), the mutableBox created must be a deallocated 2417 // pointer with the dummy argument characteristics (see table 16.5 2418 // in Fortran 2018 standard). 2419 // No length parameters are set for the created box because any non 2420 // deferred type parameters of the dummy will be evaluated on the 2421 // callee side, and it is illegal to use NULL without a MOLD if any 2422 // dummy length parameters are assumed. 2423 mlir::Type boxTy = fir::dyn_cast_ptrEleTy(argTy); 2424 assert(boxTy && boxTy.isa<fir::BoxType>() && 2425 "must be a fir.box type"); 2426 mlir::Value boxStorage = builder.createTemporary(loc, boxTy); 2427 mlir::Value nullBox = fir::factory::createUnallocatedBox( 2428 builder, loc, boxTy, /*nonDeferredParams=*/{}); 2429 builder.create<fir::StoreOp>(loc, nullBox, boxStorage); 2430 caller.placeInput(arg, boxStorage); 2431 continue; 2432 } 2433 fir::MutableBoxValue mutableBox = genMutableBoxValue(*expr); 2434 mlir::Value irBox = 2435 fir::factory::getMutableIRBox(builder, loc, mutableBox); 2436 caller.placeInput(arg, irBox); 2437 if (arg.mayBeModifiedByCall()) 2438 mutableModifiedByCall.emplace_back(std::move(mutableBox)); 2439 continue; 2440 } 2441 const bool actualArgIsVariable = Fortran::evaluate::IsVariable(*expr); 2442 if (arg.passBy == PassBy::BaseAddressValueAttribute) { 2443 mlir::Value temp; 2444 if (isArray(*expr)) { 2445 auto val = genBoxArg(*expr); 2446 if (!actualArgIsVariable) 2447 temp = getBase(val); 2448 else { 2449 ExtValue copy = genArrayTempFromMold(val, ".copy"); 2450 genArrayCopy(copy, val); 2451 temp = fir::getBase(copy); 2452 } 2453 } else { 2454 mlir::Value val = fir::getBase(genval(*expr)); 2455 temp = builder.createTemporary( 2456 loc, val.getType(), 2457 llvm::ArrayRef<mlir::NamedAttribute>{ 2458 Fortran::lower::getAdaptToByRefAttr(builder)}); 2459 builder.create<fir::StoreOp>(loc, val, temp); 2460 } 2461 caller.placeInput(arg, temp); 2462 continue; 2463 } 2464 if (arg.passBy == PassBy::BaseAddress || arg.passBy == PassBy::BoxChar) { 2465 const bool actualIsSimplyContiguous = 2466 !actualArgIsVariable || Fortran::evaluate::IsSimplyContiguous( 2467 *expr, converter.getFoldingContext()); 2468 auto argAddr = [&]() -> ExtValue { 2469 ExtValue baseAddr; 2470 if (actualArgIsVariable && arg.isOptional()) { 2471 if (Fortran::evaluate::IsAllocatableOrPointerObject( 2472 *expr, converter.getFoldingContext())) { 2473 // Fortran 2018 15.5.2.12 point 1: If unallocated/disassociated, 2474 // it is as if the argument was absent. The main care here is to 2475 // not do a copy-in/copy-out because the temp address, even though 2476 // pointing to a null size storage, would not be a nullptr and 2477 // therefore the argument would not be considered absent on the 2478 // callee side. Note: if wholeSymbol is optional, it cannot be 2479 // absent as per 15.5.2.12 point 7. and 8. We rely on this to 2480 // un-conditionally read the allocatable/pointer descriptor here. 2481 if (actualIsSimplyContiguous) 2482 return genBoxArg(*expr); 2483 fir::MutableBoxValue mutableBox = genMutableBoxValue(*expr); 2484 mlir::Value isAssociated = 2485 fir::factory::genIsAllocatedOrAssociatedTest(builder, loc, 2486 mutableBox); 2487 fir::ExtendedValue actualExv = 2488 fir::factory::genMutableBoxRead(builder, loc, mutableBox); 2489 return genCopyIn(actualExv, arg, copyOutPairs, isAssociated); 2490 } 2491 if (const Fortran::semantics::Symbol *wholeSymbol = 2492 Fortran::evaluate::UnwrapWholeSymbolOrComponentDataRef( 2493 *expr)) 2494 if (Fortran::semantics::IsOptional(*wholeSymbol)) { 2495 ExtValue actualArg = gen(*expr); 2496 mlir::Value actualArgBase = fir::getBase(actualArg); 2497 if (!actualArgBase.getType().isa<fir::BoxType>()) 2498 return actualArg; 2499 // Do not read wholeSymbol descriptor that may be a nullptr in 2500 // case wholeSymbol is absent. 2501 // Absent descriptor cannot be read. To avoid any issue in 2502 // copy-in/copy-out, and when retrieving the address/length 2503 // create an descriptor pointing to a null address here if the 2504 // fir.box is absent. 2505 mlir::Value isPresent = builder.create<fir::IsPresentOp>( 2506 loc, builder.getI1Type(), actualArgBase); 2507 mlir::Type boxType = actualArgBase.getType(); 2508 mlir::Value emptyBox = fir::factory::createUnallocatedBox( 2509 builder, loc, boxType, llvm::None); 2510 auto safeToReadBox = builder.create<mlir::arith::SelectOp>( 2511 loc, isPresent, actualArgBase, emptyBox); 2512 fir::ExtendedValue safeToReadExv = 2513 fir::substBase(actualArg, safeToReadBox); 2514 if (actualIsSimplyContiguous) 2515 return safeToReadExv; 2516 return genCopyIn(safeToReadExv, arg, copyOutPairs, isPresent); 2517 } 2518 // Fall through: The actual argument can safely be 2519 // copied-in/copied-out without any care if needed. 2520 } 2521 if (actualArgIsVariable && expr->Rank() > 0) { 2522 ExtValue box = genBoxArg(*expr); 2523 if (!actualIsSimplyContiguous) 2524 return genCopyIn(box, arg, copyOutPairs, 2525 /*restrictCopyAtRuntime=*/llvm::None); 2526 // Contiguous: just use the box we created above! 2527 // This gets "unboxed" below, if needed. 2528 return box; 2529 } 2530 // Actual argument is a non optional/non pointer/non allocatable 2531 // scalar. 2532 if (actualArgIsVariable) 2533 return genExtAddr(*expr); 2534 // Actual argument is not a variable. Make sure a variable address is 2535 // not passed. 2536 return genTempExtAddr(*expr); 2537 }(); 2538 // Scalar and contiguous expressions may be lowered to a fir.box, 2539 // either to account for potential polymorphism, or because lowering 2540 // did not account for some contiguity hints. 2541 // Here, polymorphism does not matter (an entity of the declared type 2542 // is passed, not one of the dynamic type), and the expr is known to 2543 // be simply contiguous, so it is safe to unbox it and pass the 2544 // address without making a copy. 2545 argAddr = readIfBoxValue(argAddr); 2546 2547 if (arg.passBy == PassBy::BaseAddress) { 2548 caller.placeInput(arg, fir::getBase(argAddr)); 2549 } else { 2550 assert(arg.passBy == PassBy::BoxChar); 2551 auto helper = fir::factory::CharacterExprHelper{builder, loc}; 2552 auto boxChar = argAddr.match( 2553 [&](const fir::CharBoxValue &x) { return helper.createEmbox(x); }, 2554 [&](const fir::CharArrayBoxValue &x) { 2555 return helper.createEmbox(x); 2556 }, 2557 [&](const auto &x) -> mlir::Value { 2558 // Fortran allows an actual argument of a completely different 2559 // type to be passed to a procedure expecting a CHARACTER in the 2560 // dummy argument position. When this happens, the data pointer 2561 // argument is simply assumed to point to CHARACTER data and the 2562 // LEN argument used is garbage. Simulate this behavior by 2563 // free-casting the base address to be a !fir.char reference and 2564 // setting the LEN argument to undefined. What could go wrong? 2565 auto dataPtr = fir::getBase(x); 2566 assert(!dataPtr.getType().template isa<fir::BoxType>()); 2567 return builder.convertWithSemantics( 2568 loc, argTy, dataPtr, 2569 /*allowCharacterConversion=*/true); 2570 }); 2571 caller.placeInput(arg, boxChar); 2572 } 2573 } else if (arg.passBy == PassBy::Box) { 2574 // Before lowering to an address, handle the allocatable/pointer actual 2575 // argument to optional fir.box dummy. It is legal to pass 2576 // unallocated/disassociated entity to an optional. In this case, an 2577 // absent fir.box must be created instead of a fir.box with a null value 2578 // (Fortran 2018 15.5.2.12 point 1). 2579 if (arg.isOptional() && Fortran::evaluate::IsAllocatableOrPointerObject( 2580 *expr, converter.getFoldingContext())) { 2581 // Note that passing an absent allocatable to a non-allocatable 2582 // optional dummy argument is illegal (15.5.2.12 point 3 (8)). So 2583 // nothing has to be done to generate an absent argument in this case, 2584 // and it is OK to unconditionally read the mutable box here. 2585 fir::MutableBoxValue mutableBox = genMutableBoxValue(*expr); 2586 mlir::Value isAllocated = 2587 fir::factory::genIsAllocatedOrAssociatedTest(builder, loc, 2588 mutableBox); 2589 auto absent = builder.create<fir::AbsentOp>(loc, argTy); 2590 /// For now, assume it is not OK to pass the allocatable/pointer 2591 /// descriptor to a non pointer/allocatable dummy. That is a strict 2592 /// interpretation of 18.3.6 point 4 that stipulates the descriptor 2593 /// has the dummy attributes in BIND(C) contexts. 2594 mlir::Value box = builder.createBox( 2595 loc, fir::factory::genMutableBoxRead(builder, loc, mutableBox)); 2596 // Need the box types to be exactly similar for the selectOp. 2597 mlir::Value convertedBox = builder.createConvert(loc, argTy, box); 2598 caller.placeInput(arg, builder.create<mlir::arith::SelectOp>( 2599 loc, isAllocated, convertedBox, absent)); 2600 } else { 2601 // Make sure a variable address is only passed if the expression is 2602 // actually a variable. 2603 mlir::Value box = 2604 actualArgIsVariable 2605 ? builder.createBox(loc, genBoxArg(*expr)) 2606 : builder.createBox(getLoc(), genTempExtAddr(*expr)); 2607 caller.placeInput(arg, box); 2608 } 2609 } else if (arg.passBy == PassBy::AddressAndLength) { 2610 ExtValue argRef = genExtAddr(*expr); 2611 caller.placeAddressAndLengthInput(arg, fir::getBase(argRef), 2612 fir::getLen(argRef)); 2613 } else if (arg.passBy == PassBy::CharProcTuple) { 2614 ExtValue argRef = genExtAddr(*expr); 2615 mlir::Value tuple = createBoxProcCharTuple( 2616 converter, argTy, fir::getBase(argRef), fir::getLen(argRef)); 2617 caller.placeInput(arg, tuple); 2618 } else { 2619 TODO(loc, "pass by value in non elemental function call"); 2620 } 2621 } 2622 2623 ExtValue result = genCallOpAndResult(caller, callSiteType, resultType); 2624 2625 // Sync pointers and allocatables that may have been modified during the 2626 // call. 2627 for (const auto &mutableBox : mutableModifiedByCall) 2628 fir::factory::syncMutableBoxFromIRBox(builder, loc, mutableBox); 2629 // Handle case where result was passed as argument 2630 2631 // Copy-out temps that were created for non contiguous variable arguments if 2632 // needed. 2633 for (const auto ©OutPair : copyOutPairs) 2634 genCopyOut(copyOutPair); 2635 2636 return result; 2637 } 2638 2639 template <typename A> 2640 ExtValue genval(const Fortran::evaluate::FunctionRef<A> &funcRef) { 2641 ExtValue result = genFunctionRef(funcRef); 2642 if (result.rank() == 0 && fir::isa_ref_type(fir::getBase(result).getType())) 2643 return genLoad(result); 2644 return result; 2645 } 2646 2647 ExtValue genval(const Fortran::evaluate::ProcedureRef &procRef) { 2648 llvm::Optional<mlir::Type> resTy; 2649 if (procRef.hasAlternateReturns()) 2650 resTy = builder.getIndexType(); 2651 return genProcedureRef(procRef, resTy); 2652 } 2653 2654 /// Helper to lower intrinsic arguments for inquiry intrinsic. 2655 ExtValue 2656 lowerIntrinsicArgumentAsInquired(const Fortran::lower::SomeExpr &expr) { 2657 if (Fortran::evaluate::IsAllocatableOrPointerObject( 2658 expr, converter.getFoldingContext())) 2659 return genMutableBoxValue(expr); 2660 return gen(expr); 2661 } 2662 2663 /// Helper to lower intrinsic arguments to a fir::BoxValue. 2664 /// It preserves all the non default lower bounds/non deferred length 2665 /// parameter information. 2666 ExtValue lowerIntrinsicArgumentAsBox(const Fortran::lower::SomeExpr &expr) { 2667 mlir::Location loc = getLoc(); 2668 ExtValue exv = genBoxArg(expr); 2669 mlir::Value box = builder.createBox(loc, exv); 2670 return fir::BoxValue( 2671 box, fir::factory::getNonDefaultLowerBounds(builder, loc, exv), 2672 fir::factory::getNonDeferredLengthParams(exv)); 2673 } 2674 2675 /// Generate a call to an intrinsic function. 2676 ExtValue 2677 genIntrinsicRef(const Fortran::evaluate::ProcedureRef &procRef, 2678 const Fortran::evaluate::SpecificIntrinsic &intrinsic, 2679 llvm::Optional<mlir::Type> resultType) { 2680 llvm::SmallVector<ExtValue> operands; 2681 2682 llvm::StringRef name = intrinsic.name; 2683 mlir::Location loc = getLoc(); 2684 2685 const Fortran::lower::IntrinsicArgumentLoweringRules *argLowering = 2686 Fortran::lower::getIntrinsicArgumentLowering(name); 2687 for (const auto &[arg, dummy] : 2688 llvm::zip(procRef.arguments(), 2689 intrinsic.characteristics.value().dummyArguments)) { 2690 auto *expr = Fortran::evaluate::UnwrapExpr<Fortran::lower::SomeExpr>(arg); 2691 if (!expr) { 2692 // Absent optional. 2693 operands.emplace_back(Fortran::lower::getAbsentIntrinsicArgument()); 2694 continue; 2695 } 2696 if (!argLowering) { 2697 // No argument lowering instruction, lower by value. 2698 operands.emplace_back(genval(*expr)); 2699 continue; 2700 } 2701 // Ad-hoc argument lowering handling. 2702 Fortran::lower::ArgLoweringRule argRules = 2703 Fortran::lower::lowerIntrinsicArgumentAs(loc, *argLowering, 2704 dummy.name); 2705 if (argRules.handleDynamicOptional && 2706 Fortran::evaluate::MayBePassedAsAbsentOptional( 2707 *expr, converter.getFoldingContext())) { 2708 ExtValue optional = lowerIntrinsicArgumentAsInquired(*expr); 2709 mlir::Value isPresent = genActualIsPresentTest(builder, loc, optional); 2710 switch (argRules.lowerAs) { 2711 case Fortran::lower::LowerIntrinsicArgAs::Value: 2712 operands.emplace_back( 2713 genOptionalValue(builder, loc, optional, isPresent)); 2714 continue; 2715 case Fortran::lower::LowerIntrinsicArgAs::Addr: 2716 operands.emplace_back( 2717 genOptionalAddr(builder, loc, optional, isPresent)); 2718 continue; 2719 case Fortran::lower::LowerIntrinsicArgAs::Box: 2720 operands.emplace_back( 2721 genOptionalBox(builder, loc, optional, isPresent)); 2722 continue; 2723 case Fortran::lower::LowerIntrinsicArgAs::Inquired: 2724 operands.emplace_back(optional); 2725 continue; 2726 } 2727 llvm_unreachable("bad switch"); 2728 } 2729 switch (argRules.lowerAs) { 2730 case Fortran::lower::LowerIntrinsicArgAs::Value: 2731 operands.emplace_back(genval(*expr)); 2732 continue; 2733 case Fortran::lower::LowerIntrinsicArgAs::Addr: 2734 operands.emplace_back(gen(*expr)); 2735 continue; 2736 case Fortran::lower::LowerIntrinsicArgAs::Box: 2737 operands.emplace_back(lowerIntrinsicArgumentAsBox(*expr)); 2738 continue; 2739 case Fortran::lower::LowerIntrinsicArgAs::Inquired: 2740 operands.emplace_back(lowerIntrinsicArgumentAsInquired(*expr)); 2741 continue; 2742 } 2743 llvm_unreachable("bad switch"); 2744 } 2745 // Let the intrinsic library lower the intrinsic procedure call 2746 return Fortran::lower::genIntrinsicCall(builder, getLoc(), name, resultType, 2747 operands, stmtCtx); 2748 } 2749 2750 template <typename A> 2751 bool isScalar(const A &x) { 2752 return x.Rank() == 0; 2753 } 2754 2755 /// Helper to detect Transformational function reference. 2756 template <typename T> 2757 bool isTransformationalRef(const T &) { 2758 return false; 2759 } 2760 template <typename T> 2761 bool isTransformationalRef(const Fortran::evaluate::FunctionRef<T> &funcRef) { 2762 return !funcRef.IsElemental() && funcRef.Rank(); 2763 } 2764 template <typename T> 2765 bool isTransformationalRef(Fortran::evaluate::Expr<T> expr) { 2766 return std::visit([&](const auto &e) { return isTransformationalRef(e); }, 2767 expr.u); 2768 } 2769 2770 template <typename A> 2771 ExtValue asArray(const A &x) { 2772 return Fortran::lower::createSomeArrayTempValue(converter, toEvExpr(x), 2773 symMap, stmtCtx); 2774 } 2775 2776 /// Lower an array value as an argument. This argument can be passed as a box 2777 /// value, so it may be possible to avoid making a temporary. 2778 template <typename A> 2779 ExtValue asArrayArg(const Fortran::evaluate::Expr<A> &x) { 2780 return std::visit([&](const auto &e) { return asArrayArg(e, x); }, x.u); 2781 } 2782 template <typename A, typename B> 2783 ExtValue asArrayArg(const Fortran::evaluate::Expr<A> &x, const B &y) { 2784 return std::visit([&](const auto &e) { return asArrayArg(e, y); }, x.u); 2785 } 2786 template <typename A, typename B> 2787 ExtValue asArrayArg(const Fortran::evaluate::Designator<A> &, const B &x) { 2788 // Designator is being passed as an argument to a procedure. Lower the 2789 // expression to a boxed value. 2790 auto someExpr = toEvExpr(x); 2791 return Fortran::lower::createBoxValue(getLoc(), converter, someExpr, symMap, 2792 stmtCtx); 2793 } 2794 template <typename A, typename B> 2795 ExtValue asArrayArg(const A &, const B &x) { 2796 // If the expression to pass as an argument is not a designator, then create 2797 // an array temp. 2798 return asArray(x); 2799 } 2800 2801 template <typename A> 2802 ExtValue gen(const Fortran::evaluate::Expr<A> &x) { 2803 // Whole array symbols or components, and results of transformational 2804 // functions already have a storage and the scalar expression lowering path 2805 // is used to not create a new temporary storage. 2806 if (isScalar(x) || 2807 Fortran::evaluate::UnwrapWholeSymbolOrComponentDataRef(x) || 2808 isTransformationalRef(x)) 2809 return std::visit([&](const auto &e) { return genref(e); }, x.u); 2810 if (useBoxArg) 2811 return asArrayArg(x); 2812 return asArray(x); 2813 } 2814 template <typename A> 2815 ExtValue genval(const Fortran::evaluate::Expr<A> &x) { 2816 if (isScalar(x) || Fortran::evaluate::UnwrapWholeSymbolDataRef(x) || 2817 inInitializer) 2818 return std::visit([&](const auto &e) { return genval(e); }, x.u); 2819 return asArray(x); 2820 } 2821 2822 template <int KIND> 2823 ExtValue genval(const Fortran::evaluate::Expr<Fortran::evaluate::Type< 2824 Fortran::common::TypeCategory::Logical, KIND>> &exp) { 2825 return std::visit([&](const auto &e) { return genval(e); }, exp.u); 2826 } 2827 2828 using RefSet = 2829 std::tuple<Fortran::evaluate::ComplexPart, Fortran::evaluate::Substring, 2830 Fortran::evaluate::DataRef, Fortran::evaluate::Component, 2831 Fortran::evaluate::ArrayRef, Fortran::evaluate::CoarrayRef, 2832 Fortran::semantics::SymbolRef>; 2833 template <typename A> 2834 static constexpr bool inRefSet = Fortran::common::HasMember<A, RefSet>; 2835 2836 template <typename A, typename = std::enable_if_t<inRefSet<A>>> 2837 ExtValue genref(const A &a) { 2838 return gen(a); 2839 } 2840 template <typename A> 2841 ExtValue genref(const A &a) { 2842 if (inInitializer) { 2843 // Initialization expressions can never allocate memory. 2844 return genval(a); 2845 } 2846 mlir::Type storageType = converter.genType(toEvExpr(a)); 2847 return placeScalarValueInMemory(builder, getLoc(), genval(a), storageType); 2848 } 2849 2850 template <typename A, template <typename> typename T, 2851 typename B = std::decay_t<T<A>>, 2852 std::enable_if_t< 2853 std::is_same_v<B, Fortran::evaluate::Expr<A>> || 2854 std::is_same_v<B, Fortran::evaluate::Designator<A>> || 2855 std::is_same_v<B, Fortran::evaluate::FunctionRef<A>>, 2856 bool> = true> 2857 ExtValue genref(const T<A> &x) { 2858 return gen(x); 2859 } 2860 2861 private: 2862 mlir::Location location; 2863 Fortran::lower::AbstractConverter &converter; 2864 fir::FirOpBuilder &builder; 2865 Fortran::lower::StatementContext &stmtCtx; 2866 Fortran::lower::SymMap &symMap; 2867 InitializerData *inInitializer = nullptr; 2868 bool useBoxArg = false; // expression lowered as argument 2869 }; 2870 } // namespace 2871 2872 // Helper for changing the semantics in a given context. Preserves the current 2873 // semantics which is resumed when the "push" goes out of scope. 2874 #define PushSemantics(PushVal) \ 2875 [[maybe_unused]] auto pushSemanticsLocalVariable##__LINE__ = \ 2876 Fortran::common::ScopedSet(semant, PushVal); 2877 2878 static bool isAdjustedArrayElementType(mlir::Type t) { 2879 return fir::isa_char(t) || fir::isa_derived(t) || t.isa<fir::SequenceType>(); 2880 } 2881 static bool elementTypeWasAdjusted(mlir::Type t) { 2882 if (auto ty = t.dyn_cast<fir::ReferenceType>()) 2883 return isAdjustedArrayElementType(ty.getEleTy()); 2884 return false; 2885 } 2886 2887 /// Build an ExtendedValue from a fir.array<?x...?xT> without actually setting 2888 /// the actual extents and lengths. This is only to allow their propagation as 2889 /// ExtendedValue without triggering verifier failures when propagating 2890 /// character/arrays as unboxed values. Only the base of the resulting 2891 /// ExtendedValue should be used, it is undefined to use the length or extents 2892 /// of the extended value returned, 2893 inline static fir::ExtendedValue 2894 convertToArrayBoxValue(mlir::Location loc, fir::FirOpBuilder &builder, 2895 mlir::Value val, mlir::Value len) { 2896 mlir::Type ty = fir::unwrapRefType(val.getType()); 2897 mlir::IndexType idxTy = builder.getIndexType(); 2898 auto seqTy = ty.cast<fir::SequenceType>(); 2899 auto undef = builder.create<fir::UndefOp>(loc, idxTy); 2900 llvm::SmallVector<mlir::Value> extents(seqTy.getDimension(), undef); 2901 if (fir::isa_char(seqTy.getEleTy())) 2902 return fir::CharArrayBoxValue(val, len ? len : undef, extents); 2903 return fir::ArrayBoxValue(val, extents); 2904 } 2905 2906 /// Helper to generate calls to scalar user defined assignment procedures. 2907 static void genScalarUserDefinedAssignmentCall(fir::FirOpBuilder &builder, 2908 mlir::Location loc, 2909 mlir::FuncOp func, 2910 const fir::ExtendedValue &lhs, 2911 const fir::ExtendedValue &rhs) { 2912 auto prepareUserDefinedArg = 2913 [](fir::FirOpBuilder &builder, mlir::Location loc, 2914 const fir::ExtendedValue &value, mlir::Type argType) -> mlir::Value { 2915 if (argType.isa<fir::BoxCharType>()) { 2916 const fir::CharBoxValue *charBox = value.getCharBox(); 2917 assert(charBox && "argument type mismatch in elemental user assignment"); 2918 return fir::factory::CharacterExprHelper{builder, loc}.createEmbox( 2919 *charBox); 2920 } 2921 if (argType.isa<fir::BoxType>()) { 2922 mlir::Value box = builder.createBox(loc, value); 2923 return builder.createConvert(loc, argType, box); 2924 } 2925 // Simple pass by address. 2926 mlir::Type argBaseType = fir::unwrapRefType(argType); 2927 assert(!fir::hasDynamicSize(argBaseType)); 2928 mlir::Value from = fir::getBase(value); 2929 if (argBaseType != fir::unwrapRefType(from.getType())) { 2930 // With logicals, it is possible that from is i1 here. 2931 if (fir::isa_ref_type(from.getType())) 2932 from = builder.create<fir::LoadOp>(loc, from); 2933 from = builder.createConvert(loc, argBaseType, from); 2934 } 2935 if (!fir::isa_ref_type(from.getType())) { 2936 mlir::Value temp = builder.createTemporary(loc, argBaseType); 2937 builder.create<fir::StoreOp>(loc, from, temp); 2938 from = temp; 2939 } 2940 return builder.createConvert(loc, argType, from); 2941 }; 2942 assert(func.getNumArguments() == 2); 2943 mlir::Type lhsType = func.getType().getInput(0); 2944 mlir::Type rhsType = func.getType().getInput(1); 2945 mlir::Value lhsArg = prepareUserDefinedArg(builder, loc, lhs, lhsType); 2946 mlir::Value rhsArg = prepareUserDefinedArg(builder, loc, rhs, rhsType); 2947 builder.create<fir::CallOp>(loc, func, mlir::ValueRange{lhsArg, rhsArg}); 2948 } 2949 2950 /// Convert the result of a fir.array_modify to an ExtendedValue given the 2951 /// related fir.array_load. 2952 static fir::ExtendedValue arrayModifyToExv(fir::FirOpBuilder &builder, 2953 mlir::Location loc, 2954 fir::ArrayLoadOp load, 2955 mlir::Value elementAddr) { 2956 mlir::Type eleTy = fir::unwrapPassByRefType(elementAddr.getType()); 2957 if (fir::isa_char(eleTy)) { 2958 auto len = fir::factory::CharacterExprHelper{builder, loc}.getLength( 2959 load.getMemref()); 2960 if (!len) { 2961 assert(load.getTypeparams().size() == 1 && 2962 "length must be in array_load"); 2963 len = load.getTypeparams()[0]; 2964 } 2965 return fir::CharBoxValue{elementAddr, len}; 2966 } 2967 return elementAddr; 2968 } 2969 2970 //===----------------------------------------------------------------------===// 2971 // 2972 // Lowering of scalar expressions in an explicit iteration space context. 2973 // 2974 //===----------------------------------------------------------------------===// 2975 2976 // Shared code for creating a copy of a derived type element. This function is 2977 // called from a continuation. 2978 inline static fir::ArrayAmendOp 2979 createDerivedArrayAmend(mlir::Location loc, fir::ArrayLoadOp destLoad, 2980 fir::FirOpBuilder &builder, fir::ArrayAccessOp destAcc, 2981 const fir::ExtendedValue &elementExv, mlir::Type eleTy, 2982 mlir::Value innerArg) { 2983 if (destLoad.getTypeparams().empty()) { 2984 fir::factory::genRecordAssignment(builder, loc, destAcc, elementExv); 2985 } else { 2986 auto boxTy = fir::BoxType::get(eleTy); 2987 auto toBox = builder.create<fir::EmboxOp>(loc, boxTy, destAcc.getResult(), 2988 mlir::Value{}, mlir::Value{}, 2989 destLoad.getTypeparams()); 2990 auto fromBox = builder.create<fir::EmboxOp>( 2991 loc, boxTy, fir::getBase(elementExv), mlir::Value{}, mlir::Value{}, 2992 destLoad.getTypeparams()); 2993 fir::factory::genRecordAssignment(builder, loc, fir::BoxValue(toBox), 2994 fir::BoxValue(fromBox)); 2995 } 2996 return builder.create<fir::ArrayAmendOp>(loc, innerArg.getType(), innerArg, 2997 destAcc); 2998 } 2999 3000 inline static fir::ArrayAmendOp 3001 createCharArrayAmend(mlir::Location loc, fir::FirOpBuilder &builder, 3002 fir::ArrayAccessOp dstOp, mlir::Value &dstLen, 3003 const fir::ExtendedValue &srcExv, mlir::Value innerArg, 3004 llvm::ArrayRef<mlir::Value> bounds) { 3005 fir::CharBoxValue dstChar(dstOp, dstLen); 3006 fir::factory::CharacterExprHelper helper{builder, loc}; 3007 if (!bounds.empty()) { 3008 dstChar = helper.createSubstring(dstChar, bounds); 3009 fir::factory::genCharacterCopy(fir::getBase(srcExv), fir::getLen(srcExv), 3010 dstChar.getAddr(), dstChar.getLen(), builder, 3011 loc); 3012 // Update the LEN to the substring's LEN. 3013 dstLen = dstChar.getLen(); 3014 } 3015 // For a CHARACTER, we generate the element assignment loops inline. 3016 helper.createAssign(fir::ExtendedValue{dstChar}, srcExv); 3017 // Mark this array element as amended. 3018 mlir::Type ty = innerArg.getType(); 3019 auto amend = builder.create<fir::ArrayAmendOp>(loc, ty, innerArg, dstOp); 3020 return amend; 3021 } 3022 3023 //===----------------------------------------------------------------------===// 3024 // 3025 // Lowering of array expressions. 3026 // 3027 //===----------------------------------------------------------------------===// 3028 3029 namespace { 3030 class ArrayExprLowering { 3031 using ExtValue = fir::ExtendedValue; 3032 3033 /// Structure to keep track of lowered array operands in the 3034 /// array expression. Useful to later deduce the shape of the 3035 /// array expression. 3036 struct ArrayOperand { 3037 /// Array base (can be a fir.box). 3038 mlir::Value memref; 3039 /// ShapeOp, ShapeShiftOp or ShiftOp 3040 mlir::Value shape; 3041 /// SliceOp 3042 mlir::Value slice; 3043 /// Can this operand be absent ? 3044 bool mayBeAbsent = false; 3045 }; 3046 3047 using ImplicitSubscripts = Fortran::lower::details::ImplicitSubscripts; 3048 using PathComponent = Fortran::lower::PathComponent; 3049 3050 /// Active iteration space. 3051 using IterationSpace = Fortran::lower::IterationSpace; 3052 using IterSpace = const Fortran::lower::IterationSpace &; 3053 3054 /// Current continuation. Function that will generate IR for a single 3055 /// iteration of the pending iterative loop structure. 3056 using CC = Fortran::lower::GenerateElementalArrayFunc; 3057 3058 /// Projection continuation. Function that will project one iteration space 3059 /// into another. 3060 using PC = std::function<IterationSpace(IterSpace)>; 3061 using ArrayBaseTy = 3062 std::variant<std::monostate, const Fortran::evaluate::ArrayRef *, 3063 const Fortran::evaluate::DataRef *>; 3064 using ComponentPath = Fortran::lower::ComponentPath; 3065 3066 public: 3067 //===--------------------------------------------------------------------===// 3068 // Regular array assignment 3069 //===--------------------------------------------------------------------===// 3070 3071 /// Entry point for array assignments. Both the left-hand and right-hand sides 3072 /// can either be ExtendedValue or evaluate::Expr. 3073 template <typename TL, typename TR> 3074 static void lowerArrayAssignment(Fortran::lower::AbstractConverter &converter, 3075 Fortran::lower::SymMap &symMap, 3076 Fortran::lower::StatementContext &stmtCtx, 3077 const TL &lhs, const TR &rhs) { 3078 ArrayExprLowering ael{converter, stmtCtx, symMap, 3079 ConstituentSemantics::CopyInCopyOut}; 3080 ael.lowerArrayAssignment(lhs, rhs); 3081 } 3082 3083 template <typename TL, typename TR> 3084 void lowerArrayAssignment(const TL &lhs, const TR &rhs) { 3085 mlir::Location loc = getLoc(); 3086 /// Here the target subspace is not necessarily contiguous. The ArrayUpdate 3087 /// continuation is implicitly returned in `ccStoreToDest` and the ArrayLoad 3088 /// in `destination`. 3089 PushSemantics(ConstituentSemantics::ProjectedCopyInCopyOut); 3090 ccStoreToDest = genarr(lhs); 3091 determineShapeOfDest(lhs); 3092 semant = ConstituentSemantics::RefTransparent; 3093 ExtValue exv = lowerArrayExpression(rhs); 3094 if (explicitSpaceIsActive()) { 3095 explicitSpace->finalizeContext(); 3096 builder.create<fir::ResultOp>(loc, fir::getBase(exv)); 3097 } else { 3098 builder.create<fir::ArrayMergeStoreOp>( 3099 loc, destination, fir::getBase(exv), destination.getMemref(), 3100 destination.getSlice(), destination.getTypeparams()); 3101 } 3102 } 3103 3104 //===--------------------------------------------------------------------===// 3105 // WHERE array assignment, FORALL assignment, and FORALL+WHERE array 3106 // assignment 3107 //===--------------------------------------------------------------------===// 3108 3109 /// Entry point for array assignment when the iteration space is explicitly 3110 /// defined (Fortran's FORALL) with or without masks, and/or the implied 3111 /// iteration space involves masks (Fortran's WHERE). Both contexts (explicit 3112 /// space and implicit space with masks) may be present. 3113 static void lowerAnyMaskedArrayAssignment( 3114 Fortran::lower::AbstractConverter &converter, 3115 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx, 3116 const Fortran::lower::SomeExpr &lhs, const Fortran::lower::SomeExpr &rhs, 3117 Fortran::lower::ExplicitIterSpace &explicitSpace, 3118 Fortran::lower::ImplicitIterSpace &implicitSpace) { 3119 if (explicitSpace.isActive() && lhs.Rank() == 0) { 3120 // Scalar assignment expression in a FORALL context. 3121 ArrayExprLowering ael(converter, stmtCtx, symMap, 3122 ConstituentSemantics::RefTransparent, 3123 &explicitSpace, &implicitSpace); 3124 ael.lowerScalarAssignment(lhs, rhs); 3125 return; 3126 } 3127 // Array assignment expression in a FORALL and/or WHERE context. 3128 ArrayExprLowering ael(converter, stmtCtx, symMap, 3129 ConstituentSemantics::CopyInCopyOut, &explicitSpace, 3130 &implicitSpace); 3131 ael.lowerArrayAssignment(lhs, rhs); 3132 } 3133 3134 //===--------------------------------------------------------------------===// 3135 // Array assignment to allocatable array 3136 //===--------------------------------------------------------------------===// 3137 3138 /// Entry point for assignment to allocatable array. 3139 static void lowerAllocatableArrayAssignment( 3140 Fortran::lower::AbstractConverter &converter, 3141 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx, 3142 const Fortran::lower::SomeExpr &lhs, const Fortran::lower::SomeExpr &rhs, 3143 Fortran::lower::ExplicitIterSpace &explicitSpace, 3144 Fortran::lower::ImplicitIterSpace &implicitSpace) { 3145 ArrayExprLowering ael(converter, stmtCtx, symMap, 3146 ConstituentSemantics::CopyInCopyOut, &explicitSpace, 3147 &implicitSpace); 3148 ael.lowerAllocatableArrayAssignment(lhs, rhs); 3149 } 3150 3151 /// Assignment to allocatable array. 3152 /// 3153 /// The semantics are reverse that of a "regular" array assignment. The rhs 3154 /// defines the iteration space of the computation and the lhs is 3155 /// resized/reallocated to fit if necessary. 3156 void lowerAllocatableArrayAssignment(const Fortran::lower::SomeExpr &lhs, 3157 const Fortran::lower::SomeExpr &rhs) { 3158 // With assignment to allocatable, we want to lower the rhs first and use 3159 // its shape to determine if we need to reallocate, etc. 3160 mlir::Location loc = getLoc(); 3161 // FIXME: If the lhs is in an explicit iteration space, the assignment may 3162 // be to an array of allocatable arrays rather than a single allocatable 3163 // array. 3164 fir::MutableBoxValue mutableBox = 3165 createMutableBox(loc, converter, lhs, symMap); 3166 mlir::Type resultTy = converter.genType(rhs); 3167 if (rhs.Rank() > 0) 3168 determineShapeOfDest(rhs); 3169 auto rhsCC = [&]() { 3170 PushSemantics(ConstituentSemantics::RefTransparent); 3171 return genarr(rhs); 3172 }(); 3173 3174 llvm::SmallVector<mlir::Value> lengthParams; 3175 // Currently no safe way to gather length from rhs (at least for 3176 // character, it cannot be taken from array_loads since it may be 3177 // changed by concatenations). 3178 if ((mutableBox.isCharacter() && !mutableBox.hasNonDeferredLenParams()) || 3179 mutableBox.isDerivedWithLengthParameters()) 3180 TODO(loc, "gather rhs length parameters in assignment to allocatable"); 3181 3182 // The allocatable must take lower bounds from the expr if it is 3183 // reallocated and the right hand side is not a scalar. 3184 const bool takeLboundsIfRealloc = rhs.Rank() > 0; 3185 llvm::SmallVector<mlir::Value> lbounds; 3186 // When the reallocated LHS takes its lower bounds from the RHS, 3187 // they will be non default only if the RHS is a whole array 3188 // variable. Otherwise, lbounds is left empty and default lower bounds 3189 // will be used. 3190 if (takeLboundsIfRealloc && 3191 Fortran::evaluate::UnwrapWholeSymbolOrComponentDataRef(rhs)) { 3192 assert(arrayOperands.size() == 1 && 3193 "lbounds can only come from one array"); 3194 std::vector<mlir::Value> lbs = 3195 fir::factory::getOrigins(arrayOperands[0].shape); 3196 lbounds.append(lbs.begin(), lbs.end()); 3197 } 3198 fir::factory::MutableBoxReallocation realloc = 3199 fir::factory::genReallocIfNeeded(builder, loc, mutableBox, destShape, 3200 lengthParams); 3201 // Create ArrayLoad for the mutable box and save it into `destination`. 3202 PushSemantics(ConstituentSemantics::ProjectedCopyInCopyOut); 3203 ccStoreToDest = genarr(realloc.newValue); 3204 // If the rhs is scalar, get shape from the allocatable ArrayLoad. 3205 if (destShape.empty()) 3206 destShape = getShape(destination); 3207 // Finish lowering the loop nest. 3208 assert(destination && "destination must have been set"); 3209 ExtValue exv = lowerArrayExpression(rhsCC, resultTy); 3210 if (explicitSpaceIsActive()) { 3211 explicitSpace->finalizeContext(); 3212 builder.create<fir::ResultOp>(loc, fir::getBase(exv)); 3213 } else { 3214 builder.create<fir::ArrayMergeStoreOp>( 3215 loc, destination, fir::getBase(exv), destination.getMemref(), 3216 destination.getSlice(), destination.getTypeparams()); 3217 } 3218 fir::factory::finalizeRealloc(builder, loc, mutableBox, lbounds, 3219 takeLboundsIfRealloc, realloc); 3220 } 3221 3222 /// Entry point for when an array expression appears in a context where the 3223 /// result must be boxed. (BoxValue semantics.) 3224 static ExtValue 3225 lowerBoxedArrayExpression(Fortran::lower::AbstractConverter &converter, 3226 Fortran::lower::SymMap &symMap, 3227 Fortran::lower::StatementContext &stmtCtx, 3228 const Fortran::lower::SomeExpr &expr) { 3229 ArrayExprLowering ael{converter, stmtCtx, symMap, 3230 ConstituentSemantics::BoxValue}; 3231 return ael.lowerBoxedArrayExpr(expr); 3232 } 3233 3234 ExtValue lowerBoxedArrayExpr(const Fortran::lower::SomeExpr &exp) { 3235 return std::visit( 3236 [&](const auto &e) { 3237 auto f = genarr(e); 3238 ExtValue exv = f(IterationSpace{}); 3239 if (fir::getBase(exv).getType().template isa<fir::BoxType>()) 3240 return exv; 3241 fir::emitFatalError(getLoc(), "array must be emboxed"); 3242 }, 3243 exp.u); 3244 } 3245 3246 /// Entry point into lowering an expression with rank. This entry point is for 3247 /// lowering a rhs expression, for example. (RefTransparent semantics.) 3248 static ExtValue 3249 lowerNewArrayExpression(Fortran::lower::AbstractConverter &converter, 3250 Fortran::lower::SymMap &symMap, 3251 Fortran::lower::StatementContext &stmtCtx, 3252 const Fortran::lower::SomeExpr &expr) { 3253 ArrayExprLowering ael{converter, stmtCtx, symMap}; 3254 ael.determineShapeOfDest(expr); 3255 ExtValue loopRes = ael.lowerArrayExpression(expr); 3256 fir::ArrayLoadOp dest = ael.destination; 3257 mlir::Value tempRes = dest.getMemref(); 3258 fir::FirOpBuilder &builder = converter.getFirOpBuilder(); 3259 mlir::Location loc = converter.getCurrentLocation(); 3260 builder.create<fir::ArrayMergeStoreOp>(loc, dest, fir::getBase(loopRes), 3261 tempRes, dest.getSlice(), 3262 dest.getTypeparams()); 3263 3264 auto arrTy = 3265 fir::dyn_cast_ptrEleTy(tempRes.getType()).cast<fir::SequenceType>(); 3266 if (auto charTy = 3267 arrTy.getEleTy().template dyn_cast<fir::CharacterType>()) { 3268 if (fir::characterWithDynamicLen(charTy)) 3269 TODO(loc, "CHARACTER does not have constant LEN"); 3270 mlir::Value len = builder.createIntegerConstant( 3271 loc, builder.getCharacterLengthType(), charTy.getLen()); 3272 return fir::CharArrayBoxValue(tempRes, len, dest.getExtents()); 3273 } 3274 return fir::ArrayBoxValue(tempRes, dest.getExtents()); 3275 } 3276 3277 static void lowerLazyArrayExpression( 3278 Fortran::lower::AbstractConverter &converter, 3279 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx, 3280 const Fortran::lower::SomeExpr &expr, mlir::Value raggedHeader) { 3281 ArrayExprLowering ael(converter, stmtCtx, symMap); 3282 ael.lowerLazyArrayExpression(expr, raggedHeader); 3283 } 3284 3285 /// Lower the expression \p expr into a buffer that is created on demand. The 3286 /// variable containing the pointer to the buffer is \p var and the variable 3287 /// containing the shape of the buffer is \p shapeBuffer. 3288 void lowerLazyArrayExpression(const Fortran::lower::SomeExpr &expr, 3289 mlir::Value header) { 3290 mlir::Location loc = getLoc(); 3291 mlir::TupleType hdrTy = fir::factory::getRaggedArrayHeaderType(builder); 3292 mlir::IntegerType i32Ty = builder.getIntegerType(32); 3293 3294 // Once the loop extents have been computed, which may require being inside 3295 // some explicit loops, lazily allocate the expression on the heap. The 3296 // following continuation creates the buffer as needed. 3297 ccPrelude = [=](llvm::ArrayRef<mlir::Value> shape) { 3298 mlir::IntegerType i64Ty = builder.getIntegerType(64); 3299 mlir::Value byteSize = builder.createIntegerConstant(loc, i64Ty, 1); 3300 fir::runtime::genRaggedArrayAllocate( 3301 loc, builder, header, /*asHeaders=*/false, byteSize, shape); 3302 }; 3303 3304 // Create a dummy array_load before the loop. We're storing to a lazy 3305 // temporary, so there will be no conflict and no copy-in. TODO: skip this 3306 // as there isn't any necessity for it. 3307 ccLoadDest = [=](llvm::ArrayRef<mlir::Value> shape) -> fir::ArrayLoadOp { 3308 mlir::Value one = builder.createIntegerConstant(loc, i32Ty, 1); 3309 auto var = builder.create<fir::CoordinateOp>( 3310 loc, builder.getRefType(hdrTy.getType(1)), header, one); 3311 auto load = builder.create<fir::LoadOp>(loc, var); 3312 mlir::Type eleTy = 3313 fir::unwrapSequenceType(fir::unwrapRefType(load.getType())); 3314 auto seqTy = fir::SequenceType::get(eleTy, shape.size()); 3315 mlir::Value castTo = 3316 builder.createConvert(loc, fir::HeapType::get(seqTy), load); 3317 mlir::Value shapeOp = builder.genShape(loc, shape); 3318 return builder.create<fir::ArrayLoadOp>( 3319 loc, seqTy, castTo, shapeOp, /*slice=*/mlir::Value{}, llvm::None); 3320 }; 3321 // Custom lowering of the element store to deal with the extra indirection 3322 // to the lazy allocated buffer. 3323 ccStoreToDest = [=](IterSpace iters) { 3324 mlir::Value one = builder.createIntegerConstant(loc, i32Ty, 1); 3325 auto var = builder.create<fir::CoordinateOp>( 3326 loc, builder.getRefType(hdrTy.getType(1)), header, one); 3327 auto load = builder.create<fir::LoadOp>(loc, var); 3328 mlir::Type eleTy = 3329 fir::unwrapSequenceType(fir::unwrapRefType(load.getType())); 3330 auto seqTy = fir::SequenceType::get(eleTy, iters.iterVec().size()); 3331 auto toTy = fir::HeapType::get(seqTy); 3332 mlir::Value castTo = builder.createConvert(loc, toTy, load); 3333 mlir::Value shape = builder.genShape(loc, genIterationShape()); 3334 llvm::SmallVector<mlir::Value> indices = fir::factory::originateIndices( 3335 loc, builder, castTo.getType(), shape, iters.iterVec()); 3336 auto eleAddr = builder.create<fir::ArrayCoorOp>( 3337 loc, builder.getRefType(eleTy), castTo, shape, 3338 /*slice=*/mlir::Value{}, indices, destination.getTypeparams()); 3339 mlir::Value eleVal = 3340 builder.createConvert(loc, eleTy, iters.getElement()); 3341 builder.create<fir::StoreOp>(loc, eleVal, eleAddr); 3342 return iters.innerArgument(); 3343 }; 3344 3345 // Lower the array expression now. Clean-up any temps that may have 3346 // been generated when lowering `expr` right after the lowered value 3347 // was stored to the ragged array temporary. The local temps will not 3348 // be needed afterwards. 3349 stmtCtx.pushScope(); 3350 [[maybe_unused]] ExtValue loopRes = lowerArrayExpression(expr); 3351 stmtCtx.finalize(/*popScope=*/true); 3352 assert(fir::getBase(loopRes)); 3353 } 3354 3355 static void 3356 lowerElementalUserAssignment(Fortran::lower::AbstractConverter &converter, 3357 Fortran::lower::SymMap &symMap, 3358 Fortran::lower::StatementContext &stmtCtx, 3359 Fortran::lower::ExplicitIterSpace &explicitSpace, 3360 Fortran::lower::ImplicitIterSpace &implicitSpace, 3361 const Fortran::evaluate::ProcedureRef &procRef) { 3362 ArrayExprLowering ael(converter, stmtCtx, symMap, 3363 ConstituentSemantics::CustomCopyInCopyOut, 3364 &explicitSpace, &implicitSpace); 3365 assert(procRef.arguments().size() == 2); 3366 const auto *lhs = procRef.arguments()[0].value().UnwrapExpr(); 3367 const auto *rhs = procRef.arguments()[1].value().UnwrapExpr(); 3368 assert(lhs && rhs && 3369 "user defined assignment arguments must be expressions"); 3370 mlir::FuncOp func = 3371 Fortran::lower::CallerInterface(procRef, converter).getFuncOp(); 3372 ael.lowerElementalUserAssignment(func, *lhs, *rhs); 3373 } 3374 3375 void lowerElementalUserAssignment(mlir::FuncOp userAssignment, 3376 const Fortran::lower::SomeExpr &lhs, 3377 const Fortran::lower::SomeExpr &rhs) { 3378 mlir::Location loc = getLoc(); 3379 PushSemantics(ConstituentSemantics::CustomCopyInCopyOut); 3380 auto genArrayModify = genarr(lhs); 3381 ccStoreToDest = [=](IterSpace iters) -> ExtValue { 3382 auto modifiedArray = genArrayModify(iters); 3383 auto arrayModify = mlir::dyn_cast_or_null<fir::ArrayModifyOp>( 3384 fir::getBase(modifiedArray).getDefiningOp()); 3385 assert(arrayModify && "must be created by ArrayModifyOp"); 3386 fir::ExtendedValue lhs = 3387 arrayModifyToExv(builder, loc, destination, arrayModify.getResult(0)); 3388 genScalarUserDefinedAssignmentCall(builder, loc, userAssignment, lhs, 3389 iters.elementExv()); 3390 return modifiedArray; 3391 }; 3392 determineShapeOfDest(lhs); 3393 semant = ConstituentSemantics::RefTransparent; 3394 auto exv = lowerArrayExpression(rhs); 3395 if (explicitSpaceIsActive()) { 3396 explicitSpace->finalizeContext(); 3397 builder.create<fir::ResultOp>(loc, fir::getBase(exv)); 3398 } else { 3399 builder.create<fir::ArrayMergeStoreOp>( 3400 loc, destination, fir::getBase(exv), destination.getMemref(), 3401 destination.getSlice(), destination.getTypeparams()); 3402 } 3403 } 3404 3405 /// Lower an elemental subroutine call with at least one array argument. 3406 /// An elemental subroutine is an exception and does not have copy-in/copy-out 3407 /// semantics. See 15.8.3. 3408 /// Do NOT use this for user defined assignments. 3409 static void 3410 lowerElementalSubroutine(Fortran::lower::AbstractConverter &converter, 3411 Fortran::lower::SymMap &symMap, 3412 Fortran::lower::StatementContext &stmtCtx, 3413 const Fortran::lower::SomeExpr &call) { 3414 ArrayExprLowering ael(converter, stmtCtx, symMap, 3415 ConstituentSemantics::RefTransparent); 3416 ael.lowerElementalSubroutine(call); 3417 } 3418 3419 // TODO: See the comment in genarr(const Fortran::lower::Parentheses<T>&). 3420 // This is skipping generation of copy-in/copy-out code for analysis that is 3421 // required when arguments are in parentheses. 3422 void lowerElementalSubroutine(const Fortran::lower::SomeExpr &call) { 3423 auto f = genarr(call); 3424 llvm::SmallVector<mlir::Value> shape = genIterationShape(); 3425 auto [iterSpace, insPt] = genImplicitLoops(shape, /*innerArg=*/{}); 3426 f(iterSpace); 3427 finalizeElementCtx(); 3428 builder.restoreInsertionPoint(insPt); 3429 } 3430 3431 template <typename A, typename B> 3432 ExtValue lowerScalarAssignment(const A &lhs, const B &rhs) { 3433 // 1) Lower the rhs expression with array_fetch op(s). 3434 IterationSpace iters; 3435 iters.setElement(genarr(rhs)(iters)); 3436 fir::ExtendedValue elementalExv = iters.elementExv(); 3437 // 2) Lower the lhs expression to an array_update. 3438 semant = ConstituentSemantics::ProjectedCopyInCopyOut; 3439 auto lexv = genarr(lhs)(iters); 3440 // 3) Finalize the inner context. 3441 explicitSpace->finalizeContext(); 3442 // 4) Thread the array value updated forward. Note: the lhs might be 3443 // ill-formed (performing scalar assignment in an array context), 3444 // in which case there is no array to thread. 3445 auto createResult = [&](auto op) { 3446 mlir::Value oldInnerArg = op.getSequence(); 3447 std::size_t offset = explicitSpace->argPosition(oldInnerArg); 3448 explicitSpace->setInnerArg(offset, fir::getBase(lexv)); 3449 builder.create<fir::ResultOp>(getLoc(), fir::getBase(lexv)); 3450 }; 3451 if (auto updateOp = mlir::dyn_cast<fir::ArrayUpdateOp>( 3452 fir::getBase(lexv).getDefiningOp())) 3453 createResult(updateOp); 3454 else if (auto amend = mlir::dyn_cast<fir::ArrayAmendOp>( 3455 fir::getBase(lexv).getDefiningOp())) 3456 createResult(amend); 3457 else if (auto modifyOp = mlir::dyn_cast<fir::ArrayModifyOp>( 3458 fir::getBase(lexv).getDefiningOp())) 3459 createResult(modifyOp); 3460 return lexv; 3461 } 3462 3463 static ExtValue lowerScalarUserAssignment( 3464 Fortran::lower::AbstractConverter &converter, 3465 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx, 3466 Fortran::lower::ExplicitIterSpace &explicitIterSpace, 3467 mlir::FuncOp userAssignmentFunction, const Fortran::lower::SomeExpr &lhs, 3468 const Fortran::lower::SomeExpr &rhs) { 3469 Fortran::lower::ImplicitIterSpace implicit; 3470 ArrayExprLowering ael(converter, stmtCtx, symMap, 3471 ConstituentSemantics::RefTransparent, 3472 &explicitIterSpace, &implicit); 3473 return ael.lowerScalarUserAssignment(userAssignmentFunction, lhs, rhs); 3474 } 3475 3476 ExtValue lowerScalarUserAssignment(mlir::FuncOp userAssignment, 3477 const Fortran::lower::SomeExpr &lhs, 3478 const Fortran::lower::SomeExpr &rhs) { 3479 mlir::Location loc = getLoc(); 3480 if (rhs.Rank() > 0) 3481 TODO(loc, "user-defined elemental assigment from expression with rank"); 3482 // 1) Lower the rhs expression with array_fetch op(s). 3483 IterationSpace iters; 3484 iters.setElement(genarr(rhs)(iters)); 3485 fir::ExtendedValue elementalExv = iters.elementExv(); 3486 // 2) Lower the lhs expression to an array_modify. 3487 semant = ConstituentSemantics::CustomCopyInCopyOut; 3488 auto lexv = genarr(lhs)(iters); 3489 bool isIllFormedLHS = false; 3490 // 3) Insert the call 3491 if (auto modifyOp = mlir::dyn_cast<fir::ArrayModifyOp>( 3492 fir::getBase(lexv).getDefiningOp())) { 3493 mlir::Value oldInnerArg = modifyOp.getSequence(); 3494 std::size_t offset = explicitSpace->argPosition(oldInnerArg); 3495 explicitSpace->setInnerArg(offset, fir::getBase(lexv)); 3496 fir::ExtendedValue exv = arrayModifyToExv( 3497 builder, loc, explicitSpace->getLhsLoad(0).getValue(), 3498 modifyOp.getResult(0)); 3499 genScalarUserDefinedAssignmentCall(builder, loc, userAssignment, exv, 3500 elementalExv); 3501 } else { 3502 // LHS is ill formed, it is a scalar with no references to FORALL 3503 // subscripts, so there is actually no array assignment here. The user 3504 // code is probably bad, but still insert user assignment call since it 3505 // was not rejected by semantics (a warning was emitted). 3506 isIllFormedLHS = true; 3507 genScalarUserDefinedAssignmentCall(builder, getLoc(), userAssignment, 3508 lexv, elementalExv); 3509 } 3510 // 4) Finalize the inner context. 3511 explicitSpace->finalizeContext(); 3512 // 5). Thread the array value updated forward. 3513 if (!isIllFormedLHS) 3514 builder.create<fir::ResultOp>(getLoc(), fir::getBase(lexv)); 3515 return lexv; 3516 } 3517 3518 bool explicitSpaceIsActive() const { 3519 return explicitSpace && explicitSpace->isActive(); 3520 } 3521 3522 bool implicitSpaceHasMasks() const { 3523 return implicitSpace && !implicitSpace->empty(); 3524 } 3525 3526 CC genMaskAccess(mlir::Value tmp, mlir::Value shape) { 3527 mlir::Location loc = getLoc(); 3528 return [=, builder = &converter.getFirOpBuilder()](IterSpace iters) { 3529 mlir::Type arrTy = fir::dyn_cast_ptrOrBoxEleTy(tmp.getType()); 3530 auto eleTy = arrTy.cast<fir::SequenceType>().getEleTy(); 3531 mlir::Type eleRefTy = builder->getRefType(eleTy); 3532 mlir::IntegerType i1Ty = builder->getI1Type(); 3533 // Adjust indices for any shift of the origin of the array. 3534 llvm::SmallVector<mlir::Value> indices = fir::factory::originateIndices( 3535 loc, *builder, tmp.getType(), shape, iters.iterVec()); 3536 auto addr = builder->create<fir::ArrayCoorOp>( 3537 loc, eleRefTy, tmp, shape, /*slice=*/mlir::Value{}, indices, 3538 /*typeParams=*/llvm::None); 3539 auto load = builder->create<fir::LoadOp>(loc, addr); 3540 return builder->createConvert(loc, i1Ty, load); 3541 }; 3542 } 3543 3544 /// Construct the incremental instantiations of the ragged array structure. 3545 /// Rebind the lazy buffer variable, etc. as we go. 3546 template <bool withAllocation = false> 3547 mlir::Value prepareRaggedArrays(Fortran::lower::FrontEndExpr expr) { 3548 assert(explicitSpaceIsActive()); 3549 mlir::Location loc = getLoc(); 3550 mlir::TupleType raggedTy = fir::factory::getRaggedArrayHeaderType(builder); 3551 llvm::SmallVector<llvm::SmallVector<fir::DoLoopOp>> loopStack = 3552 explicitSpace->getLoopStack(); 3553 const std::size_t depth = loopStack.size(); 3554 mlir::IntegerType i64Ty = builder.getIntegerType(64); 3555 [[maybe_unused]] mlir::Value byteSize = 3556 builder.createIntegerConstant(loc, i64Ty, 1); 3557 mlir::Value header = implicitSpace->lookupMaskHeader(expr); 3558 for (std::remove_const_t<decltype(depth)> i = 0; i < depth; ++i) { 3559 auto insPt = builder.saveInsertionPoint(); 3560 if (i < depth - 1) 3561 builder.setInsertionPoint(loopStack[i + 1][0]); 3562 3563 // Compute and gather the extents. 3564 llvm::SmallVector<mlir::Value> extents; 3565 for (auto doLoop : loopStack[i]) 3566 extents.push_back(builder.genExtentFromTriplet( 3567 loc, doLoop.getLowerBound(), doLoop.getUpperBound(), 3568 doLoop.getStep(), i64Ty)); 3569 if constexpr (withAllocation) { 3570 fir::runtime::genRaggedArrayAllocate( 3571 loc, builder, header, /*asHeader=*/true, byteSize, extents); 3572 } 3573 3574 // Compute the dynamic position into the header. 3575 llvm::SmallVector<mlir::Value> offsets; 3576 for (auto doLoop : loopStack[i]) { 3577 auto m = builder.create<mlir::arith::SubIOp>( 3578 loc, doLoop.getInductionVar(), doLoop.getLowerBound()); 3579 auto n = builder.create<mlir::arith::DivSIOp>(loc, m, doLoop.getStep()); 3580 mlir::Value one = builder.createIntegerConstant(loc, n.getType(), 1); 3581 offsets.push_back(builder.create<mlir::arith::AddIOp>(loc, n, one)); 3582 } 3583 mlir::IntegerType i32Ty = builder.getIntegerType(32); 3584 mlir::Value uno = builder.createIntegerConstant(loc, i32Ty, 1); 3585 mlir::Type coorTy = builder.getRefType(raggedTy.getType(1)); 3586 auto hdOff = builder.create<fir::CoordinateOp>(loc, coorTy, header, uno); 3587 auto toTy = fir::SequenceType::get(raggedTy, offsets.size()); 3588 mlir::Type toRefTy = builder.getRefType(toTy); 3589 auto ldHdr = builder.create<fir::LoadOp>(loc, hdOff); 3590 mlir::Value hdArr = builder.createConvert(loc, toRefTy, ldHdr); 3591 auto shapeOp = builder.genShape(loc, extents); 3592 header = builder.create<fir::ArrayCoorOp>( 3593 loc, builder.getRefType(raggedTy), hdArr, shapeOp, 3594 /*slice=*/mlir::Value{}, offsets, 3595 /*typeparams=*/mlir::ValueRange{}); 3596 auto hdrVar = builder.create<fir::CoordinateOp>(loc, coorTy, header, uno); 3597 auto inVar = builder.create<fir::LoadOp>(loc, hdrVar); 3598 mlir::Value two = builder.createIntegerConstant(loc, i32Ty, 2); 3599 mlir::Type coorTy2 = builder.getRefType(raggedTy.getType(2)); 3600 auto hdrSh = builder.create<fir::CoordinateOp>(loc, coorTy2, header, two); 3601 auto shapePtr = builder.create<fir::LoadOp>(loc, hdrSh); 3602 // Replace the binding. 3603 implicitSpace->rebind(expr, genMaskAccess(inVar, shapePtr)); 3604 if (i < depth - 1) 3605 builder.restoreInsertionPoint(insPt); 3606 } 3607 return header; 3608 } 3609 3610 /// Lower mask expressions with implied iteration spaces from the variants of 3611 /// WHERE syntax. Since it is legal for mask expressions to have side-effects 3612 /// and modify values that will be used for the lhs, rhs, or both of 3613 /// subsequent assignments, the mask must be evaluated before the assignment 3614 /// is processed. 3615 /// Mask expressions are array expressions too. 3616 void genMasks() { 3617 // Lower the mask expressions, if any. 3618 if (implicitSpaceHasMasks()) { 3619 mlir::Location loc = getLoc(); 3620 // Mask expressions are array expressions too. 3621 for (const auto *e : implicitSpace->getExprs()) 3622 if (e && !implicitSpace->isLowered(e)) { 3623 if (mlir::Value var = implicitSpace->lookupMaskVariable(e)) { 3624 // Allocate the mask buffer lazily. 3625 assert(explicitSpaceIsActive()); 3626 mlir::Value header = 3627 prepareRaggedArrays</*withAllocations=*/true>(e); 3628 Fortran::lower::createLazyArrayTempValue(converter, *e, header, 3629 symMap, stmtCtx); 3630 // Close the explicit loops. 3631 builder.create<fir::ResultOp>(loc, explicitSpace->getInnerArgs()); 3632 builder.setInsertionPointAfter(explicitSpace->getOuterLoop()); 3633 // Open a new copy of the explicit loop nest. 3634 explicitSpace->genLoopNest(); 3635 continue; 3636 } 3637 fir::ExtendedValue tmp = Fortran::lower::createSomeArrayTempValue( 3638 converter, *e, symMap, stmtCtx); 3639 mlir::Value shape = builder.createShape(loc, tmp); 3640 implicitSpace->bind(e, genMaskAccess(fir::getBase(tmp), shape)); 3641 } 3642 3643 // Set buffer from the header. 3644 for (const auto *e : implicitSpace->getExprs()) { 3645 if (!e) 3646 continue; 3647 if (implicitSpace->lookupMaskVariable(e)) { 3648 // Index into the ragged buffer to retrieve cached results. 3649 const int rank = e->Rank(); 3650 assert(destShape.empty() || 3651 static_cast<std::size_t>(rank) == destShape.size()); 3652 mlir::Value header = prepareRaggedArrays(e); 3653 mlir::TupleType raggedTy = 3654 fir::factory::getRaggedArrayHeaderType(builder); 3655 mlir::IntegerType i32Ty = builder.getIntegerType(32); 3656 mlir::Value one = builder.createIntegerConstant(loc, i32Ty, 1); 3657 auto coor1 = builder.create<fir::CoordinateOp>( 3658 loc, builder.getRefType(raggedTy.getType(1)), header, one); 3659 auto db = builder.create<fir::LoadOp>(loc, coor1); 3660 mlir::Type eleTy = 3661 fir::unwrapSequenceType(fir::unwrapRefType(db.getType())); 3662 mlir::Type buffTy = 3663 builder.getRefType(fir::SequenceType::get(eleTy, rank)); 3664 // Address of ragged buffer data. 3665 mlir::Value buff = builder.createConvert(loc, buffTy, db); 3666 3667 mlir::Value two = builder.createIntegerConstant(loc, i32Ty, 2); 3668 auto coor2 = builder.create<fir::CoordinateOp>( 3669 loc, builder.getRefType(raggedTy.getType(2)), header, two); 3670 auto shBuff = builder.create<fir::LoadOp>(loc, coor2); 3671 mlir::IntegerType i64Ty = builder.getIntegerType(64); 3672 mlir::IndexType idxTy = builder.getIndexType(); 3673 llvm::SmallVector<mlir::Value> extents; 3674 for (std::remove_const_t<decltype(rank)> i = 0; i < rank; ++i) { 3675 mlir::Value off = builder.createIntegerConstant(loc, i32Ty, i); 3676 auto coor = builder.create<fir::CoordinateOp>( 3677 loc, builder.getRefType(i64Ty), shBuff, off); 3678 auto ldExt = builder.create<fir::LoadOp>(loc, coor); 3679 extents.push_back(builder.createConvert(loc, idxTy, ldExt)); 3680 } 3681 if (destShape.empty()) 3682 destShape = extents; 3683 // Construct shape of buffer. 3684 mlir::Value shapeOp = builder.genShape(loc, extents); 3685 3686 // Replace binding with the local result. 3687 implicitSpace->rebind(e, genMaskAccess(buff, shapeOp)); 3688 } 3689 } 3690 } 3691 } 3692 3693 // FIXME: should take multiple inner arguments. 3694 std::pair<IterationSpace, mlir::OpBuilder::InsertPoint> 3695 genImplicitLoops(mlir::ValueRange shape, mlir::Value innerArg) { 3696 mlir::Location loc = getLoc(); 3697 mlir::IndexType idxTy = builder.getIndexType(); 3698 mlir::Value one = builder.createIntegerConstant(loc, idxTy, 1); 3699 mlir::Value zero = builder.createIntegerConstant(loc, idxTy, 0); 3700 llvm::SmallVector<mlir::Value> loopUppers; 3701 3702 // Convert any implied shape to closed interval form. The fir.do_loop will 3703 // run from 0 to `extent - 1` inclusive. 3704 for (auto extent : shape) 3705 loopUppers.push_back( 3706 builder.create<mlir::arith::SubIOp>(loc, extent, one)); 3707 3708 // Iteration space is created with outermost columns, innermost rows 3709 llvm::SmallVector<fir::DoLoopOp> loops; 3710 3711 const std::size_t loopDepth = loopUppers.size(); 3712 llvm::SmallVector<mlir::Value> ivars; 3713 3714 for (auto i : llvm::enumerate(llvm::reverse(loopUppers))) { 3715 if (i.index() > 0) { 3716 assert(!loops.empty()); 3717 builder.setInsertionPointToStart(loops.back().getBody()); 3718 } 3719 fir::DoLoopOp loop; 3720 if (innerArg) { 3721 loop = builder.create<fir::DoLoopOp>( 3722 loc, zero, i.value(), one, isUnordered(), 3723 /*finalCount=*/false, mlir::ValueRange{innerArg}); 3724 innerArg = loop.getRegionIterArgs().front(); 3725 if (explicitSpaceIsActive()) 3726 explicitSpace->setInnerArg(0, innerArg); 3727 } else { 3728 loop = builder.create<fir::DoLoopOp>(loc, zero, i.value(), one, 3729 isUnordered(), 3730 /*finalCount=*/false); 3731 } 3732 ivars.push_back(loop.getInductionVar()); 3733 loops.push_back(loop); 3734 } 3735 3736 if (innerArg) 3737 for (std::remove_const_t<decltype(loopDepth)> i = 0; i + 1 < loopDepth; 3738 ++i) { 3739 builder.setInsertionPointToEnd(loops[i].getBody()); 3740 builder.create<fir::ResultOp>(loc, loops[i + 1].getResult(0)); 3741 } 3742 3743 // Move insertion point to the start of the innermost loop in the nest. 3744 builder.setInsertionPointToStart(loops.back().getBody()); 3745 // Set `afterLoopNest` to just after the entire loop nest. 3746 auto currPt = builder.saveInsertionPoint(); 3747 builder.setInsertionPointAfter(loops[0]); 3748 auto afterLoopNest = builder.saveInsertionPoint(); 3749 builder.restoreInsertionPoint(currPt); 3750 3751 // Put the implicit loop variables in row to column order to match FIR's 3752 // Ops. (The loops were constructed from outermost column to innermost 3753 // row.) 3754 mlir::Value outerRes = loops[0].getResult(0); 3755 return {IterationSpace(innerArg, outerRes, llvm::reverse(ivars)), 3756 afterLoopNest}; 3757 } 3758 3759 /// Build the iteration space into which the array expression will be 3760 /// lowered. The resultType is used to create a temporary, if needed. 3761 std::pair<IterationSpace, mlir::OpBuilder::InsertPoint> 3762 genIterSpace(mlir::Type resultType) { 3763 mlir::Location loc = getLoc(); 3764 llvm::SmallVector<mlir::Value> shape = genIterationShape(); 3765 if (!destination) { 3766 // Allocate storage for the result if it is not already provided. 3767 destination = createAndLoadSomeArrayTemp(resultType, shape); 3768 } 3769 3770 // Generate the lazy mask allocation, if one was given. 3771 if (ccPrelude.hasValue()) 3772 ccPrelude.getValue()(shape); 3773 3774 // Now handle the implicit loops. 3775 mlir::Value inner = explicitSpaceIsActive() 3776 ? explicitSpace->getInnerArgs().front() 3777 : destination.getResult(); 3778 auto [iters, afterLoopNest] = genImplicitLoops(shape, inner); 3779 mlir::Value innerArg = iters.innerArgument(); 3780 3781 // Generate the mask conditional structure, if there are masks. Unlike the 3782 // explicit masks, which are interleaved, these mask expression appear in 3783 // the innermost loop. 3784 if (implicitSpaceHasMasks()) { 3785 // Recover the cached condition from the mask buffer. 3786 auto genCond = [&](Fortran::lower::FrontEndExpr e, IterSpace iters) { 3787 return implicitSpace->getBoundClosure(e)(iters); 3788 }; 3789 3790 // Handle the negated conditions in topological order of the WHERE 3791 // clauses. See 10.2.3.2p4 as to why this control structure is produced. 3792 for (llvm::SmallVector<Fortran::lower::FrontEndExpr> maskExprs : 3793 implicitSpace->getMasks()) { 3794 const std::size_t size = maskExprs.size() - 1; 3795 auto genFalseBlock = [&](const auto *e, auto &&cond) { 3796 auto ifOp = builder.create<fir::IfOp>( 3797 loc, mlir::TypeRange{innerArg.getType()}, fir::getBase(cond), 3798 /*withElseRegion=*/true); 3799 builder.create<fir::ResultOp>(loc, ifOp.getResult(0)); 3800 builder.setInsertionPointToStart(&ifOp.getThenRegion().front()); 3801 builder.create<fir::ResultOp>(loc, innerArg); 3802 builder.setInsertionPointToStart(&ifOp.getElseRegion().front()); 3803 }; 3804 auto genTrueBlock = [&](const auto *e, auto &&cond) { 3805 auto ifOp = builder.create<fir::IfOp>( 3806 loc, mlir::TypeRange{innerArg.getType()}, fir::getBase(cond), 3807 /*withElseRegion=*/true); 3808 builder.create<fir::ResultOp>(loc, ifOp.getResult(0)); 3809 builder.setInsertionPointToStart(&ifOp.getElseRegion().front()); 3810 builder.create<fir::ResultOp>(loc, innerArg); 3811 builder.setInsertionPointToStart(&ifOp.getThenRegion().front()); 3812 }; 3813 for (std::size_t i = 0; i < size; ++i) 3814 if (const auto *e = maskExprs[i]) 3815 genFalseBlock(e, genCond(e, iters)); 3816 3817 // The last condition is either non-negated or unconditionally negated. 3818 if (const auto *e = maskExprs[size]) 3819 genTrueBlock(e, genCond(e, iters)); 3820 } 3821 } 3822 3823 // We're ready to lower the body (an assignment statement) for this context 3824 // of loop nests at this point. 3825 return {iters, afterLoopNest}; 3826 } 3827 3828 fir::ArrayLoadOp 3829 createAndLoadSomeArrayTemp(mlir::Type type, 3830 llvm::ArrayRef<mlir::Value> shape) { 3831 if (ccLoadDest.hasValue()) 3832 return ccLoadDest.getValue()(shape); 3833 auto seqTy = type.dyn_cast<fir::SequenceType>(); 3834 assert(seqTy && "must be an array"); 3835 mlir::Location loc = getLoc(); 3836 // TODO: Need to thread the length parameters here. For character, they may 3837 // differ from the operands length (e.g concatenation). So the array loads 3838 // type parameters are not enough. 3839 if (auto charTy = seqTy.getEleTy().dyn_cast<fir::CharacterType>()) 3840 if (charTy.hasDynamicLen()) 3841 TODO(loc, "character array expression temp with dynamic length"); 3842 if (auto recTy = seqTy.getEleTy().dyn_cast<fir::RecordType>()) 3843 if (recTy.getNumLenParams() > 0) 3844 TODO(loc, "derived type array expression temp with length parameters"); 3845 mlir::Value temp = seqTy.hasConstantShape() 3846 ? builder.create<fir::AllocMemOp>(loc, type) 3847 : builder.create<fir::AllocMemOp>( 3848 loc, type, ".array.expr", llvm::None, shape); 3849 fir::FirOpBuilder *bldr = &converter.getFirOpBuilder(); 3850 stmtCtx.attachCleanup( 3851 [bldr, loc, temp]() { bldr->create<fir::FreeMemOp>(loc, temp); }); 3852 mlir::Value shapeOp = genShapeOp(shape); 3853 return builder.create<fir::ArrayLoadOp>(loc, seqTy, temp, shapeOp, 3854 /*slice=*/mlir::Value{}, 3855 llvm::None); 3856 } 3857 3858 static fir::ShapeOp genShapeOp(mlir::Location loc, fir::FirOpBuilder &builder, 3859 llvm::ArrayRef<mlir::Value> shape) { 3860 mlir::IndexType idxTy = builder.getIndexType(); 3861 llvm::SmallVector<mlir::Value> idxShape; 3862 for (auto s : shape) 3863 idxShape.push_back(builder.createConvert(loc, idxTy, s)); 3864 auto shapeTy = fir::ShapeType::get(builder.getContext(), idxShape.size()); 3865 return builder.create<fir::ShapeOp>(loc, shapeTy, idxShape); 3866 } 3867 3868 fir::ShapeOp genShapeOp(llvm::ArrayRef<mlir::Value> shape) { 3869 return genShapeOp(getLoc(), builder, shape); 3870 } 3871 3872 //===--------------------------------------------------------------------===// 3873 // Expression traversal and lowering. 3874 //===--------------------------------------------------------------------===// 3875 3876 /// Lower the expression, \p x, in a scalar context. 3877 template <typename A> 3878 ExtValue asScalar(const A &x) { 3879 return ScalarExprLowering{getLoc(), converter, symMap, stmtCtx}.genval(x); 3880 } 3881 3882 /// Lower the expression, \p x, in a scalar context. If this is an explicit 3883 /// space, the expression may be scalar and refer to an array. We want to 3884 /// raise the array access to array operations in FIR to analyze potential 3885 /// conflicts even when the result is a scalar element. 3886 template <typename A> 3887 ExtValue asScalarArray(const A &x) { 3888 return explicitSpaceIsActive() ? genarr(x)(IterationSpace{}) : asScalar(x); 3889 } 3890 3891 /// Lower the expression in a scalar context to a memory reference. 3892 template <typename A> 3893 ExtValue asScalarRef(const A &x) { 3894 return ScalarExprLowering{getLoc(), converter, symMap, stmtCtx}.gen(x); 3895 } 3896 3897 /// Lower an expression without dereferencing any indirection that may be 3898 /// a nullptr (because this is an absent optional or unallocated/disassociated 3899 /// descriptor). The returned expression cannot be addressed directly, it is 3900 /// meant to inquire about its status before addressing the related entity. 3901 template <typename A> 3902 ExtValue asInquired(const A &x) { 3903 return ScalarExprLowering{getLoc(), converter, symMap, stmtCtx} 3904 .lowerIntrinsicArgumentAsInquired(x); 3905 } 3906 3907 // An expression with non-zero rank is an array expression. 3908 template <typename A> 3909 bool isArray(const A &x) const { 3910 return x.Rank() != 0; 3911 } 3912 3913 /// Some temporaries are allocated on an element-by-element basis during the 3914 /// array expression evaluation. Collect the cleanups here so the resources 3915 /// can be freed before the next loop iteration, avoiding memory leaks. etc. 3916 Fortran::lower::StatementContext &getElementCtx() { 3917 if (!elementCtx) { 3918 stmtCtx.pushScope(); 3919 elementCtx = true; 3920 } 3921 return stmtCtx; 3922 } 3923 3924 /// If there were temporaries created for this element evaluation, finalize 3925 /// and deallocate the resources now. This should be done just prior the the 3926 /// fir::ResultOp at the end of the innermost loop. 3927 void finalizeElementCtx() { 3928 if (elementCtx) { 3929 stmtCtx.finalize(/*popScope=*/true); 3930 elementCtx = false; 3931 } 3932 } 3933 3934 /// Lower an elemental function array argument. This ensures array 3935 /// sub-expressions that are not variables and must be passed by address 3936 /// are lowered by value and placed in memory. 3937 template <typename A> 3938 CC genElementalArgument(const A &x) { 3939 // Ensure the returned element is in memory if this is what was requested. 3940 if ((semant == ConstituentSemantics::RefOpaque || 3941 semant == ConstituentSemantics::DataAddr || 3942 semant == ConstituentSemantics::ByValueArg)) { 3943 if (!Fortran::evaluate::IsVariable(x)) { 3944 PushSemantics(ConstituentSemantics::DataValue); 3945 CC cc = genarr(x); 3946 mlir::Location loc = getLoc(); 3947 if (isParenthesizedVariable(x)) { 3948 // Parenthesised variables are lowered to a reference to the variable 3949 // storage. When passing it as an argument, a copy must be passed. 3950 return [=](IterSpace iters) -> ExtValue { 3951 return createInMemoryScalarCopy(builder, loc, cc(iters)); 3952 }; 3953 } 3954 mlir::Type storageType = 3955 fir::unwrapSequenceType(converter.genType(toEvExpr(x))); 3956 return [=](IterSpace iters) -> ExtValue { 3957 return placeScalarValueInMemory(builder, loc, cc(iters), storageType); 3958 }; 3959 } 3960 } 3961 return genarr(x); 3962 } 3963 3964 // A procedure reference to a Fortran elemental intrinsic procedure. 3965 CC genElementalIntrinsicProcRef( 3966 const Fortran::evaluate::ProcedureRef &procRef, 3967 llvm::Optional<mlir::Type> retTy, 3968 const Fortran::evaluate::SpecificIntrinsic &intrinsic) { 3969 llvm::SmallVector<CC> operands; 3970 llvm::StringRef name = intrinsic.name; 3971 const Fortran::lower::IntrinsicArgumentLoweringRules *argLowering = 3972 Fortran::lower::getIntrinsicArgumentLowering(name); 3973 mlir::Location loc = getLoc(); 3974 if (Fortran::lower::intrinsicRequiresCustomOptionalHandling( 3975 procRef, intrinsic, converter)) { 3976 using CcPairT = std::pair<CC, llvm::Optional<mlir::Value>>; 3977 llvm::SmallVector<CcPairT> operands; 3978 auto prepareOptionalArg = [&](const Fortran::lower::SomeExpr &expr) { 3979 if (expr.Rank() == 0) { 3980 ExtValue optionalArg = this->asInquired(expr); 3981 mlir::Value isPresent = 3982 genActualIsPresentTest(builder, loc, optionalArg); 3983 operands.emplace_back( 3984 [=](IterSpace iters) -> ExtValue { 3985 return genLoad(builder, loc, optionalArg); 3986 }, 3987 isPresent); 3988 } else { 3989 auto [cc, isPresent, _] = this->genOptionalArrayFetch(expr); 3990 operands.emplace_back(cc, isPresent); 3991 } 3992 }; 3993 auto prepareOtherArg = [&](const Fortran::lower::SomeExpr &expr) { 3994 PushSemantics(ConstituentSemantics::RefTransparent); 3995 operands.emplace_back(genElementalArgument(expr), llvm::None); 3996 }; 3997 Fortran::lower::prepareCustomIntrinsicArgument( 3998 procRef, intrinsic, retTy, prepareOptionalArg, prepareOtherArg, 3999 converter); 4000 4001 fir::FirOpBuilder *bldr = &converter.getFirOpBuilder(); 4002 llvm::StringRef name = intrinsic.name; 4003 return [=](IterSpace iters) -> ExtValue { 4004 auto getArgument = [&](std::size_t i) -> ExtValue { 4005 return operands[i].first(iters); 4006 }; 4007 auto isPresent = [&](std::size_t i) -> llvm::Optional<mlir::Value> { 4008 return operands[i].second; 4009 }; 4010 return Fortran::lower::lowerCustomIntrinsic( 4011 *bldr, loc, name, retTy, isPresent, getArgument, operands.size(), 4012 getElementCtx()); 4013 }; 4014 } 4015 /// Otherwise, pre-lower arguments and use intrinsic lowering utility. 4016 for (const auto &[arg, dummy] : 4017 llvm::zip(procRef.arguments(), 4018 intrinsic.characteristics.value().dummyArguments)) { 4019 const auto *expr = 4020 Fortran::evaluate::UnwrapExpr<Fortran::lower::SomeExpr>(arg); 4021 if (!expr) { 4022 // Absent optional. 4023 operands.emplace_back([=](IterSpace) { return mlir::Value{}; }); 4024 } else if (!argLowering) { 4025 // No argument lowering instruction, lower by value. 4026 PushSemantics(ConstituentSemantics::RefTransparent); 4027 operands.emplace_back(genElementalArgument(*expr)); 4028 } else { 4029 // Ad-hoc argument lowering handling. 4030 Fortran::lower::ArgLoweringRule argRules = 4031 Fortran::lower::lowerIntrinsicArgumentAs(getLoc(), *argLowering, 4032 dummy.name); 4033 if (argRules.handleDynamicOptional && 4034 Fortran::evaluate::MayBePassedAsAbsentOptional( 4035 *expr, converter.getFoldingContext())) { 4036 // Currently, there is not elemental intrinsic that requires lowering 4037 // a potentially absent argument to something else than a value (apart 4038 // from character MAX/MIN that are handled elsewhere.) 4039 if (argRules.lowerAs != Fortran::lower::LowerIntrinsicArgAs::Value) 4040 TODO(loc, "lowering non trivial optional elemental intrinsic array " 4041 "argument"); 4042 PushSemantics(ConstituentSemantics::RefTransparent); 4043 operands.emplace_back(genarrForwardOptionalArgumentToCall(*expr)); 4044 continue; 4045 } 4046 switch (argRules.lowerAs) { 4047 case Fortran::lower::LowerIntrinsicArgAs::Value: { 4048 PushSemantics(ConstituentSemantics::RefTransparent); 4049 operands.emplace_back(genElementalArgument(*expr)); 4050 } break; 4051 case Fortran::lower::LowerIntrinsicArgAs::Addr: { 4052 // Note: assume does not have Fortran VALUE attribute semantics. 4053 PushSemantics(ConstituentSemantics::RefOpaque); 4054 operands.emplace_back(genElementalArgument(*expr)); 4055 } break; 4056 case Fortran::lower::LowerIntrinsicArgAs::Box: { 4057 PushSemantics(ConstituentSemantics::RefOpaque); 4058 auto lambda = genElementalArgument(*expr); 4059 operands.emplace_back([=](IterSpace iters) { 4060 return builder.createBox(loc, lambda(iters)); 4061 }); 4062 } break; 4063 case Fortran::lower::LowerIntrinsicArgAs::Inquired: 4064 TODO(loc, "intrinsic function with inquired argument"); 4065 break; 4066 } 4067 } 4068 } 4069 4070 // Let the intrinsic library lower the intrinsic procedure call 4071 return [=](IterSpace iters) { 4072 llvm::SmallVector<ExtValue> args; 4073 for (const auto &cc : operands) 4074 args.push_back(cc(iters)); 4075 return Fortran::lower::genIntrinsicCall(builder, loc, name, retTy, args, 4076 getElementCtx()); 4077 }; 4078 } 4079 4080 /// Lower a procedure reference to a user-defined elemental procedure. 4081 CC genElementalUserDefinedProcRef( 4082 const Fortran::evaluate::ProcedureRef &procRef, 4083 llvm::Optional<mlir::Type> retTy) { 4084 using PassBy = Fortran::lower::CallerInterface::PassEntityBy; 4085 4086 // 10.1.4 p5. Impure elemental procedures must be called in element order. 4087 if (const Fortran::semantics::Symbol *procSym = procRef.proc().GetSymbol()) 4088 if (!Fortran::semantics::IsPureProcedure(*procSym)) 4089 setUnordered(false); 4090 4091 Fortran::lower::CallerInterface caller(procRef, converter); 4092 llvm::SmallVector<CC> operands; 4093 operands.reserve(caller.getPassedArguments().size()); 4094 mlir::Location loc = getLoc(); 4095 mlir::FunctionType callSiteType = caller.genFunctionType(); 4096 for (const Fortran::lower::CallInterface< 4097 Fortran::lower::CallerInterface>::PassedEntity &arg : 4098 caller.getPassedArguments()) { 4099 // 15.8.3 p1. Elemental procedure with intent(out)/intent(inout) 4100 // arguments must be called in element order. 4101 if (arg.mayBeModifiedByCall()) 4102 setUnordered(false); 4103 const auto *actual = arg.entity; 4104 mlir::Type argTy = callSiteType.getInput(arg.firArgument); 4105 if (!actual) { 4106 // Optional dummy argument for which there is no actual argument. 4107 auto absent = builder.create<fir::AbsentOp>(loc, argTy); 4108 operands.emplace_back([=](IterSpace) { return absent; }); 4109 continue; 4110 } 4111 const auto *expr = actual->UnwrapExpr(); 4112 if (!expr) 4113 TODO(loc, "assumed type actual argument lowering"); 4114 4115 LLVM_DEBUG(expr->AsFortran(llvm::dbgs() 4116 << "argument: " << arg.firArgument << " = [") 4117 << "]\n"); 4118 if (arg.isOptional() && Fortran::evaluate::MayBePassedAsAbsentOptional( 4119 *expr, converter.getFoldingContext())) 4120 TODO(loc, 4121 "passing dynamically optional argument to elemental procedures"); 4122 switch (arg.passBy) { 4123 case PassBy::Value: { 4124 // True pass-by-value semantics. 4125 PushSemantics(ConstituentSemantics::RefTransparent); 4126 operands.emplace_back(genElementalArgument(*expr)); 4127 } break; 4128 case PassBy::BaseAddressValueAttribute: { 4129 // VALUE attribute or pass-by-reference to a copy semantics. (byval*) 4130 if (isArray(*expr)) { 4131 PushSemantics(ConstituentSemantics::ByValueArg); 4132 operands.emplace_back(genElementalArgument(*expr)); 4133 } else { 4134 // Store scalar value in a temp to fulfill VALUE attribute. 4135 mlir::Value val = fir::getBase(asScalar(*expr)); 4136 mlir::Value temp = builder.createTemporary( 4137 loc, val.getType(), 4138 llvm::ArrayRef<mlir::NamedAttribute>{ 4139 Fortran::lower::getAdaptToByRefAttr(builder)}); 4140 builder.create<fir::StoreOp>(loc, val, temp); 4141 operands.emplace_back( 4142 [=](IterSpace iters) -> ExtValue { return temp; }); 4143 } 4144 } break; 4145 case PassBy::BaseAddress: { 4146 if (isArray(*expr)) { 4147 PushSemantics(ConstituentSemantics::RefOpaque); 4148 operands.emplace_back(genElementalArgument(*expr)); 4149 } else { 4150 ExtValue exv = asScalarRef(*expr); 4151 operands.emplace_back([=](IterSpace iters) { return exv; }); 4152 } 4153 } break; 4154 case PassBy::CharBoxValueAttribute: { 4155 if (isArray(*expr)) { 4156 PushSemantics(ConstituentSemantics::DataValue); 4157 auto lambda = genElementalArgument(*expr); 4158 operands.emplace_back([=](IterSpace iters) { 4159 return fir::factory::CharacterExprHelper{builder, loc} 4160 .createTempFrom(lambda(iters)); 4161 }); 4162 } else { 4163 fir::factory::CharacterExprHelper helper(builder, loc); 4164 fir::CharBoxValue argVal = helper.createTempFrom(asScalarRef(*expr)); 4165 operands.emplace_back( 4166 [=](IterSpace iters) -> ExtValue { return argVal; }); 4167 } 4168 } break; 4169 case PassBy::BoxChar: { 4170 PushSemantics(ConstituentSemantics::RefOpaque); 4171 operands.emplace_back(genElementalArgument(*expr)); 4172 } break; 4173 case PassBy::AddressAndLength: 4174 // PassBy::AddressAndLength is only used for character results. Results 4175 // are not handled here. 4176 fir::emitFatalError( 4177 loc, "unexpected PassBy::AddressAndLength in elemental call"); 4178 break; 4179 case PassBy::CharProcTuple: { 4180 ExtValue argRef = asScalarRef(*expr); 4181 mlir::Value tuple = createBoxProcCharTuple( 4182 converter, argTy, fir::getBase(argRef), fir::getLen(argRef)); 4183 operands.emplace_back( 4184 [=](IterSpace iters) -> ExtValue { return tuple; }); 4185 } break; 4186 case PassBy::Box: 4187 case PassBy::MutableBox: 4188 // See C15100 and C15101 4189 fir::emitFatalError(loc, "cannot be POINTER, ALLOCATABLE"); 4190 } 4191 } 4192 4193 if (caller.getIfIndirectCallSymbol()) 4194 fir::emitFatalError(loc, "cannot be indirect call"); 4195 4196 // The lambda is mutable so that `caller` copy can be modified inside it. 4197 return 4198 [=, caller = std::move(caller)](IterSpace iters) mutable -> ExtValue { 4199 for (const auto &[cc, argIface] : 4200 llvm::zip(operands, caller.getPassedArguments())) { 4201 auto exv = cc(iters); 4202 auto arg = exv.match( 4203 [&](const fir::CharBoxValue &cb) -> mlir::Value { 4204 return fir::factory::CharacterExprHelper{builder, loc} 4205 .createEmbox(cb); 4206 }, 4207 [&](const auto &) { return fir::getBase(exv); }); 4208 caller.placeInput(argIface, arg); 4209 } 4210 return ScalarExprLowering{loc, converter, symMap, getElementCtx()} 4211 .genCallOpAndResult(caller, callSiteType, retTy); 4212 }; 4213 } 4214 4215 /// Generate a procedure reference. This code is shared for both functions and 4216 /// subroutines, the difference being reflected by `retTy`. 4217 CC genProcRef(const Fortran::evaluate::ProcedureRef &procRef, 4218 llvm::Optional<mlir::Type> retTy) { 4219 mlir::Location loc = getLoc(); 4220 if (procRef.IsElemental()) { 4221 if (const Fortran::evaluate::SpecificIntrinsic *intrin = 4222 procRef.proc().GetSpecificIntrinsic()) { 4223 // All elemental intrinsic functions are pure and cannot modify their 4224 // arguments. The only elemental subroutine, MVBITS has an Intent(inout) 4225 // argument. So for this last one, loops must be in element order 4226 // according to 15.8.3 p1. 4227 if (!retTy) 4228 setUnordered(false); 4229 4230 // Elemental intrinsic call. 4231 // The intrinsic procedure is called once per element of the array. 4232 return genElementalIntrinsicProcRef(procRef, retTy, *intrin); 4233 } 4234 if (ScalarExprLowering::isStatementFunctionCall(procRef)) 4235 fir::emitFatalError(loc, "statement function cannot be elemental"); 4236 4237 // Elemental call. 4238 // The procedure is called once per element of the array argument(s). 4239 return genElementalUserDefinedProcRef(procRef, retTy); 4240 } 4241 4242 // Transformational call. 4243 // The procedure is called once and produces a value of rank > 0. 4244 if (const Fortran::evaluate::SpecificIntrinsic *intrinsic = 4245 procRef.proc().GetSpecificIntrinsic()) { 4246 if (explicitSpaceIsActive() && procRef.Rank() == 0) { 4247 // Elide any implicit loop iters. 4248 return [=, &procRef](IterSpace) { 4249 return ScalarExprLowering{loc, converter, symMap, stmtCtx} 4250 .genIntrinsicRef(procRef, *intrinsic, retTy); 4251 }; 4252 } 4253 return genarr( 4254 ScalarExprLowering{loc, converter, symMap, stmtCtx}.genIntrinsicRef( 4255 procRef, *intrinsic, retTy)); 4256 } 4257 4258 if (explicitSpaceIsActive() && procRef.Rank() == 0) { 4259 // Elide any implicit loop iters. 4260 return [=, &procRef](IterSpace) { 4261 return ScalarExprLowering{loc, converter, symMap, stmtCtx} 4262 .genProcedureRef(procRef, retTy); 4263 }; 4264 } 4265 // In the default case, the call can be hoisted out of the loop nest. Apply 4266 // the iterations to the result, which may be an array value. 4267 return genarr( 4268 ScalarExprLowering{loc, converter, symMap, stmtCtx}.genProcedureRef( 4269 procRef, retTy)); 4270 } 4271 4272 template <typename A> 4273 CC genScalarAndForwardValue(const A &x) { 4274 ExtValue result = asScalar(x); 4275 return [=](IterSpace) { return result; }; 4276 } 4277 4278 template <typename A, typename = std::enable_if_t<Fortran::common::HasMember< 4279 A, Fortran::evaluate::TypelessExpression>>> 4280 CC genarr(const A &x) { 4281 return genScalarAndForwardValue(x); 4282 } 4283 4284 template <typename A> 4285 CC genarr(const Fortran::evaluate::Expr<A> &x) { 4286 LLVM_DEBUG(Fortran::lower::DumpEvaluateExpr::dump(llvm::dbgs(), x)); 4287 if (isArray(x) || explicitSpaceIsActive() || 4288 isElementalProcWithArrayArgs(x)) 4289 return std::visit([&](const auto &e) { return genarr(e); }, x.u); 4290 return genScalarAndForwardValue(x); 4291 } 4292 4293 // Converting a value of memory bound type requires creating a temp and 4294 // copying the value. 4295 static ExtValue convertAdjustedType(fir::FirOpBuilder &builder, 4296 mlir::Location loc, mlir::Type toType, 4297 const ExtValue &exv) { 4298 return exv.match( 4299 [&](const fir::CharBoxValue &cb) -> ExtValue { 4300 mlir::Value len = cb.getLen(); 4301 auto mem = 4302 builder.create<fir::AllocaOp>(loc, toType, mlir::ValueRange{len}); 4303 fir::CharBoxValue result(mem, len); 4304 fir::factory::CharacterExprHelper{builder, loc}.createAssign( 4305 ExtValue{result}, exv); 4306 return result; 4307 }, 4308 [&](const auto &) -> ExtValue { 4309 fir::emitFatalError(loc, "convert on adjusted extended value"); 4310 }); 4311 } 4312 template <Fortran::common::TypeCategory TC1, int KIND, 4313 Fortran::common::TypeCategory TC2> 4314 CC genarr(const Fortran::evaluate::Convert<Fortran::evaluate::Type<TC1, KIND>, 4315 TC2> &x) { 4316 mlir::Location loc = getLoc(); 4317 auto lambda = genarr(x.left()); 4318 mlir::Type ty = converter.genType(TC1, KIND); 4319 return [=](IterSpace iters) -> ExtValue { 4320 auto exv = lambda(iters); 4321 mlir::Value val = fir::getBase(exv); 4322 auto valTy = val.getType(); 4323 if (elementTypeWasAdjusted(valTy) && 4324 !(fir::isa_ref_type(valTy) && fir::isa_integer(ty))) 4325 return convertAdjustedType(builder, loc, ty, exv); 4326 return builder.createConvert(loc, ty, val); 4327 }; 4328 } 4329 4330 template <int KIND> 4331 CC genarr(const Fortran::evaluate::ComplexComponent<KIND> &x) { 4332 TODO(getLoc(), "ComplexComponent<KIND>"); 4333 } 4334 4335 template <typename T> 4336 CC genarr(const Fortran::evaluate::Parentheses<T> &x) { 4337 mlir::Location loc = getLoc(); 4338 if (isReferentiallyOpaque()) { 4339 // Context is a call argument in, for example, an elemental procedure 4340 // call. TODO: all array arguments should use array_load, array_access, 4341 // array_amend, and INTENT(OUT), INTENT(INOUT) arguments should have 4342 // array_merge_store ops. 4343 TODO(loc, "parentheses on argument in elemental call"); 4344 } 4345 auto f = genarr(x.left()); 4346 return [=](IterSpace iters) -> ExtValue { 4347 auto val = f(iters); 4348 mlir::Value base = fir::getBase(val); 4349 auto newBase = 4350 builder.create<fir::NoReassocOp>(loc, base.getType(), base); 4351 return fir::substBase(val, newBase); 4352 }; 4353 } 4354 template <int KIND> 4355 CC genarr(const Fortran::evaluate::Negate<Fortran::evaluate::Type< 4356 Fortran::common::TypeCategory::Integer, KIND>> &x) { 4357 mlir::Location loc = getLoc(); 4358 auto f = genarr(x.left()); 4359 return [=](IterSpace iters) -> ExtValue { 4360 mlir::Value val = fir::getBase(f(iters)); 4361 mlir::Type ty = 4362 converter.genType(Fortran::common::TypeCategory::Integer, KIND); 4363 mlir::Value zero = builder.createIntegerConstant(loc, ty, 0); 4364 return builder.create<mlir::arith::SubIOp>(loc, zero, val); 4365 }; 4366 } 4367 template <int KIND> 4368 CC genarr(const Fortran::evaluate::Negate<Fortran::evaluate::Type< 4369 Fortran::common::TypeCategory::Real, KIND>> &x) { 4370 mlir::Location loc = getLoc(); 4371 auto f = genarr(x.left()); 4372 return [=](IterSpace iters) -> ExtValue { 4373 return builder.create<mlir::arith::NegFOp>(loc, fir::getBase(f(iters))); 4374 }; 4375 } 4376 template <int KIND> 4377 CC genarr(const Fortran::evaluate::Negate<Fortran::evaluate::Type< 4378 Fortran::common::TypeCategory::Complex, KIND>> &x) { 4379 mlir::Location loc = getLoc(); 4380 auto f = genarr(x.left()); 4381 return [=](IterSpace iters) -> ExtValue { 4382 return builder.create<fir::NegcOp>(loc, fir::getBase(f(iters))); 4383 }; 4384 } 4385 4386 //===--------------------------------------------------------------------===// 4387 // Binary elemental ops 4388 //===--------------------------------------------------------------------===// 4389 4390 template <typename OP, typename A> 4391 CC createBinaryOp(const A &evEx) { 4392 mlir::Location loc = getLoc(); 4393 auto lambda = genarr(evEx.left()); 4394 auto rf = genarr(evEx.right()); 4395 return [=](IterSpace iters) -> ExtValue { 4396 mlir::Value left = fir::getBase(lambda(iters)); 4397 mlir::Value right = fir::getBase(rf(iters)); 4398 return builder.create<OP>(loc, left, right); 4399 }; 4400 } 4401 4402 #undef GENBIN 4403 #define GENBIN(GenBinEvOp, GenBinTyCat, GenBinFirOp) \ 4404 template <int KIND> \ 4405 CC genarr(const Fortran::evaluate::GenBinEvOp<Fortran::evaluate::Type< \ 4406 Fortran::common::TypeCategory::GenBinTyCat, KIND>> &x) { \ 4407 return createBinaryOp<GenBinFirOp>(x); \ 4408 } 4409 4410 GENBIN(Add, Integer, mlir::arith::AddIOp) 4411 GENBIN(Add, Real, mlir::arith::AddFOp) 4412 GENBIN(Add, Complex, fir::AddcOp) 4413 GENBIN(Subtract, Integer, mlir::arith::SubIOp) 4414 GENBIN(Subtract, Real, mlir::arith::SubFOp) 4415 GENBIN(Subtract, Complex, fir::SubcOp) 4416 GENBIN(Multiply, Integer, mlir::arith::MulIOp) 4417 GENBIN(Multiply, Real, mlir::arith::MulFOp) 4418 GENBIN(Multiply, Complex, fir::MulcOp) 4419 GENBIN(Divide, Integer, mlir::arith::DivSIOp) 4420 GENBIN(Divide, Real, mlir::arith::DivFOp) 4421 GENBIN(Divide, Complex, fir::DivcOp) 4422 4423 template <Fortran::common::TypeCategory TC, int KIND> 4424 CC genarr( 4425 const Fortran::evaluate::Power<Fortran::evaluate::Type<TC, KIND>> &x) { 4426 mlir::Location loc = getLoc(); 4427 mlir::Type ty = converter.genType(TC, KIND); 4428 auto lf = genarr(x.left()); 4429 auto rf = genarr(x.right()); 4430 return [=](IterSpace iters) -> ExtValue { 4431 mlir::Value lhs = fir::getBase(lf(iters)); 4432 mlir::Value rhs = fir::getBase(rf(iters)); 4433 return Fortran::lower::genPow(builder, loc, ty, lhs, rhs); 4434 }; 4435 } 4436 template <Fortran::common::TypeCategory TC, int KIND> 4437 CC genarr( 4438 const Fortran::evaluate::Extremum<Fortran::evaluate::Type<TC, KIND>> &x) { 4439 TODO(getLoc(), "genarr Extremum<Fortran::evaluate::Type<TC, KIND>>"); 4440 } 4441 template <Fortran::common::TypeCategory TC, int KIND> 4442 CC genarr( 4443 const Fortran::evaluate::RealToIntPower<Fortran::evaluate::Type<TC, KIND>> 4444 &x) { 4445 TODO(getLoc(), "genarr RealToIntPower<Fortran::evaluate::Type<TC, KIND>>"); 4446 } 4447 template <int KIND> 4448 CC genarr(const Fortran::evaluate::ComplexConstructor<KIND> &x) { 4449 TODO(getLoc(), "genarr ComplexConstructor<KIND>"); 4450 } 4451 4452 template <int KIND> 4453 CC genarr(const Fortran::evaluate::Concat<KIND> &x) { 4454 TODO(getLoc(), "genarr Concat<KIND>"); 4455 } 4456 4457 template <int KIND> 4458 CC genarr(const Fortran::evaluate::SetLength<KIND> &x) { 4459 TODO(getLoc(), "genarr SetLength<KIND>"); 4460 } 4461 4462 template <typename A> 4463 CC genarr(const Fortran::evaluate::Constant<A> &x) { 4464 if (/*explicitSpaceIsActive() &&*/ x.Rank() == 0) 4465 return genScalarAndForwardValue(x); 4466 mlir::Location loc = getLoc(); 4467 mlir::IndexType idxTy = builder.getIndexType(); 4468 mlir::Type arrTy = converter.genType(toEvExpr(x)); 4469 std::string globalName = Fortran::lower::mangle::mangleArrayLiteral(x); 4470 fir::GlobalOp global = builder.getNamedGlobal(globalName); 4471 if (!global) { 4472 mlir::Type symTy = arrTy; 4473 mlir::Type eleTy = symTy.cast<fir::SequenceType>().getEleTy(); 4474 // If we have a rank-1 array of integer, real, or logical, then we can 4475 // create a global array with the dense attribute. 4476 // 4477 // The mlir tensor type can only handle integer, real, or logical. It 4478 // does not currently support nested structures which is required for 4479 // complex. 4480 // 4481 // Also, we currently handle just rank-1 since tensor type assumes 4482 // row major array ordering. We will need to reorder the dimensions 4483 // in the tensor type to support Fortran's column major array ordering. 4484 // How to create this tensor type is to be determined. 4485 if (x.Rank() == 1 && 4486 eleTy.isa<fir::LogicalType, mlir::IntegerType, mlir::FloatType>()) 4487 global = Fortran::lower::createDenseGlobal( 4488 loc, arrTy, globalName, builder.createInternalLinkage(), true, 4489 toEvExpr(x), converter); 4490 // Note: If call to createDenseGlobal() returns 0, then call 4491 // createGlobalConstant() below. 4492 if (!global) 4493 global = builder.createGlobalConstant( 4494 loc, arrTy, globalName, 4495 [&](fir::FirOpBuilder &builder) { 4496 Fortran::lower::StatementContext stmtCtx( 4497 /*cleanupProhibited=*/true); 4498 fir::ExtendedValue result = 4499 Fortran::lower::createSomeInitializerExpression( 4500 loc, converter, toEvExpr(x), symMap, stmtCtx); 4501 mlir::Value castTo = 4502 builder.createConvert(loc, arrTy, fir::getBase(result)); 4503 builder.create<fir::HasValueOp>(loc, castTo); 4504 }, 4505 builder.createInternalLinkage()); 4506 } 4507 auto addr = builder.create<fir::AddrOfOp>(getLoc(), global.resultType(), 4508 global.getSymbol()); 4509 auto seqTy = global.getType().cast<fir::SequenceType>(); 4510 llvm::SmallVector<mlir::Value> extents; 4511 for (auto extent : seqTy.getShape()) 4512 extents.push_back(builder.createIntegerConstant(loc, idxTy, extent)); 4513 if (auto charTy = seqTy.getEleTy().dyn_cast<fir::CharacterType>()) { 4514 mlir::Value len = builder.createIntegerConstant(loc, builder.getI64Type(), 4515 charTy.getLen()); 4516 return genarr(fir::CharArrayBoxValue{addr, len, extents}); 4517 } 4518 return genarr(fir::ArrayBoxValue{addr, extents}); 4519 } 4520 4521 //===--------------------------------------------------------------------===// 4522 // A vector subscript expression may be wrapped with a cast to INTEGER*8. 4523 // Get rid of it here so the vector can be loaded. Add it back when 4524 // generating the elemental evaluation (inside the loop nest). 4525 4526 static Fortran::lower::SomeExpr 4527 ignoreEvConvert(const Fortran::evaluate::Expr<Fortran::evaluate::Type< 4528 Fortran::common::TypeCategory::Integer, 8>> &x) { 4529 return std::visit([&](const auto &v) { return ignoreEvConvert(v); }, x.u); 4530 } 4531 template <Fortran::common::TypeCategory FROM> 4532 static Fortran::lower::SomeExpr ignoreEvConvert( 4533 const Fortran::evaluate::Convert< 4534 Fortran::evaluate::Type<Fortran::common::TypeCategory::Integer, 8>, 4535 FROM> &x) { 4536 return toEvExpr(x.left()); 4537 } 4538 template <typename A> 4539 static Fortran::lower::SomeExpr ignoreEvConvert(const A &x) { 4540 return toEvExpr(x); 4541 } 4542 4543 //===--------------------------------------------------------------------===// 4544 // Get the `Se::Symbol*` for the subscript expression, `x`. This symbol can 4545 // be used to determine the lbound, ubound of the vector. 4546 4547 template <typename A> 4548 static const Fortran::semantics::Symbol * 4549 extractSubscriptSymbol(const Fortran::evaluate::Expr<A> &x) { 4550 return std::visit([&](const auto &v) { return extractSubscriptSymbol(v); }, 4551 x.u); 4552 } 4553 template <typename A> 4554 static const Fortran::semantics::Symbol * 4555 extractSubscriptSymbol(const Fortran::evaluate::Designator<A> &x) { 4556 return Fortran::evaluate::UnwrapWholeSymbolDataRef(x); 4557 } 4558 template <typename A> 4559 static const Fortran::semantics::Symbol *extractSubscriptSymbol(const A &x) { 4560 return nullptr; 4561 } 4562 4563 //===--------------------------------------------------------------------===// 4564 4565 /// Get the declared lower bound value of the array `x` in dimension `dim`. 4566 /// The argument `one` must be an ssa-value for the constant 1. 4567 mlir::Value getLBound(const ExtValue &x, unsigned dim, mlir::Value one) { 4568 return fir::factory::readLowerBound(builder, getLoc(), x, dim, one); 4569 } 4570 4571 /// Get the declared upper bound value of the array `x` in dimension `dim`. 4572 /// The argument `one` must be an ssa-value for the constant 1. 4573 mlir::Value getUBound(const ExtValue &x, unsigned dim, mlir::Value one) { 4574 mlir::Location loc = getLoc(); 4575 mlir::Value lb = getLBound(x, dim, one); 4576 mlir::Value extent = fir::factory::readExtent(builder, loc, x, dim); 4577 auto add = builder.create<mlir::arith::AddIOp>(loc, lb, extent); 4578 return builder.create<mlir::arith::SubIOp>(loc, add, one); 4579 } 4580 4581 /// Return the extent of the boxed array `x` in dimesion `dim`. 4582 mlir::Value getExtent(const ExtValue &x, unsigned dim) { 4583 return fir::factory::readExtent(builder, getLoc(), x, dim); 4584 } 4585 4586 template <typename A> 4587 ExtValue genArrayBase(const A &base) { 4588 ScalarExprLowering sel{getLoc(), converter, symMap, stmtCtx}; 4589 return base.IsSymbol() ? sel.gen(base.GetFirstSymbol()) 4590 : sel.gen(base.GetComponent()); 4591 } 4592 4593 template <typename A> 4594 bool hasEvArrayRef(const A &x) { 4595 struct HasEvArrayRefHelper 4596 : public Fortran::evaluate::AnyTraverse<HasEvArrayRefHelper> { 4597 HasEvArrayRefHelper() 4598 : Fortran::evaluate::AnyTraverse<HasEvArrayRefHelper>(*this) {} 4599 using Fortran::evaluate::AnyTraverse<HasEvArrayRefHelper>::operator(); 4600 bool operator()(const Fortran::evaluate::ArrayRef &) const { 4601 return true; 4602 } 4603 } helper; 4604 return helper(x); 4605 } 4606 4607 CC genVectorSubscriptArrayFetch(const Fortran::lower::SomeExpr &expr, 4608 std::size_t dim) { 4609 PushSemantics(ConstituentSemantics::RefTransparent); 4610 auto saved = Fortran::common::ScopedSet(explicitSpace, nullptr); 4611 llvm::SmallVector<mlir::Value> savedDestShape = destShape; 4612 destShape.clear(); 4613 auto result = genarr(expr); 4614 if (destShape.empty()) 4615 TODO(getLoc(), "expected vector to have an extent"); 4616 assert(destShape.size() == 1 && "vector has rank > 1"); 4617 if (destShape[0] != savedDestShape[dim]) { 4618 // Not the same, so choose the smaller value. 4619 mlir::Location loc = getLoc(); 4620 auto cmp = builder.create<mlir::arith::CmpIOp>( 4621 loc, mlir::arith::CmpIPredicate::sgt, destShape[0], 4622 savedDestShape[dim]); 4623 auto sel = builder.create<mlir::arith::SelectOp>( 4624 loc, cmp, savedDestShape[dim], destShape[0]); 4625 savedDestShape[dim] = sel; 4626 destShape = savedDestShape; 4627 } 4628 return result; 4629 } 4630 4631 /// Generate an access by vector subscript using the index in the iteration 4632 /// vector at `dim`. 4633 mlir::Value genAccessByVector(mlir::Location loc, CC genArrFetch, 4634 IterSpace iters, std::size_t dim) { 4635 IterationSpace vecIters(iters, 4636 llvm::ArrayRef<mlir::Value>{iters.iterValue(dim)}); 4637 fir::ExtendedValue fetch = genArrFetch(vecIters); 4638 mlir::IndexType idxTy = builder.getIndexType(); 4639 return builder.createConvert(loc, idxTy, fir::getBase(fetch)); 4640 } 4641 4642 /// When we have an array reference, the expressions specified in each 4643 /// dimension may be slice operations (e.g. `i:j:k`), vectors, or simple 4644 /// (loop-invarianet) scalar expressions. This returns the base entity, the 4645 /// resulting type, and a continuation to adjust the default iteration space. 4646 void genSliceIndices(ComponentPath &cmptData, const ExtValue &arrayExv, 4647 const Fortran::evaluate::ArrayRef &x, bool atBase) { 4648 mlir::Location loc = getLoc(); 4649 mlir::IndexType idxTy = builder.getIndexType(); 4650 mlir::Value one = builder.createIntegerConstant(loc, idxTy, 1); 4651 llvm::SmallVector<mlir::Value> &trips = cmptData.trips; 4652 LLVM_DEBUG(llvm::dbgs() << "array: " << arrayExv << '\n'); 4653 auto &pc = cmptData.pc; 4654 const bool useTripsForSlice = !explicitSpaceIsActive(); 4655 const bool createDestShape = destShape.empty(); 4656 bool useSlice = false; 4657 std::size_t shapeIndex = 0; 4658 for (auto sub : llvm::enumerate(x.subscript())) { 4659 const std::size_t subsIndex = sub.index(); 4660 std::visit( 4661 Fortran::common::visitors{ 4662 [&](const Fortran::evaluate::Triplet &t) { 4663 mlir::Value lowerBound; 4664 if (auto optLo = t.lower()) 4665 lowerBound = fir::getBase(asScalar(*optLo)); 4666 else 4667 lowerBound = getLBound(arrayExv, subsIndex, one); 4668 lowerBound = builder.createConvert(loc, idxTy, lowerBound); 4669 mlir::Value stride = fir::getBase(asScalar(t.stride())); 4670 stride = builder.createConvert(loc, idxTy, stride); 4671 if (useTripsForSlice || createDestShape) { 4672 // Generate a slice operation for the triplet. The first and 4673 // second position of the triplet may be omitted, and the 4674 // declared lbound and/or ubound expression values, 4675 // respectively, should be used instead. 4676 trips.push_back(lowerBound); 4677 mlir::Value upperBound; 4678 if (auto optUp = t.upper()) 4679 upperBound = fir::getBase(asScalar(*optUp)); 4680 else 4681 upperBound = getUBound(arrayExv, subsIndex, one); 4682 upperBound = builder.createConvert(loc, idxTy, upperBound); 4683 trips.push_back(upperBound); 4684 trips.push_back(stride); 4685 if (createDestShape) { 4686 auto extent = builder.genExtentFromTriplet( 4687 loc, lowerBound, upperBound, stride, idxTy); 4688 destShape.push_back(extent); 4689 } 4690 useSlice = true; 4691 } 4692 if (!useTripsForSlice) { 4693 auto currentPC = pc; 4694 pc = [=](IterSpace iters) { 4695 IterationSpace newIters = currentPC(iters); 4696 mlir::Value impliedIter = newIters.iterValue(subsIndex); 4697 // FIXME: must use the lower bound of this component. 4698 auto arrLowerBound = 4699 atBase ? getLBound(arrayExv, subsIndex, one) : one; 4700 auto initial = builder.create<mlir::arith::SubIOp>( 4701 loc, lowerBound, arrLowerBound); 4702 auto prod = builder.create<mlir::arith::MulIOp>( 4703 loc, impliedIter, stride); 4704 auto result = 4705 builder.create<mlir::arith::AddIOp>(loc, initial, prod); 4706 newIters.setIndexValue(subsIndex, result); 4707 return newIters; 4708 }; 4709 } 4710 shapeIndex++; 4711 }, 4712 [&](const Fortran::evaluate::IndirectSubscriptIntegerExpr &ie) { 4713 const auto &e = ie.value(); // dereference 4714 if (isArray(e)) { 4715 // This is a vector subscript. Use the index values as read 4716 // from a vector to determine the temporary array value. 4717 // Note: 9.5.3.3.3(3) specifies undefined behavior for 4718 // multiple updates to any specific array element through a 4719 // vector subscript with replicated values. 4720 assert(!isBoxValue() && 4721 "fir.box cannot be created with vector subscripts"); 4722 auto arrExpr = ignoreEvConvert(e); 4723 if (createDestShape) { 4724 destShape.push_back(fir::getExtentAtDimension( 4725 arrayExv, builder, loc, subsIndex)); 4726 } 4727 auto genArrFetch = 4728 genVectorSubscriptArrayFetch(arrExpr, shapeIndex); 4729 auto currentPC = pc; 4730 pc = [=](IterSpace iters) { 4731 IterationSpace newIters = currentPC(iters); 4732 auto val = genAccessByVector(loc, genArrFetch, newIters, 4733 subsIndex); 4734 // Value read from vector subscript array and normalized 4735 // using the base array's lower bound value. 4736 mlir::Value lb = fir::factory::readLowerBound( 4737 builder, loc, arrayExv, subsIndex, one); 4738 auto origin = builder.create<mlir::arith::SubIOp>( 4739 loc, idxTy, val, lb); 4740 newIters.setIndexValue(subsIndex, origin); 4741 return newIters; 4742 }; 4743 if (useTripsForSlice) { 4744 LLVM_ATTRIBUTE_UNUSED auto vectorSubscriptShape = 4745 getShape(arrayOperands.back()); 4746 auto undef = builder.create<fir::UndefOp>(loc, idxTy); 4747 trips.push_back(undef); 4748 trips.push_back(undef); 4749 trips.push_back(undef); 4750 } 4751 shapeIndex++; 4752 } else { 4753 // This is a regular scalar subscript. 4754 if (useTripsForSlice) { 4755 // A regular scalar index, which does not yield an array 4756 // section. Use a degenerate slice operation 4757 // `(e:undef:undef)` in this dimension as a placeholder. 4758 // This does not necessarily change the rank of the original 4759 // array, so the iteration space must also be extended to 4760 // include this expression in this dimension to adjust to 4761 // the array's declared rank. 4762 mlir::Value v = fir::getBase(asScalar(e)); 4763 trips.push_back(v); 4764 auto undef = builder.create<fir::UndefOp>(loc, idxTy); 4765 trips.push_back(undef); 4766 trips.push_back(undef); 4767 auto currentPC = pc; 4768 // Cast `e` to index type. 4769 mlir::Value iv = builder.createConvert(loc, idxTy, v); 4770 // Normalize `e` by subtracting the declared lbound. 4771 mlir::Value lb = fir::factory::readLowerBound( 4772 builder, loc, arrayExv, subsIndex, one); 4773 mlir::Value ivAdj = 4774 builder.create<mlir::arith::SubIOp>(loc, idxTy, iv, lb); 4775 // Add lbound adjusted value of `e` to the iteration vector 4776 // (except when creating a box because the iteration vector 4777 // is empty). 4778 if (!isBoxValue()) 4779 pc = [=](IterSpace iters) { 4780 IterationSpace newIters = currentPC(iters); 4781 newIters.insertIndexValue(subsIndex, ivAdj); 4782 return newIters; 4783 }; 4784 } else { 4785 auto currentPC = pc; 4786 mlir::Value newValue = fir::getBase(asScalarArray(e)); 4787 mlir::Value result = 4788 builder.createConvert(loc, idxTy, newValue); 4789 mlir::Value lb = fir::factory::readLowerBound( 4790 builder, loc, arrayExv, subsIndex, one); 4791 result = builder.create<mlir::arith::SubIOp>(loc, idxTy, 4792 result, lb); 4793 pc = [=](IterSpace iters) { 4794 IterationSpace newIters = currentPC(iters); 4795 newIters.insertIndexValue(subsIndex, result); 4796 return newIters; 4797 }; 4798 } 4799 } 4800 }}, 4801 sub.value().u); 4802 } 4803 if (!useSlice) 4804 trips.clear(); 4805 } 4806 4807 CC genarr(const Fortran::semantics::SymbolRef &sym, 4808 ComponentPath &components) { 4809 return genarr(sym.get(), components); 4810 } 4811 4812 ExtValue abstractArrayExtValue(mlir::Value val, mlir::Value len = {}) { 4813 return convertToArrayBoxValue(getLoc(), builder, val, len); 4814 } 4815 4816 CC genarr(const ExtValue &extMemref) { 4817 ComponentPath dummy(/*isImplicit=*/true); 4818 return genarr(extMemref, dummy); 4819 } 4820 4821 //===--------------------------------------------------------------------===// 4822 // Array construction 4823 //===--------------------------------------------------------------------===// 4824 4825 /// Target agnostic computation of the size of an element in the array. 4826 /// Returns the size in bytes with type `index` or a null Value if the element 4827 /// size is not constant. 4828 mlir::Value computeElementSize(const ExtValue &exv, mlir::Type eleTy, 4829 mlir::Type resTy) { 4830 mlir::Location loc = getLoc(); 4831 mlir::IndexType idxTy = builder.getIndexType(); 4832 mlir::Value multiplier = builder.createIntegerConstant(loc, idxTy, 1); 4833 if (fir::hasDynamicSize(eleTy)) { 4834 if (auto charTy = eleTy.dyn_cast<fir::CharacterType>()) { 4835 // Array of char with dynamic length parameter. Downcast to an array 4836 // of singleton char, and scale by the len type parameter from 4837 // `exv`. 4838 exv.match( 4839 [&](const fir::CharBoxValue &cb) { multiplier = cb.getLen(); }, 4840 [&](const fir::CharArrayBoxValue &cb) { multiplier = cb.getLen(); }, 4841 [&](const fir::BoxValue &box) { 4842 multiplier = fir::factory::CharacterExprHelper(builder, loc) 4843 .readLengthFromBox(box.getAddr()); 4844 }, 4845 [&](const fir::MutableBoxValue &box) { 4846 multiplier = fir::factory::CharacterExprHelper(builder, loc) 4847 .readLengthFromBox(box.getAddr()); 4848 }, 4849 [&](const auto &) { 4850 fir::emitFatalError(loc, 4851 "array constructor element has unknown size"); 4852 }); 4853 fir::CharacterType newEleTy = fir::CharacterType::getSingleton( 4854 eleTy.getContext(), charTy.getFKind()); 4855 if (auto seqTy = resTy.dyn_cast<fir::SequenceType>()) { 4856 assert(eleTy == seqTy.getEleTy()); 4857 resTy = fir::SequenceType::get(seqTy.getShape(), newEleTy); 4858 } 4859 eleTy = newEleTy; 4860 } else { 4861 TODO(loc, "dynamic sized type"); 4862 } 4863 } 4864 mlir::Type eleRefTy = builder.getRefType(eleTy); 4865 mlir::Type resRefTy = builder.getRefType(resTy); 4866 mlir::Value nullPtr = builder.createNullConstant(loc, resRefTy); 4867 auto offset = builder.create<fir::CoordinateOp>( 4868 loc, eleRefTy, nullPtr, mlir::ValueRange{multiplier}); 4869 return builder.createConvert(loc, idxTy, offset); 4870 } 4871 4872 /// Get the function signature of the LLVM memcpy intrinsic. 4873 mlir::FunctionType memcpyType() { 4874 return fir::factory::getLlvmMemcpy(builder).getType(); 4875 } 4876 4877 /// Create a call to the LLVM memcpy intrinsic. 4878 void createCallMemcpy(llvm::ArrayRef<mlir::Value> args) { 4879 mlir::Location loc = getLoc(); 4880 mlir::FuncOp memcpyFunc = fir::factory::getLlvmMemcpy(builder); 4881 mlir::SymbolRefAttr funcSymAttr = 4882 builder.getSymbolRefAttr(memcpyFunc.getName()); 4883 mlir::FunctionType funcTy = memcpyFunc.getType(); 4884 builder.create<fir::CallOp>(loc, funcTy.getResults(), funcSymAttr, args); 4885 } 4886 4887 // Construct code to check for a buffer overrun and realloc the buffer when 4888 // space is depleted. This is done between each item in the ac-value-list. 4889 mlir::Value growBuffer(mlir::Value mem, mlir::Value needed, 4890 mlir::Value bufferSize, mlir::Value buffSize, 4891 mlir::Value eleSz) { 4892 mlir::Location loc = getLoc(); 4893 mlir::FuncOp reallocFunc = fir::factory::getRealloc(builder); 4894 auto cond = builder.create<mlir::arith::CmpIOp>( 4895 loc, mlir::arith::CmpIPredicate::sle, bufferSize, needed); 4896 auto ifOp = builder.create<fir::IfOp>(loc, mem.getType(), cond, 4897 /*withElseRegion=*/true); 4898 auto insPt = builder.saveInsertionPoint(); 4899 builder.setInsertionPointToStart(&ifOp.getThenRegion().front()); 4900 // Not enough space, resize the buffer. 4901 mlir::IndexType idxTy = builder.getIndexType(); 4902 mlir::Value two = builder.createIntegerConstant(loc, idxTy, 2); 4903 auto newSz = builder.create<mlir::arith::MulIOp>(loc, needed, two); 4904 builder.create<fir::StoreOp>(loc, newSz, buffSize); 4905 mlir::Value byteSz = builder.create<mlir::arith::MulIOp>(loc, newSz, eleSz); 4906 mlir::SymbolRefAttr funcSymAttr = 4907 builder.getSymbolRefAttr(reallocFunc.getName()); 4908 mlir::FunctionType funcTy = reallocFunc.getType(); 4909 auto newMem = builder.create<fir::CallOp>( 4910 loc, funcTy.getResults(), funcSymAttr, 4911 llvm::ArrayRef<mlir::Value>{ 4912 builder.createConvert(loc, funcTy.getInputs()[0], mem), 4913 builder.createConvert(loc, funcTy.getInputs()[1], byteSz)}); 4914 mlir::Value castNewMem = 4915 builder.createConvert(loc, mem.getType(), newMem.getResult(0)); 4916 builder.create<fir::ResultOp>(loc, castNewMem); 4917 builder.setInsertionPointToStart(&ifOp.getElseRegion().front()); 4918 // Otherwise, just forward the buffer. 4919 builder.create<fir::ResultOp>(loc, mem); 4920 builder.restoreInsertionPoint(insPt); 4921 return ifOp.getResult(0); 4922 } 4923 4924 /// Copy the next value (or vector of values) into the array being 4925 /// constructed. 4926 mlir::Value copyNextArrayCtorSection(const ExtValue &exv, mlir::Value buffPos, 4927 mlir::Value buffSize, mlir::Value mem, 4928 mlir::Value eleSz, mlir::Type eleTy, 4929 mlir::Type eleRefTy, mlir::Type resTy) { 4930 mlir::Location loc = getLoc(); 4931 auto off = builder.create<fir::LoadOp>(loc, buffPos); 4932 auto limit = builder.create<fir::LoadOp>(loc, buffSize); 4933 mlir::IndexType idxTy = builder.getIndexType(); 4934 mlir::Value one = builder.createIntegerConstant(loc, idxTy, 1); 4935 4936 if (fir::isRecordWithAllocatableMember(eleTy)) 4937 TODO(loc, "deep copy on allocatable members"); 4938 4939 if (!eleSz) { 4940 // Compute the element size at runtime. 4941 assert(fir::hasDynamicSize(eleTy)); 4942 if (auto charTy = eleTy.dyn_cast<fir::CharacterType>()) { 4943 auto charBytes = 4944 builder.getKindMap().getCharacterBitsize(charTy.getFKind()) / 8; 4945 mlir::Value bytes = 4946 builder.createIntegerConstant(loc, idxTy, charBytes); 4947 mlir::Value length = fir::getLen(exv); 4948 if (!length) 4949 fir::emitFatalError(loc, "result is not boxed character"); 4950 eleSz = builder.create<mlir::arith::MulIOp>(loc, bytes, length); 4951 } else { 4952 TODO(loc, "PDT size"); 4953 // Will call the PDT's size function with the type parameters. 4954 } 4955 } 4956 4957 // Compute the coordinate using `fir.coordinate_of`, or, if the type has 4958 // dynamic size, generating the pointer arithmetic. 4959 auto computeCoordinate = [&](mlir::Value buff, mlir::Value off) { 4960 mlir::Type refTy = eleRefTy; 4961 if (fir::hasDynamicSize(eleTy)) { 4962 if (auto charTy = eleTy.dyn_cast<fir::CharacterType>()) { 4963 // Scale a simple pointer using dynamic length and offset values. 4964 auto chTy = fir::CharacterType::getSingleton(charTy.getContext(), 4965 charTy.getFKind()); 4966 refTy = builder.getRefType(chTy); 4967 mlir::Type toTy = builder.getRefType(builder.getVarLenSeqTy(chTy)); 4968 buff = builder.createConvert(loc, toTy, buff); 4969 off = builder.create<mlir::arith::MulIOp>(loc, off, eleSz); 4970 } else { 4971 TODO(loc, "PDT offset"); 4972 } 4973 } 4974 auto coor = builder.create<fir::CoordinateOp>(loc, refTy, buff, 4975 mlir::ValueRange{off}); 4976 return builder.createConvert(loc, eleRefTy, coor); 4977 }; 4978 4979 // Lambda to lower an abstract array box value. 4980 auto doAbstractArray = [&](const auto &v) { 4981 // Compute the array size. 4982 mlir::Value arrSz = one; 4983 for (auto ext : v.getExtents()) 4984 arrSz = builder.create<mlir::arith::MulIOp>(loc, arrSz, ext); 4985 4986 // Grow the buffer as needed. 4987 auto endOff = builder.create<mlir::arith::AddIOp>(loc, off, arrSz); 4988 mem = growBuffer(mem, endOff, limit, buffSize, eleSz); 4989 4990 // Copy the elements to the buffer. 4991 mlir::Value byteSz = 4992 builder.create<mlir::arith::MulIOp>(loc, arrSz, eleSz); 4993 auto buff = builder.createConvert(loc, fir::HeapType::get(resTy), mem); 4994 mlir::Value buffi = computeCoordinate(buff, off); 4995 llvm::SmallVector<mlir::Value> args = fir::runtime::createArguments( 4996 builder, loc, memcpyType(), buffi, v.getAddr(), byteSz, 4997 /*volatile=*/builder.createBool(loc, false)); 4998 createCallMemcpy(args); 4999 5000 // Save the incremented buffer position. 5001 builder.create<fir::StoreOp>(loc, endOff, buffPos); 5002 }; 5003 5004 // Copy a trivial scalar value into the buffer. 5005 auto doTrivialScalar = [&](const ExtValue &v, mlir::Value len = {}) { 5006 // Increment the buffer position. 5007 auto plusOne = builder.create<mlir::arith::AddIOp>(loc, off, one); 5008 5009 // Grow the buffer as needed. 5010 mem = growBuffer(mem, plusOne, limit, buffSize, eleSz); 5011 5012 // Store the element in the buffer. 5013 mlir::Value buff = 5014 builder.createConvert(loc, fir::HeapType::get(resTy), mem); 5015 auto buffi = builder.create<fir::CoordinateOp>(loc, eleRefTy, buff, 5016 mlir::ValueRange{off}); 5017 fir::factory::genScalarAssignment( 5018 builder, loc, 5019 [&]() -> ExtValue { 5020 if (len) 5021 return fir::CharBoxValue(buffi, len); 5022 return buffi; 5023 }(), 5024 v); 5025 builder.create<fir::StoreOp>(loc, plusOne, buffPos); 5026 }; 5027 5028 // Copy the value. 5029 exv.match( 5030 [&](mlir::Value) { doTrivialScalar(exv); }, 5031 [&](const fir::CharBoxValue &v) { 5032 auto buffer = v.getBuffer(); 5033 if (fir::isa_char(buffer.getType())) { 5034 doTrivialScalar(exv, eleSz); 5035 } else { 5036 // Increment the buffer position. 5037 auto plusOne = builder.create<mlir::arith::AddIOp>(loc, off, one); 5038 5039 // Grow the buffer as needed. 5040 mem = growBuffer(mem, plusOne, limit, buffSize, eleSz); 5041 5042 // Store the element in the buffer. 5043 mlir::Value buff = 5044 builder.createConvert(loc, fir::HeapType::get(resTy), mem); 5045 mlir::Value buffi = computeCoordinate(buff, off); 5046 llvm::SmallVector<mlir::Value> args = fir::runtime::createArguments( 5047 builder, loc, memcpyType(), buffi, v.getAddr(), eleSz, 5048 /*volatile=*/builder.createBool(loc, false)); 5049 createCallMemcpy(args); 5050 5051 builder.create<fir::StoreOp>(loc, plusOne, buffPos); 5052 } 5053 }, 5054 [&](const fir::ArrayBoxValue &v) { doAbstractArray(v); }, 5055 [&](const fir::CharArrayBoxValue &v) { doAbstractArray(v); }, 5056 [&](const auto &) { 5057 TODO(loc, "unhandled array constructor expression"); 5058 }); 5059 return mem; 5060 } 5061 5062 // Lower the expr cases in an ac-value-list. 5063 template <typename A> 5064 std::pair<ExtValue, bool> 5065 genArrayCtorInitializer(const Fortran::evaluate::Expr<A> &x, mlir::Type, 5066 mlir::Value, mlir::Value, mlir::Value, 5067 Fortran::lower::StatementContext &stmtCtx) { 5068 if (isArray(x)) 5069 return {lowerNewArrayExpression(converter, symMap, stmtCtx, toEvExpr(x)), 5070 /*needCopy=*/true}; 5071 return {asScalar(x), /*needCopy=*/true}; 5072 } 5073 5074 // Lower an ac-implied-do in an ac-value-list. 5075 template <typename A> 5076 std::pair<ExtValue, bool> 5077 genArrayCtorInitializer(const Fortran::evaluate::ImpliedDo<A> &x, 5078 mlir::Type resTy, mlir::Value mem, 5079 mlir::Value buffPos, mlir::Value buffSize, 5080 Fortran::lower::StatementContext &) { 5081 mlir::Location loc = getLoc(); 5082 mlir::IndexType idxTy = builder.getIndexType(); 5083 mlir::Value lo = 5084 builder.createConvert(loc, idxTy, fir::getBase(asScalar(x.lower()))); 5085 mlir::Value up = 5086 builder.createConvert(loc, idxTy, fir::getBase(asScalar(x.upper()))); 5087 mlir::Value step = 5088 builder.createConvert(loc, idxTy, fir::getBase(asScalar(x.stride()))); 5089 auto seqTy = resTy.template cast<fir::SequenceType>(); 5090 mlir::Type eleTy = fir::unwrapSequenceType(seqTy); 5091 auto loop = 5092 builder.create<fir::DoLoopOp>(loc, lo, up, step, /*unordered=*/false, 5093 /*finalCount=*/false, mem); 5094 // create a new binding for x.name(), to ac-do-variable, to the iteration 5095 // value. 5096 symMap.pushImpliedDoBinding(toStringRef(x.name()), loop.getInductionVar()); 5097 auto insPt = builder.saveInsertionPoint(); 5098 builder.setInsertionPointToStart(loop.getBody()); 5099 // Thread mem inside the loop via loop argument. 5100 mem = loop.getRegionIterArgs()[0]; 5101 5102 mlir::Type eleRefTy = builder.getRefType(eleTy); 5103 5104 // Any temps created in the loop body must be freed inside the loop body. 5105 stmtCtx.pushScope(); 5106 llvm::Optional<mlir::Value> charLen; 5107 for (const Fortran::evaluate::ArrayConstructorValue<A> &acv : x.values()) { 5108 auto [exv, copyNeeded] = std::visit( 5109 [&](const auto &v) { 5110 return genArrayCtorInitializer(v, resTy, mem, buffPos, buffSize, 5111 stmtCtx); 5112 }, 5113 acv.u); 5114 mlir::Value eleSz = computeElementSize(exv, eleTy, resTy); 5115 mem = copyNeeded ? copyNextArrayCtorSection(exv, buffPos, buffSize, mem, 5116 eleSz, eleTy, eleRefTy, resTy) 5117 : fir::getBase(exv); 5118 if (fir::isa_char(seqTy.getEleTy()) && !charLen.hasValue()) { 5119 charLen = builder.createTemporary(loc, builder.getI64Type()); 5120 mlir::Value castLen = 5121 builder.createConvert(loc, builder.getI64Type(), fir::getLen(exv)); 5122 builder.create<fir::StoreOp>(loc, castLen, charLen.getValue()); 5123 } 5124 } 5125 stmtCtx.finalize(/*popScope=*/true); 5126 5127 builder.create<fir::ResultOp>(loc, mem); 5128 builder.restoreInsertionPoint(insPt); 5129 mem = loop.getResult(0); 5130 symMap.popImpliedDoBinding(); 5131 llvm::SmallVector<mlir::Value> extents = { 5132 builder.create<fir::LoadOp>(loc, buffPos).getResult()}; 5133 5134 // Convert to extended value. 5135 if (fir::isa_char(seqTy.getEleTy())) { 5136 auto len = builder.create<fir::LoadOp>(loc, charLen.getValue()); 5137 return {fir::CharArrayBoxValue{mem, len, extents}, /*needCopy=*/false}; 5138 } 5139 return {fir::ArrayBoxValue{mem, extents}, /*needCopy=*/false}; 5140 } 5141 5142 // To simplify the handling and interaction between the various cases, array 5143 // constructors are always lowered to the incremental construction code 5144 // pattern, even if the extent of the array value is constant. After the 5145 // MemToReg pass and constant folding, the optimizer should be able to 5146 // determine that all the buffer overrun tests are false when the 5147 // incremental construction wasn't actually required. 5148 template <typename A> 5149 CC genarr(const Fortran::evaluate::ArrayConstructor<A> &x) { 5150 mlir::Location loc = getLoc(); 5151 auto evExpr = toEvExpr(x); 5152 mlir::Type resTy = translateSomeExprToFIRType(converter, evExpr); 5153 mlir::IndexType idxTy = builder.getIndexType(); 5154 auto seqTy = resTy.template cast<fir::SequenceType>(); 5155 mlir::Type eleTy = fir::unwrapSequenceType(resTy); 5156 mlir::Value buffSize = builder.createTemporary(loc, idxTy, ".buff.size"); 5157 mlir::Value zero = builder.createIntegerConstant(loc, idxTy, 0); 5158 mlir::Value buffPos = builder.createTemporary(loc, idxTy, ".buff.pos"); 5159 builder.create<fir::StoreOp>(loc, zero, buffPos); 5160 // Allocate space for the array to be constructed. 5161 mlir::Value mem; 5162 if (fir::hasDynamicSize(resTy)) { 5163 if (fir::hasDynamicSize(eleTy)) { 5164 // The size of each element may depend on a general expression. Defer 5165 // creating the buffer until after the expression is evaluated. 5166 mem = builder.createNullConstant(loc, builder.getRefType(eleTy)); 5167 builder.create<fir::StoreOp>(loc, zero, buffSize); 5168 } else { 5169 mlir::Value initBuffSz = 5170 builder.createIntegerConstant(loc, idxTy, clInitialBufferSize); 5171 mem = builder.create<fir::AllocMemOp>( 5172 loc, eleTy, /*typeparams=*/llvm::None, initBuffSz); 5173 builder.create<fir::StoreOp>(loc, initBuffSz, buffSize); 5174 } 5175 } else { 5176 mem = builder.create<fir::AllocMemOp>(loc, resTy); 5177 int64_t buffSz = 1; 5178 for (auto extent : seqTy.getShape()) 5179 buffSz *= extent; 5180 mlir::Value initBuffSz = 5181 builder.createIntegerConstant(loc, idxTy, buffSz); 5182 builder.create<fir::StoreOp>(loc, initBuffSz, buffSize); 5183 } 5184 // Compute size of element 5185 mlir::Type eleRefTy = builder.getRefType(eleTy); 5186 5187 // Populate the buffer with the elements, growing as necessary. 5188 llvm::Optional<mlir::Value> charLen; 5189 for (const auto &expr : x) { 5190 auto [exv, copyNeeded] = std::visit( 5191 [&](const auto &e) { 5192 return genArrayCtorInitializer(e, resTy, mem, buffPos, buffSize, 5193 stmtCtx); 5194 }, 5195 expr.u); 5196 mlir::Value eleSz = computeElementSize(exv, eleTy, resTy); 5197 mem = copyNeeded ? copyNextArrayCtorSection(exv, buffPos, buffSize, mem, 5198 eleSz, eleTy, eleRefTy, resTy) 5199 : fir::getBase(exv); 5200 if (fir::isa_char(seqTy.getEleTy()) && !charLen.hasValue()) { 5201 charLen = builder.createTemporary(loc, builder.getI64Type()); 5202 mlir::Value castLen = 5203 builder.createConvert(loc, builder.getI64Type(), fir::getLen(exv)); 5204 builder.create<fir::StoreOp>(loc, castLen, charLen.getValue()); 5205 } 5206 } 5207 mem = builder.createConvert(loc, fir::HeapType::get(resTy), mem); 5208 llvm::SmallVector<mlir::Value> extents = { 5209 builder.create<fir::LoadOp>(loc, buffPos)}; 5210 5211 // Cleanup the temporary. 5212 fir::FirOpBuilder *bldr = &converter.getFirOpBuilder(); 5213 stmtCtx.attachCleanup( 5214 [bldr, loc, mem]() { bldr->create<fir::FreeMemOp>(loc, mem); }); 5215 5216 // Return the continuation. 5217 if (fir::isa_char(seqTy.getEleTy())) { 5218 if (charLen.hasValue()) { 5219 auto len = builder.create<fir::LoadOp>(loc, charLen.getValue()); 5220 return genarr(fir::CharArrayBoxValue{mem, len, extents}); 5221 } 5222 return genarr(fir::CharArrayBoxValue{mem, zero, extents}); 5223 } 5224 return genarr(fir::ArrayBoxValue{mem, extents}); 5225 } 5226 5227 CC genarr(const Fortran::evaluate::ImpliedDoIndex &) { 5228 TODO(getLoc(), "genarr ImpliedDoIndex"); 5229 } 5230 5231 CC genarr(const Fortran::evaluate::TypeParamInquiry &x) { 5232 TODO(getLoc(), "genarr TypeParamInquiry"); 5233 } 5234 5235 CC genarr(const Fortran::evaluate::DescriptorInquiry &x) { 5236 TODO(getLoc(), "genarr DescriptorInquiry"); 5237 } 5238 5239 CC genarr(const Fortran::evaluate::StructureConstructor &x) { 5240 TODO(getLoc(), "genarr StructureConstructor"); 5241 } 5242 5243 //===--------------------------------------------------------------------===// 5244 // LOCICAL operators (.NOT., .AND., .EQV., etc.) 5245 //===--------------------------------------------------------------------===// 5246 5247 template <int KIND> 5248 CC genarr(const Fortran::evaluate::Not<KIND> &x) { 5249 mlir::Location loc = getLoc(); 5250 mlir::IntegerType i1Ty = builder.getI1Type(); 5251 auto lambda = genarr(x.left()); 5252 mlir::Value truth = builder.createBool(loc, true); 5253 return [=](IterSpace iters) -> ExtValue { 5254 mlir::Value logical = fir::getBase(lambda(iters)); 5255 mlir::Value val = builder.createConvert(loc, i1Ty, logical); 5256 return builder.create<mlir::arith::XOrIOp>(loc, val, truth); 5257 }; 5258 } 5259 template <typename OP, typename A> 5260 CC createBinaryBoolOp(const A &x) { 5261 mlir::Location loc = getLoc(); 5262 mlir::IntegerType i1Ty = builder.getI1Type(); 5263 auto lf = genarr(x.left()); 5264 auto rf = genarr(x.right()); 5265 return [=](IterSpace iters) -> ExtValue { 5266 mlir::Value left = fir::getBase(lf(iters)); 5267 mlir::Value right = fir::getBase(rf(iters)); 5268 mlir::Value lhs = builder.createConvert(loc, i1Ty, left); 5269 mlir::Value rhs = builder.createConvert(loc, i1Ty, right); 5270 return builder.create<OP>(loc, lhs, rhs); 5271 }; 5272 } 5273 template <typename OP, typename A> 5274 CC createCompareBoolOp(mlir::arith::CmpIPredicate pred, const A &x) { 5275 mlir::Location loc = getLoc(); 5276 mlir::IntegerType i1Ty = builder.getI1Type(); 5277 auto lf = genarr(x.left()); 5278 auto rf = genarr(x.right()); 5279 return [=](IterSpace iters) -> ExtValue { 5280 mlir::Value left = fir::getBase(lf(iters)); 5281 mlir::Value right = fir::getBase(rf(iters)); 5282 mlir::Value lhs = builder.createConvert(loc, i1Ty, left); 5283 mlir::Value rhs = builder.createConvert(loc, i1Ty, right); 5284 return builder.create<OP>(loc, pred, lhs, rhs); 5285 }; 5286 } 5287 template <int KIND> 5288 CC genarr(const Fortran::evaluate::LogicalOperation<KIND> &x) { 5289 switch (x.logicalOperator) { 5290 case Fortran::evaluate::LogicalOperator::And: 5291 return createBinaryBoolOp<mlir::arith::AndIOp>(x); 5292 case Fortran::evaluate::LogicalOperator::Or: 5293 return createBinaryBoolOp<mlir::arith::OrIOp>(x); 5294 case Fortran::evaluate::LogicalOperator::Eqv: 5295 return createCompareBoolOp<mlir::arith::CmpIOp>( 5296 mlir::arith::CmpIPredicate::eq, x); 5297 case Fortran::evaluate::LogicalOperator::Neqv: 5298 return createCompareBoolOp<mlir::arith::CmpIOp>( 5299 mlir::arith::CmpIPredicate::ne, x); 5300 case Fortran::evaluate::LogicalOperator::Not: 5301 llvm_unreachable(".NOT. handled elsewhere"); 5302 } 5303 llvm_unreachable("unhandled case"); 5304 } 5305 5306 //===--------------------------------------------------------------------===// 5307 // Relational operators (<, <=, ==, etc.) 5308 //===--------------------------------------------------------------------===// 5309 5310 template <typename OP, typename PRED, typename A> 5311 CC createCompareOp(PRED pred, const A &x) { 5312 mlir::Location loc = getLoc(); 5313 auto lf = genarr(x.left()); 5314 auto rf = genarr(x.right()); 5315 return [=](IterSpace iters) -> ExtValue { 5316 mlir::Value lhs = fir::getBase(lf(iters)); 5317 mlir::Value rhs = fir::getBase(rf(iters)); 5318 return builder.create<OP>(loc, pred, lhs, rhs); 5319 }; 5320 } 5321 template <typename A> 5322 CC createCompareCharOp(mlir::arith::CmpIPredicate pred, const A &x) { 5323 mlir::Location loc = getLoc(); 5324 auto lf = genarr(x.left()); 5325 auto rf = genarr(x.right()); 5326 return [=](IterSpace iters) -> ExtValue { 5327 auto lhs = lf(iters); 5328 auto rhs = rf(iters); 5329 return fir::runtime::genCharCompare(builder, loc, pred, lhs, rhs); 5330 }; 5331 } 5332 template <int KIND> 5333 CC genarr(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 5334 Fortran::common::TypeCategory::Integer, KIND>> &x) { 5335 return createCompareOp<mlir::arith::CmpIOp>(translateRelational(x.opr), x); 5336 } 5337 template <int KIND> 5338 CC genarr(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 5339 Fortran::common::TypeCategory::Character, KIND>> &x) { 5340 return createCompareCharOp(translateRelational(x.opr), x); 5341 } 5342 template <int KIND> 5343 CC genarr(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 5344 Fortran::common::TypeCategory::Real, KIND>> &x) { 5345 return createCompareOp<mlir::arith::CmpFOp>(translateFloatRelational(x.opr), 5346 x); 5347 } 5348 template <int KIND> 5349 CC genarr(const Fortran::evaluate::Relational<Fortran::evaluate::Type< 5350 Fortran::common::TypeCategory::Complex, KIND>> &x) { 5351 return createCompareOp<fir::CmpcOp>(translateFloatRelational(x.opr), x); 5352 } 5353 CC genarr( 5354 const Fortran::evaluate::Relational<Fortran::evaluate::SomeType> &r) { 5355 return std::visit([&](const auto &x) { return genarr(x); }, r.u); 5356 } 5357 5358 template <typename A> 5359 CC genarr(const Fortran::evaluate::Designator<A> &des) { 5360 ComponentPath components(des.Rank() > 0); 5361 return std::visit([&](const auto &x) { return genarr(x, components); }, 5362 des.u); 5363 } 5364 5365 template <typename T> 5366 CC genarr(const Fortran::evaluate::FunctionRef<T> &funRef) { 5367 // Note that it's possible that the function being called returns either an 5368 // array or a scalar. In the first case, use the element type of the array. 5369 return genProcRef( 5370 funRef, fir::unwrapSequenceType(converter.genType(toEvExpr(funRef)))); 5371 } 5372 5373 //===-------------------------------------------------------------------===// 5374 // Array data references in an explicit iteration space. 5375 // 5376 // Use the base array that was loaded before the loop nest. 5377 //===-------------------------------------------------------------------===// 5378 5379 /// Lower the path (`revPath`, in reverse) to be appended to an array_fetch or 5380 /// array_update op. \p ty is the initial type of the array 5381 /// (reference). Returns the type of the element after application of the 5382 /// path in \p components. 5383 /// 5384 /// TODO: This needs to deal with array's with initial bounds other than 1. 5385 /// TODO: Thread type parameters correctly. 5386 mlir::Type lowerPath(const ExtValue &arrayExv, ComponentPath &components) { 5387 mlir::Location loc = getLoc(); 5388 mlir::Type ty = fir::getBase(arrayExv).getType(); 5389 auto &revPath = components.reversePath; 5390 ty = fir::unwrapPassByRefType(ty); 5391 bool prefix = true; 5392 auto addComponent = [&](mlir::Value v) { 5393 if (prefix) 5394 components.prefixComponents.push_back(v); 5395 else 5396 components.suffixComponents.push_back(v); 5397 }; 5398 mlir::IndexType idxTy = builder.getIndexType(); 5399 mlir::Value one = builder.createIntegerConstant(loc, idxTy, 1); 5400 bool atBase = true; 5401 auto saveSemant = semant; 5402 if (isProjectedCopyInCopyOut()) 5403 semant = ConstituentSemantics::RefTransparent; 5404 for (const auto &v : llvm::reverse(revPath)) { 5405 std::visit( 5406 Fortran::common::visitors{ 5407 [&](const ImplicitSubscripts &) { 5408 prefix = false; 5409 ty = fir::unwrapSequenceType(ty); 5410 }, 5411 [&](const Fortran::evaluate::ComplexPart *x) { 5412 assert(!prefix && "complex part must be at end"); 5413 mlir::Value offset = builder.createIntegerConstant( 5414 loc, builder.getI32Type(), 5415 x->part() == Fortran::evaluate::ComplexPart::Part::RE ? 0 5416 : 1); 5417 components.suffixComponents.push_back(offset); 5418 ty = fir::applyPathToType(ty, mlir::ValueRange{offset}); 5419 }, 5420 [&](const Fortran::evaluate::ArrayRef *x) { 5421 if (Fortran::lower::isRankedArrayAccess(*x)) { 5422 genSliceIndices(components, arrayExv, *x, atBase); 5423 } else { 5424 // Array access where the expressions are scalar and cannot 5425 // depend upon the implied iteration space. 5426 unsigned ssIndex = 0u; 5427 for (const auto &ss : x->subscript()) { 5428 std::visit( 5429 Fortran::common::visitors{ 5430 [&](const Fortran::evaluate:: 5431 IndirectSubscriptIntegerExpr &ie) { 5432 const auto &e = ie.value(); 5433 if (isArray(e)) 5434 fir::emitFatalError( 5435 loc, 5436 "multiple components along single path " 5437 "generating array subexpressions"); 5438 // Lower scalar index expression, append it to 5439 // subs. 5440 mlir::Value subscriptVal = 5441 fir::getBase(asScalarArray(e)); 5442 // arrayExv is the base array. It needs to reflect 5443 // the current array component instead. 5444 // FIXME: must use lower bound of this component, 5445 // not just the constant 1. 5446 mlir::Value lb = 5447 atBase ? fir::factory::readLowerBound( 5448 builder, loc, arrayExv, ssIndex, 5449 one) 5450 : one; 5451 mlir::Value val = builder.createConvert( 5452 loc, idxTy, subscriptVal); 5453 mlir::Value ivAdj = 5454 builder.create<mlir::arith::SubIOp>( 5455 loc, idxTy, val, lb); 5456 addComponent( 5457 builder.createConvert(loc, idxTy, ivAdj)); 5458 }, 5459 [&](const auto &) { 5460 fir::emitFatalError( 5461 loc, "multiple components along single path " 5462 "generating array subexpressions"); 5463 }}, 5464 ss.u); 5465 ssIndex++; 5466 } 5467 } 5468 ty = fir::unwrapSequenceType(ty); 5469 }, 5470 [&](const Fortran::evaluate::Component *x) { 5471 auto fieldTy = fir::FieldType::get(builder.getContext()); 5472 llvm::StringRef name = toStringRef(getLastSym(*x).name()); 5473 auto recTy = ty.cast<fir::RecordType>(); 5474 ty = recTy.getType(name); 5475 auto fld = builder.create<fir::FieldIndexOp>( 5476 loc, fieldTy, name, recTy, fir::getTypeParams(arrayExv)); 5477 addComponent(fld); 5478 }}, 5479 v); 5480 atBase = false; 5481 } 5482 semant = saveSemant; 5483 ty = fir::unwrapSequenceType(ty); 5484 components.applied = true; 5485 return ty; 5486 } 5487 5488 llvm::SmallVector<mlir::Value> genSubstringBounds(ComponentPath &components) { 5489 llvm::SmallVector<mlir::Value> result; 5490 if (components.substring) 5491 populateBounds(result, components.substring); 5492 return result; 5493 } 5494 5495 CC applyPathToArrayLoad(fir::ArrayLoadOp load, ComponentPath &components) { 5496 mlir::Location loc = getLoc(); 5497 auto revPath = components.reversePath; 5498 fir::ExtendedValue arrayExv = 5499 arrayLoadExtValue(builder, loc, load, {}, load); 5500 mlir::Type eleTy = lowerPath(arrayExv, components); 5501 auto currentPC = components.pc; 5502 auto pc = [=, prefix = components.prefixComponents, 5503 suffix = components.suffixComponents](IterSpace iters) { 5504 IterationSpace newIters = currentPC(iters); 5505 // Add path prefix and suffix. 5506 IterationSpace addIters(newIters, prefix, suffix); 5507 return addIters; 5508 }; 5509 components.pc = [=](IterSpace iters) { return iters; }; 5510 llvm::SmallVector<mlir::Value> substringBounds = 5511 genSubstringBounds(components); 5512 if (isProjectedCopyInCopyOut()) { 5513 destination = load; 5514 auto lambda = [=, esp = this->explicitSpace](IterSpace iters) mutable { 5515 mlir::Value innerArg = esp->findArgumentOfLoad(load); 5516 if (isAdjustedArrayElementType(eleTy)) { 5517 mlir::Type eleRefTy = builder.getRefType(eleTy); 5518 auto arrayOp = builder.create<fir::ArrayAccessOp>( 5519 loc, eleRefTy, innerArg, iters.iterVec(), load.getTypeparams()); 5520 if (auto charTy = eleTy.dyn_cast<fir::CharacterType>()) { 5521 mlir::Value dstLen = fir::factory::genLenOfCharacter( 5522 builder, loc, load, iters.iterVec(), substringBounds); 5523 fir::ArrayAmendOp amend = createCharArrayAmend( 5524 loc, builder, arrayOp, dstLen, iters.elementExv(), innerArg, 5525 substringBounds); 5526 return arrayLoadExtValue(builder, loc, load, iters.iterVec(), amend, 5527 dstLen); 5528 } else if (fir::isa_derived(eleTy)) { 5529 fir::ArrayAmendOp amend = 5530 createDerivedArrayAmend(loc, load, builder, arrayOp, 5531 iters.elementExv(), eleTy, innerArg); 5532 return arrayLoadExtValue(builder, loc, load, iters.iterVec(), 5533 amend); 5534 } 5535 assert(eleTy.isa<fir::SequenceType>()); 5536 TODO(loc, "array (as element) assignment"); 5537 } 5538 mlir::Value castedElement = 5539 builder.createConvert(loc, eleTy, iters.getElement()); 5540 auto update = builder.create<fir::ArrayUpdateOp>( 5541 loc, innerArg.getType(), innerArg, castedElement, iters.iterVec(), 5542 load.getTypeparams()); 5543 return arrayLoadExtValue(builder, loc, load, iters.iterVec(), update); 5544 }; 5545 return [=](IterSpace iters) mutable { return lambda(pc(iters)); }; 5546 } 5547 if (isCustomCopyInCopyOut()) { 5548 // Create an array_modify to get the LHS element address and indicate 5549 // the assignment, and create the call to the user defined assignment. 5550 destination = load; 5551 auto lambda = [=](IterSpace iters) mutable { 5552 mlir::Value innerArg = explicitSpace->findArgumentOfLoad(load); 5553 mlir::Type refEleTy = 5554 fir::isa_ref_type(eleTy) ? eleTy : builder.getRefType(eleTy); 5555 auto arrModify = builder.create<fir::ArrayModifyOp>( 5556 loc, mlir::TypeRange{refEleTy, innerArg.getType()}, innerArg, 5557 iters.iterVec(), load.getTypeparams()); 5558 return arrayLoadExtValue(builder, loc, load, iters.iterVec(), 5559 arrModify.getResult(1)); 5560 }; 5561 return [=](IterSpace iters) mutable { return lambda(pc(iters)); }; 5562 } 5563 auto lambda = [=, semant = this->semant](IterSpace iters) mutable { 5564 if (semant == ConstituentSemantics::RefOpaque || 5565 isAdjustedArrayElementType(eleTy)) { 5566 mlir::Type resTy = builder.getRefType(eleTy); 5567 // Use array element reference semantics. 5568 auto access = builder.create<fir::ArrayAccessOp>( 5569 loc, resTy, load, iters.iterVec(), load.getTypeparams()); 5570 mlir::Value newBase = access; 5571 if (fir::isa_char(eleTy)) { 5572 mlir::Value dstLen = fir::factory::genLenOfCharacter( 5573 builder, loc, load, iters.iterVec(), substringBounds); 5574 if (!substringBounds.empty()) { 5575 fir::CharBoxValue charDst{access, dstLen}; 5576 fir::factory::CharacterExprHelper helper{builder, loc}; 5577 charDst = helper.createSubstring(charDst, substringBounds); 5578 newBase = charDst.getAddr(); 5579 } 5580 return arrayLoadExtValue(builder, loc, load, iters.iterVec(), newBase, 5581 dstLen); 5582 } 5583 return arrayLoadExtValue(builder, loc, load, iters.iterVec(), newBase); 5584 } 5585 auto fetch = builder.create<fir::ArrayFetchOp>( 5586 loc, eleTy, load, iters.iterVec(), load.getTypeparams()); 5587 return arrayLoadExtValue(builder, loc, load, iters.iterVec(), fetch); 5588 }; 5589 return [=](IterSpace iters) mutable { 5590 auto newIters = pc(iters); 5591 return lambda(newIters); 5592 }; 5593 } 5594 5595 template <typename A> 5596 CC genImplicitArrayAccess(const A &x, ComponentPath &components) { 5597 components.reversePath.push_back(ImplicitSubscripts{}); 5598 ExtValue exv = asScalarRef(x); 5599 lowerPath(exv, components); 5600 auto lambda = genarr(exv, components); 5601 return [=](IterSpace iters) { return lambda(components.pc(iters)); }; 5602 } 5603 CC genImplicitArrayAccess(const Fortran::evaluate::NamedEntity &x, 5604 ComponentPath &components) { 5605 if (x.IsSymbol()) 5606 return genImplicitArrayAccess(x.GetFirstSymbol(), components); 5607 return genImplicitArrayAccess(x.GetComponent(), components); 5608 } 5609 5610 template <typename A> 5611 CC genAsScalar(const A &x) { 5612 mlir::Location loc = getLoc(); 5613 if (isProjectedCopyInCopyOut()) { 5614 return [=, &x, builder = &converter.getFirOpBuilder()]( 5615 IterSpace iters) -> ExtValue { 5616 ExtValue exv = asScalarRef(x); 5617 mlir::Value val = fir::getBase(exv); 5618 mlir::Type eleTy = fir::unwrapRefType(val.getType()); 5619 if (isAdjustedArrayElementType(eleTy)) { 5620 if (fir::isa_char(eleTy)) { 5621 TODO(getLoc(), "assignment of character type"); 5622 } else if (fir::isa_derived(eleTy)) { 5623 TODO(loc, "assignment of derived type"); 5624 } else { 5625 fir::emitFatalError(loc, "array type not expected in scalar"); 5626 } 5627 } else { 5628 builder->create<fir::StoreOp>(loc, iters.getElement(), val); 5629 } 5630 return exv; 5631 }; 5632 } 5633 return [=, &x](IterSpace) { return asScalar(x); }; 5634 } 5635 5636 CC genarr(const Fortran::semantics::Symbol &x, ComponentPath &components) { 5637 if (explicitSpaceIsActive()) { 5638 if (x.Rank() > 0) 5639 components.reversePath.push_back(ImplicitSubscripts{}); 5640 if (fir::ArrayLoadOp load = explicitSpace->findBinding(&x)) 5641 return applyPathToArrayLoad(load, components); 5642 } else { 5643 return genImplicitArrayAccess(x, components); 5644 } 5645 if (pathIsEmpty(components)) 5646 return genAsScalar(x); 5647 mlir::Location loc = getLoc(); 5648 return [=](IterSpace) -> ExtValue { 5649 fir::emitFatalError(loc, "reached symbol with path"); 5650 }; 5651 } 5652 5653 CC genarr(const Fortran::evaluate::Component &x, ComponentPath &components) { 5654 TODO(getLoc(), "genarr Component"); 5655 } 5656 5657 /// Array reference with subscripts. If this has rank > 0, this is a form 5658 /// of an array section (slice). 5659 /// 5660 /// There are two "slicing" primitives that may be applied on a dimension by 5661 /// dimension basis: (1) triple notation and (2) vector addressing. Since 5662 /// dimensions can be selectively sliced, some dimensions may contain 5663 /// regular scalar expressions and those dimensions do not participate in 5664 /// the array expression evaluation. 5665 CC genarr(const Fortran::evaluate::ArrayRef &x, ComponentPath &components) { 5666 if (explicitSpaceIsActive()) { 5667 if (Fortran::lower::isRankedArrayAccess(x)) 5668 components.reversePath.push_back(ImplicitSubscripts{}); 5669 if (fir::ArrayLoadOp load = explicitSpace->findBinding(&x)) { 5670 components.reversePath.push_back(&x); 5671 return applyPathToArrayLoad(load, components); 5672 } 5673 } else { 5674 if (Fortran::lower::isRankedArrayAccess(x)) { 5675 components.reversePath.push_back(&x); 5676 return genImplicitArrayAccess(x.base(), components); 5677 } 5678 } 5679 bool atEnd = pathIsEmpty(components); 5680 components.reversePath.push_back(&x); 5681 auto result = genarr(x.base(), components); 5682 if (components.applied) 5683 return result; 5684 mlir::Location loc = getLoc(); 5685 if (atEnd) { 5686 if (x.Rank() == 0) 5687 return genAsScalar(x); 5688 fir::emitFatalError(loc, "expected scalar"); 5689 } 5690 return [=](IterSpace) -> ExtValue { 5691 fir::emitFatalError(loc, "reached arrayref with path"); 5692 }; 5693 } 5694 5695 CC genarr(const Fortran::evaluate::CoarrayRef &x, ComponentPath &components) { 5696 TODO(getLoc(), "coarray reference"); 5697 } 5698 5699 CC genarr(const Fortran::evaluate::NamedEntity &x, 5700 ComponentPath &components) { 5701 return x.IsSymbol() ? genarr(x.GetFirstSymbol(), components) 5702 : genarr(x.GetComponent(), components); 5703 } 5704 5705 CC genarr(const Fortran::evaluate::DataRef &x, ComponentPath &components) { 5706 return std::visit([&](const auto &v) { return genarr(v, components); }, 5707 x.u); 5708 } 5709 5710 bool pathIsEmpty(const ComponentPath &components) { 5711 return components.reversePath.empty(); 5712 } 5713 5714 /// Given an optional fir.box, returns an fir.box that is the original one if 5715 /// it is present and it otherwise an unallocated box. 5716 /// Absent fir.box are implemented as a null pointer descriptor. Generated 5717 /// code may need to unconditionally read a fir.box that can be absent. 5718 /// This helper allows creating a fir.box that can be read in all cases 5719 /// outside of a fir.if (isPresent) region. However, the usages of the value 5720 /// read from such box should still only be done in a fir.if(isPresent). 5721 static fir::ExtendedValue 5722 absentBoxToUnalllocatedBox(fir::FirOpBuilder &builder, mlir::Location loc, 5723 const fir::ExtendedValue &exv, 5724 mlir::Value isPresent) { 5725 mlir::Value box = fir::getBase(exv); 5726 mlir::Type boxType = box.getType(); 5727 assert(boxType.isa<fir::BoxType>() && "argument must be a fir.box"); 5728 mlir::Value emptyBox = 5729 fir::factory::createUnallocatedBox(builder, loc, boxType, llvm::None); 5730 auto safeToReadBox = 5731 builder.create<mlir::arith::SelectOp>(loc, isPresent, box, emptyBox); 5732 return fir::substBase(exv, safeToReadBox); 5733 } 5734 5735 std::tuple<CC, mlir::Value, mlir::Type> 5736 genOptionalArrayFetch(const Fortran::lower::SomeExpr &expr) { 5737 assert(expr.Rank() > 0 && "expr must be an array"); 5738 mlir::Location loc = getLoc(); 5739 ExtValue optionalArg = asInquired(expr); 5740 mlir::Value isPresent = genActualIsPresentTest(builder, loc, optionalArg); 5741 // Generate an array load and access to an array that may be an absent 5742 // optional or an unallocated optional. 5743 mlir::Value base = getBase(optionalArg); 5744 const bool hasOptionalAttr = 5745 fir::valueHasFirAttribute(base, fir::getOptionalAttrName()); 5746 mlir::Type baseType = fir::unwrapRefType(base.getType()); 5747 const bool isBox = baseType.isa<fir::BoxType>(); 5748 const bool isAllocOrPtr = Fortran::evaluate::IsAllocatableOrPointerObject( 5749 expr, converter.getFoldingContext()); 5750 mlir::Type arrType = fir::unwrapPassByRefType(baseType); 5751 mlir::Type eleType = fir::unwrapSequenceType(arrType); 5752 ExtValue exv = optionalArg; 5753 if (hasOptionalAttr && isBox && !isAllocOrPtr) { 5754 // Elemental argument cannot be allocatable or pointers (C15100). 5755 // Hence, per 15.5.2.12 3 (8) and (9), the provided Allocatable and 5756 // Pointer optional arrays cannot be absent. The only kind of entities 5757 // that can get here are optional assumed shape and polymorphic entities. 5758 exv = absentBoxToUnalllocatedBox(builder, loc, exv, isPresent); 5759 } 5760 // All the properties can be read from any fir.box but the read values may 5761 // be undefined and should only be used inside a fir.if (canBeRead) region. 5762 if (const auto *mutableBox = exv.getBoxOf<fir::MutableBoxValue>()) 5763 exv = fir::factory::genMutableBoxRead(builder, loc, *mutableBox); 5764 5765 mlir::Value memref = fir::getBase(exv); 5766 mlir::Value shape = builder.createShape(loc, exv); 5767 mlir::Value noSlice; 5768 auto arrLoad = builder.create<fir::ArrayLoadOp>( 5769 loc, arrType, memref, shape, noSlice, fir::getTypeParams(exv)); 5770 mlir::Operation::operand_range arrLdTypeParams = arrLoad.getTypeparams(); 5771 mlir::Value arrLd = arrLoad.getResult(); 5772 // Mark the load to tell later passes it is unsafe to use this array_load 5773 // shape unconditionally. 5774 arrLoad->setAttr(fir::getOptionalAttrName(), builder.getUnitAttr()); 5775 5776 // Place the array as optional on the arrayOperands stack so that its 5777 // shape will only be used as a fallback to induce the implicit loop nest 5778 // (that is if there is no non optional array arguments). 5779 arrayOperands.push_back( 5780 ArrayOperand{memref, shape, noSlice, /*mayBeAbsent=*/true}); 5781 5782 // By value semantics. 5783 auto cc = [=](IterSpace iters) -> ExtValue { 5784 auto arrFetch = builder.create<fir::ArrayFetchOp>( 5785 loc, eleType, arrLd, iters.iterVec(), arrLdTypeParams); 5786 return fir::factory::arraySectionElementToExtendedValue( 5787 builder, loc, exv, arrFetch, noSlice); 5788 }; 5789 return {cc, isPresent, eleType}; 5790 } 5791 5792 /// Generate a continuation to pass \p expr to an OPTIONAL argument of an 5793 /// elemental procedure. This is meant to handle the cases where \p expr might 5794 /// be dynamically absent (i.e. when it is a POINTER, an ALLOCATABLE or an 5795 /// OPTIONAL variable). If p\ expr is guaranteed to be present genarr() can 5796 /// directly be called instead. 5797 CC genarrForwardOptionalArgumentToCall(const Fortran::lower::SomeExpr &expr) { 5798 mlir::Location loc = getLoc(); 5799 // Only by-value numerical and logical so far. 5800 if (semant != ConstituentSemantics::RefTransparent) 5801 TODO(loc, "optional arguments in user defined elemental procedures"); 5802 5803 // Handle scalar argument case (the if-then-else is generated outside of the 5804 // implicit loop nest). 5805 if (expr.Rank() == 0) { 5806 ExtValue optionalArg = asInquired(expr); 5807 mlir::Value isPresent = genActualIsPresentTest(builder, loc, optionalArg); 5808 mlir::Value elementValue = 5809 fir::getBase(genOptionalValue(builder, loc, optionalArg, isPresent)); 5810 return [=](IterSpace iters) -> ExtValue { return elementValue; }; 5811 } 5812 5813 CC cc; 5814 mlir::Value isPresent; 5815 mlir::Type eleType; 5816 std::tie(cc, isPresent, eleType) = genOptionalArrayFetch(expr); 5817 return [=](IterSpace iters) -> ExtValue { 5818 mlir::Value elementValue = 5819 builder 5820 .genIfOp(loc, {eleType}, isPresent, 5821 /*withElseRegion=*/true) 5822 .genThen([&]() { 5823 builder.create<fir::ResultOp>(loc, fir::getBase(cc(iters))); 5824 }) 5825 .genElse([&]() { 5826 mlir::Value zero = 5827 fir::factory::createZeroValue(builder, loc, eleType); 5828 builder.create<fir::ResultOp>(loc, zero); 5829 }) 5830 .getResults()[0]; 5831 return elementValue; 5832 }; 5833 } 5834 5835 /// Reduce the rank of a array to be boxed based on the slice's operands. 5836 static mlir::Type reduceRank(mlir::Type arrTy, mlir::Value slice) { 5837 if (slice) { 5838 auto slOp = mlir::dyn_cast<fir::SliceOp>(slice.getDefiningOp()); 5839 assert(slOp && "expected slice op"); 5840 auto seqTy = arrTy.dyn_cast<fir::SequenceType>(); 5841 assert(seqTy && "expected array type"); 5842 mlir::Operation::operand_range triples = slOp.getTriples(); 5843 fir::SequenceType::Shape shape; 5844 // reduce the rank for each invariant dimension 5845 for (unsigned i = 1, end = triples.size(); i < end; i += 3) 5846 if (!mlir::isa_and_nonnull<fir::UndefOp>(triples[i].getDefiningOp())) 5847 shape.push_back(fir::SequenceType::getUnknownExtent()); 5848 return fir::SequenceType::get(shape, seqTy.getEleTy()); 5849 } 5850 // not sliced, so no change in rank 5851 return arrTy; 5852 } 5853 5854 CC genarr(const Fortran::evaluate::ComplexPart &x, 5855 ComponentPath &components) { 5856 TODO(getLoc(), "genarr ComplexPart"); 5857 } 5858 5859 CC genarr(const Fortran::evaluate::StaticDataObject::Pointer &, 5860 ComponentPath &components) { 5861 TODO(getLoc(), "genarr StaticDataObject::Pointer"); 5862 } 5863 5864 /// Substrings (see 9.4.1) 5865 CC genarr(const Fortran::evaluate::Substring &x, ComponentPath &components) { 5866 TODO(getLoc(), "genarr Substring"); 5867 } 5868 5869 /// Base case of generating an array reference, 5870 CC genarr(const ExtValue &extMemref, ComponentPath &components) { 5871 mlir::Location loc = getLoc(); 5872 mlir::Value memref = fir::getBase(extMemref); 5873 mlir::Type arrTy = fir::dyn_cast_ptrOrBoxEleTy(memref.getType()); 5874 assert(arrTy.isa<fir::SequenceType>() && "memory ref must be an array"); 5875 mlir::Value shape = builder.createShape(loc, extMemref); 5876 mlir::Value slice; 5877 if (components.isSlice()) { 5878 if (isBoxValue() && components.substring) { 5879 // Append the substring operator to emboxing Op as it will become an 5880 // interior adjustment (add offset, adjust LEN) to the CHARACTER value 5881 // being referenced in the descriptor. 5882 llvm::SmallVector<mlir::Value> substringBounds; 5883 populateBounds(substringBounds, components.substring); 5884 // Convert to (offset, size) 5885 mlir::Type iTy = substringBounds[0].getType(); 5886 if (substringBounds.size() != 2) { 5887 fir::CharacterType charTy = 5888 fir::factory::CharacterExprHelper::getCharType(arrTy); 5889 if (charTy.hasConstantLen()) { 5890 mlir::IndexType idxTy = builder.getIndexType(); 5891 fir::CharacterType::LenType charLen = charTy.getLen(); 5892 mlir::Value lenValue = 5893 builder.createIntegerConstant(loc, idxTy, charLen); 5894 substringBounds.push_back(lenValue); 5895 } else { 5896 llvm::SmallVector<mlir::Value> typeparams = 5897 fir::getTypeParams(extMemref); 5898 substringBounds.push_back(typeparams.back()); 5899 } 5900 } 5901 // Convert the lower bound to 0-based substring. 5902 mlir::Value one = 5903 builder.createIntegerConstant(loc, substringBounds[0].getType(), 1); 5904 substringBounds[0] = 5905 builder.create<mlir::arith::SubIOp>(loc, substringBounds[0], one); 5906 // Convert the upper bound to a length. 5907 mlir::Value cast = builder.createConvert(loc, iTy, substringBounds[1]); 5908 mlir::Value zero = builder.createIntegerConstant(loc, iTy, 0); 5909 auto size = 5910 builder.create<mlir::arith::SubIOp>(loc, cast, substringBounds[0]); 5911 auto cmp = builder.create<mlir::arith::CmpIOp>( 5912 loc, mlir::arith::CmpIPredicate::sgt, size, zero); 5913 // size = MAX(upper - (lower - 1), 0) 5914 substringBounds[1] = 5915 builder.create<mlir::arith::SelectOp>(loc, cmp, size, zero); 5916 slice = builder.create<fir::SliceOp>(loc, components.trips, 5917 components.suffixComponents, 5918 substringBounds); 5919 } else { 5920 slice = builder.createSlice(loc, extMemref, components.trips, 5921 components.suffixComponents); 5922 } 5923 if (components.hasComponents()) { 5924 auto seqTy = arrTy.cast<fir::SequenceType>(); 5925 mlir::Type eleTy = 5926 fir::applyPathToType(seqTy.getEleTy(), components.suffixComponents); 5927 if (!eleTy) 5928 fir::emitFatalError(loc, "slicing path is ill-formed"); 5929 if (auto realTy = eleTy.dyn_cast<fir::RealType>()) 5930 eleTy = Fortran::lower::convertReal(realTy.getContext(), 5931 realTy.getFKind()); 5932 5933 // create the type of the projected array. 5934 arrTy = fir::SequenceType::get(seqTy.getShape(), eleTy); 5935 LLVM_DEBUG(llvm::dbgs() 5936 << "type of array projection from component slicing: " 5937 << eleTy << ", " << arrTy << '\n'); 5938 } 5939 } 5940 arrayOperands.push_back(ArrayOperand{memref, shape, slice}); 5941 if (destShape.empty()) 5942 destShape = getShape(arrayOperands.back()); 5943 if (isBoxValue()) { 5944 // Semantics are a reference to a boxed array. 5945 // This case just requires that an embox operation be created to box the 5946 // value. The value of the box is forwarded in the continuation. 5947 mlir::Type reduceTy = reduceRank(arrTy, slice); 5948 auto boxTy = fir::BoxType::get(reduceTy); 5949 if (components.substring) { 5950 // Adjust char length to substring size. 5951 fir::CharacterType charTy = 5952 fir::factory::CharacterExprHelper::getCharType(reduceTy); 5953 auto seqTy = reduceTy.cast<fir::SequenceType>(); 5954 // TODO: Use a constant for fir.char LEN if we can compute it. 5955 boxTy = fir::BoxType::get( 5956 fir::SequenceType::get(fir::CharacterType::getUnknownLen( 5957 builder.getContext(), charTy.getFKind()), 5958 seqTy.getDimension())); 5959 } 5960 mlir::Value embox = 5961 memref.getType().isa<fir::BoxType>() 5962 ? builder.create<fir::ReboxOp>(loc, boxTy, memref, shape, slice) 5963 .getResult() 5964 : builder 5965 .create<fir::EmboxOp>(loc, boxTy, memref, shape, slice, 5966 fir::getTypeParams(extMemref)) 5967 .getResult(); 5968 return [=](IterSpace) -> ExtValue { return fir::BoxValue(embox); }; 5969 } 5970 auto eleTy = arrTy.cast<fir::SequenceType>().getEleTy(); 5971 if (isReferentiallyOpaque()) { 5972 // Semantics are an opaque reference to an array. 5973 // This case forwards a continuation that will generate the address 5974 // arithmetic to the array element. This does not have copy-in/copy-out 5975 // semantics. No attempt to copy the array value will be made during the 5976 // interpretation of the Fortran statement. 5977 mlir::Type refEleTy = builder.getRefType(eleTy); 5978 return [=](IterSpace iters) -> ExtValue { 5979 // ArrayCoorOp does not expect zero based indices. 5980 llvm::SmallVector<mlir::Value> indices = fir::factory::originateIndices( 5981 loc, builder, memref.getType(), shape, iters.iterVec()); 5982 mlir::Value coor = builder.create<fir::ArrayCoorOp>( 5983 loc, refEleTy, memref, shape, slice, indices, 5984 fir::getTypeParams(extMemref)); 5985 if (auto charTy = eleTy.dyn_cast<fir::CharacterType>()) { 5986 llvm::SmallVector<mlir::Value> substringBounds; 5987 populateBounds(substringBounds, components.substring); 5988 if (!substringBounds.empty()) { 5989 mlir::Value dstLen = fir::factory::genLenOfCharacter( 5990 builder, loc, arrTy.cast<fir::SequenceType>(), memref, 5991 fir::getTypeParams(extMemref), iters.iterVec(), 5992 substringBounds); 5993 fir::CharBoxValue dstChar(coor, dstLen); 5994 return fir::factory::CharacterExprHelper{builder, loc} 5995 .createSubstring(dstChar, substringBounds); 5996 } 5997 } 5998 return fir::factory::arraySectionElementToExtendedValue( 5999 builder, loc, extMemref, coor, slice); 6000 }; 6001 } 6002 auto arrLoad = builder.create<fir::ArrayLoadOp>( 6003 loc, arrTy, memref, shape, slice, fir::getTypeParams(extMemref)); 6004 mlir::Value arrLd = arrLoad.getResult(); 6005 if (isProjectedCopyInCopyOut()) { 6006 // Semantics are projected copy-in copy-out. 6007 // The backing store of the destination of an array expression may be 6008 // partially modified. These updates are recorded in FIR by forwarding a 6009 // continuation that generates an `array_update` Op. The destination is 6010 // always loaded at the beginning of the statement and merged at the 6011 // end. 6012 destination = arrLoad; 6013 auto lambda = ccStoreToDest.hasValue() 6014 ? ccStoreToDest.getValue() 6015 : defaultStoreToDestination(components.substring); 6016 return [=](IterSpace iters) -> ExtValue { return lambda(iters); }; 6017 } 6018 if (isCustomCopyInCopyOut()) { 6019 // Create an array_modify to get the LHS element address and indicate 6020 // the assignment, the actual assignment must be implemented in 6021 // ccStoreToDest. 6022 destination = arrLoad; 6023 return [=](IterSpace iters) -> ExtValue { 6024 mlir::Value innerArg = iters.innerArgument(); 6025 mlir::Type resTy = innerArg.getType(); 6026 mlir::Type eleTy = fir::applyPathToType(resTy, iters.iterVec()); 6027 mlir::Type refEleTy = 6028 fir::isa_ref_type(eleTy) ? eleTy : builder.getRefType(eleTy); 6029 auto arrModify = builder.create<fir::ArrayModifyOp>( 6030 loc, mlir::TypeRange{refEleTy, resTy}, innerArg, iters.iterVec(), 6031 destination.getTypeparams()); 6032 return abstractArrayExtValue(arrModify.getResult(1)); 6033 }; 6034 } 6035 if (isCopyInCopyOut()) { 6036 // Semantics are copy-in copy-out. 6037 // The continuation simply forwards the result of the `array_load` Op, 6038 // which is the value of the array as it was when loaded. All data 6039 // references with rank > 0 in an array expression typically have 6040 // copy-in copy-out semantics. 6041 return [=](IterSpace) -> ExtValue { return arrLd; }; 6042 } 6043 mlir::Operation::operand_range arrLdTypeParams = arrLoad.getTypeparams(); 6044 if (isValueAttribute()) { 6045 // Semantics are value attribute. 6046 // Here the continuation will `array_fetch` a value from an array and 6047 // then store that value in a temporary. One can thus imitate pass by 6048 // value even when the call is pass by reference. 6049 return [=](IterSpace iters) -> ExtValue { 6050 mlir::Value base; 6051 mlir::Type eleTy = fir::applyPathToType(arrTy, iters.iterVec()); 6052 if (isAdjustedArrayElementType(eleTy)) { 6053 mlir::Type eleRefTy = builder.getRefType(eleTy); 6054 base = builder.create<fir::ArrayAccessOp>( 6055 loc, eleRefTy, arrLd, iters.iterVec(), arrLdTypeParams); 6056 } else { 6057 base = builder.create<fir::ArrayFetchOp>( 6058 loc, eleTy, arrLd, iters.iterVec(), arrLdTypeParams); 6059 } 6060 mlir::Value temp = builder.createTemporary( 6061 loc, base.getType(), 6062 llvm::ArrayRef<mlir::NamedAttribute>{ 6063 Fortran::lower::getAdaptToByRefAttr(builder)}); 6064 builder.create<fir::StoreOp>(loc, base, temp); 6065 return fir::factory::arraySectionElementToExtendedValue( 6066 builder, loc, extMemref, temp, slice); 6067 }; 6068 } 6069 // In the default case, the array reference forwards an `array_fetch` or 6070 // `array_access` Op in the continuation. 6071 return [=](IterSpace iters) -> ExtValue { 6072 mlir::Type eleTy = fir::applyPathToType(arrTy, iters.iterVec()); 6073 if (isAdjustedArrayElementType(eleTy)) { 6074 mlir::Type eleRefTy = builder.getRefType(eleTy); 6075 mlir::Value arrayOp = builder.create<fir::ArrayAccessOp>( 6076 loc, eleRefTy, arrLd, iters.iterVec(), arrLdTypeParams); 6077 if (auto charTy = eleTy.dyn_cast<fir::CharacterType>()) { 6078 llvm::SmallVector<mlir::Value> substringBounds; 6079 populateBounds(substringBounds, components.substring); 6080 if (!substringBounds.empty()) { 6081 mlir::Value dstLen = fir::factory::genLenOfCharacter( 6082 builder, loc, arrLoad, iters.iterVec(), substringBounds); 6083 fir::CharBoxValue dstChar(arrayOp, dstLen); 6084 return fir::factory::CharacterExprHelper{builder, loc} 6085 .createSubstring(dstChar, substringBounds); 6086 } 6087 } 6088 return fir::factory::arraySectionElementToExtendedValue( 6089 builder, loc, extMemref, arrayOp, slice); 6090 } 6091 auto arrFetch = builder.create<fir::ArrayFetchOp>( 6092 loc, eleTy, arrLd, iters.iterVec(), arrLdTypeParams); 6093 return fir::factory::arraySectionElementToExtendedValue( 6094 builder, loc, extMemref, arrFetch, slice); 6095 }; 6096 } 6097 6098 private: 6099 void determineShapeOfDest(const fir::ExtendedValue &lhs) { 6100 destShape = fir::factory::getExtents(builder, getLoc(), lhs); 6101 } 6102 6103 void determineShapeOfDest(const Fortran::lower::SomeExpr &lhs) { 6104 if (!destShape.empty()) 6105 return; 6106 if (explicitSpaceIsActive() && determineShapeWithSlice(lhs)) 6107 return; 6108 mlir::Type idxTy = builder.getIndexType(); 6109 mlir::Location loc = getLoc(); 6110 if (std::optional<Fortran::evaluate::ConstantSubscripts> constantShape = 6111 Fortran::evaluate::GetConstantExtents(converter.getFoldingContext(), 6112 lhs)) 6113 for (Fortran::common::ConstantSubscript extent : *constantShape) 6114 destShape.push_back(builder.createIntegerConstant(loc, idxTy, extent)); 6115 } 6116 6117 bool genShapeFromDataRef(const Fortran::semantics::Symbol &x) { 6118 return false; 6119 } 6120 bool genShapeFromDataRef(const Fortran::evaluate::CoarrayRef &) { 6121 TODO(getLoc(), "coarray ref"); 6122 return false; 6123 } 6124 bool genShapeFromDataRef(const Fortran::evaluate::Component &x) { 6125 return x.base().Rank() > 0 ? genShapeFromDataRef(x.base()) : false; 6126 } 6127 bool genShapeFromDataRef(const Fortran::evaluate::ArrayRef &x) { 6128 if (x.Rank() == 0) 6129 return false; 6130 if (x.base().Rank() > 0) 6131 if (genShapeFromDataRef(x.base())) 6132 return true; 6133 // x has rank and x.base did not produce a shape. 6134 ExtValue exv = x.base().IsSymbol() ? asScalarRef(getFirstSym(x.base())) 6135 : asScalarRef(x.base().GetComponent()); 6136 mlir::Location loc = getLoc(); 6137 mlir::IndexType idxTy = builder.getIndexType(); 6138 llvm::SmallVector<mlir::Value> definedShape = 6139 fir::factory::getExtents(builder, loc, exv); 6140 mlir::Value one = builder.createIntegerConstant(loc, idxTy, 1); 6141 for (auto ss : llvm::enumerate(x.subscript())) { 6142 std::visit(Fortran::common::visitors{ 6143 [&](const Fortran::evaluate::Triplet &trip) { 6144 // For a subscript of triple notation, we compute the 6145 // range of this dimension of the iteration space. 6146 auto lo = [&]() { 6147 if (auto optLo = trip.lower()) 6148 return fir::getBase(asScalar(*optLo)); 6149 return getLBound(exv, ss.index(), one); 6150 }(); 6151 auto hi = [&]() { 6152 if (auto optHi = trip.upper()) 6153 return fir::getBase(asScalar(*optHi)); 6154 return getUBound(exv, ss.index(), one); 6155 }(); 6156 auto step = builder.createConvert( 6157 loc, idxTy, fir::getBase(asScalar(trip.stride()))); 6158 auto extent = builder.genExtentFromTriplet(loc, lo, hi, 6159 step, idxTy); 6160 destShape.push_back(extent); 6161 }, 6162 [&](auto) {}}, 6163 ss.value().u); 6164 } 6165 return true; 6166 } 6167 bool genShapeFromDataRef(const Fortran::evaluate::NamedEntity &x) { 6168 if (x.IsSymbol()) 6169 return genShapeFromDataRef(getFirstSym(x)); 6170 return genShapeFromDataRef(x.GetComponent()); 6171 } 6172 bool genShapeFromDataRef(const Fortran::evaluate::DataRef &x) { 6173 return std::visit([&](const auto &v) { return genShapeFromDataRef(v); }, 6174 x.u); 6175 } 6176 6177 /// When in an explicit space, the ranked component must be evaluated to 6178 /// determine the actual number of iterations when slicing triples are 6179 /// present. Lower these expressions here. 6180 bool determineShapeWithSlice(const Fortran::lower::SomeExpr &lhs) { 6181 LLVM_DEBUG(Fortran::lower::DumpEvaluateExpr::dump( 6182 llvm::dbgs() << "determine shape of:\n", lhs)); 6183 // FIXME: We may not want to use ExtractDataRef here since it doesn't deal 6184 // with substrings, etc. 6185 std::optional<Fortran::evaluate::DataRef> dref = 6186 Fortran::evaluate::ExtractDataRef(lhs); 6187 return dref.has_value() ? genShapeFromDataRef(*dref) : false; 6188 } 6189 6190 ExtValue lowerArrayExpression(const Fortran::lower::SomeExpr &exp) { 6191 mlir::Type resTy = converter.genType(exp); 6192 return std::visit( 6193 [&](const auto &e) { return lowerArrayExpression(genarr(e), resTy); }, 6194 exp.u); 6195 } 6196 ExtValue lowerArrayExpression(const ExtValue &exv) { 6197 assert(!explicitSpace); 6198 mlir::Type resTy = fir::unwrapPassByRefType(fir::getBase(exv).getType()); 6199 return lowerArrayExpression(genarr(exv), resTy); 6200 } 6201 6202 void populateBounds(llvm::SmallVectorImpl<mlir::Value> &bounds, 6203 const Fortran::evaluate::Substring *substring) { 6204 if (!substring) 6205 return; 6206 bounds.push_back(fir::getBase(asScalar(substring->lower()))); 6207 if (auto upper = substring->upper()) 6208 bounds.push_back(fir::getBase(asScalar(*upper))); 6209 } 6210 6211 /// Default store to destination implementation. 6212 /// This implements the default case, which is to assign the value in 6213 /// `iters.element` into the destination array, `iters.innerArgument`. Handles 6214 /// by value and by reference assignment. 6215 CC defaultStoreToDestination(const Fortran::evaluate::Substring *substring) { 6216 return [=](IterSpace iterSpace) -> ExtValue { 6217 mlir::Location loc = getLoc(); 6218 mlir::Value innerArg = iterSpace.innerArgument(); 6219 fir::ExtendedValue exv = iterSpace.elementExv(); 6220 mlir::Type arrTy = innerArg.getType(); 6221 mlir::Type eleTy = fir::applyPathToType(arrTy, iterSpace.iterVec()); 6222 if (isAdjustedArrayElementType(eleTy)) { 6223 // The elemental update is in the memref domain. Under this semantics, 6224 // we must always copy the computed new element from its location in 6225 // memory into the destination array. 6226 mlir::Type resRefTy = builder.getRefType(eleTy); 6227 // Get a reference to the array element to be amended. 6228 auto arrayOp = builder.create<fir::ArrayAccessOp>( 6229 loc, resRefTy, innerArg, iterSpace.iterVec(), 6230 destination.getTypeparams()); 6231 if (auto charTy = eleTy.dyn_cast<fir::CharacterType>()) { 6232 llvm::SmallVector<mlir::Value> substringBounds; 6233 populateBounds(substringBounds, substring); 6234 mlir::Value dstLen = fir::factory::genLenOfCharacter( 6235 builder, loc, destination, iterSpace.iterVec(), substringBounds); 6236 fir::ArrayAmendOp amend = createCharArrayAmend( 6237 loc, builder, arrayOp, dstLen, exv, innerArg, substringBounds); 6238 return abstractArrayExtValue(amend, dstLen); 6239 } 6240 if (fir::isa_derived(eleTy)) { 6241 fir::ArrayAmendOp amend = createDerivedArrayAmend( 6242 loc, destination, builder, arrayOp, exv, eleTy, innerArg); 6243 return abstractArrayExtValue(amend /*FIXME: typeparams?*/); 6244 } 6245 assert(eleTy.isa<fir::SequenceType>() && "must be an array"); 6246 TODO(loc, "array (as element) assignment"); 6247 } 6248 // By value semantics. The element is being assigned by value. 6249 mlir::Value ele = builder.createConvert(loc, eleTy, fir::getBase(exv)); 6250 auto update = builder.create<fir::ArrayUpdateOp>( 6251 loc, arrTy, innerArg, ele, iterSpace.iterVec(), 6252 destination.getTypeparams()); 6253 return abstractArrayExtValue(update); 6254 }; 6255 } 6256 6257 /// For an elemental array expression. 6258 /// 1. Lower the scalars and array loads. 6259 /// 2. Create the iteration space. 6260 /// 3. Create the element-by-element computation in the loop. 6261 /// 4. Return the resulting array value. 6262 /// If no destination was set in the array context, a temporary of 6263 /// \p resultTy will be created to hold the evaluated expression. 6264 /// Otherwise, \p resultTy is ignored and the expression is evaluated 6265 /// in the destination. \p f is a continuation built from an 6266 /// evaluate::Expr or an ExtendedValue. 6267 ExtValue lowerArrayExpression(CC f, mlir::Type resultTy) { 6268 mlir::Location loc = getLoc(); 6269 auto [iterSpace, insPt] = genIterSpace(resultTy); 6270 auto exv = f(iterSpace); 6271 iterSpace.setElement(std::move(exv)); 6272 auto lambda = ccStoreToDest.hasValue() 6273 ? ccStoreToDest.getValue() 6274 : defaultStoreToDestination(/*substring=*/nullptr); 6275 mlir::Value updVal = fir::getBase(lambda(iterSpace)); 6276 finalizeElementCtx(); 6277 builder.create<fir::ResultOp>(loc, updVal); 6278 builder.restoreInsertionPoint(insPt); 6279 return abstractArrayExtValue(iterSpace.outerResult()); 6280 } 6281 6282 /// Compute the shape of a slice. 6283 llvm::SmallVector<mlir::Value> computeSliceShape(mlir::Value slice) { 6284 llvm::SmallVector<mlir::Value> slicedShape; 6285 auto slOp = mlir::cast<fir::SliceOp>(slice.getDefiningOp()); 6286 mlir::Operation::operand_range triples = slOp.getTriples(); 6287 mlir::IndexType idxTy = builder.getIndexType(); 6288 mlir::Location loc = getLoc(); 6289 for (unsigned i = 0, end = triples.size(); i < end; i += 3) { 6290 if (!mlir::isa_and_nonnull<fir::UndefOp>( 6291 triples[i + 1].getDefiningOp())) { 6292 // (..., lb:ub:step, ...) case: extent = max((ub-lb+step)/step, 0) 6293 // See Fortran 2018 9.5.3.3.2 section for more details. 6294 mlir::Value res = builder.genExtentFromTriplet( 6295 loc, triples[i], triples[i + 1], triples[i + 2], idxTy); 6296 slicedShape.emplace_back(res); 6297 } else { 6298 // do nothing. `..., i, ...` case, so dimension is dropped. 6299 } 6300 } 6301 return slicedShape; 6302 } 6303 6304 /// Get the shape from an ArrayOperand. The shape of the array is adjusted if 6305 /// the array was sliced. 6306 llvm::SmallVector<mlir::Value> getShape(ArrayOperand array) { 6307 if (array.slice) 6308 return computeSliceShape(array.slice); 6309 if (array.memref.getType().isa<fir::BoxType>()) 6310 return fir::factory::readExtents(builder, getLoc(), 6311 fir::BoxValue{array.memref}); 6312 std::vector<mlir::Value, std::allocator<mlir::Value>> extents = 6313 fir::factory::getExtents(array.shape); 6314 return {extents.begin(), extents.end()}; 6315 } 6316 6317 /// Get the shape from an ArrayLoad. 6318 llvm::SmallVector<mlir::Value> getShape(fir::ArrayLoadOp arrayLoad) { 6319 return getShape(ArrayOperand{arrayLoad.getMemref(), arrayLoad.getShape(), 6320 arrayLoad.getSlice()}); 6321 } 6322 6323 /// Returns the first array operand that may not be absent. If all 6324 /// array operands may be absent, return the first one. 6325 const ArrayOperand &getInducingShapeArrayOperand() const { 6326 assert(!arrayOperands.empty()); 6327 for (const ArrayOperand &op : arrayOperands) 6328 if (!op.mayBeAbsent) 6329 return op; 6330 // If all arrays operand appears in optional position, then none of them 6331 // is allowed to be absent as per 15.5.2.12 point 3. (6). Just pick the 6332 // first operands. 6333 // TODO: There is an opportunity to add a runtime check here that 6334 // this array is present as required. 6335 return arrayOperands[0]; 6336 } 6337 6338 /// Generate the shape of the iteration space over the array expression. The 6339 /// iteration space may be implicit, explicit, or both. If it is implied it is 6340 /// based on the destination and operand array loads, or an optional 6341 /// Fortran::evaluate::Shape from the front end. If the shape is explicit, 6342 /// this returns any implicit shape component, if it exists. 6343 llvm::SmallVector<mlir::Value> genIterationShape() { 6344 // Use the precomputed destination shape. 6345 if (!destShape.empty()) 6346 return destShape; 6347 // Otherwise, use the destination's shape. 6348 if (destination) 6349 return getShape(destination); 6350 // Otherwise, use the first ArrayLoad operand shape. 6351 if (!arrayOperands.empty()) 6352 return getShape(getInducingShapeArrayOperand()); 6353 fir::emitFatalError(getLoc(), 6354 "failed to compute the array expression shape"); 6355 } 6356 6357 explicit ArrayExprLowering(Fortran::lower::AbstractConverter &converter, 6358 Fortran::lower::StatementContext &stmtCtx, 6359 Fortran::lower::SymMap &symMap) 6360 : converter{converter}, builder{converter.getFirOpBuilder()}, 6361 stmtCtx{stmtCtx}, symMap{symMap} {} 6362 6363 explicit ArrayExprLowering(Fortran::lower::AbstractConverter &converter, 6364 Fortran::lower::StatementContext &stmtCtx, 6365 Fortran::lower::SymMap &symMap, 6366 ConstituentSemantics sem) 6367 : converter{converter}, builder{converter.getFirOpBuilder()}, 6368 stmtCtx{stmtCtx}, symMap{symMap}, semant{sem} {} 6369 6370 explicit ArrayExprLowering(Fortran::lower::AbstractConverter &converter, 6371 Fortran::lower::StatementContext &stmtCtx, 6372 Fortran::lower::SymMap &symMap, 6373 ConstituentSemantics sem, 6374 Fortran::lower::ExplicitIterSpace *expSpace, 6375 Fortran::lower::ImplicitIterSpace *impSpace) 6376 : converter{converter}, builder{converter.getFirOpBuilder()}, 6377 stmtCtx{stmtCtx}, symMap{symMap}, 6378 explicitSpace(expSpace->isActive() ? expSpace : nullptr), 6379 implicitSpace(impSpace->empty() ? nullptr : impSpace), semant{sem} { 6380 // Generate any mask expressions, as necessary. This is the compute step 6381 // that creates the effective masks. See 10.2.3.2 in particular. 6382 genMasks(); 6383 } 6384 6385 mlir::Location getLoc() { return converter.getCurrentLocation(); } 6386 6387 /// Array appears in a lhs context such that it is assigned after the rhs is 6388 /// fully evaluated. 6389 inline bool isCopyInCopyOut() { 6390 return semant == ConstituentSemantics::CopyInCopyOut; 6391 } 6392 6393 /// Array appears in a lhs (or temp) context such that a projected, 6394 /// discontiguous subspace of the array is assigned after the rhs is fully 6395 /// evaluated. That is, the rhs array value is merged into a section of the 6396 /// lhs array. 6397 inline bool isProjectedCopyInCopyOut() { 6398 return semant == ConstituentSemantics::ProjectedCopyInCopyOut; 6399 } 6400 6401 inline bool isCustomCopyInCopyOut() { 6402 return semant == ConstituentSemantics::CustomCopyInCopyOut; 6403 } 6404 6405 /// Array appears in a context where it must be boxed. 6406 inline bool isBoxValue() { return semant == ConstituentSemantics::BoxValue; } 6407 6408 /// Array appears in a context where differences in the memory reference can 6409 /// be observable in the computational results. For example, an array 6410 /// element is passed to an impure procedure. 6411 inline bool isReferentiallyOpaque() { 6412 return semant == ConstituentSemantics::RefOpaque; 6413 } 6414 6415 /// Array appears in a context where it is passed as a VALUE argument. 6416 inline bool isValueAttribute() { 6417 return semant == ConstituentSemantics::ByValueArg; 6418 } 6419 6420 /// Can the loops over the expression be unordered? 6421 inline bool isUnordered() const { return unordered; } 6422 6423 void setUnordered(bool b) { unordered = b; } 6424 6425 Fortran::lower::AbstractConverter &converter; 6426 fir::FirOpBuilder &builder; 6427 Fortran::lower::StatementContext &stmtCtx; 6428 bool elementCtx = false; 6429 Fortran::lower::SymMap &symMap; 6430 /// The continuation to generate code to update the destination. 6431 llvm::Optional<CC> ccStoreToDest; 6432 llvm::Optional<std::function<void(llvm::ArrayRef<mlir::Value>)>> ccPrelude; 6433 llvm::Optional<std::function<fir::ArrayLoadOp(llvm::ArrayRef<mlir::Value>)>> 6434 ccLoadDest; 6435 /// The destination is the loaded array into which the results will be 6436 /// merged. 6437 fir::ArrayLoadOp destination; 6438 /// The shape of the destination. 6439 llvm::SmallVector<mlir::Value> destShape; 6440 /// List of arrays in the expression that have been loaded. 6441 llvm::SmallVector<ArrayOperand> arrayOperands; 6442 /// If there is a user-defined iteration space, explicitShape will hold the 6443 /// information from the front end. 6444 Fortran::lower::ExplicitIterSpace *explicitSpace = nullptr; 6445 Fortran::lower::ImplicitIterSpace *implicitSpace = nullptr; 6446 ConstituentSemantics semant = ConstituentSemantics::RefTransparent; 6447 // Can the array expression be evaluated in any order? 6448 // Will be set to false if any of the expression parts prevent this. 6449 bool unordered = true; 6450 }; 6451 } // namespace 6452 6453 fir::ExtendedValue Fortran::lower::createSomeExtendedExpression( 6454 mlir::Location loc, Fortran::lower::AbstractConverter &converter, 6455 const Fortran::lower::SomeExpr &expr, Fortran::lower::SymMap &symMap, 6456 Fortran::lower::StatementContext &stmtCtx) { 6457 LLVM_DEBUG(expr.AsFortran(llvm::dbgs() << "expr: ") << '\n'); 6458 return ScalarExprLowering{loc, converter, symMap, stmtCtx}.genval(expr); 6459 } 6460 6461 fir::GlobalOp Fortran::lower::createDenseGlobal( 6462 mlir::Location loc, mlir::Type symTy, llvm::StringRef globalName, 6463 mlir::StringAttr linkage, bool isConst, 6464 const Fortran::lower::SomeExpr &expr, 6465 Fortran::lower::AbstractConverter &converter) { 6466 6467 Fortran::lower::StatementContext stmtCtx(/*prohibited=*/true); 6468 Fortran::lower::SymMap emptyMap; 6469 InitializerData initData(/*genRawVals=*/true); 6470 ScalarExprLowering sel(loc, converter, emptyMap, stmtCtx, 6471 /*initializer=*/&initData); 6472 sel.genval(expr); 6473 6474 size_t sz = initData.rawVals.size(); 6475 llvm::ArrayRef<mlir::Attribute> ar = {initData.rawVals.data(), sz}; 6476 6477 mlir::RankedTensorType tensorTy; 6478 auto &builder = converter.getFirOpBuilder(); 6479 mlir::Type iTy = initData.rawType; 6480 if (!iTy) 6481 return 0; // array extent is probably 0 in this case, so just return 0. 6482 tensorTy = mlir::RankedTensorType::get(sz, iTy); 6483 auto init = mlir::DenseElementsAttr::get(tensorTy, ar); 6484 return builder.createGlobal(loc, symTy, globalName, linkage, init, isConst); 6485 } 6486 6487 fir::ExtendedValue Fortran::lower::createSomeInitializerExpression( 6488 mlir::Location loc, Fortran::lower::AbstractConverter &converter, 6489 const Fortran::lower::SomeExpr &expr, Fortran::lower::SymMap &symMap, 6490 Fortran::lower::StatementContext &stmtCtx) { 6491 LLVM_DEBUG(expr.AsFortran(llvm::dbgs() << "expr: ") << '\n'); 6492 InitializerData initData; // needed for initializations 6493 return ScalarExprLowering{loc, converter, symMap, stmtCtx, 6494 /*initializer=*/&initData} 6495 .genval(expr); 6496 } 6497 6498 fir::ExtendedValue Fortran::lower::createSomeExtendedAddress( 6499 mlir::Location loc, Fortran::lower::AbstractConverter &converter, 6500 const Fortran::lower::SomeExpr &expr, Fortran::lower::SymMap &symMap, 6501 Fortran::lower::StatementContext &stmtCtx) { 6502 LLVM_DEBUG(expr.AsFortran(llvm::dbgs() << "address: ") << '\n'); 6503 return ScalarExprLowering{loc, converter, symMap, stmtCtx}.gen(expr); 6504 } 6505 6506 fir::ExtendedValue Fortran::lower::createInitializerAddress( 6507 mlir::Location loc, Fortran::lower::AbstractConverter &converter, 6508 const Fortran::lower::SomeExpr &expr, Fortran::lower::SymMap &symMap, 6509 Fortran::lower::StatementContext &stmtCtx) { 6510 LLVM_DEBUG(expr.AsFortran(llvm::dbgs() << "address: ") << '\n'); 6511 InitializerData init; 6512 return ScalarExprLowering(loc, converter, symMap, stmtCtx, &init).gen(expr); 6513 } 6514 6515 fir::ExtendedValue 6516 Fortran::lower::createSomeArrayBox(Fortran::lower::AbstractConverter &converter, 6517 const Fortran::lower::SomeExpr &expr, 6518 Fortran::lower::SymMap &symMap, 6519 Fortran::lower::StatementContext &stmtCtx) { 6520 LLVM_DEBUG(expr.AsFortran(llvm::dbgs() << "box designator: ") << '\n'); 6521 return ArrayExprLowering::lowerBoxedArrayExpression(converter, symMap, 6522 stmtCtx, expr); 6523 } 6524 6525 fir::MutableBoxValue Fortran::lower::createMutableBox( 6526 mlir::Location loc, Fortran::lower::AbstractConverter &converter, 6527 const Fortran::lower::SomeExpr &expr, Fortran::lower::SymMap &symMap) { 6528 // MutableBox lowering StatementContext does not need to be propagated 6529 // to the caller because the result value is a variable, not a temporary 6530 // expression. The StatementContext clean-up can occur before using the 6531 // resulting MutableBoxValue. Variables of all other types are handled in the 6532 // bridge. 6533 Fortran::lower::StatementContext dummyStmtCtx; 6534 return ScalarExprLowering{loc, converter, symMap, dummyStmtCtx} 6535 .genMutableBoxValue(expr); 6536 } 6537 6538 fir::ExtendedValue Fortran::lower::createBoxValue( 6539 mlir::Location loc, Fortran::lower::AbstractConverter &converter, 6540 const Fortran::lower::SomeExpr &expr, Fortran::lower::SymMap &symMap, 6541 Fortran::lower::StatementContext &stmtCtx) { 6542 if (expr.Rank() > 0 && Fortran::evaluate::IsVariable(expr) && 6543 !Fortran::evaluate::HasVectorSubscript(expr)) 6544 return Fortran::lower::createSomeArrayBox(converter, expr, symMap, stmtCtx); 6545 fir::ExtendedValue addr = Fortran::lower::createSomeExtendedAddress( 6546 loc, converter, expr, symMap, stmtCtx); 6547 return fir::BoxValue(converter.getFirOpBuilder().createBox(loc, addr)); 6548 } 6549 6550 mlir::Value Fortran::lower::createSubroutineCall( 6551 AbstractConverter &converter, const evaluate::ProcedureRef &call, 6552 ExplicitIterSpace &explicitIterSpace, ImplicitIterSpace &implicitIterSpace, 6553 SymMap &symMap, StatementContext &stmtCtx, bool isUserDefAssignment) { 6554 mlir::Location loc = converter.getCurrentLocation(); 6555 6556 if (isUserDefAssignment) { 6557 assert(call.arguments().size() == 2); 6558 const auto *lhs = call.arguments()[0].value().UnwrapExpr(); 6559 const auto *rhs = call.arguments()[1].value().UnwrapExpr(); 6560 assert(lhs && rhs && 6561 "user defined assignment arguments must be expressions"); 6562 if (call.IsElemental() && lhs->Rank() > 0) { 6563 // Elemental user defined assignment has special requirements to deal with 6564 // LHS/RHS overlaps. See 10.2.1.5 p2. 6565 ArrayExprLowering::lowerElementalUserAssignment( 6566 converter, symMap, stmtCtx, explicitIterSpace, implicitIterSpace, 6567 call); 6568 } else if (explicitIterSpace.isActive() && lhs->Rank() == 0) { 6569 // Scalar defined assignment (elemental or not) in a FORALL context. 6570 mlir::FuncOp func = 6571 Fortran::lower::CallerInterface(call, converter).getFuncOp(); 6572 ArrayExprLowering::lowerScalarUserAssignment( 6573 converter, symMap, stmtCtx, explicitIterSpace, func, *lhs, *rhs); 6574 } else if (explicitIterSpace.isActive()) { 6575 // TODO: need to array fetch/modify sub-arrays? 6576 TODO(loc, "non elemental user defined array assignment inside FORALL"); 6577 } else { 6578 if (!implicitIterSpace.empty()) 6579 fir::emitFatalError( 6580 loc, 6581 "C1032: user defined assignment inside WHERE must be elemental"); 6582 // Non elemental user defined assignment outside of FORALL and WHERE. 6583 // FIXME: The non elemental user defined assignment case with array 6584 // arguments must be take into account potential overlap. So far the front 6585 // end does not add parentheses around the RHS argument in the call as it 6586 // should according to 15.4.3.4.3 p2. 6587 Fortran::lower::createSomeExtendedExpression( 6588 loc, converter, toEvExpr(call), symMap, stmtCtx); 6589 } 6590 return {}; 6591 } 6592 6593 assert(implicitIterSpace.empty() && !explicitIterSpace.isActive() && 6594 "subroutine calls are not allowed inside WHERE and FORALL"); 6595 6596 if (isElementalProcWithArrayArgs(call)) { 6597 ArrayExprLowering::lowerElementalSubroutine(converter, symMap, stmtCtx, 6598 toEvExpr(call)); 6599 return {}; 6600 } 6601 // Simple subroutine call, with potential alternate return. 6602 auto res = Fortran::lower::createSomeExtendedExpression( 6603 loc, converter, toEvExpr(call), symMap, stmtCtx); 6604 return fir::getBase(res); 6605 } 6606 6607 template <typename A> 6608 fir::ArrayLoadOp genArrayLoad(mlir::Location loc, 6609 Fortran::lower::AbstractConverter &converter, 6610 fir::FirOpBuilder &builder, const A *x, 6611 Fortran::lower::SymMap &symMap, 6612 Fortran::lower::StatementContext &stmtCtx) { 6613 auto exv = ScalarExprLowering{loc, converter, symMap, stmtCtx}.gen(*x); 6614 mlir::Value addr = fir::getBase(exv); 6615 mlir::Value shapeOp = builder.createShape(loc, exv); 6616 mlir::Type arrTy = fir::dyn_cast_ptrOrBoxEleTy(addr.getType()); 6617 return builder.create<fir::ArrayLoadOp>(loc, arrTy, addr, shapeOp, 6618 /*slice=*/mlir::Value{}, 6619 fir::getTypeParams(exv)); 6620 } 6621 template <> 6622 fir::ArrayLoadOp 6623 genArrayLoad(mlir::Location loc, Fortran::lower::AbstractConverter &converter, 6624 fir::FirOpBuilder &builder, const Fortran::evaluate::ArrayRef *x, 6625 Fortran::lower::SymMap &symMap, 6626 Fortran::lower::StatementContext &stmtCtx) { 6627 if (x->base().IsSymbol()) 6628 return genArrayLoad(loc, converter, builder, &x->base().GetLastSymbol(), 6629 symMap, stmtCtx); 6630 return genArrayLoad(loc, converter, builder, &x->base().GetComponent(), 6631 symMap, stmtCtx); 6632 } 6633 6634 void Fortran::lower::createArrayLoads( 6635 Fortran::lower::AbstractConverter &converter, 6636 Fortran::lower::ExplicitIterSpace &esp, Fortran::lower::SymMap &symMap) { 6637 std::size_t counter = esp.getCounter(); 6638 fir::FirOpBuilder &builder = converter.getFirOpBuilder(); 6639 mlir::Location loc = converter.getCurrentLocation(); 6640 Fortran::lower::StatementContext &stmtCtx = esp.stmtContext(); 6641 // Gen the fir.array_load ops. 6642 auto genLoad = [&](const auto *x) -> fir::ArrayLoadOp { 6643 return genArrayLoad(loc, converter, builder, x, symMap, stmtCtx); 6644 }; 6645 if (esp.lhsBases[counter].hasValue()) { 6646 auto &base = esp.lhsBases[counter].getValue(); 6647 auto load = std::visit(genLoad, base); 6648 esp.initialArgs.push_back(load); 6649 esp.resetInnerArgs(); 6650 esp.bindLoad(base, load); 6651 } 6652 for (const auto &base : esp.rhsBases[counter]) 6653 esp.bindLoad(base, std::visit(genLoad, base)); 6654 } 6655 6656 void Fortran::lower::createArrayMergeStores( 6657 Fortran::lower::AbstractConverter &converter, 6658 Fortran::lower::ExplicitIterSpace &esp) { 6659 fir::FirOpBuilder &builder = converter.getFirOpBuilder(); 6660 mlir::Location loc = converter.getCurrentLocation(); 6661 builder.setInsertionPointAfter(esp.getOuterLoop()); 6662 // Gen the fir.array_merge_store ops for all LHS arrays. 6663 for (auto i : llvm::enumerate(esp.getOuterLoop().getResults())) 6664 if (llvm::Optional<fir::ArrayLoadOp> ldOpt = esp.getLhsLoad(i.index())) { 6665 fir::ArrayLoadOp load = ldOpt.getValue(); 6666 builder.create<fir::ArrayMergeStoreOp>(loc, load, i.value(), 6667 load.getMemref(), load.getSlice(), 6668 load.getTypeparams()); 6669 } 6670 if (esp.loopCleanup.hasValue()) { 6671 esp.loopCleanup.getValue()(builder); 6672 esp.loopCleanup = llvm::None; 6673 } 6674 esp.initialArgs.clear(); 6675 esp.innerArgs.clear(); 6676 esp.outerLoop = llvm::None; 6677 esp.resetBindings(); 6678 esp.incrementCounter(); 6679 } 6680 6681 void Fortran::lower::createSomeArrayAssignment( 6682 Fortran::lower::AbstractConverter &converter, 6683 const Fortran::lower::SomeExpr &lhs, const Fortran::lower::SomeExpr &rhs, 6684 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx) { 6685 LLVM_DEBUG(lhs.AsFortran(llvm::dbgs() << "onto array: ") << '\n'; 6686 rhs.AsFortran(llvm::dbgs() << "assign expression: ") << '\n';); 6687 ArrayExprLowering::lowerArrayAssignment(converter, symMap, stmtCtx, lhs, rhs); 6688 } 6689 6690 void Fortran::lower::createSomeArrayAssignment( 6691 Fortran::lower::AbstractConverter &converter, const fir::ExtendedValue &lhs, 6692 const Fortran::lower::SomeExpr &rhs, Fortran::lower::SymMap &symMap, 6693 Fortran::lower::StatementContext &stmtCtx) { 6694 LLVM_DEBUG(llvm::dbgs() << "onto array: " << lhs << '\n'; 6695 rhs.AsFortran(llvm::dbgs() << "assign expression: ") << '\n';); 6696 ArrayExprLowering::lowerArrayAssignment(converter, symMap, stmtCtx, lhs, rhs); 6697 } 6698 6699 void Fortran::lower::createSomeArrayAssignment( 6700 Fortran::lower::AbstractConverter &converter, const fir::ExtendedValue &lhs, 6701 const fir::ExtendedValue &rhs, Fortran::lower::SymMap &symMap, 6702 Fortran::lower::StatementContext &stmtCtx) { 6703 LLVM_DEBUG(llvm::dbgs() << "onto array: " << lhs << '\n'; 6704 llvm::dbgs() << "assign expression: " << rhs << '\n';); 6705 ArrayExprLowering::lowerArrayAssignment(converter, symMap, stmtCtx, lhs, rhs); 6706 } 6707 6708 void Fortran::lower::createAnyMaskedArrayAssignment( 6709 Fortran::lower::AbstractConverter &converter, 6710 const Fortran::lower::SomeExpr &lhs, const Fortran::lower::SomeExpr &rhs, 6711 Fortran::lower::ExplicitIterSpace &explicitSpace, 6712 Fortran::lower::ImplicitIterSpace &implicitSpace, 6713 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx) { 6714 LLVM_DEBUG(lhs.AsFortran(llvm::dbgs() << "onto array: ") << '\n'; 6715 rhs.AsFortran(llvm::dbgs() << "assign expression: ") 6716 << " given the explicit iteration space:\n" 6717 << explicitSpace << "\n and implied mask conditions:\n" 6718 << implicitSpace << '\n';); 6719 ArrayExprLowering::lowerAnyMaskedArrayAssignment( 6720 converter, symMap, stmtCtx, lhs, rhs, explicitSpace, implicitSpace); 6721 } 6722 6723 void Fortran::lower::createAllocatableArrayAssignment( 6724 Fortran::lower::AbstractConverter &converter, 6725 const Fortran::lower::SomeExpr &lhs, const Fortran::lower::SomeExpr &rhs, 6726 Fortran::lower::ExplicitIterSpace &explicitSpace, 6727 Fortran::lower::ImplicitIterSpace &implicitSpace, 6728 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx) { 6729 LLVM_DEBUG(lhs.AsFortran(llvm::dbgs() << "defining array: ") << '\n'; 6730 rhs.AsFortran(llvm::dbgs() << "assign expression: ") 6731 << " given the explicit iteration space:\n" 6732 << explicitSpace << "\n and implied mask conditions:\n" 6733 << implicitSpace << '\n';); 6734 ArrayExprLowering::lowerAllocatableArrayAssignment( 6735 converter, symMap, stmtCtx, lhs, rhs, explicitSpace, implicitSpace); 6736 } 6737 6738 fir::ExtendedValue Fortran::lower::createSomeArrayTempValue( 6739 Fortran::lower::AbstractConverter &converter, 6740 const Fortran::lower::SomeExpr &expr, Fortran::lower::SymMap &symMap, 6741 Fortran::lower::StatementContext &stmtCtx) { 6742 LLVM_DEBUG(expr.AsFortran(llvm::dbgs() << "array value: ") << '\n'); 6743 return ArrayExprLowering::lowerNewArrayExpression(converter, symMap, stmtCtx, 6744 expr); 6745 } 6746 6747 void Fortran::lower::createLazyArrayTempValue( 6748 Fortran::lower::AbstractConverter &converter, 6749 const Fortran::lower::SomeExpr &expr, mlir::Value raggedHeader, 6750 Fortran::lower::SymMap &symMap, Fortran::lower::StatementContext &stmtCtx) { 6751 LLVM_DEBUG(expr.AsFortran(llvm::dbgs() << "array value: ") << '\n'); 6752 ArrayExprLowering::lowerLazyArrayExpression(converter, symMap, stmtCtx, expr, 6753 raggedHeader); 6754 } 6755 6756 mlir::Value Fortran::lower::genMaxWithZero(fir::FirOpBuilder &builder, 6757 mlir::Location loc, 6758 mlir::Value value) { 6759 mlir::Value zero = builder.createIntegerConstant(loc, value.getType(), 0); 6760 if (mlir::Operation *definingOp = value.getDefiningOp()) 6761 if (auto cst = mlir::dyn_cast<mlir::arith::ConstantOp>(definingOp)) 6762 if (auto intAttr = cst.getValue().dyn_cast<mlir::IntegerAttr>()) 6763 return intAttr.getInt() < 0 ? zero : value; 6764 return Fortran::lower::genMax(builder, loc, 6765 llvm::SmallVector<mlir::Value>{value, zero}); 6766 } 6767