1 //===- NeonEmitter.cpp - Generate arm_neon.h for use with clang -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend is responsible for emitting arm_neon.h, which includes
11 // a declaration and definition of each function specified by the ARM NEON
12 // compiler interface. See ARM document DUI0348B.
14 // Each NEON instruction is implemented in terms of 1 or more functions which
15 // are suffixed with the element type of the input vectors. Functions may be
16 // implemented in terms of generic vector operations such as +, *, -, etc. or
17 // by calling a __builtin_-prefixed function which will be handled by clang's
20 // Additional validation code can be generated by this file when runHeader() is
21 // called, rather than the normal run() entry point.
23 //===----------------------------------------------------------------------===//
25 #include "NeonEmitter.h"
26 #include "llvm/ADT/SmallString.h"
27 #include "llvm/ADT/SmallVector.h"
28 #include "llvm/ADT/StringExtras.h"
33 /// ParseTypes - break down a string such as "fQf" into a vector of StringRefs,
34 /// which each StringRef representing a single type declared in the string.
35 /// for "fQf" we would end up with 2 StringRefs, "f", and "Qf", representing
36 /// 2xfloat and 4xfloat respectively.
37 static void ParseTypes(Record *r, std::string &s,
38 SmallVectorImpl<StringRef> &TV) {
39 const char *data = s.data();
42 for (unsigned i = 0, e = s.size(); i != e; ++i, ++len) {
43 if (data[len] == 'P' || data[len] == 'Q' || data[len] == 'U')
55 throw TGError(r->getLoc(),
56 "Unexpected letter: " + std::string(data + len, 1));
59 TV.push_back(StringRef(data, len + 1));
65 /// Widen - Convert a type code into the next wider type. char -> short,
66 /// short -> int, etc.
67 static char Widen(const char t) {
75 default: throw "unhandled type in widen!";
80 /// Narrow - Convert a type code into the next smaller type. short -> char,
81 /// float -> half float, etc.
82 static char Narrow(const char t) {
92 default: throw "unhandled type in narrow!";
97 /// For a particular StringRef, return the base type code, and whether it has
98 /// the quad-vector, polynomial, or unsigned modifiers set.
99 static char ClassifyType(StringRef ty, bool &quad, bool &poly, bool &usgn) {
103 if (ty[off] == 'Q') {
109 if (ty[off] == 'P') {
114 // remember unsigned.
115 if (ty[off] == 'U') {
120 // base type to get the type string for.
124 /// ModType - Transform a type code and its modifiers based on a mod code. The
125 /// mod code definitions may be found at the top of arm_neon.td.
126 static char ModType(const char mod, char type, bool &quad, bool &poly,
127 bool &usgn, bool &scal, bool &cnst, bool &pntr) {
200 /// TypeString - for a modifier and type, generate the name of the typedef for
201 /// that type. QUc -> uint8x8_t.
202 static std::string TypeString(const char mod, StringRef typestr) {
215 // base type to get the type string for.
216 char type = ClassifyType(typestr, quad, poly, usgn);
218 // Based on the modifying character, change the type and width if necessary.
219 type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
228 s += poly ? "poly8" : "int8";
231 s += quad ? "x16" : "x8";
234 s += poly ? "poly16" : "int16";
237 s += quad ? "x8" : "x4";
243 s += quad ? "x4" : "x2";
249 s += quad ? "x2" : "x1";
255 s += quad ? "x8" : "x4";
261 s += quad ? "x4" : "x2";
264 throw "unhandled type!";
275 // Append _t, finishing the type string typedef type.
287 /// BuiltinTypeString - for a modifier and type, generate the clang
288 /// BuiltinsARM.def prototype code for the function. See the top of clang's
289 /// Builtins.def for a description of the type strings.
290 static std::string BuiltinTypeString(const char mod, StringRef typestr,
291 ClassKind ck, bool ret) {
304 // base type to get the type string for.
305 char type = ClassifyType(typestr, quad, poly, usgn);
307 // Based on the modifying character, change the type and width if necessary.
308 type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
310 // All pointers are void* pointers. Change type to 'v' now.
316 // Treat half-float ('h') types as unsigned short ('s') types.
321 usgn = usgn | poly | ((ck == ClassI || ck == ClassW) && scal && type != 'f');
328 else if (type == 'c')
329 s.push_back('S'); // make chars explicitly signed
331 if (type == 'l') // 64-bit long
343 // Since the return value must be one type, return a vector type of the
344 // appropriate width which we will bitcast. An exception is made for
345 // returning structs of 2, 3, or 4 vectors which are returned in a sret-like
346 // fashion, storing them to a pointer arg.
348 if (mod >= '2' && mod <= '4')
349 return "vv*"; // void result with void* first argument
350 if (mod == 'f' || (ck != ClassB && type == 'f'))
351 return quad ? "V4f" : "V2f";
352 if (ck != ClassB && type == 's')
353 return quad ? "V8s" : "V4s";
354 if (ck != ClassB && type == 'i')
355 return quad ? "V4i" : "V2i";
356 if (ck != ClassB && type == 'l')
357 return quad ? "V2LLi" : "V1LLi";
359 return quad ? "V16Sc" : "V8Sc";
362 // Non-return array types are passed as individual vectors.
364 return quad ? "V16ScV16Sc" : "V8ScV8Sc";
366 return quad ? "V16ScV16ScV16Sc" : "V8ScV8ScV8Sc";
368 return quad ? "V16ScV16ScV16ScV16Sc" : "V8ScV8ScV8ScV8Sc";
370 if (mod == 'f' || (ck != ClassB && type == 'f'))
371 return quad ? "V4f" : "V2f";
372 if (ck != ClassB && type == 's')
373 return quad ? "V8s" : "V4s";
374 if (ck != ClassB && type == 'i')
375 return quad ? "V4i" : "V2i";
376 if (ck != ClassB && type == 'l')
377 return quad ? "V2LLi" : "V1LLi";
379 return quad ? "V16Sc" : "V8Sc";
382 /// MangleName - Append a type or width suffix to a base neon function name,
383 /// and insert a 'q' in the appropriate location if the operation works on
384 /// 128b rather than 64b. E.g. turn "vst2_lane" into "vst2q_lane_f32", etc.
385 static std::string MangleName(const std::string &name, StringRef typestr,
387 if (name == "vcvt_f32_f16")
393 char type = ClassifyType(typestr, quad, poly, usgn);
395 std::string s = name;
400 case ClassS: s += poly ? "_p8" : usgn ? "_u8" : "_s8"; break;
401 case ClassI: s += "_i8"; break;
402 case ClassW: s += "_8"; break;
408 case ClassS: s += poly ? "_p16" : usgn ? "_u16" : "_s16"; break;
409 case ClassI: s += "_i16"; break;
410 case ClassW: s += "_16"; break;
416 case ClassS: s += usgn ? "_u32" : "_s32"; break;
417 case ClassI: s += "_i32"; break;
418 case ClassW: s += "_32"; break;
424 case ClassS: s += usgn ? "_u64" : "_s64"; break;
425 case ClassI: s += "_i64"; break;
426 case ClassW: s += "_64"; break;
433 case ClassI: s += "_f16"; break;
434 case ClassW: s += "_16"; break;
441 case ClassI: s += "_f32"; break;
442 case ClassW: s += "_32"; break;
447 throw "unhandled type!";
453 // Insert a 'q' before the first '_' character so that it ends up before
454 // _lane or _n on vector-scalar operations.
456 size_t pos = s.find('_');
457 s = s.insert(pos, "q");
462 // Generate the string "(argtype a, argtype b, ...)"
463 static std::string GenArgs(const std::string &proto, StringRef typestr) {
464 bool define = proto.find('i') != std::string::npos;
470 for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
472 // Immediate macro arguments are used directly instead of being assigned
473 // to local temporaries; prepend an underscore prefix to make their
474 // names consistent with the local temporaries.
478 s += TypeString(proto[i], typestr) + " __";
489 // Macro arguments are not type-checked like inline function arguments, so
490 // assign them to local temporaries to get the right type checking.
491 static std::string GenMacroLocals(const std::string &proto, StringRef typestr) {
495 for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
496 // Do not create a temporary for an immediate argument.
497 // That would defeat the whole point of using a macro!
498 if (proto[i] == 'i') continue;
500 s += TypeString(proto[i], typestr) + " __";
511 // Use the vmovl builtin to sign-extend or zero-extend a vector.
512 static std::string Extend(StringRef typestr, const std::string &a) {
514 s = MangleName("vmovl", typestr, ClassS);
519 static std::string Duplicate(unsigned nElts, StringRef typestr,
520 const std::string &a) {
523 s = "(" + TypeString('d', typestr) + "){ ";
524 for (unsigned i = 0; i != nElts; ++i) {
534 static std::string SplatLane(unsigned nElts, const std::string &vec,
535 const std::string &lane) {
536 std::string s = "__builtin_shufflevector(" + vec + ", " + vec;
537 for (unsigned i = 0; i < nElts; ++i)
543 static unsigned GetNumElements(StringRef typestr, bool &quad) {
546 char type = ClassifyType(typestr, quad, dummy, dummy);
549 case 'c': nElts = 8; break;
550 case 's': nElts = 4; break;
551 case 'i': nElts = 2; break;
552 case 'l': nElts = 1; break;
553 case 'h': nElts = 4; break;
554 case 'f': nElts = 2; break;
556 throw "unhandled type!";
559 if (quad) nElts <<= 1;
563 // Generate the definition for this intrinsic, e.g. "a + b" for OpAdd.
564 static std::string GenOpString(OpKind op, const std::string &proto,
567 unsigned nElts = GetNumElements(typestr, quad);
569 // If this builtin takes an immediate argument, we need to #define it rather
570 // than use a standard declaration, so that SemaChecking can range check
571 // the immediate passed by the user.
572 bool define = proto.find('i') != std::string::npos;
574 std::string ts = TypeString(proto[0], typestr);
576 if (op == OpHi || op == OpLo) {
577 s = "union { " + ts + " r; double d; } u; u.d = ";
578 } else if (!define) {
587 s += Extend(typestr, "__a") + " + " + Extend(typestr, "__b") + ";";
590 s += "__a + " + Extend(typestr, "__b") + ";";
596 s += Extend(typestr, "__a") + " - " + Extend(typestr, "__b") + ";";
599 s += "__a - " + Extend(typestr, "__b") + ";";
602 s += "__a * " + Duplicate(nElts, typestr, "__b") + ";";
605 s += "__a * " + SplatLane(nElts, "__b", "__c") + ";";
611 s += Extend(typestr, "__a") + " * " +
612 Extend(typestr, Duplicate(nElts << (int)quad, typestr, "__b")) + ";";
615 s += Extend(typestr, "__a") + " * " +
616 Extend(typestr, SplatLane(nElts, "__b", "__c")) + ";";
619 s += Extend(typestr, "__a") + " * " + Extend(typestr, "__b") + ";";
622 s += "__a + (__b * " + Duplicate(nElts, typestr, "__c") + ");";
625 s += "__a + (__b * " + SplatLane(nElts, "__c", "__d") + ");";
628 s += "__a + (__b * __c);";
631 s += "__a + (" + Extend(typestr, "__b") + " * " +
632 Extend(typestr, Duplicate(nElts, typestr, "__c")) + ");";
635 s += "__a + (" + Extend(typestr, "__b") + " * " +
636 Extend(typestr, SplatLane(nElts, "__c", "__d")) + ");";
639 s += "__a + (" + Extend(typestr, "__b") + " * " +
640 Extend(typestr, "__c") + ");";
643 s += "__a - (__b * " + Duplicate(nElts, typestr, "__c") + ");";
646 s += "__a - (__b * " + SplatLane(nElts, "__c", "__d") + ");";
649 s += "__a - (__b * __c);";
652 s += "__a - (" + Extend(typestr, "__b") + " * " +
653 Extend(typestr, Duplicate(nElts, typestr, "__c")) + ");";
656 s += "__a - (" + Extend(typestr, "__b") + " * " +
657 Extend(typestr, SplatLane(nElts, "__c", "__d")) + ");";
660 s += "__a - (" + Extend(typestr, "__b") + " * " +
661 Extend(typestr, "__c") + ");";
664 s += "(" + ts + ")(__a == __b);";
667 s += "(" + ts + ")(__a >= __b);";
670 s += "(" + ts + ")(__a <= __b);";
673 s += "(" + ts + ")(__a > __b);";
676 s += "(" + ts + ")(__a < __b);";
700 s += "(" + ts + ")__a;";
703 s += "(" + ts + ")__builtin_shufflevector((int64x1_t)__a";
704 s += ", (int64x1_t)__b, 0, 1);";
707 s += "(((float64x2_t)__a)[1]);";
710 s += "(((float64x2_t)__a)[0]);";
713 s += Duplicate(nElts, typestr, "__a") + ";";
716 s += SplatLane(nElts, "__a", "__b") + ";";
719 // ((0 & 1) | (~0 & 2))
721 ts = TypeString(proto[1], typestr);
722 s += "((__a & (" + ts + ")__b) | ";
723 s += "(~__a & (" + ts + ")__c));";
726 s += "__builtin_shufflevector(__a, __a";
727 for (unsigned i = 2; i <= nElts; i += 2)
728 for (unsigned j = 0; j != 2; ++j)
729 s += ", " + utostr(i - j - 1);
733 unsigned WordElts = nElts >> (1 + (int)quad);
734 s += "__builtin_shufflevector(__a, __a";
735 for (unsigned i = WordElts; i <= nElts; i += WordElts)
736 for (unsigned j = 0; j != WordElts; ++j)
737 s += ", " + utostr(i - j - 1);
742 unsigned DblWordElts = nElts >> (int)quad;
743 s += "__builtin_shufflevector(__a, __a";
744 for (unsigned i = DblWordElts; i <= nElts; i += DblWordElts)
745 for (unsigned j = 0; j != DblWordElts; ++j)
746 s += ", " + utostr(i - j - 1);
751 s += "__a + " + MangleName("vabd", typestr, ClassS) + "(__b, __c);";
754 throw "unknown OpKind!";
757 if (op == OpHi || op == OpLo) {
765 static unsigned GetNeonEnum(const std::string &proto, StringRef typestr) {
766 unsigned mod = proto[0];
769 if (mod == 'v' || mod == 'f')
779 // Base type to get the type string for.
780 char type = ClassifyType(typestr, quad, poly, usgn);
782 // Based on the modifying character, change the type and width if necessary.
783 type = ModType(mod, type, quad, poly, usgn, scal, cnst, pntr);
787 if (quad && proto[1] != 'g')
810 throw "unhandled type!";
816 // Generate the definition for this intrinsic, e.g. __builtin_neon_cls(a)
817 static std::string GenBuiltin(const std::string &name, const std::string &proto,
818 StringRef typestr, ClassKind ck) {
821 // If this builtin returns a struct 2, 3, or 4 vectors, pass it as an implicit
822 // sret-like argument.
823 bool sret = (proto[0] >= '2' && proto[0] <= '4');
825 // If this builtin takes an immediate argument, we need to #define it rather
826 // than use a standard declaration, so that SemaChecking can range check
827 // the immediate passed by the user.
828 bool define = proto.find('i') != std::string::npos;
830 // Check if the prototype has a scalar operand with the type of the vector
831 // elements. If not, bitcasting the args will take care of arg checking.
832 // The actual signedness etc. will be taken care of with special enums.
833 if (proto.find('s') == std::string::npos)
836 if (proto[0] != 'v') {
837 std::string ts = TypeString(proto[0], typestr);
847 s += "return (" + ts + ")";
851 bool splat = proto.find('a') != std::string::npos;
853 s += "__builtin_neon_";
855 // Call the non-splat builtin: chop off the "_n" suffix from the name.
856 std::string vname(name, 0, name.size()-2);
857 s += MangleName(vname, typestr, ck);
859 s += MangleName(name, typestr, ck);
863 // Pass the address of the return variable as the first argument to sret-like
869 for (unsigned i = 1, e = proto.size(); i != e; ++i, ++arg) {
870 std::string args = std::string(&arg, 1);
872 // Use the local temporaries instead of the macro arguments.
875 bool argQuad = false;
876 bool argPoly = false;
877 bool argUsgn = false;
878 bool argScalar = false;
880 char argType = ClassifyType(typestr, argQuad, argPoly, argUsgn);
881 argType = ModType(proto[i], argType, argQuad, argPoly, argUsgn, argScalar,
884 // Handle multiple-vector values specially, emitting each subvector as an
885 // argument to the __builtin.
886 if (proto[i] >= '2' && proto[i] <= '4') {
887 // Check if an explicit cast is needed.
888 if (argType != 'c' || argPoly || argUsgn)
889 args = (argQuad ? "(int8x16_t)" : "(int8x8_t)") + args;
891 for (unsigned vi = 0, ve = proto[i] - '0'; vi != ve; ++vi) {
892 s += args + ".val[" + utostr(vi) + "]";
902 if (splat && (i + 1) == e)
903 args = Duplicate(GetNumElements(typestr, argQuad), typestr, args);
905 // Check if an explicit cast is needed.
906 if ((splat || !argScalar) &&
907 ((ck == ClassB && argType != 'c') || argPoly || argUsgn)) {
908 std::string argTypeStr = "c";
910 argTypeStr = argType;
912 argTypeStr = "Q" + argTypeStr;
913 args = "(" + TypeString('d', argTypeStr) + ")" + args;
921 // Extra constant integer to hold type class enum for this function, e.g. s8
923 s += ", " + utostr(GetNeonEnum(proto, typestr));
927 if (proto[0] != 'v' && sret) {
936 static std::string GenBuiltinDef(const std::string &name,
937 const std::string &proto,
938 StringRef typestr, ClassKind ck) {
939 std::string s("BUILTIN(__builtin_neon_");
941 // If all types are the same size, bitcasting the args will take care
942 // of arg checking. The actual signedness etc. will be taken care of with
944 if (proto.find('s') == std::string::npos)
947 s += MangleName(name, typestr, ck);
950 for (unsigned i = 0, e = proto.size(); i != e; ++i)
951 s += BuiltinTypeString(proto[i], typestr, ck, i == 0);
953 // Extra constant integer to hold type class enum for this function, e.g. s8
961 static std::string GenIntrinsic(const std::string &name,
962 const std::string &proto,
963 StringRef outTypeStr, StringRef inTypeStr,
964 OpKind kind, ClassKind classKind) {
965 assert(!proto.empty() && "");
966 bool define = proto.find('i') != std::string::npos;
969 // static always inline + return type
973 s += "__ai " + TypeString(proto[0], outTypeStr) + " ";
975 // Function name with type suffix
976 std::string mangledName = MangleName(name, outTypeStr, ClassS);
977 if (outTypeStr != inTypeStr) {
978 // If the input type is different (e.g., for vreinterpret), append a suffix
979 // for the input type. String off a "Q" (quad) prefix so that MangleName
980 // does not insert another "q" in the name.
981 unsigned typeStrOff = (inTypeStr[0] == 'Q' ? 1 : 0);
982 StringRef inTypeNoQuad = inTypeStr.substr(typeStrOff);
983 mangledName = MangleName(mangledName, inTypeNoQuad, ClassS);
987 // Function arguments
988 s += GenArgs(proto, inTypeStr);
992 s += " __extension__ ({ \\\n ";
993 s += GenMacroLocals(proto, inTypeStr);
999 s += GenOpString(kind, proto, outTypeStr);
1001 s += GenBuiltin(name, proto, outTypeStr, classKind);
1010 /// run - Read the records in arm_neon.td and output arm_neon.h. arm_neon.h
1011 /// is comprised of type definitions and function declarations.
1012 void NeonEmitter::run(raw_ostream &OS) {
1013 EmitSourceFileHeader("ARM NEON Header", OS);
1015 // FIXME: emit license into file?
1017 OS << "#ifndef __ARM_NEON_H\n";
1018 OS << "#define __ARM_NEON_H\n\n";
1020 OS << "#ifndef __ARM_NEON__\n";
1021 OS << "#error \"NEON support not enabled\"\n";
1024 OS << "#include <stdint.h>\n\n";
1026 // Emit NEON-specific scalar typedefs.
1027 OS << "typedef float float32_t;\n";
1028 OS << "typedef int8_t poly8_t;\n";
1029 OS << "typedef int16_t poly16_t;\n";
1030 OS << "typedef uint16_t float16_t;\n";
1032 // Emit Neon vector typedefs.
1033 std::string TypedefTypes("cQcsQsiQilQlUcQUcUsQUsUiQUiUlQUlhQhfQfPcQPcPsQPs");
1034 SmallVector<StringRef, 24> TDTypeVec;
1035 ParseTypes(0, TypedefTypes, TDTypeVec);
1037 // Emit vector typedefs.
1038 for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1039 bool dummy, quad = false, poly = false;
1040 (void) ClassifyType(TDTypeVec[i], quad, poly, dummy);
1042 OS << "typedef __attribute__((neon_polyvector_type(";
1044 OS << "typedef __attribute__((neon_vector_type(";
1046 unsigned nElts = GetNumElements(TDTypeVec[i], quad);
1047 OS << utostr(nElts) << "))) ";
1051 OS << TypeString('s', TDTypeVec[i]);
1052 OS << " " << TypeString('d', TDTypeVec[i]) << ";\n";
1055 OS << "typedef __attribute__((__vector_size__(8))) "
1056 "double float64x1_t;\n";
1057 OS << "typedef __attribute__((__vector_size__(16))) "
1058 "double float64x2_t;\n";
1061 // Emit struct typedefs.
1062 for (unsigned vi = 2; vi != 5; ++vi) {
1063 for (unsigned i = 0, e = TDTypeVec.size(); i != e; ++i) {
1064 std::string ts = TypeString('d', TDTypeVec[i]);
1065 std::string vs = TypeString('0' + vi, TDTypeVec[i]);
1066 OS << "typedef struct " << vs << " {\n";
1067 OS << " " << ts << " val";
1068 OS << "[" << utostr(vi) << "]";
1070 OS << vs << ";\n\n";
1074 OS << "#define __ai static __attribute__((__always_inline__))\n\n";
1076 std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1078 // Emit vmovl and vabd intrinsics first so they can be used by other
1080 emitIntrinsic(OS, Records.getDef("VMOVL"));
1081 emitIntrinsic(OS, Records.getDef("VABD"));
1083 // Unique the return+pattern types, and assign them.
1084 for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1086 if (R->getName() != "VMOVL" && R->getName() != "VABD")
1087 emitIntrinsic(OS, R);
1090 OS << "#undef __ai\n\n";
1091 OS << "#endif /* __ARM_NEON_H */\n";
1094 /// emitIntrinsic - Write out the arm_neon.h header file definitions for the
1095 /// intrinsics specified by record R.
1096 void NeonEmitter::emitIntrinsic(raw_ostream &OS, Record *R) {
1097 std::string name = R->getValueAsString("Name");
1098 std::string Proto = R->getValueAsString("Prototype");
1099 std::string Types = R->getValueAsString("Types");
1101 SmallVector<StringRef, 16> TypeVec;
1102 ParseTypes(R, Types, TypeVec);
1104 OpKind kind = OpMap[R->getValueAsDef("Operand")->getName()];
1106 ClassKind classKind = ClassNone;
1107 if (R->getSuperClasses().size() >= 2)
1108 classKind = ClassMap[R->getSuperClasses()[1]];
1109 if (classKind == ClassNone && kind == OpNone)
1110 throw TGError(R->getLoc(), "Builtin has no class kind");
1112 for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1113 if (kind == OpReinterpret) {
1114 bool outQuad = false;
1116 (void)ClassifyType(TypeVec[ti], outQuad, dummy, dummy);
1117 for (unsigned srcti = 0, srcte = TypeVec.size();
1118 srcti != srcte; ++srcti) {
1119 bool inQuad = false;
1120 (void)ClassifyType(TypeVec[srcti], inQuad, dummy, dummy);
1121 if (srcti == ti || inQuad != outQuad)
1123 OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[srcti],
1127 OS << GenIntrinsic(name, Proto, TypeVec[ti], TypeVec[ti],
1134 static unsigned RangeFromType(StringRef typestr) {
1135 // base type to get the type string for.
1136 bool quad = false, dummy = false;
1137 char type = ClassifyType(typestr, quad, dummy, dummy);
1141 return (8 << (int)quad) - 1;
1144 return (4 << (int)quad) - 1;
1147 return (2 << (int)quad) - 1;
1149 return (1 << (int)quad) - 1;
1151 throw "unhandled type!";
1154 assert(0 && "unreachable");
1158 /// runHeader - Emit a file with sections defining:
1159 /// 1. the NEON section of BuiltinsARM.def.
1160 /// 2. the SemaChecking code for the type overload checking.
1161 /// 3. the SemaChecking code for validation of intrinsic immedate arguments.
1162 void NeonEmitter::runHeader(raw_ostream &OS) {
1163 std::vector<Record*> RV = Records.getAllDerivedDefinitions("Inst");
1165 StringMap<OpKind> EmittedMap;
1167 // Generate BuiltinsARM.def for NEON
1168 OS << "#ifdef GET_NEON_BUILTINS\n";
1169 for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1171 OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1175 std::string Proto = R->getValueAsString("Prototype");
1177 // Functions with 'a' (the splat code) in the type prototype should not get
1178 // their own builtin as they use the non-splat variant.
1179 if (Proto.find('a') != std::string::npos)
1182 std::string Types = R->getValueAsString("Types");
1183 SmallVector<StringRef, 16> TypeVec;
1184 ParseTypes(R, Types, TypeVec);
1186 if (R->getSuperClasses().size() < 2)
1187 throw TGError(R->getLoc(), "Builtin has no class kind");
1189 std::string name = R->getValueAsString("Name");
1190 ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1192 for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1193 // Generate the BuiltinsARM.def declaration for this builtin, ensuring
1194 // that each unique BUILTIN() macro appears only once in the output
1196 std::string bd = GenBuiltinDef(name, Proto, TypeVec[ti], ck);
1197 if (EmittedMap.count(bd))
1200 EmittedMap[bd] = OpNone;
1206 // Generate the overloaded type checking code for SemaChecking.cpp
1207 OS << "#ifdef GET_NEON_OVERLOAD_CHECK\n";
1208 for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1210 OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1214 std::string Proto = R->getValueAsString("Prototype");
1215 std::string Types = R->getValueAsString("Types");
1216 std::string name = R->getValueAsString("Name");
1218 // Functions with 'a' (the splat code) in the type prototype should not get
1219 // their own builtin as they use the non-splat variant.
1220 if (Proto.find('a') != std::string::npos)
1223 // Functions which have a scalar argument cannot be overloaded, no need to
1224 // check them if we are emitting the type checking code.
1225 if (Proto.find('s') != std::string::npos)
1228 SmallVector<StringRef, 16> TypeVec;
1229 ParseTypes(R, Types, TypeVec);
1231 if (R->getSuperClasses().size() < 2)
1232 throw TGError(R->getLoc(), "Builtin has no class kind");
1234 int si = -1, qi = -1;
1235 unsigned mask = 0, qmask = 0;
1236 for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1237 // Generate the switch case(s) for this builtin for the type validation.
1238 bool quad = false, poly = false, usgn = false;
1239 (void) ClassifyType(TypeVec[ti], quad, poly, usgn);
1243 qmask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1246 mask |= 1 << GetNeonEnum(Proto, TypeVec[ti]);
1250 OS << "case ARM::BI__builtin_neon_"
1251 << MangleName(name, TypeVec[si], ClassB)
1252 << ": mask = " << "0x" << utohexstr(mask) << "; break;\n";
1254 OS << "case ARM::BI__builtin_neon_"
1255 << MangleName(name, TypeVec[qi], ClassB)
1256 << ": mask = " << "0x" << utohexstr(qmask) << "; break;\n";
1260 // Generate the intrinsic range checking code for shift/lane immediates.
1261 OS << "#ifdef GET_NEON_IMMEDIATE_CHECK\n";
1262 for (unsigned i = 0, e = RV.size(); i != e; ++i) {
1265 OpKind k = OpMap[R->getValueAsDef("Operand")->getName()];
1269 std::string name = R->getValueAsString("Name");
1270 std::string Proto = R->getValueAsString("Prototype");
1271 std::string Types = R->getValueAsString("Types");
1273 // Functions with 'a' (the splat code) in the type prototype should not get
1274 // their own builtin as they use the non-splat variant.
1275 if (Proto.find('a') != std::string::npos)
1278 // Functions which do not have an immediate do not need to have range
1279 // checking code emitted.
1280 if (Proto.find('i') == std::string::npos)
1283 SmallVector<StringRef, 16> TypeVec;
1284 ParseTypes(R, Types, TypeVec);
1286 if (R->getSuperClasses().size() < 2)
1287 throw TGError(R->getLoc(), "Builtin has no class kind");
1289 ClassKind ck = ClassMap[R->getSuperClasses()[1]];
1291 for (unsigned ti = 0, te = TypeVec.size(); ti != te; ++ti) {
1292 std::string namestr, shiftstr, rangestr;
1294 // Builtins which are overloaded by type will need to have their upper
1295 // bound computed at Sema time based on the type constant.
1296 if (Proto.find('s') == std::string::npos) {
1298 if (R->getValueAsBit("isShift")) {
1299 shiftstr = ", true";
1301 // Right shifts have an 'r' in the name, left shifts do not.
1302 if (name.find('r') != std::string::npos)
1303 rangestr = "l = 1; ";
1305 rangestr += "u = RFT(TV" + shiftstr + ")";
1307 rangestr = "u = " + utostr(RangeFromType(TypeVec[ti]));
1309 // Make sure cases appear only once by uniquing them in a string map.
1310 namestr = MangleName(name, TypeVec[ti], ck);
1311 if (EmittedMap.count(namestr))
1313 EmittedMap[namestr] = OpNone;
1315 // Calculate the index of the immediate that should be range checked.
1316 unsigned immidx = 0;
1318 // Builtins that return a struct of multiple vectors have an extra
1319 // leading arg for the struct return.
1320 if (Proto[0] >= '2' && Proto[0] <= '4')
1323 // Add one to the index for each argument until we reach the immediate
1324 // to be checked. Structs of vectors are passed as multiple arguments.
1325 for (unsigned ii = 1, ie = Proto.size(); ii != ie; ++ii) {
1326 switch (Proto[ii]) {
1327 default: immidx += 1; break;
1328 case '2': immidx += 2; break;
1329 case '3': immidx += 3; break;
1330 case '4': immidx += 4; break;
1331 case 'i': ie = ii + 1; break;
1334 OS << "case ARM::BI__builtin_neon_" << MangleName(name, TypeVec[ti], ck)
1335 << ": i = " << immidx << "; " << rangestr << "; break;\n";