1 //===- LLVMCConfigurationEmitter.cpp - Generate LLVMC config --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open
6 // Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend is responsible for emitting LLVMC configuration code.
12 //===----------------------------------------------------------------------===//
14 #include "LLVMCConfigurationEmitter.h"
17 #include "llvm/ADT/IntrusiveRefCntPtr.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/Support/Streams.h"
32 //===----------------------------------------------------------------------===//
35 typedef std::vector<Record*> RecordVector;
36 typedef std::vector<std::string> StrVector;
38 //===----------------------------------------------------------------------===//
41 // Indentation strings
42 const char * Indent1 = " ";
43 const char * Indent2 = " ";
44 const char * Indent3 = " ";
45 const char * Indent4 = " ";
47 // Default help string
48 const char * DefaultHelpString = "NO HELP MESSAGE PROVIDED";
50 // Name for the "sink" option
51 const char * SinkOptionName = "AutoGeneratedSinkOption";
53 //===----------------------------------------------------------------------===//
56 std::string InitPtrToString(Init* ptr) {
57 StringInit& val = dynamic_cast<StringInit&>(*ptr);
58 return val.getValue();
61 int InitPtrToInt(Init* ptr) {
62 IntInit& val = dynamic_cast<IntInit&>(*ptr);
63 return val.getValue();
66 const DagInit& InitPtrToDagInitRef(Init* ptr) {
67 DagInit& val = dynamic_cast<DagInit&>(*ptr);
72 // Ensure that the number of args in d is <= min_arguments,
73 // throw exception otherwise
74 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
75 if (d->getNumArgs() < min_arguments)
76 throw "Property " + d->getOperator()->getAsString()
77 + " has too few arguments!";
81 //===----------------------------------------------------------------------===//
82 /// Back-end specific code
84 // A command-line option can have one of the following types:
86 // Switch - a simple switch w/o arguments, e.g. -O2
88 // Parameter - an option that takes one(and only one) argument, e.g. -o file,
91 // ParameterList - same as Parameter, but more than one occurence
92 // of the option is allowed, e.g. -lm -lpthread
94 // Prefix - argument is everything after the prefix,
95 // e.g. -Wa,-foo,-bar, -DNAME=VALUE
97 // PrefixList - same as Prefix, but more than one option occurence is
100 namespace OptionType {
101 enum OptionType { Switch, Parameter, ParameterList, Prefix, PrefixList};
104 bool IsListOptionType (OptionType::OptionType t) {
105 return (t == OptionType::ParameterList || t == OptionType::PrefixList);
108 // Code duplication here is necessary because one option can affect
109 // several tools and those tools may have different actions associated
110 // with this option. GlobalOptionDescriptions are used to generate
111 // the option registration code, while ToolOptionDescriptions are used
112 // to generate tool-specific code.
114 // Base class for option descriptions
116 struct OptionDescription {
117 OptionType::OptionType Type;
120 OptionDescription(OptionType::OptionType t = OptionType::Switch,
121 const std::string& n = "")
125 const char* GenTypeDeclaration() const {
127 case OptionType::PrefixList:
128 case OptionType::ParameterList:
129 return "cl::list<std::string>";
130 case OptionType::Switch:
131 return "cl::opt<bool>";
132 case OptionType::Parameter:
133 case OptionType::Prefix:
135 return "cl::opt<std::string>";
139 std::string GenVariableName() const {
141 case OptionType::Switch:
142 return "AutoGeneratedSwitch" + Name;
143 case OptionType::Prefix:
144 return "AutoGeneratedPrefix" + Name;
145 case OptionType::PrefixList:
146 return "AutoGeneratedPrefixList" + Name;
147 case OptionType::Parameter:
148 return "AutoGeneratedParameter" + Name;
149 case OptionType::ParameterList:
151 return "AutoGeneratedParameterList" + Name;
157 // Global option description
159 namespace GlobalOptionDescriptionFlags {
160 enum GlobalOptionDescriptionFlags { Required = 0x1 };
163 struct GlobalOptionDescription : public OptionDescription {
167 // We need t provide a default constructor since
168 // StringMap can only store DefaultConstructible objects
169 GlobalOptionDescription() : OptionDescription(), Flags(0)
172 GlobalOptionDescription (OptionType::OptionType t, const std::string& n)
173 : OptionDescription(t, n), Help(DefaultHelpString), Flags(0)
176 bool isRequired() const {
177 return Flags & GlobalOptionDescriptionFlags::Required;
180 Flags |= GlobalOptionDescriptionFlags::Required;
183 // Merge two option descriptions
184 void Merge (const GlobalOptionDescription& other)
186 if (other.Type != Type)
187 throw "Conflicting definitions for the option " + Name + "!";
189 if (Help == DefaultHelpString)
191 else if (other.Help != DefaultHelpString) {
192 llvm::cerr << "Warning: more than one help string defined for option "
196 Flags |= other.Flags;
200 // A GlobalOptionDescription array
201 // + some flags affecting generation of option declarations
202 struct GlobalOptionDescriptions {
203 typedef StringMap<GlobalOptionDescription> container_type;
204 typedef container_type::const_iterator const_iterator;
206 // A list of GlobalOptionDescriptions
207 container_type Descriptions;
208 // Should the emitter generate a "cl::sink" option?
211 const GlobalOptionDescription& FindOption(const std::string& OptName) const {
212 const_iterator I = Descriptions.find(OptName);
213 if (I != Descriptions.end())
216 throw OptName + ": no such option!";
219 // Support for STL-style iteration
220 const_iterator begin() const { return Descriptions.begin(); }
221 const_iterator end() const { return Descriptions.end(); }
225 // Tool-local option description
227 // Properties without arguments are implemented as flags
228 namespace ToolOptionDescriptionFlags {
229 enum ToolOptionDescriptionFlags { StopCompilation = 0x1,
230 Forward = 0x2, UnpackValues = 0x4};
232 namespace OptionPropertyType {
233 enum OptionPropertyType { AppendCmd };
236 typedef std::pair<OptionPropertyType::OptionPropertyType, std::string>
238 typedef SmallVector<OptionProperty, 4> OptionPropertyList;
240 struct ToolOptionDescription : public OptionDescription {
242 OptionPropertyList Props;
244 // StringMap can only store DefaultConstructible objects
245 ToolOptionDescription() : OptionDescription(), Flags(0) {}
247 ToolOptionDescription (OptionType::OptionType t, const std::string& n)
248 : OptionDescription(t, n)
251 // Various boolean properties
252 bool isStopCompilation() const {
253 return Flags & ToolOptionDescriptionFlags::StopCompilation;
255 void setStopCompilation() {
256 Flags |= ToolOptionDescriptionFlags::StopCompilation;
259 bool isForward() const {
260 return Flags & ToolOptionDescriptionFlags::Forward;
263 Flags |= ToolOptionDescriptionFlags::Forward;
266 bool isUnpackValues() const {
267 return Flags & ToolOptionDescriptionFlags::UnpackValues;
269 void setUnpackValues() {
270 Flags |= ToolOptionDescriptionFlags::UnpackValues;
273 void AddProperty (OptionPropertyType::OptionPropertyType t,
274 const std::string& val)
276 Props.push_back(std::make_pair(t, val));
280 typedef StringMap<ToolOptionDescription> ToolOptionDescriptions;
282 // Tool information record
284 namespace ToolFlags {
285 enum ToolFlags { Join = 0x1, Sink = 0x2 };
288 struct ToolProperties : public RefCountedBase<ToolProperties> {
291 std::string InLanguage;
292 std::string OutLanguage;
293 std::string OutputSuffix;
295 ToolOptionDescriptions OptDescs;
297 // Various boolean properties
298 void setSink() { Flags |= ToolFlags::Sink; }
299 bool isSink() const { return Flags & ToolFlags::Sink; }
300 void setJoin() { Flags |= ToolFlags::Join; }
301 bool isJoin() const { return Flags & ToolFlags::Join; }
303 // Default ctor here is needed because StringMap can only store
304 // DefaultConstructible objects
305 ToolProperties() : Flags(0) {}
306 ToolProperties (const std::string& n) : Name(n), Flags(0) {}
310 // A list of Tool information records
311 // IntrusiveRefCntPtrs are used because StringMap has no copy constructor
312 // (and we want to avoid copying ToolProperties anyway)
313 typedef std::vector<IntrusiveRefCntPtr<ToolProperties> > ToolPropertiesList;
316 // Function object for iterating over a list of tool property records
317 class CollectProperties {
320 /// Implementation details
322 // "Property handler" - a function that extracts information
323 // about a given tool property from its DAG representation
324 typedef void (CollectProperties::*PropertyHandler)(const DagInit*);
326 // Map from property names -> property handlers
327 typedef StringMap<PropertyHandler> PropertyHandlerMap;
329 // "Option property handler" - a function that extracts information
330 // about a given option property from its DAG representation
331 typedef void (CollectProperties::* OptionPropertyHandler)
332 (const DagInit*, GlobalOptionDescription &);
334 // Map from option property names -> option property handlers
335 typedef StringMap<OptionPropertyHandler> OptionPropertyHandlerMap;
337 // Static maps from strings to CollectProperties methods("handlers")
338 static PropertyHandlerMap propertyHandlers_;
339 static OptionPropertyHandlerMap optionPropertyHandlers_;
340 static bool staticMembersInitialized_;
343 /// This is where the information is stored
345 // Current Tool properties
346 ToolProperties& toolProps_;
347 // OptionDescriptions table(used to register options globally)
348 GlobalOptionDescriptions& optDescs_;
352 explicit CollectProperties (ToolProperties& p, GlobalOptionDescriptions& d)
353 : toolProps_(p), optDescs_(d)
355 if (!staticMembersInitialized_) {
356 // Init tool property handlers
357 propertyHandlers_["cmd_line"] = &CollectProperties::onCmdLine;
358 propertyHandlers_["in_language"] = &CollectProperties::onInLanguage;
359 propertyHandlers_["join"] = &CollectProperties::onJoin;
360 propertyHandlers_["out_language"] = &CollectProperties::onOutLanguage;
361 propertyHandlers_["output_suffix"] = &CollectProperties::onOutputSuffix;
362 propertyHandlers_["parameter_option"]
363 = &CollectProperties::onParameter;
364 propertyHandlers_["parameter_list_option"] =
365 &CollectProperties::onParameterList;
366 propertyHandlers_["prefix_option"] = &CollectProperties::onPrefix;
367 propertyHandlers_["prefix_list_option"] =
368 &CollectProperties::onPrefixList;
369 propertyHandlers_["sink"] = &CollectProperties::onSink;
370 propertyHandlers_["switch_option"] = &CollectProperties::onSwitch;
372 // Init option property handlers
373 optionPropertyHandlers_["append_cmd"] = &CollectProperties::onAppendCmd;
374 optionPropertyHandlers_["forward"] = &CollectProperties::onForward;
375 optionPropertyHandlers_["help"] = &CollectProperties::onHelp;
376 optionPropertyHandlers_["required"] = &CollectProperties::onRequired;
377 optionPropertyHandlers_["stop_compilation"] =
378 &CollectProperties::onStopCompilation;
379 optionPropertyHandlers_["unpack_values"] =
380 &CollectProperties::onUnpackValues;
382 staticMembersInitialized_ = true;
386 // Gets called for every tool property;
387 // Just forwards to the corresponding property handler.
388 void operator() (Init* i) {
389 const DagInit& d = InitPtrToDagInitRef(i);
390 const std::string& property_name = d.getOperator()->getAsString();
391 PropertyHandlerMap::iterator method
392 = propertyHandlers_.find(property_name);
394 if (method != propertyHandlers_.end()) {
395 PropertyHandler h = method->second;
399 throw "Unknown tool property: " + property_name + "!";
405 /// Property handlers --
406 /// Functions that extract information about tool properties from
407 /// DAG representation.
409 void onCmdLine (const DagInit* d) {
410 checkNumberOfArguments(d, 1);
411 SplitString(InitPtrToString(d->getArg(0)), toolProps_.CmdLine);
412 if (toolProps_.CmdLine.empty())
413 throw "Tool " + toolProps_.Name + " has empty command line!";
416 void onInLanguage (const DagInit* d) {
417 checkNumberOfArguments(d, 1);
418 toolProps_.InLanguage = InitPtrToString(d->getArg(0));
421 void onJoin (const DagInit* d) {
422 checkNumberOfArguments(d, 0);
423 toolProps_.setJoin();
426 void onOutLanguage (const DagInit* d) {
427 checkNumberOfArguments(d, 1);
428 toolProps_.OutLanguage = InitPtrToString(d->getArg(0));
431 void onOutputSuffix (const DagInit* d) {
432 checkNumberOfArguments(d, 1);
433 toolProps_.OutputSuffix = InitPtrToString(d->getArg(0));
436 void onSink (const DagInit* d) {
437 checkNumberOfArguments(d, 0);
438 optDescs_.HasSink = true;
439 toolProps_.setSink();
442 void onSwitch (const DagInit* d) {
443 addOption(d, OptionType::Switch);
446 void onParameter (const DagInit* d) {
447 addOption(d, OptionType::Parameter);
450 void onParameterList (const DagInit* d) {
451 addOption(d, OptionType::ParameterList);
454 void onPrefix (const DagInit* d) {
455 addOption(d, OptionType::Prefix);
458 void onPrefixList (const DagInit* d) {
459 addOption(d, OptionType::PrefixList);
462 /// Option property handlers --
463 /// Methods that handle properties that are common for all types of
464 /// options (like append_cmd, stop_compilation)
466 void onAppendCmd (const DagInit* d, GlobalOptionDescription& o) {
467 checkNumberOfArguments(d, 1);
468 std::string const& cmd = InitPtrToString(d->getArg(0));
470 toolProps_.OptDescs[o.Name].AddProperty(OptionPropertyType::AppendCmd, cmd);
473 void onForward (const DagInit* d, GlobalOptionDescription& o) {
474 checkNumberOfArguments(d, 0);
475 toolProps_.OptDescs[o.Name].setForward();
478 void onHelp (const DagInit* d, GlobalOptionDescription& o) {
479 checkNumberOfArguments(d, 1);
480 const std::string& help_message = InitPtrToString(d->getArg(0));
482 o.Help = help_message;
485 void onRequired (const DagInit* d, GlobalOptionDescription& o) {
486 checkNumberOfArguments(d, 0);
490 void onStopCompilation (const DagInit* d, GlobalOptionDescription& o) {
491 checkNumberOfArguments(d, 0);
492 if (o.Type != OptionType::Switch)
493 throw std::string("Only options of type Switch can stop compilation!");
494 toolProps_.OptDescs[o.Name].setStopCompilation();
497 void onUnpackValues (const DagInit* d, GlobalOptionDescription& o) {
498 checkNumberOfArguments(d, 0);
499 toolProps_.OptDescs[o.Name].setUnpackValues();
504 // Add an option of type t
505 void addOption (const DagInit* d, OptionType::OptionType t) {
506 checkNumberOfArguments(d, 2);
507 const std::string& name = InitPtrToString(d->getArg(0));
509 GlobalOptionDescription o(t, name);
510 toolProps_.OptDescs[name].Type = t;
511 toolProps_.OptDescs[name].Name = name;
512 processOptionProperties(d, o);
513 insertDescription(o);
516 // Insert new GlobalOptionDescription into GlobalOptionDescriptions list
517 void insertDescription (const GlobalOptionDescription& o)
519 if (optDescs_.Descriptions.count(o.Name)) {
520 GlobalOptionDescription& D = optDescs_.Descriptions[o.Name];
524 optDescs_.Descriptions[o.Name] = o;
528 // Go through the list of option properties and call a corresponding
532 // name - option name
533 // d - option property list
534 void processOptionProperties (const DagInit* d, GlobalOptionDescription& o) {
535 // First argument is option name
536 checkNumberOfArguments(d, 2);
538 for (unsigned B = 1, E = d->getNumArgs(); B!=E; ++B) {
539 const DagInit& option_property
540 = InitPtrToDagInitRef(d->getArg(B));
541 const std::string& option_property_name
542 = option_property.getOperator()->getAsString();
543 OptionPropertyHandlerMap::iterator method
544 = optionPropertyHandlers_.find(option_property_name);
546 if (method != optionPropertyHandlers_.end()) {
547 OptionPropertyHandler h = method->second;
548 (this->*h)(&option_property, o);
551 throw "Unknown option property: " + option_property_name + "!";
557 // Static members of CollectProperties
558 CollectProperties::PropertyHandlerMap
559 CollectProperties::propertyHandlers_;
561 CollectProperties::OptionPropertyHandlerMap
562 CollectProperties::optionPropertyHandlers_;
564 bool CollectProperties::staticMembersInitialized_ = false;
567 // Gather information from the parsed TableGen data
568 // (Basically a wrapper for CollectProperties)
569 void CollectToolProperties (RecordVector::const_iterator B,
570 RecordVector::const_iterator E,
571 ToolPropertiesList& TPList,
572 GlobalOptionDescriptions& OptDescs)
574 // Iterate over a properties list of every Tool definition
576 RecordVector::value_type T = *B;
577 ListInit* PropList = T->getValueAsListInit("properties");
579 IntrusiveRefCntPtr<ToolProperties>
580 ToolProps(new ToolProperties(T->getName()));
582 std::for_each(PropList->begin(), PropList->end(),
583 CollectProperties(*ToolProps, OptDescs));
584 TPList.push_back(ToolProps);
588 // Used by EmitGenerateActionMethod
589 void EmitOptionPropertyHandlingCode (const ToolProperties& P,
590 const ToolOptionDescription& D,
594 O << Indent2 << "if (";
595 if (D.Type == OptionType::Switch)
596 O << D.GenVariableName();
598 O << '!' << D.GenVariableName() << ".empty()";
602 // Handle option properties that take an argument
603 for (OptionPropertyList::const_iterator B = D.Props.begin(),
604 E = D.Props.end(); B!=E; ++B) {
605 const OptionProperty& val = *B;
608 // (append_cmd cmd) property
609 case OptionPropertyType::AppendCmd:
610 O << Indent3 << "vec.push_back(\"" << val.second << "\");\n";
612 // Other properties with argument
620 // (forward) property
623 case OptionType::Switch:
624 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
626 case OptionType::Parameter:
627 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
628 O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n";
630 case OptionType::Prefix:
631 O << Indent3 << "vec.push_back(\"-" << D.Name << "\" + "
632 << D.GenVariableName() << ");\n";
634 case OptionType::PrefixList:
635 O << Indent3 << "for (" << D.GenTypeDeclaration()
636 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
637 << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
638 << Indent4 << "vec.push_back(\"-" << D.Name << "\" + "
641 case OptionType::ParameterList:
642 O << Indent3 << "for (" << D.GenTypeDeclaration()
643 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
644 << Indent3 << "E = " << D.GenVariableName()
645 << ".end() ; B != E; ++B) {\n"
646 << Indent4 << "vec.push_back(\"-" << D.Name << "\");\n"
647 << Indent4 << "vec.push_back(*B);\n"
653 // (unpack_values) property
654 if (D.isUnpackValues()) {
655 if (IsListOptionType(D.Type)) {
656 O << Indent3 << "for (" << D.GenTypeDeclaration()
657 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
658 << Indent3 << "E = " << D.GenVariableName()
659 << ".end(); B != E; ++B)\n"
660 << Indent4 << "llvm::SplitString(*B, vec, \",\");\n";
662 else if (D.Type == OptionType::Prefix || D.Type == OptionType::Parameter){
663 O << Indent3 << "llvm::SplitString("
664 << D.GenVariableName() << ", vec, \",\");\n";
667 // TOFIX: move this to the type-checking phase
668 throw std::string("Switches can't have unpack_values property!");
673 O << Indent2 << "}\n";
676 // Emite one of two versions of GenerateAction method
677 void EmitGenerateActionMethod (const ToolProperties& P, int V, std::ostream& O)
679 assert(V==1 || V==2);
681 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
683 O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
685 O << Indent2 << "const sys::Path& outFile) const\n"
687 << Indent2 << "std::vector<std::string> vec;\n";
689 // Parse CmdLine tool property
690 if(P.CmdLine.empty())
691 throw "Tool " + P.Name + " has empty command line!";
693 StrVector::const_iterator I = P.CmdLine.begin();
695 for (StrVector::const_iterator E = P.CmdLine.end(); I != E; ++I) {
696 const std::string& cmd = *I;
698 if (cmd == "$INFILE") {
700 O << "for (PathVector::const_iterator B = inFiles.begin()"
701 << ", E = inFiles.end();\n"
702 << Indent2 << "B != E; ++B)\n"
703 << Indent3 << "vec.push_back(B->toString());\n";
705 O << "vec.push_back(inFile.toString());\n";
707 else if (cmd == "$OUTFILE") {
708 O << "vec.push_back(outFile.toString());\n";
711 O << "vec.push_back(\"" << cmd << "\");\n";
715 // For every understood option, emit handling code
716 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
717 E = P.OptDescs.end(); B != E; ++B) {
718 const ToolOptionDescription& val = B->second;
719 EmitOptionPropertyHandlingCode(P, val, O);
722 // Handle Sink property
724 O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
725 << Indent3 << "vec.insert(vec.end(), "
726 << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
730 O << Indent2 << "return Action(\"" << P.CmdLine.at(0) << "\", vec);\n"
731 << Indent1 << "}\n\n";
734 // Emit GenerateAction methods for Tool classes
735 void EmitGenerateActionMethods (const ToolProperties& P, std::ostream& O) {
738 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
739 << Indent2 << "const llvm::sys::Path& outFile) const\n"
741 << Indent2 << "throw std::runtime_error(\"" << P.Name
742 << " is not a Join tool!\");\n"
743 << Indent1 << "}\n\n";
745 EmitGenerateActionMethod(P, 1, O);
747 EmitGenerateActionMethod(P, 2, O);
750 // Emit IsLast() method for Tool classes
751 void EmitIsLastMethod (const ToolProperties& P, std::ostream& O) {
752 O << Indent1 << "bool IsLast() const {\n"
753 << Indent2 << "bool last = false;\n";
755 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
756 E = P.OptDescs.end(); B != E; ++B) {
757 const ToolOptionDescription& val = B->second;
759 if (val.isStopCompilation())
761 << "if (" << val.GenVariableName()
762 << ")\n" << Indent3 << "last = true;\n";
765 O << Indent2 << "return last;\n"
766 << Indent1 << "}\n\n";
769 // Emit static [Input,Output]Language() methods for Tool classes
770 void EmitInOutLanguageMethods (const ToolProperties& P, std::ostream& O) {
771 O << Indent1 << "const char* InputLanguage() const {\n"
772 << Indent2 << "return \"" << P.InLanguage << "\";\n"
773 << Indent1 << "}\n\n";
775 O << Indent1 << "const char* OutputLanguage() const {\n"
776 << Indent2 << "return \"" << P.OutLanguage << "\";\n"
777 << Indent1 << "}\n\n";
780 // Emit static [Input,Output]Language() methods for Tool classes
781 void EmitOutputSuffixMethod (const ToolProperties& P, std::ostream& O) {
782 O << Indent1 << "const char* OutputSuffix() const {\n"
783 << Indent2 << "return \"" << P.OutputSuffix << "\";\n"
784 << Indent1 << "}\n\n";
787 // Emit static Name() method for Tool classes
788 void EmitNameMethod (const ToolProperties& P, std::ostream& O) {
789 O << Indent1 << "const char* Name() const {\n"
790 << Indent2 << "return \"" << P.Name << "\";\n"
791 << Indent1 << "}\n\n";
794 // Emit static Name() method for Tool classes
795 void EmitIsJoinMethod (const ToolProperties& P, std::ostream& O) {
796 O << Indent1 << "bool IsJoin() const {\n";
798 O << Indent2 << "return true;\n";
800 O << Indent2 << "return false;\n";
801 O << Indent1 << "}\n\n";
804 // Emit a Tool class definition
805 void EmitToolClassDefinition (const ToolProperties& P, std::ostream& O) {
811 O << "class " << P.Name << " : public ";
816 O << " {\npublic:\n";
818 EmitNameMethod(P, O);
819 EmitInOutLanguageMethods(P, O);
820 EmitOutputSuffixMethod(P, O);
821 EmitIsJoinMethod(P, O);
822 EmitGenerateActionMethods(P, O);
823 EmitIsLastMethod(P, O);
825 // Close class definition
829 // Iterate over a list of option descriptions and emit registration code
830 void EmitOptionDescriptions (const GlobalOptionDescriptions& descs,
833 // Emit static cl::Option variables
834 for (GlobalOptionDescriptions::const_iterator B = descs.begin(),
835 E = descs.end(); B!=E; ++B) {
836 const GlobalOptionDescription& val = B->second;
838 O << val.GenTypeDeclaration() << ' '
839 << val.GenVariableName()
840 << "(\"" << val.Name << '\"';
842 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
845 if (val.isRequired()) {
847 case OptionType::PrefixList:
848 case OptionType::ParameterList:
849 O << ", cl::OneOrMore";
852 O << ", cl::Required";
856 O << ", cl::desc(\"" << val.Help << "\"));\n";
860 O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
865 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
867 // Get the relevant field out of RecordKeeper
868 Record* LangMapRecord = Records.getDef("LanguageMap");
870 throw std::string("Language map definition not found!");
872 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
873 if (!LangsToSuffixesList)
874 throw std::string("Error in the language map definition!");
877 O << "void llvmc::PopulateLanguageMap(LanguageMap& language_map) {\n";
879 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
880 Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
882 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
883 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
885 for (unsigned i = 0; i < Suffixes->size(); ++i)
886 O << Indent1 << "language_map[\""
887 << InitPtrToString(Suffixes->getElement(i))
888 << "\"] = \"" << Lang << "\";\n";
894 // Fills in two tables that map tool names to (input, output) languages.
895 // Used by the typechecker.
896 void FillInToolToLang (const ToolPropertiesList& TPList,
897 StringMap<std::string>& ToolToInLang,
898 StringMap<std::string>& ToolToOutLang) {
899 for (ToolPropertiesList::const_iterator B = TPList.begin(), E = TPList.end();
901 const ToolProperties& P = *(*B);
902 ToolToInLang[P.Name] = P.InLanguage;
903 ToolToOutLang[P.Name] = P.OutLanguage;
907 // Check that all output and input language names match.
908 // TOFIX: check for cycles.
909 // TOFIX: check for multiple default edges.
910 void TypecheckGraph (Record* CompilationGraph,
911 const ToolPropertiesList& TPList) {
912 StringMap<std::string> ToolToInLang;
913 StringMap<std::string> ToolToOutLang;
915 FillInToolToLang(TPList, ToolToInLang, ToolToOutLang);
916 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
917 StringMap<std::string>::iterator IAE = ToolToInLang.end();
918 StringMap<std::string>::iterator IBE = ToolToOutLang.end();
920 for (unsigned i = 0; i < edges->size(); ++i) {
921 Record* Edge = edges->getElementAsRecord(i);
922 Record* A = Edge->getValueAsDef("a");
923 Record* B = Edge->getValueAsDef("b");
924 StringMap<std::string>::iterator IA = ToolToOutLang.find(A->getName());
925 StringMap<std::string>::iterator IB = ToolToInLang.find(B->getName());
927 throw A->getName() + ": no such tool!";
929 throw B->getName() + ": no such tool!";
930 if(A->getName() != "root" && IA->second != IB->second)
931 throw "Edge " + A->getName() + "->" + B->getName()
932 + ": output->input language mismatch";
933 if(B->getName() == "root")
934 throw std::string("Edges back to the root are not allowed!");
938 // Helper function used by EmitEdgePropertyTest.
939 bool EmitEdgePropertyTest1Arg(const std::string& PropName,
941 const GlobalOptionDescriptions& OptDescs,
943 checkNumberOfArguments(&Prop, 1);
944 const std::string& OptName = InitPtrToString(Prop.getArg(0));
945 if (PropName == "switch_on") {
946 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
947 if (OptDesc.Type != OptionType::Switch)
948 throw OptName + ": incorrect option type!";
949 O << OptDesc.GenVariableName();
951 } else if (PropName == "if_input_languages_contain") {
952 O << "InLangs.count(\"" << OptName << "\") != 0";
959 // Helper function used by EmitEdgePropertyTest.
960 bool EmitEdgePropertyTest2Args(const std::string& PropName,
962 const GlobalOptionDescriptions& OptDescs,
964 checkNumberOfArguments(&Prop, 2);
965 const std::string& OptName = InitPtrToString(Prop.getArg(0));
966 const std::string& OptArg = InitPtrToString(Prop.getArg(1));
967 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
969 if (PropName == "parameter_equals") {
970 if (OptDesc.Type != OptionType::Parameter
971 && OptDesc.Type != OptionType::Prefix)
972 throw OptName + ": incorrect option type!";
973 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
976 else if (PropName == "element_in_list") {
977 if (OptDesc.Type != OptionType::ParameterList
978 && OptDesc.Type != OptionType::PrefixList)
979 throw OptName + ": incorrect option type!";
980 const std::string& VarName = OptDesc.GenVariableName();
981 O << "std::find(" << VarName << ".begin(),\n"
982 << Indent3 << VarName << ".end(), \""
983 << OptArg << "\") != " << VarName << ".end()";
990 // Forward declaration.
991 void EmitEdgePropertyTest(const DagInit& Prop,
992 const GlobalOptionDescriptions& OptDescs,
995 // Helper function used by EmitEdgeClass.
996 void EmitLogicalOperationTest(const DagInit& Prop, const char* LogicOp,
997 const GlobalOptionDescriptions& OptDescs,
1000 for (unsigned j = 0, NumArgs = Prop.getNumArgs(); j < NumArgs; ++j) {
1001 const DagInit& InnerProp = InitPtrToDagInitRef(Prop.getArg(j));
1002 EmitEdgePropertyTest(InnerProp, OptDescs, O);
1003 if (j != NumArgs - 1)
1004 O << ")\n" << Indent3 << ' ' << LogicOp << " (";
1010 // Helper function used by EmitEdgeClass.
1011 void EmitEdgePropertyTest(const DagInit& Prop,
1012 const GlobalOptionDescriptions& OptDescs,
1014 const std::string& PropName = Prop.getOperator()->getAsString();
1016 if (PropName == "and")
1017 EmitLogicalOperationTest(Prop, "&&", OptDescs, O);
1018 else if (PropName == "or")
1019 EmitLogicalOperationTest(Prop, "||", OptDescs, O);
1020 else if (EmitEdgePropertyTest1Arg(PropName, Prop, OptDescs, O))
1022 else if (EmitEdgePropertyTest2Args(PropName, Prop, OptDescs, O))
1025 throw PropName + ": unknown edge property!";
1028 // Emit a single Edge* class.
1029 void EmitEdgeClass(unsigned N, const std::string& Target,
1030 ListInit* Props, const GlobalOptionDescriptions& OptDescs,
1033 // Class constructor.
1034 O << "class Edge" << N << ": public Edge {\n"
1036 << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1039 // Function Weight().
1040 << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1041 << Indent2 << "unsigned ret = 0;\n";
1043 // Emit tests for every edge property.
1044 for (size_t i = 0, PropsSize = Props->size(); i < PropsSize; ++i) {
1045 const DagInit& Prop = InitPtrToDagInitRef(Props->getElement(i));
1046 const std::string& PropName = Prop.getOperator()->getAsString();
1049 O << Indent2 << "if (";
1051 if (PropName == "weight") {
1052 checkNumberOfArguments(&Prop, 2);
1053 N = InitPtrToInt(Prop.getArg(0));
1054 const DagInit& InnerProp = InitPtrToDagInitRef(Prop.getArg(1));
1055 EmitEdgePropertyTest(InnerProp, OptDescs, O);
1058 EmitEdgePropertyTest(Prop, OptDescs, O);
1061 O << ")\n" << Indent3 << "ret += " << N << ";\n";
1064 O << Indent2 << "return ret;\n"
1065 << Indent1 << "};\n\n};\n\n";
1068 // Emit Edge* classes that represent graph edges.
1069 void EmitEdgeClasses (Record* CompilationGraph,
1070 const GlobalOptionDescriptions& OptDescs,
1072 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1074 for (unsigned i = 0; i < edges->size(); ++i) {
1075 Record* Edge = edges->getElementAsRecord(i);
1076 Record* B = Edge->getValueAsDef("b");
1077 ListInit* Props = Edge->getValueAsListInit("props");
1082 EmitEdgeClass(i, B->getName(), Props, OptDescs, O);
1086 void EmitPopulateCompilationGraph (Record* CompilationGraph,
1089 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1092 O << "void llvmc::PopulateCompilationGraph(CompilationGraph& G) {\n"
1093 << Indent1 << "PopulateLanguageMap(G.ExtsToLangs);\n\n";
1097 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1099 throw std::string("No tool definitions found!");
1101 for (RecordVector::iterator B = Tools.begin(), E = Tools.end(); B != E; ++B) {
1102 const std::string& Name = (*B)->getName();
1104 O << Indent1 << "G.insertNode(new "
1105 << Name << "());\n";
1111 for (unsigned i = 0; i < edges->size(); ++i) {
1112 Record* Edge = edges->getElementAsRecord(i);
1113 Record* A = Edge->getValueAsDef("a");
1114 Record* B = Edge->getValueAsDef("b");
1115 ListInit* Props = Edge->getValueAsListInit("props");
1117 O << Indent1 << "G.insertEdge(\"" << A->getName() << "\", ";
1120 O << "new SimpleEdge(\"" << B->getName() << "\")";
1122 O << "new Edge" << i << "()";
1131 // End of anonymous namespace
1134 // Back-end entry point
1135 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1137 EmitSourceFileHeader("LLVMC Configuration Library", O);
1139 // Get a list of all defined Tools
1140 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1142 throw std::string("No tool definitions found!");
1144 // Gather information from the Tool descriptions
1145 ToolPropertiesList tool_props;
1146 GlobalOptionDescriptions opt_descs;
1147 CollectToolProperties(Tools.begin(), Tools.end(), tool_props, opt_descs);
1149 // Emit global option registration code
1150 EmitOptionDescriptions(opt_descs, O);
1152 // Emit PopulateLanguageMap function
1153 // (a language map maps from file extensions to language names)
1154 EmitPopulateLanguageMap(Records, O);
1156 // Emit Tool classes
1157 for (ToolPropertiesList::const_iterator B = tool_props.begin(),
1158 E = tool_props.end(); B!=E; ++B)
1159 EmitToolClassDefinition(*(*B), O);
1161 Record* CompilationGraphRecord = Records.getDef("CompilationGraph");
1162 if (!CompilationGraphRecord)
1163 throw std::string("Compilation graph description not found!");
1165 // Typecheck the compilation graph.
1166 TypecheckGraph(CompilationGraphRecord, tool_props);
1168 // Emit Edge* classes.
1169 EmitEdgeClasses(CompilationGraphRecord, opt_descs, O);
1171 // Emit PopulateCompilationGraph function
1172 EmitPopulateCompilationGraph(CompilationGraphRecord, O);