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,
394 fir::ExtendedValue genStorageSize(mlir::Type,
397 void genSignalSubroutine(llvm::ArrayRef<fir::ExtendedValue>);
399 fir::ExtendedValue genSystem(std::optional<mlir::Type>,
400 mlir::ArrayRef<fir::ExtendedValue> args);
401 void genSystemClock(llvm::ArrayRef<fir::ExtendedValue>);
402 mlir::Value genTand(mlir::Type, llvm::ArrayRef<mlir::Value>);
403 mlir::Value genTanpi(mlir::Type, llvm::ArrayRef<mlir::Value>);
404 fir::ExtendedValue genTeamNumber(mlir::Type,
406 mlir::Value genTime(mlir::Type, llvm::ArrayRef<mlir::Value>);
407 void genTokenize(llvm::ArrayRef<fir::ExtendedValue>);
408 mlir::Value genTrailz(mlir::Type, llvm::ArrayRef<mlir::Value>);
409 fir::ExtendedValue genTransfer(mlir::Type,
411 fir::ExtendedValue genTranspose(mlir::Type,
413 fir::ExtendedValue genThisImage(mlir::Type,
417 fir::ExtendedValue genUnlink(std::optional<mlir::Type> resultType,
421
425 mlir::Value genConversion(mlir::Type, llvm::ArrayRef<mlir::Value>);
426
432 template <typename FN, typename FD>
433 fir::ExtendedValue genExtremumloc(FN func, FD funcDim, llvm::StringRef errMsg,
434 mlir::Type,
436 template <typename FN, typename FD, typename FC>
438 fir::ExtendedValue genExtremumVal(FN func, FD funcDim, FC funcChar,
439 llvm::StringRef errMsg,
440 mlir::Type resultType,
443 template <typename FN, typename FD>
444 fir::ExtendedValue genReduction(FN func, FD funcDim, llvm::StringRef errMsg,
445 mlir::Type resultType,
447
450 void genRaiseExcept(int excepts, mlir::Value cond = {});
451
453 mlir::Value genQNan(mlir::Type resultType);
454
458 using ExtendedGenerator = decltype(&IntrinsicLibrary::genLenTrim);
459 using SubroutineGenerator = decltype(&IntrinsicLibrary::genDateAndTime);
461 using DualGenerator = decltype(&IntrinsicLibrary::genEtime);
462 using Generator = std::variant<ElementalGenerator, ExtendedGenerator,
463 SubroutineGenerator, DualGenerator>;
464
471 template <typename GeneratorType>
472 mlir::Value outlineInWrapper(GeneratorType, llvm::StringRef name,
473 mlir::Type resultType,
475 template <typename GeneratorType>
477 outlineInExtendedWrapper(GeneratorType, llvm::StringRef name,
478 std::optional<mlir::Type> resultType,
480
481 template <typename GeneratorType>
482 mlir::func::FuncOp getWrapper(GeneratorType, llvm::StringRef name,
483 mlir::FunctionType,
484 bool loadRefArguments = false);
485
487 template <typename GeneratorType>
489 genElementalCall(GeneratorType, llvm::StringRef name, mlir::Type resultType,
490 llvm::ArrayRef<fir::ExtendedValue> args, bool outline);
491
493 mlir::Value invokeGenerator(ElementalGenerator generator,
494 mlir::Type resultType,
496 mlir::Value invokeGenerator(RuntimeCallGenerator generator,
497 mlir::Type resultType,
499 mlir::Value invokeGenerator(ExtendedGenerator generator,
500 mlir::Type resultType,
502 mlir::Value invokeGenerator(SubroutineGenerator generator,
504 mlir::Value invokeGenerator(DualGenerator generator,
506 mlir::Value invokeGenerator(DualGenerator generator, mlir::Type resultType,
508
511 mlir::SymbolRefAttr
512 getUnrestrictedIntrinsicSymbolRefAttr(llvm::StringRef name,
513 mlir::FunctionType signature);
514
517 mlir::Type resultType,
518 llvm::StringRef errMsg);
519
520 void setResultMustBeFreed() { resultMustBeFreed = true; }
521
522 fir::FirOpBuilder &builder;
523 mlir::Location loc;
524 bool resultMustBeFreed = false;
525 Fortran::lower::AbstractConverter *converter = nullptr;
526};
527
529 const char *name = nullptr;
531 bool handleDynamicOptional = false;
532};
533
538 constexpr bool hasDefaultRules() const { return args[0].name == nullptr; }
539};
540
544 const char *name;
545 IntrinsicLibrary::Generator generator;
546 // The following may be omitted in the table below.
547 fir::IntrinsicArgumentLoweringRules argLoweringRules = {};
548 bool isElemental = true;
551 bool outline = false;
552};
553
555 // llvm::StringRef comparison operator are not constexpr, so use string_view.
556 using Key = std::string_view;
557 // Needed for implicit compare with keys.
558 constexpr operator Key() const { return key; }
559 Key key; // intrinsic name
560
561 // Name of a runtime function that implements the operation.
562 llvm::StringRef symbol;
563 fir::runtime::FuncTypeBuilderFunc typeGenerator;
564};
565
567 // Callback type for generating lowering for a math operation.
568 using MathGeneratorTy = mlir::Value (*)(fir::FirOpBuilder &, mlir::Location,
569 const MathOperation &,
570 mlir::FunctionType,
572
573 // Overrides fir::runtime::FuncTypeBuilderFunc to add FirOpBuilder argument.
574 using FuncTypeBuilderFunc = mlir::FunctionType (*)(mlir::MLIRContext *,
576
577 // llvm::StringRef comparison operator are not constexpr, so use string_view.
578 using Key = std::string_view;
579 // Needed for implicit compare with keys.
580 constexpr operator Key() const { return key; }
581 // Intrinsic name.
582 Key key;
583
584 // Name of a runtime function that implements the operation.
585 llvm::StringRef runtimeFunc;
586 FuncTypeBuilderFunc typeGenerator;
587
588 // A callback to generate FIR for the intrinsic defined by 'key'.
589 // A callback may generate either dedicated MLIR operation(s) or
590 // a function call to a runtime function with name defined by
591 // 'runtimeFunc'.
592 MathGeneratorTy funcGenerator;
593};
594
595// Enum of most supported intrinsic argument or return types.
596enum class ParamTypeId {
597 Void,
598 Address, // pointer (to an [array of] Integers of some kind)
599 Integer,
600 Real,
601 Complex,
602 IntegerVector,
603 UnsignedVector,
604 RealVector,
605};
606
607// Helper function to get length of a 16-byte vector of element type eleTy.
608static int getVecLen(mlir::Type eleTy) {
609 assert((mlir::isa<mlir::IntegerType>(eleTy) ||
610 mlir::isa<mlir::FloatType>(eleTy)) &&
611 "unsupported vector element type");
612 return 16 / (eleTy.getIntOrFloatBitWidth() / 8);
613}
614
615template <ParamTypeId t, int k>
616struct ParamType {
617 // Supported kinds can be checked with static asserts at compile time.
618 static_assert(t != ParamTypeId::Integer || k == 1 || k == 2 || k == 4 ||
619 k == 8,
620 "Unsupported integer kind");
621 static_assert(t != ParamTypeId::Real || k == 4 || k == 8 || k == 10 ||
622 k == 16,
623 "Unsupported real kind");
624 static_assert(t != ParamTypeId::Complex || k == 2 || k == 3 || k == 4 ||
625 k == 8 || k == 10 || k == 16,
626 "Unsupported complex kind");
627
628 static const ParamTypeId ty = t;
629 static const int kind = k;
630};
631
632// Namespace encapsulating type definitions for parameter types.
633namespace Ty {
635template <int k>
637template <int k>
639template <int k>
641template <int k>
643template <int k>
644using IntegerVector = ParamType<ParamTypeId::IntegerVector, k>;
645template <int k>
646using UnsignedVector = ParamType<ParamTypeId::UnsignedVector, k>;
647template <int k>
649} // namespace Ty
650
651// Helper function that generates most types that are supported for intrinsic
652// arguments and return type. Used by `genFuncType` to generate function
653// types for most of the intrinsics.
654static inline mlir::Type getTypeHelper(mlir::MLIRContext *context,
655 fir::FirOpBuilder &builder,
656 ParamTypeId typeId, int kind) {
657 mlir::Type r;
658 unsigned bits{0};
659 switch (typeId) {
660 case ParamTypeId::Void:
661 llvm::report_fatal_error("can not get type of void");
662 break;
663 case ParamTypeId::Address:
664 bits = builder.getKindMap().getIntegerBitsize(kind);
665 assert(bits != 0 && "failed to convert address kind to integer bitsize");
666 r = fir::ReferenceType::get(mlir::IntegerType::get(context, bits));
667 break;
668 case ParamTypeId::Integer:
669 case ParamTypeId::IntegerVector:
670 bits = builder.getKindMap().getIntegerBitsize(kind);
671 assert(bits != 0 && "failed to convert kind to integer bitsize");
672 r = mlir::IntegerType::get(context, bits);
673 break;
674 case ParamTypeId::UnsignedVector:
675 bits = builder.getKindMap().getIntegerBitsize(kind);
676 assert(bits != 0 && "failed to convert kind to unsigned bitsize");
677 r = mlir::IntegerType::get(context, bits, mlir::IntegerType::Unsigned);
678 break;
679 case ParamTypeId::Real:
680 case ParamTypeId::RealVector:
681 r = builder.getRealType(kind);
682 break;
683 case ParamTypeId::Complex:
684 r = mlir::ComplexType::get(builder.getRealType(kind));
685 break;
686 }
687
688 switch (typeId) {
689 case ParamTypeId::Void:
690 case ParamTypeId::Address:
691 case ParamTypeId::Integer:
692 case ParamTypeId::Real:
693 case ParamTypeId::Complex:
694 break;
695 case ParamTypeId::IntegerVector:
696 case ParamTypeId::UnsignedVector:
697 case ParamTypeId::RealVector:
698 // convert to vector type
699 r = fir::VectorType::get(getVecLen(r), r);
700 }
701 return r;
702}
703
704// Generic function type generator that supports most of the function types
705// used by intrinsics.
706template <typename TyR, typename... ArgTys>
707static inline mlir::FunctionType genFuncType(mlir::MLIRContext *context,
708 fir::FirOpBuilder &builder) {
709 llvm::SmallVector<ParamTypeId> argTys = {ArgTys::ty...};
710 llvm::SmallVector<int> argKinds = {ArgTys::kind...};
711 llvm::SmallVector<mlir::Type> argTypes;
712
713 for (size_t i = 0; i < argTys.size(); ++i) {
714 argTypes.push_back(getTypeHelper(context, builder, argTys[i], argKinds[i]));
715 }
716
717 if (TyR::ty == ParamTypeId::Void)
718 return mlir::FunctionType::get(context, argTypes, {});
719
720 auto resType = getTypeHelper(context, builder, TyR::ty, TyR::kind);
721 return mlir::FunctionType::get(context, argTypes, {resType});
722}
723
725struct IntrinsicHandlerEntry {
726 using RuntimeGeneratorRange =
727 std::pair<const MathOperation *, const MathOperation *>;
728 IntrinsicHandlerEntry(const IntrinsicHandler *handler) : entry{handler} {
729 assert(handler && "handler must not be nullptr");
730 };
731 IntrinsicHandlerEntry(RuntimeGeneratorRange rt) : entry{rt} {};
732 const IntrinsicArgumentLoweringRules *getArgumentLoweringRules() const;
733 std::variant<const IntrinsicHandler *, RuntimeGeneratorRange> entry;
734};
735
736//===----------------------------------------------------------------------===//
737// Helper functions for argument handling.
738//===----------------------------------------------------------------------===//
739static inline mlir::Type getConvertedElementType(mlir::MLIRContext *context,
740 mlir::Type eleTy) {
741 if (mlir::isa<mlir::IntegerType>(eleTy) && !eleTy.isSignlessInteger()) {
742 const auto intTy{mlir::dyn_cast<mlir::IntegerType>(eleTy)};
743 auto newEleTy{mlir::IntegerType::get(context, intTy.getWidth())};
744 return newEleTy;
745 }
746 return eleTy;
747}
748
749static inline llvm::SmallVector<mlir::Value, 4>
750getBasesForArgs(llvm::ArrayRef<fir::ExtendedValue> args) {
751 llvm::SmallVector<mlir::Value, 4> baseVec;
752 for (auto arg : args)
753 baseVec.push_back(getBase(arg));
754 return baseVec;
755}
756
757static inline llvm::SmallVector<mlir::Type, 4>
758getTypesForArgs(llvm::ArrayRef<mlir::Value> args) {
759 llvm::SmallVector<mlir::Type, 4> typeVec;
760 for (auto arg : args)
761 typeVec.push_back(arg.getType());
762 return typeVec;
763}
764
765mlir::Value genLibCall(fir::FirOpBuilder &builder, mlir::Location loc,
766 const MathOperation &mathOp,
767 mlir::FunctionType libFuncType,
768 llvm::ArrayRef<mlir::Value> args);
769
770template <typename T>
771mlir::Value genMathOp(fir::FirOpBuilder &builder, mlir::Location loc,
772 const MathOperation &mathOp,
773 mlir::FunctionType mathLibFuncType,
774 llvm::ArrayRef<mlir::Value> args);
775
776template <typename T>
777mlir::Value genComplexMathOp(fir::FirOpBuilder &builder, mlir::Location loc,
778 const MathOperation &mathOp,
779 mlir::FunctionType mathLibFuncType,
780 llvm::ArrayRef<mlir::Value> args);
781
782mlir::Value genLibSplitComplexArgsCall(fir::FirOpBuilder &builder,
783 mlir::Location loc,
784 const MathOperation &mathOp,
785 mlir::FunctionType libFuncType,
786 llvm::ArrayRef<mlir::Value> args);
787
790std::optional<IntrinsicHandlerEntry>
791lookupIntrinsicHandler(fir::FirOpBuilder &, llvm::StringRef intrinsicName,
792 std::optional<mlir::Type> resultType);
793
795void crashOnMissingIntrinsic(mlir::Location loc, llvm::StringRef name);
796
800getIntrinsicArgumentLowering(llvm::StringRef intrinsicName);
801
805 unsigned position);
806
808fir::ExtendedValue getAbsentIntrinsicArgument();
809
811// implementation) of an unrestricted intrinsic (defined by its signature
812// and generic name)
813mlir::SymbolRefAttr
814getUnrestrictedIntrinsicSymbolRefAttr(fir::FirOpBuilder &, mlir::Location,
815 llvm::StringRef name,
816 mlir::FunctionType signature);
817
818//===----------------------------------------------------------------------===//
819// Direct access to intrinsics that may be used by lowering outside
820// of intrinsic call lowering.
821//===----------------------------------------------------------------------===//
822
825mlir::Value genMax(fir::FirOpBuilder &, mlir::Location,
826 llvm::ArrayRef<mlir::Value> args);
827
829mlir::Value genMin(fir::FirOpBuilder &, mlir::Location,
830 llvm::ArrayRef<mlir::Value> args);
831
834mlir::Value genDivC(fir::FirOpBuilder &builder, mlir::Location loc,
835 mlir::Type resultType, mlir::Value x, mlir::Value y);
836
839mlir::Value genPow(fir::FirOpBuilder &, mlir::Location, mlir::Type resultType,
840 mlir::Value x, mlir::Value y);
841
842} // namespace fir
843
844#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:92
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:1889
const IntrinsicArgumentLoweringRules * getIntrinsicArgumentLowering(llvm::StringRef intrinsicName)
Definition IntrinsicCall.cpp:9129
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:9185
mlir::Value genPow(fir::FirOpBuilder &, mlir::Location, mlir::Type resultType, mlir::Value x, mlir::Value y)
Definition IntrinsicCall.cpp:9197
mlir::Value genDivC(fir::FirOpBuilder &builder, mlir::Location loc, mlir::Type resultType, mlir::Value x, mlir::Value y)
Definition IntrinsicCall.cpp:9192
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:1914
ArgLoweringRule lowerIntrinsicArgumentAs(const IntrinsicArgumentLoweringRules &, unsigned position)
Definition IntrinsicCall.cpp:9157
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:9218
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:9170
mlir::Value genMax(fir::FirOpBuilder &, mlir::Location, llvm::ArrayRef< mlir::Value > args)
Definition IntrinsicCall.cpp:9178
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:535
IntrinsicDummyArgument args[7]
There is no more than 7 non repeated arguments in Fortran intrinsics.
Definition IntrinsicCall.h:537
Definition IntrinsicCall.h:528
Entry into the tables describing how an intrinsic must be lowered.
Definition IntrinsicCall.h:725
Definition IntrinsicCall.h:543
bool outline
Definition IntrinsicCall.h:551
mlir::SymbolRefAttr getUnrestrictedIntrinsicSymbolRefAttr(llvm::StringRef name, mlir::FunctionType signature)
Definition IntrinsicCall.cpp:2421
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:1926
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:4488
std::pair< fir::ExtendedValue, bool > genIntrinsicCall(llvm::StringRef name, std::optional< mlir::Type > resultType, llvm::ArrayRef< fir::ExtendedValue > arg)
Definition IntrinsicCall.cpp:2111
decltype(&IntrinsicLibrary::genEtime) DualGenerator
The generator for intrinsic that has both function and subroutine form.
Definition IntrinsicCall.h:461
mlir::Value outlineInWrapper(GeneratorType, llvm::StringRef name, mlir::Type resultType, llvm::ArrayRef< mlir::Value > args)
Definition IntrinsicCall.cpp:2320
mlir::Value genRuntimeCall(llvm::StringRef name, mlir::Type, llvm::ArrayRef< mlir::Value >)
Definition IntrinsicCall.cpp:2492
mlir::Value genQNan(mlir::Type resultType)
Generate a quiet NaN of a given floating point type.
Definition IntrinsicCall.cpp:4701
mlir::Value genConversion(mlir::Type, llvm::ArrayRef< mlir::Value >)
Definition IntrinsicCall.cpp:2500
mlir::Value genAbs(mlir::Type, llvm::ArrayRef< mlir::Value >)
Definition IntrinsicCall.cpp:2514
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:9041
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:2455
decltype(&IntrinsicLibrary::genAbs) ElementalGenerator
Definition IntrinsicCall.h:457
fir::ExtendedValue genCAssociatedCPtr(mlir::Type, llvm::ArrayRef< fir::ExtendedValue >)
C_ASSOCIATED (C_PTR [, C_PTR])
Definition IntrinsicCall.cpp:3162
fir::ExtendedValue genCAssociatedCFunPtr(mlir::Type, llvm::ArrayRef< fir::ExtendedValue >)
C_ASSOCIATED (C_FUNPTR [, C_FUNPTR])
Definition IntrinsicCall.cpp:3155
void genRaiseExcept(int excepts, mlir::Value cond={})
Definition IntrinsicCall.cpp:4708
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:2126
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:8960
Definition IntrinsicCall.h:566
Definition IntrinsicCall.h:616
Definition IntrinsicCall.h:554