1 //===- IntrinsicEmitter.cpp - Generate intrinsic information --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend emits information about intrinsic functions.
12 //===----------------------------------------------------------------------===//
14 #include "IntrinsicEmitter.h"
16 #include "llvm/ADT/StringExtras.h"
20 //===----------------------------------------------------------------------===//
21 // IntrinsicEmitter Implementation
22 //===----------------------------------------------------------------------===//
24 void IntrinsicEmitter::run(std::ostream &OS) {
25 EmitSourceFileHeader("Intrinsic Function Source Fragment", OS);
27 std::vector<CodeGenIntrinsic> Ints = LoadIntrinsics(Records);
29 // Emit the enum information.
30 EmitEnumInfo(Ints, OS);
32 // Emit the intrinsic ID -> name table.
33 EmitIntrinsicToNameTable(Ints, OS);
35 // Emit the function name recognizer.
36 EmitFnNameRecognizer(Ints, OS);
38 // Emit the intrinsic verifier.
39 EmitVerifier(Ints, OS);
41 // Emit the intrinsic declaration generator.
42 EmitGenerator(Ints, OS);
44 // Emit mod/ref info for each function.
45 EmitModRefInfo(Ints, OS);
47 // Emit table of non-memory accessing intrinsics.
48 EmitNoMemoryInfo(Ints, OS);
50 // Emit side effect info for each intrinsic.
51 EmitSideEffectInfo(Ints, OS);
53 // Emit a list of intrinsics with corresponding GCC builtins.
54 EmitGCCBuiltinList(Ints, OS);
56 // Emit code to translate GCC builtins into LLVM intrinsics.
57 EmitIntrinsicToGCCBuiltinMap(Ints, OS);
60 void IntrinsicEmitter::EmitEnumInfo(const std::vector<CodeGenIntrinsic> &Ints,
62 OS << "// Enum values for Intrinsics.h\n";
63 OS << "#ifdef GET_INTRINSIC_ENUM_VALUES\n";
64 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
65 OS << " " << Ints[i].EnumName;
66 OS << ((i != e-1) ? ", " : " ");
67 OS << std::string(40-Ints[i].EnumName.size(), ' ')
68 << "// " << Ints[i].Name << "\n";
73 void IntrinsicEmitter::
74 EmitFnNameRecognizer(const std::vector<CodeGenIntrinsic> &Ints,
76 // Build a function name -> intrinsic name mapping.
77 std::map<std::string, std::string> IntMapping;
78 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
79 IntMapping[Ints[i].Name] = Ints[i].EnumName;
81 OS << "// Function name -> enum value recognizer code.\n";
82 OS << "#ifdef GET_FUNCTION_RECOGNIZER\n";
83 OS << " switch (Name[5]) {\n";
85 // Emit the intrinsics in sorted order.
87 for (std::map<std::string, std::string>::iterator I = IntMapping.begin(),
88 E = IntMapping.end(); I != E; ++I) {
89 if (I->first[5] != LastChar) {
90 LastChar = I->first[5];
92 OS << " case '" << LastChar << "':\n";
95 OS << " if (Len == " << I->first.size()
96 << " && !memcmp(Name, \"" << I->first << "\", Len)) return Intrinsic::"
97 << I->second << ";\n";
100 OS << " // The 'llvm.' namespace is reserved!\n";
101 OS << " assert(0 && \"Unknown LLVM intrinsic function!\");\n";
105 void IntrinsicEmitter::
106 EmitIntrinsicToNameTable(const std::vector<CodeGenIntrinsic> &Ints,
108 OS << "// Intrinsic ID to name table\n";
109 OS << "#ifdef GET_INTRINSIC_NAME_TABLE\n";
110 OS << " // Note that entry #0 is the invalid intrinsic!\n";
111 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
112 OS << " \"" << Ints[i].Name << "\",\n";
116 static bool EmitTypeVerify(std::ostream &OS, Record *ArgType) {
117 if (ArgType->getValueAsString("TypeVal") == "...") return true;
119 OS << "(int)" << ArgType->getValueAsString("TypeVal") << ", ";
120 // If this is an integer type, check the width is correct.
121 if (ArgType->isSubClassOf("LLVMIntegerType"))
122 OS << ArgType->getValueAsInt("Width") << ", ";
124 // If this is a vector type, check that the subtype and size are correct.
125 else if (ArgType->isSubClassOf("LLVMVectorType")) {
126 EmitTypeVerify(OS, ArgType->getValueAsDef("ElTy"));
127 OS << ArgType->getValueAsInt("NumElts") << ", ";
133 static void EmitTypeGenerate(std::ostream &OS, Record *ArgType) {
134 if (ArgType->isSubClassOf("LLVMIntegerType")) {
135 OS << "IntegerType::get(" << ArgType->getValueAsInt("Width") << ")";
136 } else if (ArgType->isSubClassOf("LLVMVectorType")) {
137 OS << "VectorType::get(";
138 EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"));
139 OS << ", " << ArgType->getValueAsInt("NumElts") << ")";
140 } else if (ArgType->isSubClassOf("LLVMPointerType")) {
141 OS << "PointerType::get(";
142 EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"));
144 } else if (ArgType->isSubClassOf("LLVMEmptyStructType")) {
145 OS << "StructType::get(std::vector<const Type *>())";
147 OS << "Type::getPrimitiveType(";
148 OS << ArgType->getValueAsString("TypeVal") << ")";
152 /// RecordListComparator - Provide a determinstic comparator for lists of
155 struct RecordListComparator {
156 bool operator()(const std::vector<Record*> &LHS,
157 const std::vector<Record*> &RHS) const {
160 if (i == RHS.size()) return false; // RHS is shorter than LHS.
161 if (LHS[i] != RHS[i])
162 return LHS[i]->getName() < RHS[i]->getName();
163 } while (++i != LHS.size());
165 return i != RHS.size();
170 void IntrinsicEmitter::EmitVerifier(const std::vector<CodeGenIntrinsic> &Ints,
172 OS << "// Verifier::visitIntrinsicFunctionCall code.\n";
173 OS << "#ifdef GET_INTRINSIC_VERIFIER\n";
174 OS << " switch (ID) {\n";
175 OS << " default: assert(0 && \"Invalid intrinsic!\");\n";
177 // This checking can emit a lot of very common code. To reduce the amount of
178 // code that we emit, batch up cases that have identical types. This avoids
179 // problems where GCC can run out of memory compiling Verifier.cpp.
180 typedef std::map<std::vector<Record*>, std::vector<unsigned>,
181 RecordListComparator> MapTy;
182 MapTy UniqueArgInfos;
184 // Compute the unique argument type info.
185 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
186 UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
188 // Loop through the array, emitting one comparison for each batch.
189 for (MapTy::iterator I = UniqueArgInfos.begin(),
190 E = UniqueArgInfos.end(); I != E; ++I) {
191 for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
192 OS << " case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
193 << Ints[I->second[i]].Name << "\n";
196 const std::vector<Record*> &ArgTypes = I->first;
197 OS << " VerifyIntrinsicPrototype(IF, ";
199 for (unsigned j = 0; j != ArgTypes.size(); ++j) {
200 VarArg = EmitTypeVerify(OS, ArgTypes[j]);
202 if ((j+1) != ArgTypes.size())
203 throw "Var arg type not last argument";
208 OS << (VarArg ? "-2);\n" : "-1);\n");
215 void IntrinsicEmitter::EmitGenerator(const std::vector<CodeGenIntrinsic> &Ints,
217 OS << "// Code for generating Intrinsic function declarations.\n";
218 OS << "#ifdef GET_INTRINSIC_GENERATOR\n";
219 OS << " switch (id) {\n";
220 OS << " default: assert(0 && \"Invalid intrinsic!\");\n";
222 // Similar to GET_INTRINSIC_VERIFIER, batch up cases that have identical
224 typedef std::map<std::vector<Record*>, std::vector<unsigned>,
225 RecordListComparator> MapTy;
226 MapTy UniqueArgInfos;
228 // Compute the unique argument type info.
229 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
230 UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
232 // Loop through the array, emitting one generator for each batch.
233 for (MapTy::iterator I = UniqueArgInfos.begin(),
234 E = UniqueArgInfos.end(); I != E; ++I) {
235 for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
236 OS << " case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
237 << Ints[I->second[i]].Name << "\n";
240 const std::vector<Record*> &ArgTypes = I->first;
241 unsigned N = ArgTypes.size();
243 if (ArgTypes[N-1]->getValueAsString("TypeVal") == "...") {
244 OS << " IsVarArg = true;\n";
248 OS << " ResultTy = ";
249 EmitTypeGenerate(OS, ArgTypes[0]);
252 for (unsigned j = 1; j != N; ++j) {
253 OS << " ArgTys.push_back(";
254 EmitTypeGenerate(OS, ArgTypes[j]);
264 void IntrinsicEmitter::EmitModRefInfo(const std::vector<CodeGenIntrinsic> &Ints,
266 OS << "// BasicAliasAnalysis code.\n";
267 OS << "#ifdef GET_MODREF_BEHAVIOR\n";
268 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
269 switch (Ints[i].ModRef) {
271 case CodeGenIntrinsic::NoMem:
272 OS << " NoMemoryTable->push_back(\"" << Ints[i].Name << "\");\n";
274 case CodeGenIntrinsic::ReadArgMem:
275 case CodeGenIntrinsic::ReadMem:
276 OS << " OnlyReadsMemoryTable->push_back(\"" << Ints[i].Name << "\");\n";
283 void IntrinsicEmitter::
284 EmitNoMemoryInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS) {
285 OS << "// SelectionDAGIsel code.\n";
286 OS << "#ifdef GET_NO_MEMORY_INTRINSICS\n";
287 OS << " switch (IntrinsicID) {\n";
288 OS << " default: break;\n";
289 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
290 switch (Ints[i].ModRef) {
292 case CodeGenIntrinsic::NoMem:
293 OS << " case Intrinsic::" << Ints[i].EnumName << ":\n";
297 OS << " return true; // These intrinsics have no side effects.\n";
302 void IntrinsicEmitter::
303 EmitSideEffectInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
304 OS << "// Return true if doesn't access or only reads memory.\n";
305 OS << "#ifdef GET_SIDE_EFFECT_INFO\n";
306 OS << " switch (IntrinsicID) {\n";
307 OS << " default: break;\n";
308 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
309 switch (Ints[i].ModRef) {
311 case CodeGenIntrinsic::NoMem:
312 case CodeGenIntrinsic::ReadArgMem:
313 case CodeGenIntrinsic::ReadMem:
314 OS << " case Intrinsic::" << Ints[i].EnumName << ":\n";
318 OS << " return true; // These intrinsics have no side effects.\n";
323 void IntrinsicEmitter::
324 EmitGCCBuiltinList(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
325 OS << "// Get the GCC builtin that corresponds to an LLVM intrinsic.\n";
326 OS << "#ifdef GET_GCC_BUILTIN_NAME\n";
327 OS << " switch (F->getIntrinsicID()) {\n";
328 OS << " default: BuiltinName = \"\"; break;\n";
329 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
330 if (!Ints[i].GCCBuiltinName.empty()) {
331 OS << " case Intrinsic::" << Ints[i].EnumName << ": BuiltinName = \""
332 << Ints[i].GCCBuiltinName << "\"; break;\n";
339 void IntrinsicEmitter::
340 EmitIntrinsicToGCCBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
342 typedef std::map<std::pair<std::string, std::string>, std::string> BIMTy;
344 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
345 if (!Ints[i].GCCBuiltinName.empty()) {
346 std::pair<std::string, std::string> Key(Ints[i].GCCBuiltinName,
347 Ints[i].TargetPrefix);
348 if (!BuiltinMap.insert(std::make_pair(Key, Ints[i].EnumName)).second)
349 throw "Intrinsic '" + Ints[i].TheDef->getName() +
350 "': duplicate GCC builtin name!";
354 OS << "// Get the LLVM intrinsic that corresponds to a GCC builtin.\n";
355 OS << "// This is used by the C front-end. The GCC builtin name is passed\n";
356 OS << "// in as BuiltinName, and a target prefix (e.g. 'ppc') is passed\n";
357 OS << "// in as TargetPrefix. The result is assigned to 'IntrinsicID'.\n";
358 OS << "#ifdef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN\n";
360 // Note: this could emit significantly better code if we cared.
361 for (BIMTy::iterator I = BuiltinMap.begin(), E = BuiltinMap.end();I != E;++I){
363 if (!I->first.second.empty()) {
364 // Emit this as a strcmp, so it can be constant folded by the FE.
365 OS << "!strcmp(TargetPrefix, \"" << I->first.second << "\") &&\n"
368 OS << "!strcmp(BuiltinName, \"" << I->first.first << "\"))\n";
369 OS << " IntrinsicID = Intrinsic::" << I->second << ";\n";
372 OS << " IntrinsicID = Intrinsic::not_intrinsic;\n";