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, unsigned> IntMapping;
78 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
79 IntMapping[Ints[i].Name] = i;
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, unsigned>::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 // For overloaded intrinsics, only the prefix needs to match
96 if (Ints[I->second].isOverloaded)
97 OS << " if (Len >= " << I->first.size()
98 << " && !memcmp(Name, \"" << I->first << "\", " << I->first.size()
99 << ")) return Intrinsic::" << Ints[I->second].EnumName << ";\n";
101 OS << " if (Len == " << I->first.size()
102 << " && !memcmp(Name, \"" << I->first << "\", Len)) return Intrinsic::"
103 << Ints[I->second].EnumName << ";\n";
106 OS << " // The 'llvm.' namespace is reserved!\n";
107 OS << " assert(0 && \"Unknown LLVM intrinsic function!\");\n";
111 void IntrinsicEmitter::
112 EmitIntrinsicToNameTable(const std::vector<CodeGenIntrinsic> &Ints,
114 OS << "// Intrinsic ID to name table\n";
115 OS << "#ifdef GET_INTRINSIC_NAME_TABLE\n";
116 OS << " // Note that entry #0 is the invalid intrinsic!\n";
117 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
118 OS << " \"" << Ints[i].Name << "\",\n";
122 static bool EmitTypeVerify(std::ostream &OS, Record *ArgType) {
123 if (ArgType->getValueAsString("TypeVal") == "...") return true;
125 OS << "(int)" << ArgType->getValueAsString("TypeVal") << ", ";
126 // If this is an integer type, check the width is correct.
127 if (ArgType->isSubClassOf("LLVMIntegerType"))
128 OS << ArgType->getValueAsInt("Width") << ", ";
130 // If this is a vector type, check that the subtype and size are correct.
131 else if (ArgType->isSubClassOf("LLVMVectorType")) {
132 EmitTypeVerify(OS, ArgType->getValueAsDef("ElTy"));
133 OS << ArgType->getValueAsInt("NumElts") << ", ";
139 static void EmitTypeGenerate(std::ostream &OS, Record *ArgType, unsigned ArgNo){
140 if (ArgType->isSubClassOf("LLVMIntegerType")) {
141 unsigned BitWidth = ArgType->getValueAsInt("Width");
143 OS << "Tys[" << ArgNo << "]";
145 OS << "IntegerType::get(" << BitWidth << ")";
146 } else if (ArgType->isSubClassOf("LLVMVectorType")) {
147 OS << "VectorType::get(";
148 EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"), ArgNo);
149 OS << ", " << ArgType->getValueAsInt("NumElts") << ")";
150 } else if (ArgType->isSubClassOf("LLVMPointerType")) {
151 OS << "PointerType::get(";
152 EmitTypeGenerate(OS, ArgType->getValueAsDef("ElTy"), ArgNo);
154 } else if (ArgType->isSubClassOf("LLVMEmptyStructType")) {
155 OS << "StructType::get(std::vector<const Type *>())";
157 OS << "Type::getPrimitiveType(";
158 OS << ArgType->getValueAsString("TypeVal") << ")";
162 /// RecordListComparator - Provide a determinstic comparator for lists of
165 struct RecordListComparator {
166 bool operator()(const std::vector<Record*> &LHS,
167 const std::vector<Record*> &RHS) const {
170 if (i == RHS.size()) return false; // RHS is shorter than LHS.
171 if (LHS[i] != RHS[i])
172 return LHS[i]->getName() < RHS[i]->getName();
173 } while (++i != LHS.size());
175 return i != RHS.size();
180 void IntrinsicEmitter::EmitVerifier(const std::vector<CodeGenIntrinsic> &Ints,
182 OS << "// Verifier::visitIntrinsicFunctionCall code.\n";
183 OS << "#ifdef GET_INTRINSIC_VERIFIER\n";
184 OS << " switch (ID) {\n";
185 OS << " default: assert(0 && \"Invalid intrinsic!\");\n";
187 // This checking can emit a lot of very common code. To reduce the amount of
188 // code that we emit, batch up cases that have identical types. This avoids
189 // problems where GCC can run out of memory compiling Verifier.cpp.
190 typedef std::map<std::vector<Record*>, std::vector<unsigned>,
191 RecordListComparator> MapTy;
192 MapTy UniqueArgInfos;
194 // Compute the unique argument type info.
195 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
196 UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
198 // Loop through the array, emitting one comparison for each batch.
199 for (MapTy::iterator I = UniqueArgInfos.begin(),
200 E = UniqueArgInfos.end(); I != E; ++I) {
201 for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
202 OS << " case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
203 << Ints[I->second[i]].Name << "\n";
206 const std::vector<Record*> &ArgTypes = I->first;
207 OS << " VerifyIntrinsicPrototype(ID, IF, ";
209 for (unsigned j = 0; j != ArgTypes.size(); ++j) {
210 VarArg = EmitTypeVerify(OS, ArgTypes[j]);
212 if ((j+1) != ArgTypes.size())
213 throw "Var arg type not last argument";
218 OS << (VarArg ? "-2);\n" : "-1);\n");
225 void IntrinsicEmitter::EmitGenerator(const std::vector<CodeGenIntrinsic> &Ints,
227 OS << "// Code for generating Intrinsic function declarations.\n";
228 OS << "#ifdef GET_INTRINSIC_GENERATOR\n";
229 OS << " switch (id) {\n";
230 OS << " default: assert(0 && \"Invalid intrinsic!\");\n";
232 // Similar to GET_INTRINSIC_VERIFIER, batch up cases that have identical
234 typedef std::map<std::vector<Record*>, std::vector<unsigned>,
235 RecordListComparator> MapTy;
236 MapTy UniqueArgInfos;
238 // Compute the unique argument type info.
239 for (unsigned i = 0, e = Ints.size(); i != e; ++i)
240 UniqueArgInfos[Ints[i].ArgTypeDefs].push_back(i);
242 // Loop through the array, emitting one generator for each batch.
243 for (MapTy::iterator I = UniqueArgInfos.begin(),
244 E = UniqueArgInfos.end(); I != E; ++I) {
245 for (unsigned i = 0, e = I->second.size(); i != e; ++i) {
246 OS << " case Intrinsic::" << Ints[I->second[i]].EnumName << ":\t\t// "
247 << Ints[I->second[i]].Name << "\n";
250 const std::vector<Record*> &ArgTypes = I->first;
251 unsigned N = ArgTypes.size();
253 if (ArgTypes[N-1]->getValueAsString("TypeVal") == "...") {
254 OS << " IsVarArg = true;\n";
258 OS << " ResultTy = ";
259 EmitTypeGenerate(OS, ArgTypes[0], 0);
262 for (unsigned j = 1; j != N; ++j) {
263 OS << " ArgTys.push_back(";
264 EmitTypeGenerate(OS, ArgTypes[j], j);
274 void IntrinsicEmitter::EmitModRefInfo(const std::vector<CodeGenIntrinsic> &Ints,
276 OS << "// BasicAliasAnalysis code.\n";
277 OS << "#ifdef GET_MODREF_BEHAVIOR\n";
278 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
279 switch (Ints[i].ModRef) {
281 case CodeGenIntrinsic::NoMem:
282 OS << " NoMemoryTable->push_back(\"" << Ints[i].Name << "\");\n";
284 case CodeGenIntrinsic::ReadArgMem:
285 case CodeGenIntrinsic::ReadMem:
286 OS << " OnlyReadsMemoryTable->push_back(\"" << Ints[i].Name << "\");\n";
293 void IntrinsicEmitter::
294 EmitNoMemoryInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS) {
295 OS << "// SelectionDAGIsel code.\n";
296 OS << "#ifdef GET_NO_MEMORY_INTRINSICS\n";
297 OS << " switch (IntrinsicID) {\n";
298 OS << " default: break;\n";
299 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
300 switch (Ints[i].ModRef) {
302 case CodeGenIntrinsic::NoMem:
303 OS << " case Intrinsic::" << Ints[i].EnumName << ":\n";
307 OS << " return true; // These intrinsics have no side effects.\n";
312 void IntrinsicEmitter::
313 EmitSideEffectInfo(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
314 OS << "// Return true if doesn't access or only reads memory.\n";
315 OS << "#ifdef GET_SIDE_EFFECT_INFO\n";
316 OS << " switch (IntrinsicID) {\n";
317 OS << " default: break;\n";
318 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
319 switch (Ints[i].ModRef) {
321 case CodeGenIntrinsic::NoMem:
322 case CodeGenIntrinsic::ReadArgMem:
323 case CodeGenIntrinsic::ReadMem:
324 OS << " case Intrinsic::" << Ints[i].EnumName << ":\n";
328 OS << " return true; // These intrinsics have no side effects.\n";
333 void IntrinsicEmitter::
334 EmitGCCBuiltinList(const std::vector<CodeGenIntrinsic> &Ints, std::ostream &OS){
335 OS << "// Get the GCC builtin that corresponds to an LLVM intrinsic.\n";
336 OS << "#ifdef GET_GCC_BUILTIN_NAME\n";
337 OS << " switch (F->getIntrinsicID()) {\n";
338 OS << " default: BuiltinName = \"\"; break;\n";
339 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
340 if (!Ints[i].GCCBuiltinName.empty()) {
341 OS << " case Intrinsic::" << Ints[i].EnumName << ": BuiltinName = \""
342 << Ints[i].GCCBuiltinName << "\"; break;\n";
349 void IntrinsicEmitter::
350 EmitIntrinsicToGCCBuiltinMap(const std::vector<CodeGenIntrinsic> &Ints,
352 typedef std::map<std::pair<std::string, std::string>, std::string> BIMTy;
354 for (unsigned i = 0, e = Ints.size(); i != e; ++i) {
355 if (!Ints[i].GCCBuiltinName.empty()) {
356 std::pair<std::string, std::string> Key(Ints[i].GCCBuiltinName,
357 Ints[i].TargetPrefix);
358 if (!BuiltinMap.insert(std::make_pair(Key, Ints[i].EnumName)).second)
359 throw "Intrinsic '" + Ints[i].TheDef->getName() +
360 "': duplicate GCC builtin name!";
364 OS << "// Get the LLVM intrinsic that corresponds to a GCC builtin.\n";
365 OS << "// This is used by the C front-end. The GCC builtin name is passed\n";
366 OS << "// in as BuiltinName, and a target prefix (e.g. 'ppc') is passed\n";
367 OS << "// in as TargetPrefix. The result is assigned to 'IntrinsicID'.\n";
368 OS << "#ifdef GET_LLVM_INTRINSIC_FOR_GCC_BUILTIN\n";
370 // Note: this could emit significantly better code if we cared.
371 for (BIMTy::iterator I = BuiltinMap.begin(), E = BuiltinMap.end();I != E;++I){
373 if (!I->first.second.empty()) {
374 // Emit this as a strcmp, so it can be constant folded by the FE.
375 OS << "!strcmp(TargetPrefix, \"" << I->first.second << "\") &&\n"
378 OS << "!strcmp(BuiltinName, \"" << I->first.first << "\"))\n";
379 OS << " IntrinsicID = Intrinsic::" << I->second << ";\n";
382 OS << " IntrinsicID = Intrinsic::not_intrinsic;\n";