llvm/utils/TableGen/Attributes.cpp

   1 //===- Attributes.cpp - Generate attributes -------------------------------===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "llvm/TableGen/Error.h"
  10 #include "llvm/TableGen/Record.h"
  11 #include "llvm/TableGen/TableGenBackend.h"
  12 using namespace llvm;
  13
  14 #define DEBUG_TYPE "attr-enum"
  15
  16 namespace {
  17
  18 class Attributes {
  19 public:
  20   Attributes(const RecordKeeper &R) : Records(R) {}
  21   void run(raw_ostream &OS);
  22
  23 private:
  24   void emitTargetIndependentNames(raw_ostream &OS);
  25   void emitFnAttrCompatCheck(raw_ostream &OS, bool IsStringAttr);
  26   void emitAttributeProperties(raw_ostream &OF);
  27
  28   const RecordKeeper &Records;
  29 };
  30
  31 } // End anonymous namespace.
  32
  33 void Attributes::emitTargetIndependentNames(raw_ostream &OS) {
  34   OS << "#ifdef GET_ATTR_NAMES\n";
  35   OS << "#undef GET_ATTR_NAMES\n";
  36
  37   OS << "#ifndef ATTRIBUTE_ALL\n";
  38   OS << "#define ATTRIBUTE_ALL(FIRST, SECOND)\n";
  39   OS << "#endif\n\n";
  40
  41   auto Emit = [&](ArrayRef<StringRef> KindNames, StringRef MacroName) {
  42     OS << "#ifndef " << MacroName << "\n";
  43     OS << "#define " << MacroName
  44        << "(FIRST, SECOND) ATTRIBUTE_ALL(FIRST, SECOND)\n";
  45     OS << "#endif\n\n";
  46     for (StringRef KindName : KindNames) {
  47       for (auto *A : Records.getAllDerivedDefinitions(KindName)) {
  48         OS << MacroName << "(" << A->getName() << ","
  49            << A->getValueAsString("AttrString") << ")\n";
  50       }
  51     }
  52     OS << "#undef " << MacroName << "\n\n";
  53   };
  54
  55   // Emit attribute enums in the same order llvm::Attribute::operator< expects.
  56   Emit({"EnumAttr", "TypeAttr", "IntAttr", "ConstantRangeAttr",
  57         "ConstantRangeListAttr"},
  58        "ATTRIBUTE_ENUM");
  59   Emit({"StrBoolAttr"}, "ATTRIBUTE_STRBOOL");
  60   Emit({"ComplexStrAttr"}, "ATTRIBUTE_COMPLEXSTR");
  61
  62   OS << "#undef ATTRIBUTE_ALL\n";
  63   OS << "#endif\n\n";
  64
  65   OS << "#ifdef GET_ATTR_ENUM\n";
  66   OS << "#undef GET_ATTR_ENUM\n";
  67   unsigned Value = 1; // Leave zero for AttrKind::None.
  68   for (StringRef KindName : {"EnumAttr", "TypeAttr", "IntAttr",
  69                              "ConstantRangeAttr", "ConstantRangeListAttr"}) {
  70     OS << "First" << KindName << " = " << Value << ",\n";
  71     for (auto *A : Records.getAllDerivedDefinitions(KindName)) {
  72       OS << A->getName() << " = " << Value << ",\n";
  73       Value++;
  74     }
  75     OS << "Last" << KindName << " = " << (Value - 1) << ",\n";
  76   }
  77   OS << "#endif\n\n";
  78 }
  79
  80 void Attributes::emitFnAttrCompatCheck(raw_ostream &OS, bool IsStringAttr) {
  81   OS << "#ifdef GET_ATTR_COMPAT_FUNC\n";
  82   OS << "#undef GET_ATTR_COMPAT_FUNC\n";
  83
  84   OS << "static inline bool hasCompatibleFnAttrs(const Function &Caller,\n"
  85      << "                                        const Function &Callee) {\n";
  86   OS << "  bool Ret = true;\n\n";
  87
  88   for (const Record *Rule : Records.getAllDerivedDefinitions("CompatRule")) {
  89     StringRef FuncName = Rule->getValueAsString("CompatFunc");
  90     OS << "  Ret &= " << FuncName << "(Caller, Callee";
  91     StringRef AttrName = Rule->getValueAsString("AttrName");
  92     if (!AttrName.empty())
  93       OS << ", \"" << AttrName << "\"";
  94     OS << ");\n";
  95   }
  96
  97   OS << "\n";
  98   OS << "  return Ret;\n";
  99   OS << "}\n\n";
 100
 101   OS << "static inline void mergeFnAttrs(Function &Caller,\n"
 102      << "                                const Function &Callee) {\n";
 103
 104   for (const Record *Rule : Records.getAllDerivedDefinitions("MergeRule")) {
 105     StringRef FuncName = Rule->getValueAsString("MergeFunc");
 106     OS << "  " << FuncName << "(Caller, Callee);\n";
 107   }
 108
 109   OS << "}\n\n";
 110
 111   OS << "#endif\n";
 112 }
 113
 114 void Attributes::emitAttributeProperties(raw_ostream &OS) {
 115   OS << "#ifdef GET_ATTR_PROP_TABLE\n";
 116   OS << "#undef GET_ATTR_PROP_TABLE\n";
 117   OS << "static const uint8_t AttrPropTable[] = {\n";
 118   for (StringRef KindName : {"EnumAttr", "TypeAttr", "IntAttr",
 119                              "ConstantRangeAttr", "ConstantRangeListAttr"}) {
 120     bool AllowIntersectAnd = KindName == "EnumAttr";
 121     bool AllowIntersectMin = KindName == "IntAttr";
 122     for (auto *A : Records.getAllDerivedDefinitions(KindName)) {
 123       OS << "0";
 124       for (const Init *P : *A->getValueAsListInit("Properties")) {
 125         if (!AllowIntersectAnd &&
 126             cast<DefInit>(P)->getDef()->getName() == "IntersectAnd")
 127           PrintFatalError("'IntersectAnd' only compatible with 'EnumAttr'");
 128         if (!AllowIntersectMin &&
 129             cast<DefInit>(P)->getDef()->getName() == "IntersectMin")
 130           PrintFatalError("'IntersectMin' only compatible with 'IntAttr'");
 131
 132         OS << " | AttributeProperty::" << cast<DefInit>(P)->getDef()->getName();
 133       }
 134       OS << ",\n";
 135     }
 136   }
 137   OS << "};\n";
 138   OS << "#endif\n";
 139 }
 140
 141 void Attributes::run(raw_ostream &OS) {
 142   emitTargetIndependentNames(OS);
 143   emitFnAttrCompatCheck(OS, false);
 144   emitAttributeProperties(OS);
 145 }
 146
 147 static TableGen::Emitter::OptClass<Attributes> X("gen-attrs",
 148                                                  "Generate attributes");