FLANG
IntrinsicCall.h
1//===-- Builder/IntrinsicCall.h -- lowering of intrinsics -------*- C++ -*-===//
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#ifndef FORTRAN_LOWER_INTRINSICCALL_H
10#define FORTRAN_LOWER_INTRINSICCALL_H
11
12#include "flang/Optimizer/Builder/BoxValue.h"
13#include "flang/Optimizer/Builder/FIRBuilder.h"
14#include "flang/Optimizer/Builder/Runtime/Character.h"
15#include "flang/Optimizer/Builder/Runtime/Numeric.h"
17#include "flang/Runtime/entry-names.h"
18#include "flang/Runtime/iostat-consts.h"
19#include "mlir/Dialect/Complex/IR/Complex.h"
20#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
21#include "mlir/Dialect/Math/IR/Math.h"
22#include <optional>
23
24namespace Fortran {
25namespace lower {
26// TODO: remove the usage of AbstractConverter to avoid making IntrinsicCall.cpp
27// depend upon Lower/Evaluate and use a data structure to pass options to
28// IntrinsicLibrary.
30} // namespace lower
31} // namespace Fortran
32
33namespace fir {
34
35class StatementContext;
37
43std::pair<fir::ExtendedValue, bool>
44genIntrinsicCall(fir::FirOpBuilder &, mlir::Location, llvm::StringRef name,
45 std::optional<mlir::Type> resultType,
46 llvm::ArrayRef<fir::ExtendedValue> args,
47 Fortran::lower::AbstractConverter *converter = nullptr);
48
52std::pair<fir::ExtendedValue, bool>
53genIntrinsicCall(fir::FirOpBuilder &, mlir::Location,
55 std::optional<mlir::Type> resultType,
56 llvm::ArrayRef<fir::ExtendedValue> args,
57 Fortran::lower::AbstractConverter *converter = nullptr);
58
74
77 LowerIntrinsicArgAs lowerAs;
79 // - Numerical: 0
80 // - Logical : false
81 // - Derived/character: not possible. Need custom intrinsic lowering.
82 // Addr:
83 // - nullptr
84 // Box:
85 // - absent box
86 // AsInquired:
87 // - no-op
89};
90
91constexpr auto asValue = fir::LowerIntrinsicArgAs::Value;
92constexpr auto asAddr = fir::LowerIntrinsicArgAs::Addr;
93constexpr auto asBox = fir::LowerIntrinsicArgAs::Box;
94constexpr auto asInquired = fir::LowerIntrinsicArgAs::Inquired;
95
99
100// TODO error handling -> return a code or directly emit messages ?
101struct IntrinsicLibrary {
102
103 // Constructors.
104 explicit IntrinsicLibrary(
105 fir::FirOpBuilder &builder, mlir::Location loc,
106 Fortran::lower::AbstractConverter *converter = nullptr)
107 : builder{builder}, loc{loc}, converter{converter} {}
108 IntrinsicLibrary() = delete;
109 IntrinsicLibrary(const IntrinsicLibrary &) = delete;
110
114 std::pair<fir::ExtendedValue, bool>
115 genIntrinsicCall(llvm::StringRef name, std::optional<mlir::Type> resultType,
117
125 mlir::Value genRuntimeCall(llvm::StringRef name, mlir::Type,
127
128 using RuntimeCallGenerator = std::function<mlir::Value(
130 RuntimeCallGenerator
131 getRuntimeCallGenerator(llvm::StringRef name,
132 mlir::FunctionType soughtFuncType);
133
139 mlir::Value genAbs(mlir::Type, llvm::ArrayRef<mlir::Value>);
140 mlir::Value genAcosd(mlir::Type, llvm::ArrayRef<mlir::Value>);
141 mlir::Value genAcospi(mlir::Type, llvm::ArrayRef<mlir::Value>);
142 template <void (*CallRuntime)(fir::FirOpBuilder &, mlir::Location loc,
143 mlir::Value, mlir::Value)>
144 fir::ExtendedValue genAdjustRtCall(mlir::Type,
146 mlir::Value genAimag(mlir::Type, llvm::ArrayRef<mlir::Value>);
147 mlir::Value genAint(mlir::Type, llvm::ArrayRef<mlir::Value>);
149 fir::ExtendedValue genAllocated(mlir::Type,
151 mlir::Value genAnint(mlir::Type, llvm::ArrayRef<mlir::Value>);
153 mlir::Value genAtanpi(mlir::Type, llvm::ArrayRef<mlir::Value>);
155 genCommandArgumentCount(mlir::Type, llvm::ArrayRef<fir::ExtendedValue>);
156 mlir::Value genAsind(mlir::Type, llvm::ArrayRef<mlir::Value>);
157 mlir::Value genAsinpi(mlir::Type, llvm::ArrayRef<mlir::Value>);
158 fir::ExtendedValue genAssociated(mlir::Type,
160 mlir::Value genAtand(mlir::Type, llvm::ArrayRef<mlir::Value>);
161 fir::ExtendedValue genBesselJn(mlir::Type,
163 fir::ExtendedValue genBesselYn(mlir::Type,
165 template <mlir::arith::CmpIPredicate pred>
166 mlir::Value genBitwiseCompare(mlir::Type resultType,
168
169 mlir::Value genBtest(mlir::Type, llvm::ArrayRef<mlir::Value>);
170 mlir::Value genCeiling(mlir::Type, llvm::ArrayRef<mlir::Value>);
172 fir::ExtendedValue genChdir(std::optional<mlir::Type> resultType,
174 template <mlir::arith::CmpIPredicate pred>
175 fir::ExtendedValue genCharacterCompare(mlir::Type,
177 mlir::Value genCmplx(mlir::Type, llvm::ArrayRef<mlir::Value>);
178 mlir::Value genConjg(mlir::Type, llvm::ArrayRef<mlir::Value>);
180 void genCpuTime(llvm::ArrayRef<fir::ExtendedValue>);
187 mlir::Value genErfcScaled(mlir::Type resultType,
189 void genCFPointer(llvm::ArrayRef<fir::ExtendedValue>);
190 void genCFProcPointer(llvm::ArrayRef<fir::ExtendedValue>);
191 void genCFStrPointer(llvm::ArrayRef<fir::ExtendedValue>);
194 template <mlir::arith::CmpIPredicate pred>
195 fir::ExtendedValue genCPtrCompare(mlir::Type,
197 void genCoBroadcast(llvm::ArrayRef<fir::ExtendedValue>);
201 mlir::Value genCosd(mlir::Type, llvm::ArrayRef<mlir::Value>);
202 mlir::Value genCospi(mlir::Type, llvm::ArrayRef<mlir::Value>);
203 void genDateAndTime(llvm::ArrayRef<fir::ExtendedValue>);
204 fir::ExtendedValue genDsecnds(mlir::Type resultType,
206 mlir::Value genDim(mlir::Type, llvm::ArrayRef<mlir::Value>);
207 fir::ExtendedValue genDotProduct(mlir::Type,
209 mlir::Value genDprod(mlir::Type, llvm::ArrayRef<mlir::Value>);
210 mlir::Value genDshiftl(mlir::Type, llvm::ArrayRef<mlir::Value>);
211 mlir::Value genDshiftr(mlir::Type, llvm::ArrayRef<mlir::Value>);
214 void genExecuteCommandLine(mlir::ArrayRef<fir::ExtendedValue> args);
215 fir::ExtendedValue genEtime(std::optional<mlir::Type>,
216 mlir::ArrayRef<fir::ExtendedValue> args);
217 mlir::Value genExponent(mlir::Type, llvm::ArrayRef<mlir::Value>);
218 fir::ExtendedValue genExtendsTypeOf(mlir::Type,
220 template <bool isMax>
221 mlir::Value genExtremum(mlir::Type, llvm::ArrayRef<mlir::Value>);
222 fir::ExtendedValue genFCString(mlir::Type,
224 mlir::Value genFloor(mlir::Type, llvm::ArrayRef<mlir::Value>);
226 mlir::Value genFraction(mlir::Type resultType,
227 mlir::ArrayRef<mlir::Value> args);
228 void genFree(mlir::ArrayRef<fir::ExtendedValue> args);
229 fir::ExtendedValue genFseek(std::optional<mlir::Type>,
230 mlir::ArrayRef<fir::ExtendedValue> args);
231 fir::ExtendedValue genFtell(std::optional<mlir::Type>,
232 mlir::ArrayRef<fir::ExtendedValue> args);
233 fir::ExtendedValue genGetCwd(std::optional<mlir::Type> resultType,
235 void genGetCommand(mlir::ArrayRef<fir::ExtendedValue> args);
236 mlir::Value genGetPID(mlir::Type resultType,
238 void genGetCommandArgument(mlir::ArrayRef<fir::ExtendedValue> args);
239 void genGetEnvironmentVariable(llvm::ArrayRef<fir::ExtendedValue>);
240 mlir::Value genGetGID(mlir::Type resultType,
242 mlir::Value genGetTeam(mlir::Type, llvm::ArrayRef<mlir::Value>);
243 mlir::Value genGetUID(mlir::Type resultType,
245 fir::ExtendedValue genHostnm(std::optional<mlir::Type> resultType,
248 mlir::Value genIand(mlir::Type, llvm::ArrayRef<mlir::Value>);
250 mlir::Value genIbclr(mlir::Type, llvm::ArrayRef<mlir::Value>);
251 mlir::Value genIbits(mlir::Type, llvm::ArrayRef<mlir::Value>);
252 mlir::Value genIbset(mlir::Type, llvm::ArrayRef<mlir::Value>);
255 mlir::Value genIeeeClass(mlir::Type, llvm::ArrayRef<mlir::Value>);
256 mlir::Value genIeeeCopySign(mlir::Type, llvm::ArrayRef<mlir::Value>);
257 void genIeeeGetFlag(llvm::ArrayRef<fir::ExtendedValue>);
258 void genIeeeGetHaltingMode(llvm::ArrayRef<fir::ExtendedValue>);
259 template <bool isGet, bool isModes>
260 void genIeeeGetOrSetModesOrStatus(llvm::ArrayRef<fir::ExtendedValue>);
261 void genIeeeGetRoundingMode(llvm::ArrayRef<fir::ExtendedValue>);
262 void genIeeeGetUnderflowMode(llvm::ArrayRef<fir::ExtendedValue>);
263 mlir::Value genIeeeInt(mlir::Type, llvm::ArrayRef<mlir::Value>);
264 mlir::Value genIeeeIsFinite(mlir::Type, llvm::ArrayRef<mlir::Value>);
265 mlir::Value genIeeeIsNan(mlir::Type, llvm::ArrayRef<mlir::Value>);
266 mlir::Value genIeeeIsNegative(mlir::Type, llvm::ArrayRef<mlir::Value>);
267 mlir::Value genIeeeIsNormal(mlir::Type, llvm::ArrayRef<mlir::Value>);
268 mlir::Value genIeeeLogb(mlir::Type, mlir::ArrayRef<mlir::Value>);
269 template <bool isMax, bool isNum, bool isMag>
270 mlir::Value genIeeeMaxMin(mlir::Type, llvm::ArrayRef<mlir::Value>);
271 template <mlir::arith::CmpFPredicate pred>
272 mlir::Value genIeeeQuietCompare(mlir::Type resultType,
274 mlir::Value genIeeeReal(mlir::Type, llvm::ArrayRef<mlir::Value>);
275 mlir::Value genIeeeRem(mlir::Type, llvm::ArrayRef<mlir::Value>);
276 mlir::Value genIeeeRint(mlir::Type, llvm::ArrayRef<mlir::Value>);
277 template <bool isFlag>
278 void genIeeeSetFlagOrHaltingMode(llvm::ArrayRef<fir::ExtendedValue>);
279 void genIeeeSetRoundingMode(llvm::ArrayRef<fir::ExtendedValue>);
280 void genIeeeSetUnderflowMode(llvm::ArrayRef<fir::ExtendedValue>);
281 template <mlir::arith::CmpFPredicate pred>
282 mlir::Value genIeeeSignalingCompare(mlir::Type resultType,
284 mlir::Value genIeeeSignbit(mlir::Type, llvm::ArrayRef<mlir::Value>);
285 fir::ExtendedValue genIeeeSupportFlag(mlir::Type,
287 fir::ExtendedValue genIeeeSupportHalting(mlir::Type,
289 fir::ExtendedValue genIeeeSupportRounding(mlir::Type,
291 fir::ExtendedValue genIeeeSupportStandard(mlir::Type,
293 template <mlir::arith::CmpIPredicate pred>
294 mlir::Value genIeeeTypeCompare(mlir::Type, llvm::ArrayRef<mlir::Value>);
295 mlir::Value genIeeeUnordered(mlir::Type, llvm::ArrayRef<mlir::Value>);
296 mlir::Value genIeeeValue(mlir::Type, llvm::ArrayRef<mlir::Value>);
297 mlir::Value genIeor(mlir::Type, llvm::ArrayRef<mlir::Value>);
299 mlir::Value genIor(mlir::Type, llvm::ArrayRef<mlir::Value>);
301 fir::ExtendedValue genIrand(mlir::Type resultType,
303 fir::ExtendedValue genIsContiguous(mlir::Type,
305 template <Fortran::runtime::io::Iostat value>
306 mlir::Value genIsIostatValue(mlir::Type, llvm::ArrayRef<mlir::Value>);
307 mlir::Value genIsFPClass(mlir::Type, llvm::ArrayRef<mlir::Value>,
308 int fpclass);
309 mlir::Value genIshft(mlir::Type, llvm::ArrayRef<mlir::Value>);
310 mlir::Value genIshftc(mlir::Type, llvm::ArrayRef<mlir::Value>);
312 mlir::Value genLeadz(mlir::Type, llvm::ArrayRef<mlir::Value>);
316 mlir::Value genMalloc(mlir::Type, llvm::ArrayRef<mlir::Value>);
317 template <typename Shift>
318 mlir::Value genMask(mlir::Type, llvm::ArrayRef<mlir::Value>);
320 fir::ExtendedValue genMatmulTranspose(mlir::Type,
325 mlir::Value genMergeBits(mlir::Type, llvm::ArrayRef<mlir::Value>);
328 mlir::Value genMod(mlir::Type, llvm::ArrayRef<mlir::Value>);
329 mlir::Value genModulo(mlir::Type, llvm::ArrayRef<mlir::Value>);
330 void genMoveAlloc(llvm::ArrayRef<fir::ExtendedValue>);
332 enum class NearestProc { Nearest, NextAfter, NextDown, NextUp };
333 template <NearestProc>
334 mlir::Value genNearest(mlir::Type, llvm::ArrayRef<mlir::Value>);
335 mlir::Value genNint(mlir::Type, llvm::ArrayRef<mlir::Value>);
337 mlir::Value genNot(mlir::Type, llvm::ArrayRef<mlir::Value>);
339 fir::ExtendedValue genNumImages(mlir::Type,
344 mlir::Value genPopcnt(mlir::Type, llvm::ArrayRef<mlir::Value>);
345 mlir::Value genPoppar(mlir::Type, llvm::ArrayRef<mlir::Value>);
348 fir::ExtendedValue genPutenv(std::optional<mlir::Type>,
350 fir::ExtendedValue genRand(mlir::Type resultType,
352 void genRandomInit(llvm::ArrayRef<fir::ExtendedValue>);
353 void genRandomNumber(llvm::ArrayRef<fir::ExtendedValue>);
354 void genRandomSeed(llvm::ArrayRef<fir::ExtendedValue>);
356 fir::ExtendedValue genReduceDim(mlir::Type,
358 fir::ExtendedValue genRename(std::optional<mlir::Type>,
359 mlir::ArrayRef<fir::ExtendedValue>);
362 mlir::Value genRRSpacing(mlir::Type resultType,
364 mlir::Value genRtc(mlir::Type resultType, llvm::ArrayRef<mlir::Value> args);
365 fir::ExtendedValue genSameTypeAs(mlir::Type,
367 mlir::Value genScale(mlir::Type, llvm::ArrayRef<mlir::Value>);
369 fir::ExtendedValue genSecnds(mlir::Type resultType,
371 fir::ExtendedValue genSecond(std::optional<mlir::Type>,
372 mlir::ArrayRef<fir::ExtendedValue>);
373 fir::ExtendedValue genSelectedCharKind(mlir::Type,
375 mlir::Value genSelectedIntKind(mlir::Type, llvm::ArrayRef<mlir::Value>);
376 mlir::Value genSelectedLogicalKind(mlir::Type, llvm::ArrayRef<mlir::Value>);
377 mlir::Value genSelectedRealKind(mlir::Type, llvm::ArrayRef<mlir::Value>);
378 mlir::Value genSetExponent(mlir::Type resultType,
380 fir::ExtendedValue genShape(mlir::Type resultType,
382 template <typename Shift>
383 mlir::Value genShift(mlir::Type resultType, llvm::ArrayRef<mlir::Value>);
384 mlir::Value genShiftA(mlir::Type resultType, llvm::ArrayRef<mlir::Value>);
385 void genShowDescriptor(llvm::ArrayRef<fir::ExtendedValue>);
386 mlir::Value genSign(mlir::Type, llvm::ArrayRef<mlir::Value>);
387 mlir::Value genSind(mlir::Type, llvm::ArrayRef<mlir::Value>);
388 mlir::Value genSinpi(mlir::Type, llvm::ArrayRef<mlir::Value>);
391 mlir::Value genSpacing(mlir::Type resultType,
395 fir::ExtendedValue genStorageSize(mlir::Type,
398 void genSignalSubroutine(llvm::ArrayRef<fir::ExtendedValue>);
400 fir::ExtendedValue genSystem(std::optional<mlir::Type>,
401 mlir::ArrayRef<fir::ExtendedValue> args);
402 void genSystemClock(llvm::ArrayRef<fir::ExtendedValue>);
403 mlir::Value genTand(mlir::Type, llvm::ArrayRef<mlir::Value>);
404 mlir::Value genTanpi(mlir::Type, llvm::ArrayRef<mlir::Value>);
405 fir::ExtendedValue genTeamNumber(mlir::Type,
407 mlir::Value genTime(mlir::Type, llvm::ArrayRef<mlir::Value>);
408 void genTokenize(llvm::ArrayRef<fir::ExtendedValue>);
409 mlir::Value genTrailz(mlir::Type, llvm::ArrayRef<mlir::Value>);
410 fir::ExtendedValue genTransfer(mlir::Type,
412 fir::ExtendedValue genTranspose(mlir::Type,
414 fir::ExtendedValue genThisImage(mlir::Type,
418 fir::ExtendedValue genUnlink(std::optional<mlir::Type> resultType,
422
426 mlir::Value genConversion(mlir::Type, llvm::ArrayRef<mlir::Value>);
427
433 template <typename FN, typename FD>
434 fir::ExtendedValue genExtremumloc(FN func, FD funcDim, llvm::StringRef errMsg,
435 mlir::Type,
437 template <typename FN, typename FD, typename FC>
439 fir::ExtendedValue genExtremumVal(FN func, FD funcDim, FC funcChar,
440 llvm::StringRef errMsg,
441 mlir::Type resultType,
444 template <typename FN, typename FD>
445 fir::ExtendedValue genReduction(FN func, FD funcDim, llvm::StringRef errMsg,
446 mlir::Type resultType,
448
451 void genRaiseExcept(int excepts, mlir::Value cond = {});
452
454 mlir::Value genQNan(mlir::Type resultType);
455
459 using ExtendedGenerator = decltype(&IntrinsicLibrary::genLenTrim);
460 using SubroutineGenerator = decltype(&IntrinsicLibrary::genDateAndTime);
462 using DualGenerator = decltype(&IntrinsicLibrary::genEtime);
463 using Generator = std::variant<ElementalGenerator, ExtendedGenerator,
464 SubroutineGenerator, DualGenerator>;
465
472 template <typename GeneratorType>
473 mlir::Value outlineInWrapper(GeneratorType, llvm::StringRef name,
474 mlir::Type resultType,
476 template <typename GeneratorType>
478 outlineInExtendedWrapper(GeneratorType, llvm::StringRef name,
479 std::optional<mlir::Type> resultType,
481
482 template <typename GeneratorType>
483 mlir::func::FuncOp getWrapper(GeneratorType, llvm::StringRef name,
484 mlir::FunctionType,
485 bool loadRefArguments = false);
486
488 template <typename GeneratorType>
490 genElementalCall(GeneratorType, llvm::StringRef name, mlir::Type resultType,
491 llvm::ArrayRef<fir::ExtendedValue> args, bool outline);
492
494 mlir::Value invokeGenerator(ElementalGenerator generator,
495 mlir::Type resultType,
497 mlir::Value invokeGenerator(RuntimeCallGenerator generator,
498 mlir::Type resultType,
500 mlir::Value invokeGenerator(ExtendedGenerator generator,
501 mlir::Type resultType,
503 mlir::Value invokeGenerator(SubroutineGenerator generator,
505 mlir::Value invokeGenerator(DualGenerator generator,
507 mlir::Value invokeGenerator(DualGenerator generator, mlir::Type resultType,
509
512 mlir::SymbolRefAttr
513 getUnrestrictedIntrinsicSymbolRefAttr(llvm::StringRef name,
514 mlir::FunctionType signature);
515
518 mlir::Type resultType,
519 llvm::StringRef errMsg);
520
521 void setResultMustBeFreed() { resultMustBeFreed = true; }
522
523 fir::FirOpBuilder &builder;
524 mlir::Location loc;
525 bool resultMustBeFreed = false;
526 Fortran::lower::AbstractConverter *converter = nullptr;
527};
528
530 const char *name = nullptr;
532 bool handleDynamicOptional = false;
533};
534
539 constexpr bool hasDefaultRules() const { return args[0].name == nullptr; }
540};
541
545 const char *name;
546 IntrinsicLibrary::Generator generator;
547 // The following may be omitted in the table below.
548 fir::IntrinsicArgumentLoweringRules argLoweringRules = {};
549 bool isElemental = true;
552 bool outline = false;
553};
554
556 // llvm::StringRef comparison operator are not constexpr, so use string_view.
557 using Key = std::string_view;
558 // Needed for implicit compare with keys.
559 constexpr operator Key() const { return key; }
560 Key key; // intrinsic name
561
562 // Name of a runtime function that implements the operation.
563 llvm::StringRef symbol;
564 fir::runtime::FuncTypeBuilderFunc typeGenerator;
565};
566
568 // Callback type for generating lowering for a math operation.
569 using MathGeneratorTy = mlir::Value (*)(fir::FirOpBuilder &, mlir::Location,
570 const MathOperation &,
571 mlir::FunctionType,
573
574 // Overrides fir::runtime::FuncTypeBuilderFunc to add FirOpBuilder argument.
575 using FuncTypeBuilderFunc = mlir::FunctionType (*)(mlir::MLIRContext *,
577
578 // llvm::StringRef comparison operator are not constexpr, so use string_view.
579 using Key = std::string_view;
580 // Needed for implicit compare with keys.
581 constexpr operator Key() const { return key; }
582 // Intrinsic name.
583 Key key;
584
585 // Name of a runtime function that implements the operation.
586 llvm::StringRef runtimeFunc;
587 FuncTypeBuilderFunc typeGenerator;
588
589 // A callback to generate FIR for the intrinsic defined by 'key'.
590 // A callback may generate either dedicated MLIR operation(s) or
591 // a function call to a runtime function with name defined by
592 // 'runtimeFunc'.
593 MathGeneratorTy funcGenerator;
594};
595
596// Enum of most supported intrinsic argument or return types.
597enum class ParamTypeId {
598 Void,
599 Address, // pointer (to an [array of] Integers of some kind)
600 Integer,
601 Real,
602 Complex,
603 IntegerVector,
604 UnsignedVector,
605 RealVector,
606};
607
608// Helper function to get length of a 16-byte vector of element type eleTy.
609static int getVecLen(mlir::Type eleTy) {
610 assert((mlir::isa<mlir::IntegerType>(eleTy) ||
611 mlir::isa<mlir::FloatType>(eleTy)) &&
612 "unsupported vector element type");
613 return 16 / (eleTy.getIntOrFloatBitWidth() / 8);
614}
615
616template <ParamTypeId t, int k>
617struct ParamType {
618 // Supported kinds can be checked with static asserts at compile time.
619 static_assert(t != ParamTypeId::Integer || k == 1 || k == 2 || k == 4 ||
620 k == 8,
621 "Unsupported integer kind");
622 static_assert(t != ParamTypeId::Real || k == 4 || k == 8 || k == 10 ||
623 k == 16,
624 "Unsupported real kind");
625 static_assert(t != ParamTypeId::Complex || k == 2 || k == 3 || k == 4 ||
626 k == 8 || k == 10 || k == 16,
627 "Unsupported complex kind");
628
629 static const ParamTypeId ty = t;
630 static const int kind = k;
631};
632
633// Namespace encapsulating type definitions for parameter types.
634namespace Ty {
636template <int k>
638template <int k>
640template <int k>
642template <int k>
644template <int k>
645using IntegerVector = ParamType<ParamTypeId::IntegerVector, k>;
646template <int k>
647using UnsignedVector = ParamType<ParamTypeId::UnsignedVector, k>;
648template <int k>
650} // namespace Ty
651
652// Helper function that generates most types that are supported for intrinsic
653// arguments and return type. Used by `genFuncType` to generate function
654// types for most of the intrinsics.
655static inline mlir::Type getTypeHelper(mlir::MLIRContext *context,
656 fir::FirOpBuilder &builder,
657 ParamTypeId typeId, int kind) {
658 mlir::Type r;
659 unsigned bits{0};
660 switch (typeId) {
661 case ParamTypeId::Void:
662 llvm::report_fatal_error("can not get type of void");
663 break;
664 case ParamTypeId::Address:
665 bits = builder.getKindMap().getIntegerBitsize(kind);
666 assert(bits != 0 && "failed to convert address kind to integer bitsize");
667 r = fir::ReferenceType::get(mlir::IntegerType::get(context, bits));
668 break;
669 case ParamTypeId::Integer:
670 case ParamTypeId::IntegerVector:
671 bits = builder.getKindMap().getIntegerBitsize(kind);
672 assert(bits != 0 && "failed to convert kind to integer bitsize");
673 r = mlir::IntegerType::get(context, bits);
674 break;
675 case ParamTypeId::UnsignedVector:
676 bits = builder.getKindMap().getIntegerBitsize(kind);
677 assert(bits != 0 && "failed to convert kind to unsigned bitsize");
678 r = mlir::IntegerType::get(context, bits, mlir::IntegerType::Unsigned);
679 break;
680 case ParamTypeId::Real:
681 case ParamTypeId::RealVector:
682 r = builder.getRealType(kind);
683 break;
684 case ParamTypeId::Complex:
685 r = mlir::ComplexType::get(builder.getRealType(kind));
686 break;
687 }
688
689 switch (typeId) {
690 case ParamTypeId::Void:
691 case ParamTypeId::Address:
692 case ParamTypeId::Integer:
693 case ParamTypeId::Real:
694 case ParamTypeId::Complex:
695 break;
696 case ParamTypeId::IntegerVector:
697 case ParamTypeId::UnsignedVector:
698 case ParamTypeId::RealVector:
699 // convert to vector type
700 r = fir::VectorType::get(getVecLen(r), r);
701 }
702 return r;
703}
704
705// Generic function type generator that supports most of the function types
706// used by intrinsics.
707template <typename TyR, typename... ArgTys>
708static inline mlir::FunctionType genFuncType(mlir::MLIRContext *context,
709 fir::FirOpBuilder &builder) {
710 llvm::SmallVector<ParamTypeId> argTys = {ArgTys::ty...};
711 llvm::SmallVector<int> argKinds = {ArgTys::kind...};
712 llvm::SmallVector<mlir::Type> argTypes;
713
714 for (size_t i = 0; i < argTys.size(); ++i) {
715 argTypes.push_back(getTypeHelper(context, builder, argTys[i], argKinds[i]));
716 }
717
718 if (TyR::ty == ParamTypeId::Void)
719 return mlir::FunctionType::get(context, argTypes, {});
720
721 auto resType = getTypeHelper(context, builder, TyR::ty, TyR::kind);
722 return mlir::FunctionType::get(context, argTypes, {resType});
723}
724
726struct IntrinsicHandlerEntry {
727 using RuntimeGeneratorRange =
728 std::pair<const MathOperation *, const MathOperation *>;
729 IntrinsicHandlerEntry(const IntrinsicHandler *handler) : entry{handler} {
730 assert(handler && "handler must not be nullptr");
731 };
732 IntrinsicHandlerEntry(RuntimeGeneratorRange rt) : entry{rt} {};
733 const IntrinsicArgumentLoweringRules *getArgumentLoweringRules() const;
734 std::variant<const IntrinsicHandler *, RuntimeGeneratorRange> entry;
735};
736
737//===----------------------------------------------------------------------===//
738// Helper functions for argument handling.
739//===----------------------------------------------------------------------===//
740static inline mlir::Type getConvertedElementType(mlir::MLIRContext *context,
741 mlir::Type eleTy) {
742 if (mlir::isa<mlir::IntegerType>(eleTy) && !eleTy.isSignlessInteger()) {
743 const auto intTy{mlir::dyn_cast<mlir::IntegerType>(eleTy)};
744 auto newEleTy{mlir::IntegerType::get(context, intTy.getWidth())};
745 return newEleTy;
746 }
747 return eleTy;
748}
749
750static inline llvm::SmallVector<mlir::Value, 4>
751getBasesForArgs(llvm::ArrayRef<fir::ExtendedValue> args) {
752 llvm::SmallVector<mlir::Value, 4> baseVec;
753 for (auto arg : args)
754 baseVec.push_back(getBase(arg));
755 return baseVec;
756}
757
758static inline llvm::SmallVector<mlir::Type, 4>
759getTypesForArgs(llvm::ArrayRef<mlir::Value> args) {
760 llvm::SmallVector<mlir::Type, 4> typeVec;
761 for (auto arg : args)
762 typeVec.push_back(arg.getType());
763 return typeVec;
764}
765
766mlir::Value genLibCall(fir::FirOpBuilder &builder, mlir::Location loc,
767 const MathOperation &mathOp,
768 mlir::FunctionType libFuncType,
769 llvm::ArrayRef<mlir::Value> args);
770
771template <typename T>
772mlir::Value genMathOp(fir::FirOpBuilder &builder, mlir::Location loc,
773 const MathOperation &mathOp,
774 mlir::FunctionType mathLibFuncType,
775 llvm::ArrayRef<mlir::Value> args);
776
777template <typename T>
778mlir::Value genComplexMathOp(fir::FirOpBuilder &builder, mlir::Location loc,
779 const MathOperation &mathOp,
780 mlir::FunctionType mathLibFuncType,
781 llvm::ArrayRef<mlir::Value> args);
782
783mlir::Value genLibSplitComplexArgsCall(fir::FirOpBuilder &builder,
784 mlir::Location loc,
785 const MathOperation &mathOp,
786 mlir::FunctionType libFuncType,
787 llvm::ArrayRef<mlir::Value> args);
788
791std::optional<IntrinsicHandlerEntry>
792lookupIntrinsicHandler(fir::FirOpBuilder &, llvm::StringRef intrinsicName,
793 std::optional<mlir::Type> resultType);
794
796void crashOnMissingIntrinsic(mlir::Location loc, llvm::StringRef name);
797
801getIntrinsicArgumentLowering(llvm::StringRef intrinsicName);
802
806 unsigned position);
807
809fir::ExtendedValue getAbsentIntrinsicArgument();
810
812// implementation) of an unrestricted intrinsic (defined by its signature
813// and generic name)
814mlir::SymbolRefAttr
815getUnrestrictedIntrinsicSymbolRefAttr(fir::FirOpBuilder &, mlir::Location,
816 llvm::StringRef name,
817 mlir::FunctionType signature);
818
819//===----------------------------------------------------------------------===//
820// Direct access to intrinsics that may be used by lowering outside
821// of intrinsic call lowering.
822//===----------------------------------------------------------------------===//
823
826mlir::Value genMax(fir::FirOpBuilder &, mlir::Location,
827 llvm::ArrayRef<mlir::Value> args);
828
830mlir::Value genMin(fir::FirOpBuilder &, mlir::Location,
831 llvm::ArrayRef<mlir::Value> args);
832
835mlir::Value genDivC(fir::FirOpBuilder &builder, mlir::Location loc,
836 mlir::Type resultType, mlir::Value x, mlir::Value y);
837
840mlir::Value genPow(fir::FirOpBuilder &, mlir::Location, mlir::Type resultType,
841 mlir::Value x, mlir::Value y);
842
843} // namespace fir
844
845#endif // FORTRAN_LOWER_INTRINSICCALL_H
Definition AbstractConverter.h:87
Definition BoxValue.h:478
Definition FIRBuilder.h:56
const fir::KindMapping & getKindMap()
Get a reference to the kind map.
Definition FIRBuilder.h:123
mlir::Type getRealType(int kind)
Get the mlir float type that implements Fortran REAL(kind).
Definition FIRBuilder.cpp:119
Bitsize getIntegerBitsize(KindTy kind) const
Get the size in bits of !fir.int<kind>
Definition KindMapping.cpp:283
Definition BoxValue.h:360
Definition FIRType.h:103
Definition ParserActions.h:24
Definition bit-population-count.h:20
Definition AbstractConverter.h:37
std::optional< IntrinsicHandlerEntry > lookupIntrinsicHandler(fir::FirOpBuilder &, llvm::StringRef intrinsicName, std::optional< mlir::Type > resultType)
Definition IntrinsicCall.cpp:1896
const IntrinsicArgumentLoweringRules * getIntrinsicArgumentLowering(llvm::StringRef intrinsicName)
Definition IntrinsicCall.cpp:9169
mlir::Value getBase(const ExtendedValue &exv)
Definition BoxValue.cpp:21
mlir::Value genMin(fir::FirOpBuilder &, mlir::Location, llvm::ArrayRef< mlir::Value > args)
Generate minimum. Same constraints as genMax.
Definition IntrinsicCall.cpp:9225
mlir::Value genPow(fir::FirOpBuilder &, mlir::Location, mlir::Type resultType, mlir::Value x, mlir::Value y)
Definition IntrinsicCall.cpp:9237
mlir::Value genDivC(fir::FirOpBuilder &builder, mlir::Location loc, mlir::Type resultType, mlir::Value x, mlir::Value y)
Definition IntrinsicCall.cpp:9232
fir::ExtendedValue getAbsentIntrinsicArgument()
Return place-holder for absent intrinsic arguments.
Definition IntrinsicCall.cpp:80
void crashOnMissingIntrinsic(mlir::Location loc, llvm::StringRef name)
Generate a TODO error message for an as yet unimplemented intrinsic.
Definition IntrinsicCall.cpp:1921
ArgLoweringRule lowerIntrinsicArgumentAs(const IntrinsicArgumentLoweringRules &, unsigned position)
Definition IntrinsicCall.cpp:9197
mlir::SymbolRefAttr getUnrestrictedIntrinsicSymbolRefAttr(fir::FirOpBuilder &, mlir::Location, llvm::StringRef name, mlir::FunctionType signature)
Get SymbolRefAttr of runtime (or wrapper function containing inlined.
Definition IntrinsicCall.cpp:9258
LowerIntrinsicArgAs
Definition IntrinsicCall.h:61
@ Addr
Definition IntrinsicCall.h:66
@ Inquired
Definition IntrinsicCall.h:72
@ Box
Lower argument to a box.
Definition IntrinsicCall.h:68
@ Value
Lower argument to a value. Mainly intended for scalar arguments.
Definition IntrinsicCall.h:63
std::pair< fir::ExtendedValue, bool > genIntrinsicCall(fir::FirOpBuilder &, mlir::Location, llvm::StringRef name, std::optional< mlir::Type > resultType, llvm::ArrayRef< fir::ExtendedValue > args, Fortran::lower::AbstractConverter *converter=nullptr)
Definition IntrinsicCall.cpp:9210
mlir::Value genMax(fir::FirOpBuilder &, mlir::Location, llvm::ArrayRef< mlir::Value > args)
Definition IntrinsicCall.cpp:9218
Define how a given intrinsic argument must be lowered.
Definition IntrinsicCall.h:76
bool handleDynamicOptional
Value:
Definition IntrinsicCall.h:88
This is shared by intrinsics and intrinsic module procedures.
Definition IntrinsicCall.h:536
IntrinsicDummyArgument args[7]
There is no more than 7 non repeated arguments in Fortran intrinsics.
Definition IntrinsicCall.h:538
Definition IntrinsicCall.h:529
Entry into the tables describing how an intrinsic must be lowered.
Definition IntrinsicCall.h:726
Definition IntrinsicCall.h:544
bool outline
Definition IntrinsicCall.h:552
mlir::SymbolRefAttr getUnrestrictedIntrinsicSymbolRefAttr(llvm::StringRef name, mlir::FunctionType signature)
Definition IntrinsicCall.cpp:2428
fir::ExtendedValue genElementalCall(GeneratorType, llvm::StringRef name, mlir::Type resultType, llvm::ArrayRef< fir::ExtendedValue > args, bool outline)
Generate calls to ElementalGenerator, handling the elemental aspects.
Definition IntrinsicCall.cpp:1933
fir::ExtendedValue genReduction(FN func, FD funcDim, llvm::StringRef errMsg, mlir::Type resultType, llvm::ArrayRef< fir::ExtendedValue > args)
Process calls to Product, Sum, IAll, IAny, IParity intrinsic functions.
Definition IntrinsicCall.cpp:4495
std::pair< fir::ExtendedValue, bool > genIntrinsicCall(llvm::StringRef name, std::optional< mlir::Type > resultType, llvm::ArrayRef< fir::ExtendedValue > arg)
Definition IntrinsicCall.cpp:2118
decltype(&IntrinsicLibrary::genEtime) DualGenerator
The generator for intrinsic that has both function and subroutine form.
Definition IntrinsicCall.h:462
mlir::Value outlineInWrapper(GeneratorType, llvm::StringRef name, mlir::Type resultType, llvm::ArrayRef< mlir::Value > args)
Definition IntrinsicCall.cpp:2327
mlir::Value genRuntimeCall(llvm::StringRef name, mlir::Type, llvm::ArrayRef< mlir::Value >)
Definition IntrinsicCall.cpp:2499
mlir::Value genQNan(mlir::Type resultType)
Generate a quiet NaN of a given floating point type.
Definition IntrinsicCall.cpp:4708
mlir::Value genConversion(mlir::Type, llvm::ArrayRef< mlir::Value >)
Definition IntrinsicCall.cpp:2507
mlir::Value genAbs(mlir::Type, llvm::ArrayRef< mlir::Value >)
Definition IntrinsicCall.cpp:2521
fir::ExtendedValue genExtremumVal(FN func, FD funcDim, FC funcChar, llvm::StringRef errMsg, mlir::Type resultType, llvm::ArrayRef< fir::ExtendedValue > args)
Helper for MinVal/MaxVal.
Definition IntrinsicCall.cpp:9081
fir::ExtendedValue readAndAddCleanUp(fir::MutableBoxValue resultMutableBox, mlir::Type resultType, llvm::StringRef errMsg)
Helper function for generating code clean-up for result descriptors.
Definition IntrinsicCall.cpp:2462
decltype(&IntrinsicLibrary::genAbs) ElementalGenerator
Definition IntrinsicCall.h:458
fir::ExtendedValue genCAssociatedCPtr(mlir::Type, llvm::ArrayRef< fir::ExtendedValue >)
C_ASSOCIATED (C_PTR [, C_PTR])
Definition IntrinsicCall.cpp:3169
fir::ExtendedValue genCAssociatedCFunPtr(mlir::Type, llvm::ArrayRef< fir::ExtendedValue >)
C_ASSOCIATED (C_FUNPTR [, C_FUNPTR])
Definition IntrinsicCall.cpp:3162
void genRaiseExcept(int excepts, mlir::Value cond={})
Definition IntrinsicCall.cpp:4715
mlir::Value invokeGenerator(ElementalGenerator generator, mlir::Type resultType, llvm::ArrayRef< mlir::Value > args)
Helper to invoke code generator for the intrinsics given arguments.
Definition IntrinsicCall.cpp:2133
fir::ExtendedValue genExtremumloc(FN func, FD funcDim, llvm::StringRef errMsg, mlir::Type, llvm::ArrayRef< fir::ExtendedValue >)
Process calls to Minloc, Maxloc intrinsic functions.
Definition IntrinsicCall.cpp:9000
Definition IntrinsicCall.h:567
Definition IntrinsicCall.h:617
Definition IntrinsicCall.h:555