123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631 |
- //===- NeonEmitter.cpp - Generate arm_neon.h for use with clang -*- C++ -*-===//
- //
- // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
- // See https://llvm.org/LICENSE.txt for license information.
- // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
- //
- //===----------------------------------------------------------------------===//
- //
- // This tablegen backend is responsible for emitting arm_neon.h, which includes
- // a declaration and definition of each function specified by the ARM NEON
- // compiler interface. See ARM document DUI0348B.
- //
- // Each NEON instruction is implemented in terms of 1 or more functions which
- // are suffixed with the element type of the input vectors. Functions may be
- // implemented in terms of generic vector operations such as +, *, -, etc. or
- // by calling a __builtin_-prefixed function which will be handled by clang's
- // CodeGen library.
- //
- // Additional validation code can be generated by this file when runHeader() is
- // called, rather than the normal run() entry point.
- //
- // See also the documentation in include/clang/Basic/arm_neon.td.
- //
- //===----------------------------------------------------------------------===//
- #include "TableGenBackends.h"
- #include "llvm/ADT/ArrayRef.h"
- #include "llvm/ADT/DenseMap.h"
- #include "llvm/ADT/None.h"
- #include "llvm/ADT/Optional.h"
- #include "llvm/ADT/STLExtras.h"
- #include "llvm/ADT/SmallVector.h"
- #include "llvm/ADT/StringExtras.h"
- #include "llvm/ADT/StringRef.h"
- #include "llvm/Support/Casting.h"
- #include "llvm/Support/ErrorHandling.h"
- #include "llvm/Support/raw_ostream.h"
- #include "llvm/TableGen/Error.h"
- #include "llvm/TableGen/Record.h"
- #include "llvm/TableGen/SetTheory.h"
- #include <algorithm>
- #include <cassert>
- #include <cctype>
- #include <cstddef>
- #include <cstdint>
- #include <deque>
- #include <map>
- #include <set>
- #include <sstream>
- #include <string>
- #include <utility>
- #include <vector>
- using namespace llvm;
- namespace {
- // While globals are generally bad, this one allows us to perform assertions
- // liberally and somehow still trace them back to the def they indirectly
- // came from.
- static Record *CurrentRecord = nullptr;
- static void assert_with_loc(bool Assertion, const std::string &Str) {
- if (!Assertion) {
- if (CurrentRecord)
- PrintFatalError(CurrentRecord->getLoc(), Str);
- else
- PrintFatalError(Str);
- }
- }
- enum ClassKind {
- ClassNone,
- ClassI, // generic integer instruction, e.g., "i8" suffix
- ClassS, // signed/unsigned/poly, e.g., "s8", "u8" or "p8" suffix
- ClassW, // width-specific instruction, e.g., "8" suffix
- ClassB, // bitcast arguments with enum argument to specify type
- ClassL, // Logical instructions which are op instructions
- // but we need to not emit any suffix for in our
- // tests.
- ClassNoTest // Instructions which we do not test since they are
- // not TRUE instructions.
- };
- /// NeonTypeFlags - Flags to identify the types for overloaded Neon
- /// builtins. These must be kept in sync with the flags in
- /// include/clang/Basic/TargetBuiltins.h.
- namespace NeonTypeFlags {
- enum { EltTypeMask = 0xf, UnsignedFlag = 0x10, QuadFlag = 0x20 };
- enum EltType {
- Int8,
- Int16,
- Int32,
- Int64,
- Poly8,
- Poly16,
- Poly64,
- Poly128,
- Float16,
- Float32,
- Float64,
- BFloat16
- };
- } // end namespace NeonTypeFlags
- class NeonEmitter;
- //===----------------------------------------------------------------------===//
- // TypeSpec
- //===----------------------------------------------------------------------===//
- /// A TypeSpec is just a simple wrapper around a string, but gets its own type
- /// for strong typing purposes.
- ///
- /// A TypeSpec can be used to create a type.
- class TypeSpec : public std::string {
- public:
- static std::vector<TypeSpec> fromTypeSpecs(StringRef Str) {
- std::vector<TypeSpec> Ret;
- TypeSpec Acc;
- for (char I : Str.str()) {
- if (islower(I)) {
- Acc.push_back(I);
- Ret.push_back(TypeSpec(Acc));
- Acc.clear();
- } else {
- Acc.push_back(I);
- }
- }
- return Ret;
- }
- };
- //===----------------------------------------------------------------------===//
- // Type
- //===----------------------------------------------------------------------===//
- /// A Type. Not much more to say here.
- class Type {
- private:
- TypeSpec TS;
- enum TypeKind {
- Void,
- Float,
- SInt,
- UInt,
- Poly,
- BFloat16,
- };
- TypeKind Kind;
- bool Immediate, Constant, Pointer;
- // ScalarForMangling and NoManglingQ are really not suited to live here as
- // they are not related to the type. But they live in the TypeSpec (not the
- // prototype), so this is really the only place to store them.
- bool ScalarForMangling, NoManglingQ;
- unsigned Bitwidth, ElementBitwidth, NumVectors;
- public:
- Type()
- : Kind(Void), Immediate(false), Constant(false),
- Pointer(false), ScalarForMangling(false), NoManglingQ(false),
- Bitwidth(0), ElementBitwidth(0), NumVectors(0) {}
- Type(TypeSpec TS, StringRef CharMods)
- : TS(std::move(TS)), Kind(Void), Immediate(false),
- Constant(false), Pointer(false), ScalarForMangling(false),
- NoManglingQ(false), Bitwidth(0), ElementBitwidth(0), NumVectors(0) {
- applyModifiers(CharMods);
- }
- /// Returns a type representing "void".
- static Type getVoid() { return Type(); }
- bool operator==(const Type &Other) const { return str() == Other.str(); }
- bool operator!=(const Type &Other) const { return !operator==(Other); }
- //
- // Query functions
- //
- bool isScalarForMangling() const { return ScalarForMangling; }
- bool noManglingQ() const { return NoManglingQ; }
- bool isPointer() const { return Pointer; }
- bool isValue() const { return !isVoid() && !isPointer(); }
- bool isScalar() const { return isValue() && NumVectors == 0; }
- bool isVector() const { return isValue() && NumVectors > 0; }
- bool isConstPointer() const { return Constant; }
- bool isFloating() const { return Kind == Float; }
- bool isInteger() const { return Kind == SInt || Kind == UInt; }
- bool isPoly() const { return Kind == Poly; }
- bool isSigned() const { return Kind == SInt; }
- bool isImmediate() const { return Immediate; }
- bool isFloat() const { return isFloating() && ElementBitwidth == 32; }
- bool isDouble() const { return isFloating() && ElementBitwidth == 64; }
- bool isHalf() const { return isFloating() && ElementBitwidth == 16; }
- bool isChar() const { return ElementBitwidth == 8; }
- bool isShort() const { return isInteger() && ElementBitwidth == 16; }
- bool isInt() const { return isInteger() && ElementBitwidth == 32; }
- bool isLong() const { return isInteger() && ElementBitwidth == 64; }
- bool isVoid() const { return Kind == Void; }
- bool isBFloat16() const { return Kind == BFloat16; }
- unsigned getNumElements() const { return Bitwidth / ElementBitwidth; }
- unsigned getSizeInBits() const { return Bitwidth; }
- unsigned getElementSizeInBits() const { return ElementBitwidth; }
- unsigned getNumVectors() const { return NumVectors; }
- //
- // Mutator functions
- //
- void makeUnsigned() {
- assert(!isVoid() && "not a potentially signed type");
- Kind = UInt;
- }
- void makeSigned() {
- assert(!isVoid() && "not a potentially signed type");
- Kind = SInt;
- }
- void makeInteger(unsigned ElemWidth, bool Sign) {
- assert(!isVoid() && "converting void to int probably not useful");
- Kind = Sign ? SInt : UInt;
- Immediate = false;
- ElementBitwidth = ElemWidth;
- }
- void makeImmediate(unsigned ElemWidth) {
- Kind = SInt;
- Immediate = true;
- ElementBitwidth = ElemWidth;
- }
- void makeScalar() {
- Bitwidth = ElementBitwidth;
- NumVectors = 0;
- }
- void makeOneVector() {
- assert(isVector());
- NumVectors = 1;
- }
- void make32BitElement() {
- assert_with_loc(Bitwidth > 32, "Not enough bits to make it 32!");
- ElementBitwidth = 32;
- }
- void doubleLanes() {
- assert_with_loc(Bitwidth != 128, "Can't get bigger than 128!");
- Bitwidth = 128;
- }
- void halveLanes() {
- assert_with_loc(Bitwidth != 64, "Can't get smaller than 64!");
- Bitwidth = 64;
- }
- /// Return the C string representation of a type, which is the typename
- /// defined in stdint.h or arm_neon.h.
- std::string str() const;
- /// Return the string representation of a type, which is an encoded
- /// string for passing to the BUILTIN() macro in Builtins.def.
- std::string builtin_str() const;
- /// Return the value in NeonTypeFlags for this type.
- unsigned getNeonEnum() const;
- /// Parse a type from a stdint.h or arm_neon.h typedef name,
- /// for example uint32x2_t or int64_t.
- static Type fromTypedefName(StringRef Name);
- private:
- /// Creates the type based on the typespec string in TS.
- /// Sets "Quad" to true if the "Q" or "H" modifiers were
- /// seen. This is needed by applyModifier as some modifiers
- /// only take effect if the type size was changed by "Q" or "H".
- void applyTypespec(bool &Quad);
- /// Applies prototype modifiers to the type.
- void applyModifiers(StringRef Mods);
- };
- //===----------------------------------------------------------------------===//
- // Variable
- //===----------------------------------------------------------------------===//
- /// A variable is a simple class that just has a type and a name.
- class Variable {
- Type T;
- std::string N;
- public:
- Variable() : T(Type::getVoid()) {}
- Variable(Type T, std::string N) : T(std::move(T)), N(std::move(N)) {}
- Type getType() const { return T; }
- std::string getName() const { return "__" + N; }
- };
- //===----------------------------------------------------------------------===//
- // Intrinsic
- //===----------------------------------------------------------------------===//
- /// The main grunt class. This represents an instantiation of an intrinsic with
- /// a particular typespec and prototype.
- class Intrinsic {
- /// The Record this intrinsic was created from.
- Record *R;
- /// The unmangled name.
- std::string Name;
- /// The input and output typespecs. InTS == OutTS except when
- /// CartesianProductWith is non-empty - this is the case for vreinterpret.
- TypeSpec OutTS, InTS;
- /// The base class kind. Most intrinsics use ClassS, which has full type
- /// info for integers (s32/u32). Some use ClassI, which doesn't care about
- /// signedness (i32), while some (ClassB) have no type at all, only a width
- /// (32).
- ClassKind CK;
- /// The list of DAGs for the body. May be empty, in which case we should
- /// emit a builtin call.
- ListInit *Body;
- /// The architectural #ifdef guard.
- std::string Guard;
- /// Set if the Unavailable bit is 1. This means we don't generate a body,
- /// just an "unavailable" attribute on a declaration.
- bool IsUnavailable;
- /// Is this intrinsic safe for big-endian? or does it need its arguments
- /// reversing?
- bool BigEndianSafe;
- /// The types of return value [0] and parameters [1..].
- std::vector<Type> Types;
- /// The index of the key type passed to CGBuiltin.cpp for polymorphic calls.
- int PolymorphicKeyType;
- /// The local variables defined.
- std::map<std::string, Variable> Variables;
- /// NeededEarly - set if any other intrinsic depends on this intrinsic.
- bool NeededEarly;
- /// UseMacro - set if we should implement using a macro or unset for a
- /// function.
- bool UseMacro;
- /// The set of intrinsics that this intrinsic uses/requires.
- std::set<Intrinsic *> Dependencies;
- /// The "base type", which is Type('d', OutTS). InBaseType is only
- /// different if CartesianProductWith is non-empty (for vreinterpret).
- Type BaseType, InBaseType;
- /// The return variable.
- Variable RetVar;
- /// A postfix to apply to every variable. Defaults to "".
- std::string VariablePostfix;
- NeonEmitter &Emitter;
- std::stringstream OS;
- bool isBigEndianSafe() const {
- if (BigEndianSafe)
- return true;
- for (const auto &T : Types){
- if (T.isVector() && T.getNumElements() > 1)
- return false;
- }
- return true;
- }
- public:
- Intrinsic(Record *R, StringRef Name, StringRef Proto, TypeSpec OutTS,
- TypeSpec InTS, ClassKind CK, ListInit *Body, NeonEmitter &Emitter,
- StringRef Guard, bool IsUnavailable, bool BigEndianSafe)
- : R(R), Name(Name.str()), OutTS(OutTS), InTS(InTS), CK(CK), Body(Body),
- Guard(Guard.str()), IsUnavailable(IsUnavailable),
- BigEndianSafe(BigEndianSafe), PolymorphicKeyType(0), NeededEarly(false),
- UseMacro(false), BaseType(OutTS, "."), InBaseType(InTS, "."),
- Emitter(Emitter) {
- // Modify the TypeSpec per-argument to get a concrete Type, and create
- // known variables for each.
- // Types[0] is the return value.
- unsigned Pos = 0;
- Types.emplace_back(OutTS, getNextModifiers(Proto, Pos));
- StringRef Mods = getNextModifiers(Proto, Pos);
- while (!Mods.empty()) {
- Types.emplace_back(InTS, Mods);
- if (Mods.contains('!'))
- PolymorphicKeyType = Types.size() - 1;
- Mods = getNextModifiers(Proto, Pos);
- }
- for (auto Type : Types) {
- // If this builtin takes an immediate argument, we need to #define it rather
- // than use a standard declaration, so that SemaChecking can range check
- // the immediate passed by the user.
- // Pointer arguments need to use macros to avoid hiding aligned attributes
- // from the pointer type.
- // It is not permitted to pass or return an __fp16 by value, so intrinsics
- // taking a scalar float16_t must be implemented as macros.
- if (Type.isImmediate() || Type.isPointer() ||
- (Type.isScalar() && Type.isHalf()))
- UseMacro = true;
- }
- }
- /// Get the Record that this intrinsic is based off.
- Record *getRecord() const { return R; }
- /// Get the set of Intrinsics that this intrinsic calls.
- /// this is the set of immediate dependencies, NOT the
- /// transitive closure.
- const std::set<Intrinsic *> &getDependencies() const { return Dependencies; }
- /// Get the architectural guard string (#ifdef).
- std::string getGuard() const { return Guard; }
- /// Get the non-mangled name.
- std::string getName() const { return Name; }
- /// Return true if the intrinsic takes an immediate operand.
- bool hasImmediate() const {
- return llvm::any_of(Types, [](const Type &T) { return T.isImmediate(); });
- }
- /// Return the parameter index of the immediate operand.
- unsigned getImmediateIdx() const {
- for (unsigned Idx = 0; Idx < Types.size(); ++Idx)
- if (Types[Idx].isImmediate())
- return Idx - 1;
- llvm_unreachable("Intrinsic has no immediate");
- }
- unsigned getNumParams() const { return Types.size() - 1; }
- Type getReturnType() const { return Types[0]; }
- Type getParamType(unsigned I) const { return Types[I + 1]; }
- Type getBaseType() const { return BaseType; }
- Type getPolymorphicKeyType() const { return Types[PolymorphicKeyType]; }
- /// Return true if the prototype has a scalar argument.
- bool protoHasScalar() const;
- /// Return the index that parameter PIndex will sit at
- /// in a generated function call. This is often just PIndex,
- /// but may not be as things such as multiple-vector operands
- /// and sret parameters need to be taken into accont.
- unsigned getGeneratedParamIdx(unsigned PIndex) {
- unsigned Idx = 0;
- if (getReturnType().getNumVectors() > 1)
- // Multiple vectors are passed as sret.
- ++Idx;
- for (unsigned I = 0; I < PIndex; ++I)
- Idx += std::max(1U, getParamType(I).getNumVectors());
- return Idx;
- }
- bool hasBody() const { return Body && !Body->getValues().empty(); }
- void setNeededEarly() { NeededEarly = true; }
- bool operator<(const Intrinsic &Other) const {
- // Sort lexicographically on a two-tuple (Guard, Name)
- if (Guard != Other.Guard)
- return Guard < Other.Guard;
- return Name < Other.Name;
- }
- ClassKind getClassKind(bool UseClassBIfScalar = false) {
- if (UseClassBIfScalar && !protoHasScalar())
- return ClassB;
- return CK;
- }
- /// Return the name, mangled with type information.
- /// If ForceClassS is true, use ClassS (u32/s32) instead
- /// of the intrinsic's own type class.
- std::string getMangledName(bool ForceClassS = false) const;
- /// Return the type code for a builtin function call.
- std::string getInstTypeCode(Type T, ClassKind CK) const;
- /// Return the type string for a BUILTIN() macro in Builtins.def.
- std::string getBuiltinTypeStr();
- /// Generate the intrinsic, returning code.
- std::string generate();
- /// Perform type checking and populate the dependency graph, but
- /// don't generate code yet.
- void indexBody();
- private:
- StringRef getNextModifiers(StringRef Proto, unsigned &Pos) const;
- std::string mangleName(std::string Name, ClassKind CK) const;
- void initVariables();
- std::string replaceParamsIn(std::string S);
- void emitBodyAsBuiltinCall();
- void generateImpl(bool ReverseArguments,
- StringRef NamePrefix, StringRef CallPrefix);
- void emitReturn();
- void emitBody(StringRef CallPrefix);
- void emitShadowedArgs();
- void emitArgumentReversal();
- void emitReturnVarDecl();
- void emitReturnReversal();
- void emitReverseVariable(Variable &Dest, Variable &Src);
- void emitNewLine();
- void emitClosingBrace();
- void emitOpeningBrace();
- void emitPrototype(StringRef NamePrefix);
- class DagEmitter {
- Intrinsic &Intr;
- StringRef CallPrefix;
- public:
- DagEmitter(Intrinsic &Intr, StringRef CallPrefix) :
- Intr(Intr), CallPrefix(CallPrefix) {
- }
- std::pair<Type, std::string> emitDagArg(Init *Arg, std::string ArgName);
- std::pair<Type, std::string> emitDagSaveTemp(DagInit *DI);
- std::pair<Type, std::string> emitDagSplat(DagInit *DI);
- std::pair<Type, std::string> emitDagDup(DagInit *DI);
- std::pair<Type, std::string> emitDagDupTyped(DagInit *DI);
- std::pair<Type, std::string> emitDagShuffle(DagInit *DI);
- std::pair<Type, std::string> emitDagCast(DagInit *DI, bool IsBitCast);
- std::pair<Type, std::string> emitDagCall(DagInit *DI,
- bool MatchMangledName);
- std::pair<Type, std::string> emitDagNameReplace(DagInit *DI);
- std::pair<Type, std::string> emitDagLiteral(DagInit *DI);
- std::pair<Type, std::string> emitDagOp(DagInit *DI);
- std::pair<Type, std::string> emitDag(DagInit *DI);
- };
- };
- //===----------------------------------------------------------------------===//
- // NeonEmitter
- //===----------------------------------------------------------------------===//
- class NeonEmitter {
- RecordKeeper &Records;
- DenseMap<Record *, ClassKind> ClassMap;
- std::map<std::string, std::deque<Intrinsic>> IntrinsicMap;
- unsigned UniqueNumber;
- void createIntrinsic(Record *R, SmallVectorImpl<Intrinsic *> &Out);
- void genBuiltinsDef(raw_ostream &OS, SmallVectorImpl<Intrinsic *> &Defs);
- void genOverloadTypeCheckCode(raw_ostream &OS,
- SmallVectorImpl<Intrinsic *> &Defs);
- void genIntrinsicRangeCheckCode(raw_ostream &OS,
- SmallVectorImpl<Intrinsic *> &Defs);
- public:
- /// Called by Intrinsic - this attempts to get an intrinsic that takes
- /// the given types as arguments.
- Intrinsic &getIntrinsic(StringRef Name, ArrayRef<Type> Types,
- Optional<std::string> MangledName);
- /// Called by Intrinsic - returns a globally-unique number.
- unsigned getUniqueNumber() { return UniqueNumber++; }
- NeonEmitter(RecordKeeper &R) : Records(R), UniqueNumber(0) {
- Record *SI = R.getClass("SInst");
- Record *II = R.getClass("IInst");
- Record *WI = R.getClass("WInst");
- Record *SOpI = R.getClass("SOpInst");
- Record *IOpI = R.getClass("IOpInst");
- Record *WOpI = R.getClass("WOpInst");
- Record *LOpI = R.getClass("LOpInst");
- Record *NoTestOpI = R.getClass("NoTestOpInst");
- ClassMap[SI] = ClassS;
- ClassMap[II] = ClassI;
- ClassMap[WI] = ClassW;
- ClassMap[SOpI] = ClassS;
- ClassMap[IOpI] = ClassI;
- ClassMap[WOpI] = ClassW;
- ClassMap[LOpI] = ClassL;
- ClassMap[NoTestOpI] = ClassNoTest;
- }
- // Emit arm_neon.h.inc
- void run(raw_ostream &o);
- // Emit arm_fp16.h.inc
- void runFP16(raw_ostream &o);
- // Emit arm_bf16.h.inc
- void runBF16(raw_ostream &o);
- // Emit all the __builtin prototypes used in arm_neon.h, arm_fp16.h and
- // arm_bf16.h
- void runHeader(raw_ostream &o);
- };
- } // end anonymous namespace
- //===----------------------------------------------------------------------===//
- // Type implementation
- //===----------------------------------------------------------------------===//
- std::string Type::str() const {
- if (isVoid())
- return "void";
- std::string S;
- if (isInteger() && !isSigned())
- S += "u";
- if (isPoly())
- S += "poly";
- else if (isFloating())
- S += "float";
- else if (isBFloat16())
- S += "bfloat";
- else
- S += "int";
- S += utostr(ElementBitwidth);
- if (isVector())
- S += "x" + utostr(getNumElements());
- if (NumVectors > 1)
- S += "x" + utostr(NumVectors);
- S += "_t";
- if (Constant)
- S += " const";
- if (Pointer)
- S += " *";
- return S;
- }
- std::string Type::builtin_str() const {
- std::string S;
- if (isVoid())
- return "v";
- if (isPointer()) {
- // All pointers are void pointers.
- S = "v";
- if (isConstPointer())
- S += "C";
- S += "*";
- return S;
- } else if (isInteger())
- switch (ElementBitwidth) {
- case 8: S += "c"; break;
- case 16: S += "s"; break;
- case 32: S += "i"; break;
- case 64: S += "Wi"; break;
- case 128: S += "LLLi"; break;
- default: llvm_unreachable("Unhandled case!");
- }
- else if (isBFloat16()) {
- assert(ElementBitwidth == 16 && "BFloat16 can only be 16 bits");
- S += "y";
- } else
- switch (ElementBitwidth) {
- case 16: S += "h"; break;
- case 32: S += "f"; break;
- case 64: S += "d"; break;
- default: llvm_unreachable("Unhandled case!");
- }
- // FIXME: NECESSARY???????????????????????????????????????????????????????????????????????
- if (isChar() && !isPointer() && isSigned())
- // Make chars explicitly signed.
- S = "S" + S;
- else if (isInteger() && !isSigned())
- S = "U" + S;
- // Constant indices are "int", but have the "constant expression" modifier.
- if (isImmediate()) {
- assert(isInteger() && isSigned());
- S = "I" + S;
- }
- if (isScalar())
- return S;
- std::string Ret;
- for (unsigned I = 0; I < NumVectors; ++I)
- Ret += "V" + utostr(getNumElements()) + S;
- return Ret;
- }
- unsigned Type::getNeonEnum() const {
- unsigned Addend;
- switch (ElementBitwidth) {
- case 8: Addend = 0; break;
- case 16: Addend = 1; break;
- case 32: Addend = 2; break;
- case 64: Addend = 3; break;
- case 128: Addend = 4; break;
- default: llvm_unreachable("Unhandled element bitwidth!");
- }
- unsigned Base = (unsigned)NeonTypeFlags::Int8 + Addend;
- if (isPoly()) {
- // Adjustment needed because Poly32 doesn't exist.
- if (Addend >= 2)
- --Addend;
- Base = (unsigned)NeonTypeFlags::Poly8 + Addend;
- }
- if (isFloating()) {
- assert(Addend != 0 && "Float8 doesn't exist!");
- Base = (unsigned)NeonTypeFlags::Float16 + (Addend - 1);
- }
- if (isBFloat16()) {
- assert(Addend == 1 && "BFloat16 is only 16 bit");
- Base = (unsigned)NeonTypeFlags::BFloat16;
- }
- if (Bitwidth == 128)
- Base |= (unsigned)NeonTypeFlags::QuadFlag;
- if (isInteger() && !isSigned())
- Base |= (unsigned)NeonTypeFlags::UnsignedFlag;
- return Base;
- }
- Type Type::fromTypedefName(StringRef Name) {
- Type T;
- T.Kind = SInt;
- if (Name.front() == 'u') {
- T.Kind = UInt;
- Name = Name.drop_front();
- }
- if (Name.startswith("float")) {
- T.Kind = Float;
- Name = Name.drop_front(5);
- } else if (Name.startswith("poly")) {
- T.Kind = Poly;
- Name = Name.drop_front(4);
- } else if (Name.startswith("bfloat")) {
- T.Kind = BFloat16;
- Name = Name.drop_front(6);
- } else {
- assert(Name.startswith("int"));
- Name = Name.drop_front(3);
- }
- unsigned I = 0;
- for (I = 0; I < Name.size(); ++I) {
- if (!isdigit(Name[I]))
- break;
- }
- Name.substr(0, I).getAsInteger(10, T.ElementBitwidth);
- Name = Name.drop_front(I);
- T.Bitwidth = T.ElementBitwidth;
- T.NumVectors = 1;
- if (Name.front() == 'x') {
- Name = Name.drop_front();
- unsigned I = 0;
- for (I = 0; I < Name.size(); ++I) {
- if (!isdigit(Name[I]))
- break;
- }
- unsigned NumLanes;
- Name.substr(0, I).getAsInteger(10, NumLanes);
- Name = Name.drop_front(I);
- T.Bitwidth = T.ElementBitwidth * NumLanes;
- } else {
- // Was scalar.
- T.NumVectors = 0;
- }
- if (Name.front() == 'x') {
- Name = Name.drop_front();
- unsigned I = 0;
- for (I = 0; I < Name.size(); ++I) {
- if (!isdigit(Name[I]))
- break;
- }
- Name.substr(0, I).getAsInteger(10, T.NumVectors);
- Name = Name.drop_front(I);
- }
- assert(Name.startswith("_t") && "Malformed typedef!");
- return T;
- }
- void Type::applyTypespec(bool &Quad) {
- std::string S = TS;
- ScalarForMangling = false;
- Kind = SInt;
- ElementBitwidth = ~0U;
- NumVectors = 1;
- for (char I : S) {
- switch (I) {
- case 'S':
- ScalarForMangling = true;
- break;
- case 'H':
- NoManglingQ = true;
- Quad = true;
- break;
- case 'Q':
- Quad = true;
- break;
- case 'P':
- Kind = Poly;
- break;
- case 'U':
- Kind = UInt;
- break;
- case 'c':
- ElementBitwidth = 8;
- break;
- case 'h':
- Kind = Float;
- LLVM_FALLTHROUGH;
- case 's':
- ElementBitwidth = 16;
- break;
- case 'f':
- Kind = Float;
- LLVM_FALLTHROUGH;
- case 'i':
- ElementBitwidth = 32;
- break;
- case 'd':
- Kind = Float;
- LLVM_FALLTHROUGH;
- case 'l':
- ElementBitwidth = 64;
- break;
- case 'k':
- ElementBitwidth = 128;
- // Poly doesn't have a 128x1 type.
- if (isPoly())
- NumVectors = 0;
- break;
- case 'b':
- Kind = BFloat16;
- ElementBitwidth = 16;
- break;
- default:
- llvm_unreachable("Unhandled type code!");
- }
- }
- assert(ElementBitwidth != ~0U && "Bad element bitwidth!");
- Bitwidth = Quad ? 128 : 64;
- }
- void Type::applyModifiers(StringRef Mods) {
- bool AppliedQuad = false;
- applyTypespec(AppliedQuad);
- for (char Mod : Mods) {
- switch (Mod) {
- case '.':
- break;
- case 'v':
- Kind = Void;
- break;
- case 'S':
- Kind = SInt;
- break;
- case 'U':
- Kind = UInt;
- break;
- case 'B':
- Kind = BFloat16;
- ElementBitwidth = 16;
- break;
- case 'F':
- Kind = Float;
- break;
- case 'P':
- Kind = Poly;
- break;
- case '>':
- assert(ElementBitwidth < 128);
- ElementBitwidth *= 2;
- break;
- case '<':
- assert(ElementBitwidth > 8);
- ElementBitwidth /= 2;
- break;
- case '1':
- NumVectors = 0;
- break;
- case '2':
- NumVectors = 2;
- break;
- case '3':
- NumVectors = 3;
- break;
- case '4':
- NumVectors = 4;
- break;
- case '*':
- Pointer = true;
- break;
- case 'c':
- Constant = true;
- break;
- case 'Q':
- Bitwidth = 128;
- break;
- case 'q':
- Bitwidth = 64;
- break;
- case 'I':
- Kind = SInt;
- ElementBitwidth = Bitwidth = 32;
- NumVectors = 0;
- Immediate = true;
- break;
- case 'p':
- if (isPoly())
- Kind = UInt;
- break;
- case '!':
- // Key type, handled elsewhere.
- break;
- default:
- llvm_unreachable("Unhandled character!");
- }
- }
- }
- //===----------------------------------------------------------------------===//
- // Intrinsic implementation
- //===----------------------------------------------------------------------===//
- StringRef Intrinsic::getNextModifiers(StringRef Proto, unsigned &Pos) const {
- if (Proto.size() == Pos)
- return StringRef();
- else if (Proto[Pos] != '(')
- return Proto.substr(Pos++, 1);
- size_t Start = Pos + 1;
- size_t End = Proto.find(')', Start);
- assert_with_loc(End != StringRef::npos, "unmatched modifier group paren");
- Pos = End + 1;
- return Proto.slice(Start, End);
- }
- std::string Intrinsic::getInstTypeCode(Type T, ClassKind CK) const {
- char typeCode = '\0';
- bool printNumber = true;
- if (CK == ClassB)
- return "";
- if (T.isBFloat16())
- return "bf16";
- if (T.isPoly())
- typeCode = 'p';
- else if (T.isInteger())
- typeCode = T.isSigned() ? 's' : 'u';
- else
- typeCode = 'f';
- if (CK == ClassI) {
- switch (typeCode) {
- default:
- break;
- case 's':
- case 'u':
- case 'p':
- typeCode = 'i';
- break;
- }
- }
- if (CK == ClassB) {
- typeCode = '\0';
- }
- std::string S;
- if (typeCode != '\0')
- S.push_back(typeCode);
- if (printNumber)
- S += utostr(T.getElementSizeInBits());
- return S;
- }
- std::string Intrinsic::getBuiltinTypeStr() {
- ClassKind LocalCK = getClassKind(true);
- std::string S;
- Type RetT = getReturnType();
- if ((LocalCK == ClassI || LocalCK == ClassW) && RetT.isScalar() &&
- !RetT.isFloating() && !RetT.isBFloat16())
- RetT.makeInteger(RetT.getElementSizeInBits(), false);
- // Since the return value must be one type, return a vector type of the
- // appropriate width which we will bitcast. An exception is made for
- // returning structs of 2, 3, or 4 vectors which are returned in a sret-like
- // fashion, storing them to a pointer arg.
- if (RetT.getNumVectors() > 1) {
- S += "vv*"; // void result with void* first argument
- } else {
- if (RetT.isPoly())
- RetT.makeInteger(RetT.getElementSizeInBits(), false);
- if (!RetT.isScalar() && RetT.isInteger() && !RetT.isSigned())
- RetT.makeSigned();
- if (LocalCK == ClassB && RetT.isValue() && !RetT.isScalar())
- // Cast to vector of 8-bit elements.
- RetT.makeInteger(8, true);
- S += RetT.builtin_str();
- }
- for (unsigned I = 0; I < getNumParams(); ++I) {
- Type T = getParamType(I);
- if (T.isPoly())
- T.makeInteger(T.getElementSizeInBits(), false);
- if (LocalCK == ClassB && !T.isScalar())
- T.makeInteger(8, true);
- // Halves always get converted to 8-bit elements.
- if (T.isHalf() && T.isVector() && !T.isScalarForMangling())
- T.makeInteger(8, true);
- if (LocalCK == ClassI && T.isInteger())
- T.makeSigned();
- if (hasImmediate() && getImmediateIdx() == I)
- T.makeImmediate(32);
- S += T.builtin_str();
- }
- // Extra constant integer to hold type class enum for this function, e.g. s8
- if (LocalCK == ClassB)
- S += "i";
- return S;
- }
- std::string Intrinsic::getMangledName(bool ForceClassS) const {
- // Check if the prototype has a scalar operand with the type of the vector
- // elements. If not, bitcasting the args will take care of arg checking.
- // The actual signedness etc. will be taken care of with special enums.
- ClassKind LocalCK = CK;
- if (!protoHasScalar())
- LocalCK = ClassB;
- return mangleName(Name, ForceClassS ? ClassS : LocalCK);
- }
- std::string Intrinsic::mangleName(std::string Name, ClassKind LocalCK) const {
- std::string typeCode = getInstTypeCode(BaseType, LocalCK);
- std::string S = Name;
- if (Name == "vcvt_f16_f32" || Name == "vcvt_f32_f16" ||
- Name == "vcvt_f32_f64" || Name == "vcvt_f64_f32" ||
- Name == "vcvt_f32_bf16")
- return Name;
- if (!typeCode.empty()) {
- // If the name ends with _xN (N = 2,3,4), insert the typeCode before _xN.
- if (Name.size() >= 3 && isdigit(Name.back()) &&
- Name[Name.length() - 2] == 'x' && Name[Name.length() - 3] == '_')
- S.insert(S.length() - 3, "_" + typeCode);
- else
- S += "_" + typeCode;
- }
- if (BaseType != InBaseType) {
- // A reinterpret - out the input base type at the end.
- S += "_" + getInstTypeCode(InBaseType, LocalCK);
- }
- if (LocalCK == ClassB)
- S += "_v";
- // Insert a 'q' before the first '_' character so that it ends up before
- // _lane or _n on vector-scalar operations.
- if (BaseType.getSizeInBits() == 128 && !BaseType.noManglingQ()) {
- size_t Pos = S.find('_');
- S.insert(Pos, "q");
- }
- char Suffix = '\0';
- if (BaseType.isScalarForMangling()) {
- switch (BaseType.getElementSizeInBits()) {
- case 8: Suffix = 'b'; break;
- case 16: Suffix = 'h'; break;
- case 32: Suffix = 's'; break;
- case 64: Suffix = 'd'; break;
- default: llvm_unreachable("Bad suffix!");
- }
- }
- if (Suffix != '\0') {
- size_t Pos = S.find('_');
- S.insert(Pos, &Suffix, 1);
- }
- return S;
- }
- std::string Intrinsic::replaceParamsIn(std::string S) {
- while (S.find('$') != std::string::npos) {
- size_t Pos = S.find('$');
- size_t End = Pos + 1;
- while (isalpha(S[End]))
- ++End;
- std::string VarName = S.substr(Pos + 1, End - Pos - 1);
- assert_with_loc(Variables.find(VarName) != Variables.end(),
- "Variable not defined!");
- S.replace(Pos, End - Pos, Variables.find(VarName)->second.getName());
- }
- return S;
- }
- void Intrinsic::initVariables() {
- Variables.clear();
- // Modify the TypeSpec per-argument to get a concrete Type, and create
- // known variables for each.
- for (unsigned I = 1; I < Types.size(); ++I) {
- char NameC = '0' + (I - 1);
- std::string Name = "p";
- Name.push_back(NameC);
- Variables[Name] = Variable(Types[I], Name + VariablePostfix);
- }
- RetVar = Variable(Types[0], "ret" + VariablePostfix);
- }
- void Intrinsic::emitPrototype(StringRef NamePrefix) {
- if (UseMacro)
- OS << "#define ";
- else
- OS << "__ai " << Types[0].str() << " ";
- OS << NamePrefix.str() << mangleName(Name, ClassS) << "(";
- for (unsigned I = 0; I < getNumParams(); ++I) {
- if (I != 0)
- OS << ", ";
- char NameC = '0' + I;
- std::string Name = "p";
- Name.push_back(NameC);
- assert(Variables.find(Name) != Variables.end());
- Variable &V = Variables[Name];
- if (!UseMacro)
- OS << V.getType().str() << " ";
- OS << V.getName();
- }
- OS << ")";
- }
- void Intrinsic::emitOpeningBrace() {
- if (UseMacro)
- OS << " __extension__ ({";
- else
- OS << " {";
- emitNewLine();
- }
- void Intrinsic::emitClosingBrace() {
- if (UseMacro)
- OS << "})";
- else
- OS << "}";
- }
- void Intrinsic::emitNewLine() {
- if (UseMacro)
- OS << " \\\n";
- else
- OS << "\n";
- }
- void Intrinsic::emitReverseVariable(Variable &Dest, Variable &Src) {
- if (Dest.getType().getNumVectors() > 1) {
- emitNewLine();
- for (unsigned K = 0; K < Dest.getType().getNumVectors(); ++K) {
- OS << " " << Dest.getName() << ".val[" << K << "] = "
- << "__builtin_shufflevector("
- << Src.getName() << ".val[" << K << "], "
- << Src.getName() << ".val[" << K << "]";
- for (int J = Dest.getType().getNumElements() - 1; J >= 0; --J)
- OS << ", " << J;
- OS << ");";
- emitNewLine();
- }
- } else {
- OS << " " << Dest.getName()
- << " = __builtin_shufflevector(" << Src.getName() << ", " << Src.getName();
- for (int J = Dest.getType().getNumElements() - 1; J >= 0; --J)
- OS << ", " << J;
- OS << ");";
- emitNewLine();
- }
- }
- void Intrinsic::emitArgumentReversal() {
- if (isBigEndianSafe())
- return;
- // Reverse all vector arguments.
- for (unsigned I = 0; I < getNumParams(); ++I) {
- std::string Name = "p" + utostr(I);
- std::string NewName = "rev" + utostr(I);
- Variable &V = Variables[Name];
- Variable NewV(V.getType(), NewName + VariablePostfix);
- if (!NewV.getType().isVector() || NewV.getType().getNumElements() == 1)
- continue;
- OS << " " << NewV.getType().str() << " " << NewV.getName() << ";";
- emitReverseVariable(NewV, V);
- V = NewV;
- }
- }
- void Intrinsic::emitReturnVarDecl() {
- assert(RetVar.getType() == Types[0]);
- // Create a return variable, if we're not void.
- if (!RetVar.getType().isVoid()) {
- OS << " " << RetVar.getType().str() << " " << RetVar.getName() << ";";
- emitNewLine();
- }
- }
- void Intrinsic::emitReturnReversal() {
- if (isBigEndianSafe())
- return;
- if (!getReturnType().isVector() || getReturnType().isVoid() ||
- getReturnType().getNumElements() == 1)
- return;
- emitReverseVariable(RetVar, RetVar);
- }
- void Intrinsic::emitShadowedArgs() {
- // Macro arguments are not type-checked like inline function arguments,
- // so assign them to local temporaries to get the right type checking.
- if (!UseMacro)
- return;
- for (unsigned I = 0; I < getNumParams(); ++I) {
- // Do not create a temporary for an immediate argument.
- // That would defeat the whole point of using a macro!
- if (getParamType(I).isImmediate())
- continue;
- // Do not create a temporary for pointer arguments. The input
- // pointer may have an alignment hint.
- if (getParamType(I).isPointer())
- continue;
- std::string Name = "p" + utostr(I);
- assert(Variables.find(Name) != Variables.end());
- Variable &V = Variables[Name];
- std::string NewName = "s" + utostr(I);
- Variable V2(V.getType(), NewName + VariablePostfix);
- OS << " " << V2.getType().str() << " " << V2.getName() << " = "
- << V.getName() << ";";
- emitNewLine();
- V = V2;
- }
- }
- bool Intrinsic::protoHasScalar() const {
- return llvm::any_of(
- Types, [](const Type &T) { return T.isScalar() && !T.isImmediate(); });
- }
- void Intrinsic::emitBodyAsBuiltinCall() {
- std::string S;
- // If this builtin returns a struct 2, 3, or 4 vectors, pass it as an implicit
- // sret-like argument.
- bool SRet = getReturnType().getNumVectors() >= 2;
- StringRef N = Name;
- ClassKind LocalCK = CK;
- if (!protoHasScalar())
- LocalCK = ClassB;
- if (!getReturnType().isVoid() && !SRet)
- S += "(" + RetVar.getType().str() + ") ";
- S += "__builtin_neon_" + mangleName(std::string(N), LocalCK) + "(";
- if (SRet)
- S += "&" + RetVar.getName() + ", ";
- for (unsigned I = 0; I < getNumParams(); ++I) {
- Variable &V = Variables["p" + utostr(I)];
- Type T = V.getType();
- // Handle multiple-vector values specially, emitting each subvector as an
- // argument to the builtin.
- if (T.getNumVectors() > 1) {
- // Check if an explicit cast is needed.
- std::string Cast;
- if (LocalCK == ClassB) {
- Type T2 = T;
- T2.makeOneVector();
- T2.makeInteger(8, /*Sign=*/true);
- Cast = "(" + T2.str() + ")";
- }
- for (unsigned J = 0; J < T.getNumVectors(); ++J)
- S += Cast + V.getName() + ".val[" + utostr(J) + "], ";
- continue;
- }
- std::string Arg = V.getName();
- Type CastToType = T;
- // Check if an explicit cast is needed.
- if (CastToType.isVector() &&
- (LocalCK == ClassB || (T.isHalf() && !T.isScalarForMangling()))) {
- CastToType.makeInteger(8, true);
- Arg = "(" + CastToType.str() + ")" + Arg;
- } else if (CastToType.isVector() && LocalCK == ClassI) {
- if (CastToType.isInteger())
- CastToType.makeSigned();
- Arg = "(" + CastToType.str() + ")" + Arg;
- }
- S += Arg + ", ";
- }
- // Extra constant integer to hold type class enum for this function, e.g. s8
- if (getClassKind(true) == ClassB) {
- S += utostr(getPolymorphicKeyType().getNeonEnum());
- } else {
- // Remove extraneous ", ".
- S.pop_back();
- S.pop_back();
- }
- S += ");";
- std::string RetExpr;
- if (!SRet && !RetVar.getType().isVoid())
- RetExpr = RetVar.getName() + " = ";
- OS << " " << RetExpr << S;
- emitNewLine();
- }
- void Intrinsic::emitBody(StringRef CallPrefix) {
- std::vector<std::string> Lines;
- if (!Body || Body->getValues().empty()) {
- // Nothing specific to output - must output a builtin.
- emitBodyAsBuiltinCall();
- return;
- }
- // We have a list of "things to output". The last should be returned.
- for (auto *I : Body->getValues()) {
- if (StringInit *SI = dyn_cast<StringInit>(I)) {
- Lines.push_back(replaceParamsIn(SI->getAsString()));
- } else if (DagInit *DI = dyn_cast<DagInit>(I)) {
- DagEmitter DE(*this, CallPrefix);
- Lines.push_back(DE.emitDag(DI).second + ";");
- }
- }
- assert(!Lines.empty() && "Empty def?");
- if (!RetVar.getType().isVoid())
- Lines.back().insert(0, RetVar.getName() + " = ");
- for (auto &L : Lines) {
- OS << " " << L;
- emitNewLine();
- }
- }
- void Intrinsic::emitReturn() {
- if (RetVar.getType().isVoid())
- return;
- if (UseMacro)
- OS << " " << RetVar.getName() << ";";
- else
- OS << " return " << RetVar.getName() << ";";
- emitNewLine();
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDag(DagInit *DI) {
- // At this point we should only be seeing a def.
- DefInit *DefI = cast<DefInit>(DI->getOperator());
- std::string Op = DefI->getAsString();
- if (Op == "cast" || Op == "bitcast")
- return emitDagCast(DI, Op == "bitcast");
- if (Op == "shuffle")
- return emitDagShuffle(DI);
- if (Op == "dup")
- return emitDagDup(DI);
- if (Op == "dup_typed")
- return emitDagDupTyped(DI);
- if (Op == "splat")
- return emitDagSplat(DI);
- if (Op == "save_temp")
- return emitDagSaveTemp(DI);
- if (Op == "op")
- return emitDagOp(DI);
- if (Op == "call" || Op == "call_mangled")
- return emitDagCall(DI, Op == "call_mangled");
- if (Op == "name_replace")
- return emitDagNameReplace(DI);
- if (Op == "literal")
- return emitDagLiteral(DI);
- assert_with_loc(false, "Unknown operation!");
- return std::make_pair(Type::getVoid(), "");
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagOp(DagInit *DI) {
- std::string Op = cast<StringInit>(DI->getArg(0))->getAsUnquotedString();
- if (DI->getNumArgs() == 2) {
- // Unary op.
- std::pair<Type, std::string> R =
- emitDagArg(DI->getArg(1), std::string(DI->getArgNameStr(1)));
- return std::make_pair(R.first, Op + R.second);
- } else {
- assert(DI->getNumArgs() == 3 && "Can only handle unary and binary ops!");
- std::pair<Type, std::string> R1 =
- emitDagArg(DI->getArg(1), std::string(DI->getArgNameStr(1)));
- std::pair<Type, std::string> R2 =
- emitDagArg(DI->getArg(2), std::string(DI->getArgNameStr(2)));
- assert_with_loc(R1.first == R2.first, "Argument type mismatch!");
- return std::make_pair(R1.first, R1.second + " " + Op + " " + R2.second);
- }
- }
- std::pair<Type, std::string>
- Intrinsic::DagEmitter::emitDagCall(DagInit *DI, bool MatchMangledName) {
- std::vector<Type> Types;
- std::vector<std::string> Values;
- for (unsigned I = 0; I < DI->getNumArgs() - 1; ++I) {
- std::pair<Type, std::string> R =
- emitDagArg(DI->getArg(I + 1), std::string(DI->getArgNameStr(I + 1)));
- Types.push_back(R.first);
- Values.push_back(R.second);
- }
- // Look up the called intrinsic.
- std::string N;
- if (StringInit *SI = dyn_cast<StringInit>(DI->getArg(0)))
- N = SI->getAsUnquotedString();
- else
- N = emitDagArg(DI->getArg(0), "").second;
- Optional<std::string> MangledName;
- if (MatchMangledName) {
- if (Intr.getRecord()->getValueAsBit("isLaneQ"))
- N += "q";
- MangledName = Intr.mangleName(N, ClassS);
- }
- Intrinsic &Callee = Intr.Emitter.getIntrinsic(N, Types, MangledName);
- // Make sure the callee is known as an early def.
- Callee.setNeededEarly();
- Intr.Dependencies.insert(&Callee);
- // Now create the call itself.
- std::string S;
- if (!Callee.isBigEndianSafe())
- S += CallPrefix.str();
- S += Callee.getMangledName(true) + "(";
- for (unsigned I = 0; I < DI->getNumArgs() - 1; ++I) {
- if (I != 0)
- S += ", ";
- S += Values[I];
- }
- S += ")";
- return std::make_pair(Callee.getReturnType(), S);
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagCast(DagInit *DI,
- bool IsBitCast){
- // (cast MOD* VAL) -> cast VAL to type given by MOD.
- std::pair<Type, std::string> R =
- emitDagArg(DI->getArg(DI->getNumArgs() - 1),
- std::string(DI->getArgNameStr(DI->getNumArgs() - 1)));
- Type castToType = R.first;
- for (unsigned ArgIdx = 0; ArgIdx < DI->getNumArgs() - 1; ++ArgIdx) {
- // MOD can take several forms:
- // 1. $X - take the type of parameter / variable X.
- // 2. The value "R" - take the type of the return type.
- // 3. a type string
- // 4. The value "U" or "S" to switch the signedness.
- // 5. The value "H" or "D" to half or double the bitwidth.
- // 6. The value "8" to convert to 8-bit (signed) integer lanes.
- if (!DI->getArgNameStr(ArgIdx).empty()) {
- assert_with_loc(Intr.Variables.find(std::string(
- DI->getArgNameStr(ArgIdx))) != Intr.Variables.end(),
- "Variable not found");
- castToType =
- Intr.Variables[std::string(DI->getArgNameStr(ArgIdx))].getType();
- } else {
- StringInit *SI = dyn_cast<StringInit>(DI->getArg(ArgIdx));
- assert_with_loc(SI, "Expected string type or $Name for cast type");
- if (SI->getAsUnquotedString() == "R") {
- castToType = Intr.getReturnType();
- } else if (SI->getAsUnquotedString() == "U") {
- castToType.makeUnsigned();
- } else if (SI->getAsUnquotedString() == "S") {
- castToType.makeSigned();
- } else if (SI->getAsUnquotedString() == "H") {
- castToType.halveLanes();
- } else if (SI->getAsUnquotedString() == "D") {
- castToType.doubleLanes();
- } else if (SI->getAsUnquotedString() == "8") {
- castToType.makeInteger(8, true);
- } else if (SI->getAsUnquotedString() == "32") {
- castToType.make32BitElement();
- } else {
- castToType = Type::fromTypedefName(SI->getAsUnquotedString());
- assert_with_loc(!castToType.isVoid(), "Unknown typedef");
- }
- }
- }
- std::string S;
- if (IsBitCast) {
- // Emit a reinterpret cast. The second operand must be an lvalue, so create
- // a temporary.
- std::string N = "reint";
- unsigned I = 0;
- while (Intr.Variables.find(N) != Intr.Variables.end())
- N = "reint" + utostr(++I);
- Intr.Variables[N] = Variable(R.first, N + Intr.VariablePostfix);
- Intr.OS << R.first.str() << " " << Intr.Variables[N].getName() << " = "
- << R.second << ";";
- Intr.emitNewLine();
- S = "*(" + castToType.str() + " *) &" + Intr.Variables[N].getName() + "";
- } else {
- // Emit a normal (static) cast.
- S = "(" + castToType.str() + ")(" + R.second + ")";
- }
- return std::make_pair(castToType, S);
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagShuffle(DagInit *DI){
- // See the documentation in arm_neon.td for a description of these operators.
- class LowHalf : public SetTheory::Operator {
- public:
- void apply(SetTheory &ST, DagInit *Expr, SetTheory::RecSet &Elts,
- ArrayRef<SMLoc> Loc) override {
- SetTheory::RecSet Elts2;
- ST.evaluate(Expr->arg_begin(), Expr->arg_end(), Elts2, Loc);
- Elts.insert(Elts2.begin(), Elts2.begin() + (Elts2.size() / 2));
- }
- };
- class HighHalf : public SetTheory::Operator {
- public:
- void apply(SetTheory &ST, DagInit *Expr, SetTheory::RecSet &Elts,
- ArrayRef<SMLoc> Loc) override {
- SetTheory::RecSet Elts2;
- ST.evaluate(Expr->arg_begin(), Expr->arg_end(), Elts2, Loc);
- Elts.insert(Elts2.begin() + (Elts2.size() / 2), Elts2.end());
- }
- };
- class Rev : public SetTheory::Operator {
- unsigned ElementSize;
- public:
- Rev(unsigned ElementSize) : ElementSize(ElementSize) {}
- void apply(SetTheory &ST, DagInit *Expr, SetTheory::RecSet &Elts,
- ArrayRef<SMLoc> Loc) override {
- SetTheory::RecSet Elts2;
- ST.evaluate(Expr->arg_begin() + 1, Expr->arg_end(), Elts2, Loc);
- int64_t VectorSize = cast<IntInit>(Expr->getArg(0))->getValue();
- VectorSize /= ElementSize;
- std::vector<Record *> Revved;
- for (unsigned VI = 0; VI < Elts2.size(); VI += VectorSize) {
- for (int LI = VectorSize - 1; LI >= 0; --LI) {
- Revved.push_back(Elts2[VI + LI]);
- }
- }
- Elts.insert(Revved.begin(), Revved.end());
- }
- };
- class MaskExpander : public SetTheory::Expander {
- unsigned N;
- public:
- MaskExpander(unsigned N) : N(N) {}
- void expand(SetTheory &ST, Record *R, SetTheory::RecSet &Elts) override {
- unsigned Addend = 0;
- if (R->getName() == "mask0")
- Addend = 0;
- else if (R->getName() == "mask1")
- Addend = N;
- else
- return;
- for (unsigned I = 0; I < N; ++I)
- Elts.insert(R->getRecords().getDef("sv" + utostr(I + Addend)));
- }
- };
- // (shuffle arg1, arg2, sequence)
- std::pair<Type, std::string> Arg1 =
- emitDagArg(DI->getArg(0), std::string(DI->getArgNameStr(0)));
- std::pair<Type, std::string> Arg2 =
- emitDagArg(DI->getArg(1), std::string(DI->getArgNameStr(1)));
- assert_with_loc(Arg1.first == Arg2.first,
- "Different types in arguments to shuffle!");
- SetTheory ST;
- SetTheory::RecSet Elts;
- ST.addOperator("lowhalf", std::make_unique<LowHalf>());
- ST.addOperator("highhalf", std::make_unique<HighHalf>());
- ST.addOperator("rev",
- std::make_unique<Rev>(Arg1.first.getElementSizeInBits()));
- ST.addExpander("MaskExpand",
- std::make_unique<MaskExpander>(Arg1.first.getNumElements()));
- ST.evaluate(DI->getArg(2), Elts, None);
- std::string S = "__builtin_shufflevector(" + Arg1.second + ", " + Arg2.second;
- for (auto &E : Elts) {
- StringRef Name = E->getName();
- assert_with_loc(Name.startswith("sv"),
- "Incorrect element kind in shuffle mask!");
- S += ", " + Name.drop_front(2).str();
- }
- S += ")";
- // Recalculate the return type - the shuffle may have halved or doubled it.
- Type T(Arg1.first);
- if (Elts.size() > T.getNumElements()) {
- assert_with_loc(
- Elts.size() == T.getNumElements() * 2,
- "Can only double or half the number of elements in a shuffle!");
- T.doubleLanes();
- } else if (Elts.size() < T.getNumElements()) {
- assert_with_loc(
- Elts.size() == T.getNumElements() / 2,
- "Can only double or half the number of elements in a shuffle!");
- T.halveLanes();
- }
- return std::make_pair(T, S);
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagDup(DagInit *DI) {
- assert_with_loc(DI->getNumArgs() == 1, "dup() expects one argument");
- std::pair<Type, std::string> A =
- emitDagArg(DI->getArg(0), std::string(DI->getArgNameStr(0)));
- assert_with_loc(A.first.isScalar(), "dup() expects a scalar argument");
- Type T = Intr.getBaseType();
- assert_with_loc(T.isVector(), "dup() used but default type is scalar!");
- std::string S = "(" + T.str() + ") {";
- for (unsigned I = 0; I < T.getNumElements(); ++I) {
- if (I != 0)
- S += ", ";
- S += A.second;
- }
- S += "}";
- return std::make_pair(T, S);
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagDupTyped(DagInit *DI) {
- assert_with_loc(DI->getNumArgs() == 2, "dup_typed() expects two arguments");
- std::pair<Type, std::string> B =
- emitDagArg(DI->getArg(1), std::string(DI->getArgNameStr(1)));
- assert_with_loc(B.first.isScalar(),
- "dup_typed() requires a scalar as the second argument");
- Type T;
- // If the type argument is a constant string, construct the type directly.
- if (StringInit *SI = dyn_cast<StringInit>(DI->getArg(0))) {
- T = Type::fromTypedefName(SI->getAsUnquotedString());
- assert_with_loc(!T.isVoid(), "Unknown typedef");
- } else
- T = emitDagArg(DI->getArg(0), std::string(DI->getArgNameStr(0))).first;
- assert_with_loc(T.isVector(), "dup_typed() used but target type is scalar!");
- std::string S = "(" + T.str() + ") {";
- for (unsigned I = 0; I < T.getNumElements(); ++I) {
- if (I != 0)
- S += ", ";
- S += B.second;
- }
- S += "}";
- return std::make_pair(T, S);
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagSplat(DagInit *DI) {
- assert_with_loc(DI->getNumArgs() == 2, "splat() expects two arguments");
- std::pair<Type, std::string> A =
- emitDagArg(DI->getArg(0), std::string(DI->getArgNameStr(0)));
- std::pair<Type, std::string> B =
- emitDagArg(DI->getArg(1), std::string(DI->getArgNameStr(1)));
- assert_with_loc(B.first.isScalar(),
- "splat() requires a scalar int as the second argument");
- std::string S = "__builtin_shufflevector(" + A.second + ", " + A.second;
- for (unsigned I = 0; I < Intr.getBaseType().getNumElements(); ++I) {
- S += ", " + B.second;
- }
- S += ")";
- return std::make_pair(Intr.getBaseType(), S);
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagSaveTemp(DagInit *DI) {
- assert_with_loc(DI->getNumArgs() == 2, "save_temp() expects two arguments");
- std::pair<Type, std::string> A =
- emitDagArg(DI->getArg(1), std::string(DI->getArgNameStr(1)));
- assert_with_loc(!A.first.isVoid(),
- "Argument to save_temp() must have non-void type!");
- std::string N = std::string(DI->getArgNameStr(0));
- assert_with_loc(!N.empty(),
- "save_temp() expects a name as the first argument");
- assert_with_loc(Intr.Variables.find(N) == Intr.Variables.end(),
- "Variable already defined!");
- Intr.Variables[N] = Variable(A.first, N + Intr.VariablePostfix);
- std::string S =
- A.first.str() + " " + Intr.Variables[N].getName() + " = " + A.second;
- return std::make_pair(Type::getVoid(), S);
- }
- std::pair<Type, std::string>
- Intrinsic::DagEmitter::emitDagNameReplace(DagInit *DI) {
- std::string S = Intr.Name;
- assert_with_loc(DI->getNumArgs() == 2, "name_replace requires 2 arguments!");
- std::string ToReplace = cast<StringInit>(DI->getArg(0))->getAsUnquotedString();
- std::string ReplaceWith = cast<StringInit>(DI->getArg(1))->getAsUnquotedString();
- size_t Idx = S.find(ToReplace);
- assert_with_loc(Idx != std::string::npos, "name should contain '" + ToReplace + "'!");
- S.replace(Idx, ToReplace.size(), ReplaceWith);
- return std::make_pair(Type::getVoid(), S);
- }
- std::pair<Type, std::string> Intrinsic::DagEmitter::emitDagLiteral(DagInit *DI){
- std::string Ty = cast<StringInit>(DI->getArg(0))->getAsUnquotedString();
- std::string Value = cast<StringInit>(DI->getArg(1))->getAsUnquotedString();
- return std::make_pair(Type::fromTypedefName(Ty), Value);
- }
- std::pair<Type, std::string>
- Intrinsic::DagEmitter::emitDagArg(Init *Arg, std::string ArgName) {
- if (!ArgName.empty()) {
- assert_with_loc(!Arg->isComplete(),
- "Arguments must either be DAGs or names, not both!");
- assert_with_loc(Intr.Variables.find(ArgName) != Intr.Variables.end(),
- "Variable not defined!");
- Variable &V = Intr.Variables[ArgName];
- return std::make_pair(V.getType(), V.getName());
- }
- assert(Arg && "Neither ArgName nor Arg?!");
- DagInit *DI = dyn_cast<DagInit>(Arg);
- assert_with_loc(DI, "Arguments must either be DAGs or names!");
- return emitDag(DI);
- }
- std::string Intrinsic::generate() {
- // Avoid duplicated code for big and little endian
- if (isBigEndianSafe()) {
- generateImpl(false, "", "");
- return OS.str();
- }
- // Little endian intrinsics are simple and don't require any argument
- // swapping.
- OS << "#ifdef __LITTLE_ENDIAN__\n";
- generateImpl(false, "", "");
- OS << "#else\n";
- // Big endian intrinsics are more complex. The user intended these
- // intrinsics to operate on a vector "as-if" loaded by (V)LDR,
- // but we load as-if (V)LD1. So we should swap all arguments and
- // swap the return value too.
- //
- // If we call sub-intrinsics, we should call a version that does
- // not re-swap the arguments!
- generateImpl(true, "", "__noswap_");
- // If we're needed early, create a non-swapping variant for
- // big-endian.
- if (NeededEarly) {
- generateImpl(false, "__noswap_", "__noswap_");
- }
- OS << "#endif\n\n";
- return OS.str();
- }
- void Intrinsic::generateImpl(bool ReverseArguments,
- StringRef NamePrefix, StringRef CallPrefix) {
- CurrentRecord = R;
- // If we call a macro, our local variables may be corrupted due to
- // lack of proper lexical scoping. So, add a globally unique postfix
- // to every variable.
- //
- // indexBody() should have set up the Dependencies set by now.
- for (auto *I : Dependencies)
- if (I->UseMacro) {
- VariablePostfix = "_" + utostr(Emitter.getUniqueNumber());
- break;
- }
- initVariables();
- emitPrototype(NamePrefix);
- if (IsUnavailable) {
- OS << " __attribute__((unavailable));";
- } else {
- emitOpeningBrace();
- // Emit return variable declaration first as to not trigger
- // -Wdeclaration-after-statement.
- emitReturnVarDecl();
- emitShadowedArgs();
- if (ReverseArguments)
- emitArgumentReversal();
- emitBody(CallPrefix);
- if (ReverseArguments)
- emitReturnReversal();
- emitReturn();
- emitClosingBrace();
- }
- OS << "\n";
- CurrentRecord = nullptr;
- }
- void Intrinsic::indexBody() {
- CurrentRecord = R;
- initVariables();
- // Emit return variable declaration first as to not trigger
- // -Wdeclaration-after-statement.
- emitReturnVarDecl();
- emitBody("");
- OS.str("");
- CurrentRecord = nullptr;
- }
- //===----------------------------------------------------------------------===//
- // NeonEmitter implementation
- //===----------------------------------------------------------------------===//
- Intrinsic &NeonEmitter::getIntrinsic(StringRef Name, ArrayRef<Type> Types,
- Optional<std::string> MangledName) {
- // First, look up the name in the intrinsic map.
- assert_with_loc(IntrinsicMap.find(Name.str()) != IntrinsicMap.end(),
- ("Intrinsic '" + Name + "' not found!").str());
- auto &V = IntrinsicMap.find(Name.str())->second;
- std::vector<Intrinsic *> GoodVec;
- // Create a string to print if we end up failing.
- std::string ErrMsg = "looking up intrinsic '" + Name.str() + "(";
- for (unsigned I = 0; I < Types.size(); ++I) {
- if (I != 0)
- ErrMsg += ", ";
- ErrMsg += Types[I].str();
- }
- ErrMsg += ")'\n";
- ErrMsg += "Available overloads:\n";
- // Now, look through each intrinsic implementation and see if the types are
- // compatible.
- for (auto &I : V) {
- ErrMsg += " - " + I.getReturnType().str() + " " + I.getMangledName();
- ErrMsg += "(";
- for (unsigned A = 0; A < I.getNumParams(); ++A) {
- if (A != 0)
- ErrMsg += ", ";
- ErrMsg += I.getParamType(A).str();
- }
- ErrMsg += ")\n";
- if (MangledName && MangledName != I.getMangledName(true))
- continue;
- if (I.getNumParams() != Types.size())
- continue;
- unsigned ArgNum = 0;
- bool MatchingArgumentTypes = llvm::all_of(Types, [&](const auto &Type) {
- return Type == I.getParamType(ArgNum++);
- });
- if (MatchingArgumentTypes)
- GoodVec.push_back(&I);
- }
- assert_with_loc(!GoodVec.empty(),
- "No compatible intrinsic found - " + ErrMsg);
- assert_with_loc(GoodVec.size() == 1, "Multiple overloads found - " + ErrMsg);
- return *GoodVec.front();
- }
- void NeonEmitter::createIntrinsic(Record *R,
- SmallVectorImpl<Intrinsic *> &Out) {
- std::string Name = std::string(R->getValueAsString("Name"));
- std::string Proto = std::string(R->getValueAsString("Prototype"));
- std::string Types = std::string(R->getValueAsString("Types"));
- Record *OperationRec = R->getValueAsDef("Operation");
- bool BigEndianSafe = R->getValueAsBit("BigEndianSafe");
- std::string Guard = std::string(R->getValueAsString("ArchGuard"));
- bool IsUnavailable = OperationRec->getValueAsBit("Unavailable");
- std::string CartesianProductWith = std::string(R->getValueAsString("CartesianProductWith"));
- // Set the global current record. This allows assert_with_loc to produce
- // decent location information even when highly nested.
- CurrentRecord = R;
- ListInit *Body = OperationRec->getValueAsListInit("Ops");
- std::vector<TypeSpec> TypeSpecs = TypeSpec::fromTypeSpecs(Types);
- ClassKind CK = ClassNone;
- if (R->getSuperClasses().size() >= 2)
- CK = ClassMap[R->getSuperClasses()[1].first];
- std::vector<std::pair<TypeSpec, TypeSpec>> NewTypeSpecs;
- if (!CartesianProductWith.empty()) {
- std::vector<TypeSpec> ProductTypeSpecs = TypeSpec::fromTypeSpecs(CartesianProductWith);
- for (auto TS : TypeSpecs) {
- Type DefaultT(TS, ".");
- for (auto SrcTS : ProductTypeSpecs) {
- Type DefaultSrcT(SrcTS, ".");
- if (TS == SrcTS ||
- DefaultSrcT.getSizeInBits() != DefaultT.getSizeInBits())
- continue;
- NewTypeSpecs.push_back(std::make_pair(TS, SrcTS));
- }
- }
- } else {
- for (auto TS : TypeSpecs) {
- NewTypeSpecs.push_back(std::make_pair(TS, TS));
- }
- }
- llvm::sort(NewTypeSpecs);
- NewTypeSpecs.erase(std::unique(NewTypeSpecs.begin(), NewTypeSpecs.end()),
- NewTypeSpecs.end());
- auto &Entry = IntrinsicMap[Name];
- for (auto &I : NewTypeSpecs) {
- Entry.emplace_back(R, Name, Proto, I.first, I.second, CK, Body, *this,
- Guard, IsUnavailable, BigEndianSafe);
- Out.push_back(&Entry.back());
- }
- CurrentRecord = nullptr;
- }
- /// genBuiltinsDef: Generate the BuiltinsARM.def and BuiltinsAArch64.def
- /// declaration of builtins, checking for unique builtin declarations.
- void NeonEmitter::genBuiltinsDef(raw_ostream &OS,
- SmallVectorImpl<Intrinsic *> &Defs) {
- OS << "#ifdef GET_NEON_BUILTINS\n";
- // We only want to emit a builtin once, and we want to emit them in
- // alphabetical order, so use a std::set.
- std::set<std::string> Builtins;
- for (auto *Def : Defs) {
- if (Def->hasBody())
- continue;
- std::string S = "BUILTIN(__builtin_neon_" + Def->getMangledName() + ", \"";
- S += Def->getBuiltinTypeStr();
- S += "\", \"n\")";
- Builtins.insert(S);
- }
- for (auto &S : Builtins)
- OS << S << "\n";
- OS << "#endif\n\n";
- }
- /// Generate the ARM and AArch64 overloaded type checking code for
- /// SemaChecking.cpp, checking for unique builtin declarations.
- void NeonEmitter::genOverloadTypeCheckCode(raw_ostream &OS,
- SmallVectorImpl<Intrinsic *> &Defs) {
- OS << "#ifdef GET_NEON_OVERLOAD_CHECK\n";
- // We record each overload check line before emitting because subsequent Inst
- // definitions may extend the number of permitted types (i.e. augment the
- // Mask). Use std::map to avoid sorting the table by hash number.
- struct OverloadInfo {
- uint64_t Mask;
- int PtrArgNum;
- bool HasConstPtr;
- OverloadInfo() : Mask(0ULL), PtrArgNum(0), HasConstPtr(false) {}
- };
- std::map<std::string, OverloadInfo> OverloadMap;
- for (auto *Def : Defs) {
- // If the def has a body (that is, it has Operation DAGs), it won't call
- // __builtin_neon_* so we don't need to generate a definition for it.
- if (Def->hasBody())
- continue;
- // Functions which have a scalar argument cannot be overloaded, no need to
- // check them if we are emitting the type checking code.
- if (Def->protoHasScalar())
- continue;
- uint64_t Mask = 0ULL;
- Mask |= 1ULL << Def->getPolymorphicKeyType().getNeonEnum();
- // Check if the function has a pointer or const pointer argument.
- int PtrArgNum = -1;
- bool HasConstPtr = false;
- for (unsigned I = 0; I < Def->getNumParams(); ++I) {
- const auto &Type = Def->getParamType(I);
- if (Type.isPointer()) {
- PtrArgNum = I;
- HasConstPtr = Type.isConstPointer();
- }
- }
- // For sret builtins, adjust the pointer argument index.
- if (PtrArgNum >= 0 && Def->getReturnType().getNumVectors() > 1)
- PtrArgNum += 1;
- std::string Name = Def->getName();
- // Omit type checking for the pointer arguments of vld1_lane, vld1_dup,
- // and vst1_lane intrinsics. Using a pointer to the vector element
- // type with one of those operations causes codegen to select an aligned
- // load/store instruction. If you want an unaligned operation,
- // the pointer argument needs to have less alignment than element type,
- // so just accept any pointer type.
- if (Name == "vld1_lane" || Name == "vld1_dup" || Name == "vst1_lane") {
- PtrArgNum = -1;
- HasConstPtr = false;
- }
- if (Mask) {
- std::string Name = Def->getMangledName();
- OverloadMap.insert(std::make_pair(Name, OverloadInfo()));
- OverloadInfo &OI = OverloadMap[Name];
- OI.Mask |= Mask;
- OI.PtrArgNum |= PtrArgNum;
- OI.HasConstPtr = HasConstPtr;
- }
- }
- for (auto &I : OverloadMap) {
- OverloadInfo &OI = I.second;
- OS << "case NEON::BI__builtin_neon_" << I.first << ": ";
- OS << "mask = 0x" << Twine::utohexstr(OI.Mask) << "ULL";
- if (OI.PtrArgNum >= 0)
- OS << "; PtrArgNum = " << OI.PtrArgNum;
- if (OI.HasConstPtr)
- OS << "; HasConstPtr = true";
- OS << "; break;\n";
- }
- OS << "#endif\n\n";
- }
- void NeonEmitter::genIntrinsicRangeCheckCode(raw_ostream &OS,
- SmallVectorImpl<Intrinsic *> &Defs) {
- OS << "#ifdef GET_NEON_IMMEDIATE_CHECK\n";
- std::set<std::string> Emitted;
- for (auto *Def : Defs) {
- if (Def->hasBody())
- continue;
- // Functions which do not have an immediate do not need to have range
- // checking code emitted.
- if (!Def->hasImmediate())
- continue;
- if (Emitted.find(Def->getMangledName()) != Emitted.end())
- continue;
- std::string LowerBound, UpperBound;
- Record *R = Def->getRecord();
- if (R->getValueAsBit("isVXAR")) {
- //VXAR takes an immediate in the range [0, 63]
- LowerBound = "0";
- UpperBound = "63";
- } else if (R->getValueAsBit("isVCVT_N")) {
- // VCVT between floating- and fixed-point values takes an immediate
- // in the range [1, 32) for f32 or [1, 64) for f64 or [1, 16) for f16.
- LowerBound = "1";
- if (Def->getBaseType().getElementSizeInBits() == 16 ||
- Def->getName().find('h') != std::string::npos)
- // VCVTh operating on FP16 intrinsics in range [1, 16)
- UpperBound = "15";
- else if (Def->getBaseType().getElementSizeInBits() == 32)
- UpperBound = "31";
- else
- UpperBound = "63";
- } else if (R->getValueAsBit("isScalarShift")) {
- // Right shifts have an 'r' in the name, left shifts do not. Convert
- // instructions have the same bounds and right shifts.
- if (Def->getName().find('r') != std::string::npos ||
- Def->getName().find("cvt") != std::string::npos)
- LowerBound = "1";
- UpperBound = utostr(Def->getReturnType().getElementSizeInBits() - 1);
- } else if (R->getValueAsBit("isShift")) {
- // Builtins which are overloaded by type will need to have their upper
- // bound computed at Sema time based on the type constant.
- // Right shifts have an 'r' in the name, left shifts do not.
- if (Def->getName().find('r') != std::string::npos)
- LowerBound = "1";
- UpperBound = "RFT(TV, true)";
- } else if (Def->getClassKind(true) == ClassB) {
- // ClassB intrinsics have a type (and hence lane number) that is only
- // known at runtime.
- if (R->getValueAsBit("isLaneQ"))
- UpperBound = "RFT(TV, false, true)";
- else
- UpperBound = "RFT(TV, false, false)";
- } else {
- // The immediate generally refers to a lane in the preceding argument.
- assert(Def->getImmediateIdx() > 0);
- Type T = Def->getParamType(Def->getImmediateIdx() - 1);
- UpperBound = utostr(T.getNumElements() - 1);
- }
- // Calculate the index of the immediate that should be range checked.
- unsigned Idx = Def->getNumParams();
- if (Def->hasImmediate())
- Idx = Def->getGeneratedParamIdx(Def->getImmediateIdx());
- OS << "case NEON::BI__builtin_neon_" << Def->getMangledName() << ": "
- << "i = " << Idx << ";";
- if (!LowerBound.empty())
- OS << " l = " << LowerBound << ";";
- if (!UpperBound.empty())
- OS << " u = " << UpperBound << ";";
- OS << " break;\n";
- Emitted.insert(Def->getMangledName());
- }
- OS << "#endif\n\n";
- }
- /// runHeader - Emit a file with sections defining:
- /// 1. the NEON section of BuiltinsARM.def and BuiltinsAArch64.def.
- /// 2. the SemaChecking code for the type overload checking.
- /// 3. the SemaChecking code for validation of intrinsic immediate arguments.
- void NeonEmitter::runHeader(raw_ostream &OS) {
- std::vector<Record *> RV = Records.getAllDerivedDefinitions("Inst");
- SmallVector<Intrinsic *, 128> Defs;
- for (auto *R : RV)
- createIntrinsic(R, Defs);
- // Generate shared BuiltinsXXX.def
- genBuiltinsDef(OS, Defs);
- // Generate ARM overloaded type checking code for SemaChecking.cpp
- genOverloadTypeCheckCode(OS, Defs);
- // Generate ARM range checking code for shift/lane immediates.
- genIntrinsicRangeCheckCode(OS, Defs);
- }
- static void emitNeonTypeDefs(const std::string& types, raw_ostream &OS) {
- std::string TypedefTypes(types);
- std::vector<TypeSpec> TDTypeVec = TypeSpec::fromTypeSpecs(TypedefTypes);
- // Emit vector typedefs.
- bool InIfdef = false;
- for (auto &TS : TDTypeVec) {
- bool IsA64 = false;
- Type T(TS, ".");
- if (T.isDouble())
- IsA64 = true;
- if (InIfdef && !IsA64) {
- OS << "#endif\n";
- InIfdef = false;
- }
- if (!InIfdef && IsA64) {
- OS << "#ifdef __aarch64__\n";
- InIfdef = true;
- }
- if (T.isPoly())
- OS << "typedef __attribute__((neon_polyvector_type(";
- else
- OS << "typedef __attribute__((neon_vector_type(";
- Type T2 = T;
- T2.makeScalar();
- OS << T.getNumElements() << "))) ";
- OS << T2.str();
- OS << " " << T.str() << ";\n";
- }
- if (InIfdef)
- OS << "#endif\n";
- OS << "\n";
- // Emit struct typedefs.
- InIfdef = false;
- for (unsigned NumMembers = 2; NumMembers <= 4; ++NumMembers) {
- for (auto &TS : TDTypeVec) {
- bool IsA64 = false;
- Type T(TS, ".");
- if (T.isDouble())
- IsA64 = true;
- if (InIfdef && !IsA64) {
- OS << "#endif\n";
- InIfdef = false;
- }
- if (!InIfdef && IsA64) {
- OS << "#ifdef __aarch64__\n";
- InIfdef = true;
- }
- const char Mods[] = { static_cast<char>('2' + (NumMembers - 2)), 0};
- Type VT(TS, Mods);
- OS << "typedef struct " << VT.str() << " {\n";
- OS << " " << T.str() << " val";
- OS << "[" << NumMembers << "]";
- OS << ";\n} ";
- OS << VT.str() << ";\n";
- OS << "\n";
- }
- }
- if (InIfdef)
- OS << "#endif\n";
- }
- /// run - Read the records in arm_neon.td and output arm_neon.h. arm_neon.h
- /// is comprised of type definitions and function declarations.
- void NeonEmitter::run(raw_ostream &OS) {
- OS << "/*===---- arm_neon.h - ARM Neon intrinsics "
- "------------------------------"
- "---===\n"
- " *\n"
- " * Permission is hereby granted, free of charge, to any person "
- "obtaining "
- "a copy\n"
- " * of this software and associated documentation files (the "
- "\"Software\"),"
- " to deal\n"
- " * in the Software without restriction, including without limitation "
- "the "
- "rights\n"
- " * to use, copy, modify, merge, publish, distribute, sublicense, "
- "and/or sell\n"
- " * copies of the Software, and to permit persons to whom the Software "
- "is\n"
- " * furnished to do so, subject to the following conditions:\n"
- " *\n"
- " * The above copyright notice and this permission notice shall be "
- "included in\n"
- " * all copies or substantial portions of the Software.\n"
- " *\n"
- " * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, "
- "EXPRESS OR\n"
- " * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF "
- "MERCHANTABILITY,\n"
- " * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT "
- "SHALL THE\n"
- " * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR "
- "OTHER\n"
- " * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, "
- "ARISING FROM,\n"
- " * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER "
- "DEALINGS IN\n"
- " * THE SOFTWARE.\n"
- " *\n"
- " *===-----------------------------------------------------------------"
- "---"
- "---===\n"
- " */\n\n";
- OS << "#ifndef __ARM_NEON_H\n";
- OS << "#define __ARM_NEON_H\n\n";
- OS << "#ifndef __ARM_FP\n";
- OS << "#error \"NEON intrinsics not available with the soft-float ABI. "
- "Please use -mfloat-abi=softfp or -mfloat-abi=hard\"\n";
- OS << "#else\n\n";
- OS << "#if !defined(__ARM_NEON)\n";
- OS << "#error \"NEON support not enabled\"\n";
- OS << "#else\n\n";
- OS << "#include <stdint.h>\n\n";
- OS << "#ifdef __ARM_FEATURE_BF16\n";
- OS << "#include <arm_bf16.h>\n";
- OS << "typedef __bf16 bfloat16_t;\n";
- OS << "#endif\n\n";
- // Emit NEON-specific scalar typedefs.
- OS << "typedef float float32_t;\n";
- OS << "typedef __fp16 float16_t;\n";
- OS << "#ifdef __aarch64__\n";
- OS << "typedef double float64_t;\n";
- OS << "#endif\n\n";
- // For now, signedness of polynomial types depends on target
- OS << "#ifdef __aarch64__\n";
- OS << "typedef uint8_t poly8_t;\n";
- OS << "typedef uint16_t poly16_t;\n";
- OS << "typedef uint64_t poly64_t;\n";
- OS << "typedef __uint128_t poly128_t;\n";
- OS << "#else\n";
- OS << "typedef int8_t poly8_t;\n";
- OS << "typedef int16_t poly16_t;\n";
- OS << "typedef int64_t poly64_t;\n";
- OS << "#endif\n";
- emitNeonTypeDefs("cQcsQsiQilQlUcQUcUsQUsUiQUiUlQUlhQhfQfdQdPcQPcPsQPsPlQPl", OS);
- OS << "#ifdef __ARM_FEATURE_BF16\n";
- emitNeonTypeDefs("bQb", OS);
- OS << "#endif\n\n";
- OS << "#define __ai static __inline__ __attribute__((__always_inline__, "
- "__nodebug__))\n\n";
- SmallVector<Intrinsic *, 128> Defs;
- std::vector<Record *> RV = Records.getAllDerivedDefinitions("Inst");
- for (auto *R : RV)
- createIntrinsic(R, Defs);
- for (auto *I : Defs)
- I->indexBody();
- llvm::stable_sort(Defs, llvm::deref<std::less<>>());
- // Only emit a def when its requirements have been met.
- // FIXME: This loop could be made faster, but it's fast enough for now.
- bool MadeProgress = true;
- std::string InGuard;
- while (!Defs.empty() && MadeProgress) {
- MadeProgress = false;
- for (SmallVector<Intrinsic *, 128>::iterator I = Defs.begin();
- I != Defs.end(); /*No step*/) {
- bool DependenciesSatisfied = true;
- for (auto *II : (*I)->getDependencies()) {
- if (llvm::is_contained(Defs, II))
- DependenciesSatisfied = false;
- }
- if (!DependenciesSatisfied) {
- // Try the next one.
- ++I;
- continue;
- }
- // Emit #endif/#if pair if needed.
- if ((*I)->getGuard() != InGuard) {
- if (!InGuard.empty())
- OS << "#endif\n";
- InGuard = (*I)->getGuard();
- if (!InGuard.empty())
- OS << "#if " << InGuard << "\n";
- }
- // Actually generate the intrinsic code.
- OS << (*I)->generate();
- MadeProgress = true;
- I = Defs.erase(I);
- }
- }
- assert(Defs.empty() && "Some requirements were not satisfied!");
- if (!InGuard.empty())
- OS << "#endif\n";
- OS << "\n";
- OS << "#undef __ai\n\n";
- OS << "#endif /* if !defined(__ARM_NEON) */\n";
- OS << "#endif /* ifndef __ARM_FP */\n";
- OS << "#endif /* __ARM_NEON_H */\n";
- }
- /// run - Read the records in arm_fp16.td and output arm_fp16.h. arm_fp16.h
- /// is comprised of type definitions and function declarations.
- void NeonEmitter::runFP16(raw_ostream &OS) {
- OS << "/*===---- arm_fp16.h - ARM FP16 intrinsics "
- "------------------------------"
- "---===\n"
- " *\n"
- " * Permission is hereby granted, free of charge, to any person "
- "obtaining a copy\n"
- " * of this software and associated documentation files (the "
- "\"Software\"), to deal\n"
- " * in the Software without restriction, including without limitation "
- "the rights\n"
- " * to use, copy, modify, merge, publish, distribute, sublicense, "
- "and/or sell\n"
- " * copies of the Software, and to permit persons to whom the Software "
- "is\n"
- " * furnished to do so, subject to the following conditions:\n"
- " *\n"
- " * The above copyright notice and this permission notice shall be "
- "included in\n"
- " * all copies or substantial portions of the Software.\n"
- " *\n"
- " * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, "
- "EXPRESS OR\n"
- " * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF "
- "MERCHANTABILITY,\n"
- " * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT "
- "SHALL THE\n"
- " * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR "
- "OTHER\n"
- " * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, "
- "ARISING FROM,\n"
- " * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER "
- "DEALINGS IN\n"
- " * THE SOFTWARE.\n"
- " *\n"
- " *===-----------------------------------------------------------------"
- "---"
- "---===\n"
- " */\n\n";
- OS << "#ifndef __ARM_FP16_H\n";
- OS << "#define __ARM_FP16_H\n\n";
- OS << "#include <stdint.h>\n\n";
- OS << "typedef __fp16 float16_t;\n";
- OS << "#define __ai static __inline__ __attribute__((__always_inline__, "
- "__nodebug__))\n\n";
- SmallVector<Intrinsic *, 128> Defs;
- std::vector<Record *> RV = Records.getAllDerivedDefinitions("Inst");
- for (auto *R : RV)
- createIntrinsic(R, Defs);
- for (auto *I : Defs)
- I->indexBody();
- llvm::stable_sort(Defs, llvm::deref<std::less<>>());
- // Only emit a def when its requirements have been met.
- // FIXME: This loop could be made faster, but it's fast enough for now.
- bool MadeProgress = true;
- std::string InGuard;
- while (!Defs.empty() && MadeProgress) {
- MadeProgress = false;
- for (SmallVector<Intrinsic *, 128>::iterator I = Defs.begin();
- I != Defs.end(); /*No step*/) {
- bool DependenciesSatisfied = true;
- for (auto *II : (*I)->getDependencies()) {
- if (llvm::is_contained(Defs, II))
- DependenciesSatisfied = false;
- }
- if (!DependenciesSatisfied) {
- // Try the next one.
- ++I;
- continue;
- }
- // Emit #endif/#if pair if needed.
- if ((*I)->getGuard() != InGuard) {
- if (!InGuard.empty())
- OS << "#endif\n";
- InGuard = (*I)->getGuard();
- if (!InGuard.empty())
- OS << "#if " << InGuard << "\n";
- }
- // Actually generate the intrinsic code.
- OS << (*I)->generate();
- MadeProgress = true;
- I = Defs.erase(I);
- }
- }
- assert(Defs.empty() && "Some requirements were not satisfied!");
- if (!InGuard.empty())
- OS << "#endif\n";
- OS << "\n";
- OS << "#undef __ai\n\n";
- OS << "#endif /* __ARM_FP16_H */\n";
- }
- void NeonEmitter::runBF16(raw_ostream &OS) {
- OS << "/*===---- arm_bf16.h - ARM BF16 intrinsics "
- "-----------------------------------===\n"
- " *\n"
- " *\n"
- " * Part of the LLVM Project, under the Apache License v2.0 with LLVM "
- "Exceptions.\n"
- " * See https://llvm.org/LICENSE.txt for license information.\n"
- " * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception\n"
- " *\n"
- " *===-----------------------------------------------------------------"
- "------===\n"
- " */\n\n";
- OS << "#ifndef __ARM_BF16_H\n";
- OS << "#define __ARM_BF16_H\n\n";
- OS << "typedef __bf16 bfloat16_t;\n";
- OS << "#define __ai static __inline__ __attribute__((__always_inline__, "
- "__nodebug__))\n\n";
- SmallVector<Intrinsic *, 128> Defs;
- std::vector<Record *> RV = Records.getAllDerivedDefinitions("Inst");
- for (auto *R : RV)
- createIntrinsic(R, Defs);
- for (auto *I : Defs)
- I->indexBody();
- llvm::stable_sort(Defs, llvm::deref<std::less<>>());
- // Only emit a def when its requirements have been met.
- // FIXME: This loop could be made faster, but it's fast enough for now.
- bool MadeProgress = true;
- std::string InGuard;
- while (!Defs.empty() && MadeProgress) {
- MadeProgress = false;
- for (SmallVector<Intrinsic *, 128>::iterator I = Defs.begin();
- I != Defs.end(); /*No step*/) {
- bool DependenciesSatisfied = true;
- for (auto *II : (*I)->getDependencies()) {
- if (llvm::is_contained(Defs, II))
- DependenciesSatisfied = false;
- }
- if (!DependenciesSatisfied) {
- // Try the next one.
- ++I;
- continue;
- }
- // Emit #endif/#if pair if needed.
- if ((*I)->getGuard() != InGuard) {
- if (!InGuard.empty())
- OS << "#endif\n";
- InGuard = (*I)->getGuard();
- if (!InGuard.empty())
- OS << "#if " << InGuard << "\n";
- }
- // Actually generate the intrinsic code.
- OS << (*I)->generate();
- MadeProgress = true;
- I = Defs.erase(I);
- }
- }
- assert(Defs.empty() && "Some requirements were not satisfied!");
- if (!InGuard.empty())
- OS << "#endif\n";
- OS << "\n";
- OS << "#undef __ai\n\n";
- OS << "#endif\n";
- }
- void clang::EmitNeon(RecordKeeper &Records, raw_ostream &OS) {
- NeonEmitter(Records).run(OS);
- }
- void clang::EmitFP16(RecordKeeper &Records, raw_ostream &OS) {
- NeonEmitter(Records).runFP16(OS);
- }
- void clang::EmitBF16(RecordKeeper &Records, raw_ostream &OS) {
- NeonEmitter(Records).runBF16(OS);
- }
- void clang::EmitNeonSema(RecordKeeper &Records, raw_ostream &OS) {
- NeonEmitter(Records).runHeader(OS);
- }
- void clang::EmitNeonTest(RecordKeeper &Records, raw_ostream &OS) {
- llvm_unreachable("Neon test generation no longer implemented!");
- }
|