X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=utils%2FTableGen%2FLLVMCConfigurationEmitter.cpp;h=43729033c39c4e0ca81189f94421050eb1e7a53e;hb=8ad4c00c00233acb8a3395098e2b575cc34de46b;hp=8b79105a79983f9285087d82d07a1b914a2a3458;hpb=2b7bcb4e8d8f3ab4bd3a8e39183d41314c5a2d16;p=oota-llvm.git diff --git a/utils/TableGen/LLVMCConfigurationEmitter.cpp b/utils/TableGen/LLVMCConfigurationEmitter.cpp index 8b79105a799..43729033c39 100644 --- a/utils/TableGen/LLVMCConfigurationEmitter.cpp +++ b/utils/TableGen/LLVMCConfigurationEmitter.cpp @@ -20,13 +20,12 @@ #include "llvm/ADT/StringMap.h" #include "llvm/ADT/StringSet.h" #include "llvm/Support/Streams.h" - #include #include #include #include #include - +#include using namespace llvm; namespace { @@ -156,11 +155,18 @@ struct OptionDescription { std::string EscapeVariableName(const std::string& Var) const { std::string ret; for (unsigned i = 0; i != Var.size(); ++i) { - if (Var[i] == ',') { + char cur_char = Var[i]; + if (cur_char == ',') { + ret += "_comma_"; + } + else if (cur_char == '+') { + ret += "_plus_"; + } + else if (cur_char == ',') { ret += "_comma_"; } else { - ret.push_back(Var[i]); + ret.push_back(cur_char); } } return ret; @@ -243,6 +249,7 @@ struct GlobalOptionDescriptions { /// HasSink - Should the emitter generate a "cl::sink" option? bool HasSink; + /// FindOption - exception-throwing wrapper for find(). const GlobalOptionDescription& FindOption(const std::string& OptName) const { const_iterator I = Descriptions.find(OptName); if (I != Descriptions.end()) @@ -251,7 +258,8 @@ struct GlobalOptionDescriptions { throw OptName + ": no such option!"; } - // Insert new GlobalOptionDescription into GlobalOptionDescriptions list + /// insertDescription - Insert new GlobalOptionDescription into + /// GlobalOptionDescriptions list void insertDescription (const GlobalOptionDescription& o) { container_type::iterator I = Descriptions.find(o.Name); @@ -278,7 +286,7 @@ namespace ToolOptionDescriptionFlags { Forward = 0x2, UnpackValues = 0x4}; } namespace OptionPropertyType { - enum OptionPropertyType { AppendCmd, OutputSuffix }; + enum OptionPropertyType { AppendCmd, ForwardAs, OutputSuffix }; } typedef std::pair @@ -350,8 +358,8 @@ struct ToolProperties : public RefCountedBase { // Default ctor here is needed because StringMap can only store // DefaultConstructible objects - ToolProperties() : Flags(0) {} - ToolProperties (const std::string& n) : Name(n), Flags(0) {} + ToolProperties() : CmdLine(0), Flags(0) {} + ToolProperties (const std::string& n) : Name(n), CmdLine(0), Flags(0) {} }; @@ -398,6 +406,8 @@ public: &CollectOptionProperties::onAppendCmd; optionPropertyHandlers_["forward"] = &CollectOptionProperties::onForward; + optionPropertyHandlers_["forward_as"] = + &CollectOptionProperties::onForwardAs; optionPropertyHandlers_["help"] = &CollectOptionProperties::onHelp; optionPropertyHandlers_["output_suffix"] = @@ -465,6 +475,15 @@ private: toolProps_->OptDescs[optDesc_.Name].setForward(); } + void onForwardAs (const DagInit* d) { + checkNumberOfArguments(d, 1); + checkToolProps(d); + const std::string& cmd = InitPtrToString(d->getArg(0)); + + toolProps_->OptDescs[optDesc_.Name]. + AddProperty(OptionPropertyType::ForwardAs, cmd); + } + void onHelp (const DagInit* d) { checkNumberOfArguments(d, 1); const std::string& help_message = InitPtrToString(d->getArg(0)); @@ -750,7 +769,6 @@ void CollectPropertiesFromOptionList (RecordVector::const_iterator B, GlobalOptionDescriptions& OptDescs) { // Iterate over a properties list of every Tool definition - for (;B!=E;++B) { RecordVector::value_type T = *B; // Throws an exception if the value does not exist. @@ -760,6 +778,36 @@ void CollectPropertiesFromOptionList (RecordVector::const_iterator B, } } +/// CheckForSuperfluousOptions - Check that there are no side +/// effect-free options (specified only in the OptionList). Otherwise, +/// output a warning. +void CheckForSuperfluousOptions (const ToolPropertiesList& TPList, + const GlobalOptionDescriptions& OptDescs) { + llvm::StringSet<> nonSuperfluousOptions; + + // Add all options mentioned in the TPList to the set of + // non-superfluous options. + for (ToolPropertiesList::const_iterator B = TPList.begin(), + E = TPList.end(); B != E; ++B) { + const ToolProperties& TP = *(*B); + for (ToolOptionDescriptions::const_iterator B = TP.OptDescs.begin(), + E = TP.OptDescs.end(); B != E; ++B) { + nonSuperfluousOptions.insert(B->first()); + } + } + + // Check that all options in OptDescs belong to the set of + // non-superfluous options. + for (GlobalOptionDescriptions::const_iterator B = OptDescs.begin(), + E = OptDescs.end(); B != E; ++B) { + const GlobalOptionDescription& Val = B->second; + if (!nonSuperfluousOptions.count(Val.Name) + && Val.Type != OptionType::Alias) + cerr << "Warning: option '-" << Val.Name << "' has no effect! " + "Probable cause: this option is specified only in the OptionList.\n"; + } +} + /// EmitCaseTest1Arg - Helper function used by /// EmitCaseConstructHandler. bool EmitCaseTest1Arg(const std::string& TestName, @@ -778,8 +826,11 @@ bool EmitCaseTest1Arg(const std::string& TestName, O << "InLangs.count(\"" << OptName << "\") != 0"; return true; } else if (TestName == "in_language") { - // Works only for cmd_line! - O << "GetLanguage(inFile) == \"" << OptName << '\"'; + // This works only for single-argument Tool::GenerateAction. Join + // tools can process several files in different languages simultaneously. + + // TODO: make this work with Edge::Weight (if possible). + O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"'; return true; } else if (TestName == "not_empty") { if (OptName == "o") { @@ -878,7 +929,7 @@ void EmitCaseTest(const DagInit& d, const char* IndentLevel, // void F(Init* Statement, const char* IndentLevel, std::ostream& O). template void EmitCaseConstructHandler(const DagInit* d, const char* IndentLevel, - const F& Callback, bool EmitElseIf, + F Callback, bool EmitElseIf, const GlobalOptionDescriptions& OptDescs, std::ostream& O) { assert(d->getOperator()->getAsString() == "case"); @@ -926,26 +977,31 @@ void EmitCaseConstructHandler(const DagInit* d, const char* IndentLevel, /// EmitForwardOptionPropertyHandlingCode - Helper function used to /// implement EmitOptionPropertyHandlingCode(). Emits code for -/// handling the (forward) option property. +/// handling the (forward) and (forward_as) option properties. void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D, + const std::string& NewName, std::ostream& O) { + const std::string& Name = NewName.empty() + ? ("-" + D.Name) + : NewName; + switch (D.Type) { case OptionType::Switch: - O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n"; + O << Indent3 << "vec.push_back(\"" << Name << "\");\n"; break; case OptionType::Parameter: - O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n"; + O << Indent3 << "vec.push_back(\"" << Name << "\");\n"; O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n"; break; case OptionType::Prefix: - O << Indent3 << "vec.push_back(\"-" << D.Name << "\" + " + O << Indent3 << "vec.push_back(\"" << Name << "\" + " << D.GenVariableName() << ");\n"; break; case OptionType::PrefixList: O << Indent3 << "for (" << D.GenTypeDeclaration() << "::iterator B = " << D.GenVariableName() << ".begin(),\n" << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n" - << Indent4 << "vec.push_back(\"-" << D.Name << "\" + " + << Indent4 << "vec.push_back(\"" << Name << "\" + " << "*B);\n"; break; case OptionType::ParameterList: @@ -953,7 +1009,7 @@ void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D, << "::iterator B = " << D.GenVariableName() << ".begin(),\n" << Indent3 << "E = " << D.GenVariableName() << ".end() ; B != E; ++B) {\n" - << Indent4 << "vec.push_back(\"-" << D.Name << "\");\n" + << Indent4 << "vec.push_back(\"" << Name << "\");\n" << Indent4 << "vec.push_back(*B);\n" << Indent3 << "}\n"; break; @@ -971,7 +1027,8 @@ bool ToolOptionHasInterestingProperties(const ToolOptionDescription& D) { for (OptionPropertyList::const_iterator B = D.Props.begin(), E = D.Props.end(); B != E; ++B) { const OptionProperty& OptProp = *B; - if (OptProp.first == OptionPropertyType::AppendCmd) + if (OptProp.first == OptionPropertyType::AppendCmd + || OptProp.first == OptionPropertyType::ForwardAs) ret = true; } if (D.isForward() || D.isUnpackValues()) @@ -1006,6 +1063,10 @@ void EmitOptionPropertyHandlingCode (const ToolOptionDescription& D, case OptionPropertyType::AppendCmd: O << Indent3 << "vec.push_back(\"" << val.second << "\");\n"; break; + // (forward_as) property + case OptionPropertyType::ForwardAs: + EmitForwardOptionPropertyHandlingCode(D, val.second, O); + break; // Other properties with argument default: break; @@ -1016,7 +1077,7 @@ void EmitOptionPropertyHandlingCode (const ToolOptionDescription& D, // (forward) property if (D.isForward()) - EmitForwardOptionPropertyHandlingCode(D, O); + EmitForwardOptionPropertyHandlingCode(D, "", O); // (unpack_values) property if (D.isUnpackValues()) { @@ -1147,7 +1208,8 @@ void EmitGenerateActionMethod (const ToolProperties& P, O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n"; O << Indent2 << "const sys::Path& outFile,\n" - << Indent2 << "const InputLanguagesSet& InLangs) const\n" + << Indent2 << "const InputLanguagesSet& InLangs,\n" + << Indent2 << "const LanguageMap& LangMap) const\n" << Indent1 << "{\n" << Indent2 << "const char* cmd;\n" << Indent2 << "std::vector vec;\n"; @@ -1187,7 +1249,8 @@ void EmitGenerateActionMethods (const ToolProperties& P, if (!P.isJoin()) O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n" << Indent2 << "const llvm::sys::Path& outFile,\n" - << Indent2 << "const InputLanguagesSet& InLangs) const\n" + << Indent2 << "const InputLanguagesSet& InLangs,\n" + << Indent2 << "const LanguageMap& LangMap) const\n" << Indent1 << "{\n" << Indent2 << "throw std::runtime_error(\"" << P.Name << " is not a Join tool!\");\n" @@ -1393,7 +1456,8 @@ void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O) throw std::string("Error in the language map definition!"); // Generate code - O << "void llvmc::PopulateLanguageMap() {\n"; + O << "namespace {\n\n"; + O << "void PopulateLanguageMapLocal(LanguageMap& langMap) {\n"; for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) { Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i); @@ -1402,12 +1466,12 @@ void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O) const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes"); for (unsigned i = 0; i < Suffixes->size(); ++i) - O << Indent1 << "GlobalLanguageMap[\"" + O << Indent1 << "langMap[\"" << InitPtrToString(Suffixes->getElement(i)) << "\"] = \"" << Lang << "\";\n"; } - O << "}\n\n"; + O << "}\n\n}\n\n"; } /// FillInToolToLang - Fills in two tables that map tool names to @@ -1431,8 +1495,8 @@ void FillInToolToLang (const ToolPropertiesList& TPList, // and multiple default edges in the graph (better error // reporting). Unfortunately, it is awkward to do right now because // our intermediate representation is not sufficiently -// sofisticated. Algorithms like these should be run on a real graph -// instead of AST. +// sophisticated. Algorithms like these require a real graph instead of +// an AST. void TypecheckGraph (Record* CompilationGraph, const ToolPropertiesList& TPList) { StringMap > ToolToInLang; @@ -1530,8 +1594,8 @@ void EmitPopulateCompilationGraph (Record* CompilationGraph, ListInit* edges = CompilationGraph->getValueAsListInit("edges"); // Generate code - O << "void llvmc::PopulateCompilationGraph(CompilationGraph& G) {\n" - << Indent1 << "PopulateLanguageMap();\n\n"; + O << "namespace {\n\n"; + O << "void PopulateCompilationGraphLocal(CompilationGraph& G) {\n"; // Insert vertices @@ -1565,7 +1629,7 @@ void EmitPopulateCompilationGraph (Record* CompilationGraph, O << ");\n"; } - O << "}\n\n"; + O << "}\n\n}\n\n"; } /// ExtractHookNames - Extract the hook names from all instances of @@ -1642,6 +1706,38 @@ void EmitHookDeclarations(const ToolPropertiesList& ToolProps, O << "}\n\n"; } +/// EmitRegisterPlugin - Emit code to register this plugin. +void EmitRegisterPlugin(std::ostream& O) { + O << "namespace {\n\n" + << "struct Plugin : public llvmc::BasePlugin {\n" + << Indent1 << "void PopulateLanguageMap(LanguageMap& langMap) const\n" + << Indent1 << "{ PopulateLanguageMapLocal(langMap); }\n\n" + << Indent1 + << "void PopulateCompilationGraph(CompilationGraph& graph) const\n" + << Indent1 << "{ PopulateCompilationGraphLocal(graph); }\n" + << "};\n\n" + + << "static llvmc::RegisterPlugin RP;\n\n}\n\n"; +} + +/// EmitInclude - Emit necessary #include directives. +void EmitIncludes(std::ostream& O) { + O << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n" + << "#include \"llvm/CompilerDriver/Plugin.h\"\n" + << "#include \"llvm/CompilerDriver/Tool.h\"\n\n" + + << "#include \"llvm/ADT/StringExtras.h\"\n" + << "#include \"llvm/Support/CommandLine.h\"\n\n" + + << "#include \n" + << "#include \n\n" + + << "using namespace llvm;\n" + << "using namespace llvmc;\n\n" + + << "extern cl::opt OutputFilename;\n\n"; +} + // End of anonymous namespace } @@ -1651,6 +1747,7 @@ void LLVMCConfigurationEmitter::run (std::ostream &O) { // Emit file header. EmitSourceFileHeader("LLVMC Configuration Library", O); + EmitIncludes(O); // Get a list of all defined Tools. RecordVector Tools = Records.getAllDerivedDefinitions("Tool"); @@ -1666,6 +1763,10 @@ void LLVMCConfigurationEmitter::run (std::ostream &O) { CollectPropertiesFromOptionList(OptionLists.begin(), OptionLists.end(), opt_descs); + // Check that there are no options without side effects (specified + // only in the OptionList). + CheckForSuperfluousOptions(tool_props, opt_descs); + // Emit global option registration code. EmitOptionDescriptions(opt_descs, O); @@ -1694,6 +1795,9 @@ void LLVMCConfigurationEmitter::run (std::ostream &O) { // Emit PopulateCompilationGraph() function. EmitPopulateCompilationGraph(CompilationGraphRecord, O); + // Emit code for plugin registration. + EmitRegisterPlugin(O); + // EOF } catch (std::exception& Error) { throw Error.what() + std::string(" - usually this means a syntax error.");