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