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 const std::string& InitPtrToString(const Init* ptr) {
57 const StringInit& val = dynamic_cast<const StringInit&>(*ptr);
58 return val.getValue();
61 int InitPtrToInt(const Init* ptr) {
62 const IntInit& val = dynamic_cast<const IntInit&>(*ptr);
63 return val.getValue();
66 const DagInit& InitPtrToDagInitRef(const Init* ptr) {
67 const DagInit& val = dynamic_cast<const DagInit&>(*ptr);
71 // checkNumberOfArguments - Ensure that the number of args in d is
72 // less than or equal to min_arguments, otherwise throw an exception.
73 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
74 if (d->getNumArgs() < min_arguments)
75 throw "Property " + d->getOperator()->getAsString()
76 + " has too few arguments!";
79 // isDagEmpty - is this DAG marked with an empty marker?
80 bool isDagEmpty (const DagInit* d) {
81 return d->getOperator()->getAsString() == "empty";
84 //===----------------------------------------------------------------------===//
85 /// Back-end specific code
87 // A command-line option can have one of the following types:
89 // Switch - a simple switch w/o arguments, e.g. -O2
91 // Parameter - an option that takes one(and only one) argument, e.g. -o file,
94 // ParameterList - same as Parameter, but more than one occurence
95 // of the option is allowed, e.g. -lm -lpthread
97 // Prefix - argument is everything after the prefix,
98 // e.g. -Wa,-foo,-bar, -DNAME=VALUE
100 // PrefixList - same as Prefix, but more than one option occurence is
103 namespace OptionType {
104 enum OptionType { Switch, Parameter, ParameterList, Prefix, PrefixList};
107 bool IsListOptionType (OptionType::OptionType t) {
108 return (t == OptionType::ParameterList || t == OptionType::PrefixList);
111 // Code duplication here is necessary because one option can affect
112 // several tools and those tools may have different actions associated
113 // with this option. GlobalOptionDescriptions are used to generate
114 // the option registration code, while ToolOptionDescriptions are used
115 // to generate tool-specific code.
117 /// OptionDescription - Base class for option descriptions.
118 struct OptionDescription {
119 OptionType::OptionType Type;
122 OptionDescription(OptionType::OptionType t = OptionType::Switch,
123 const std::string& n = "")
127 const char* GenTypeDeclaration() const {
129 case OptionType::PrefixList:
130 case OptionType::ParameterList:
131 return "cl::list<std::string>";
132 case OptionType::Switch:
133 return "cl::opt<bool>";
134 case OptionType::Parameter:
135 case OptionType::Prefix:
137 return "cl::opt<std::string>";
141 // Escape commas and other symbols not allowed in the C++ variable
142 // names. Makes it possible to use options with names like "Wa,"
143 // (useful for prefix options).
144 std::string EscapeVariableName(const std::string& Var) const {
146 for (unsigned i = 0; i != Var.size(); ++i) {
151 ret.push_back(Var[i]);
157 std::string GenVariableName() const {
158 const std::string& EscapedName = EscapeVariableName(Name);
160 case OptionType::Switch:
161 return "AutoGeneratedSwitch" + EscapedName;
162 case OptionType::Prefix:
163 return "AutoGeneratedPrefix" + EscapedName;
164 case OptionType::PrefixList:
165 return "AutoGeneratedPrefixList" + EscapedName;
166 case OptionType::Parameter:
167 return "AutoGeneratedParameter" + EscapedName;
168 case OptionType::ParameterList:
170 return "AutoGeneratedParameterList" + EscapedName;
176 // Global option description.
178 namespace GlobalOptionDescriptionFlags {
179 enum GlobalOptionDescriptionFlags { Required = 0x1 };
182 struct GlobalOptionDescription : public OptionDescription {
186 // We need to provide a default constructor because
187 // StringMap can only store DefaultConstructible objects.
188 GlobalOptionDescription() : OptionDescription(), Flags(0)
191 GlobalOptionDescription (OptionType::OptionType t, const std::string& n)
192 : OptionDescription(t, n), Help(DefaultHelpString), Flags(0)
195 bool isRequired() const {
196 return Flags & GlobalOptionDescriptionFlags::Required;
199 Flags |= GlobalOptionDescriptionFlags::Required;
202 /// Merge - Merge two option descriptions.
203 void Merge (const GlobalOptionDescription& other)
205 if (other.Type != Type)
206 throw "Conflicting definitions for the option " + Name + "!";
208 if (Help == DefaultHelpString)
210 else if (other.Help != DefaultHelpString) {
211 llvm::cerr << "Warning: more than one help string defined for option "
215 Flags |= other.Flags;
219 /// GlobalOptionDescriptions - A GlobalOptionDescription array
220 /// together with some flags affecting generation of option
222 struct GlobalOptionDescriptions {
223 typedef StringMap<GlobalOptionDescription> container_type;
224 typedef container_type::const_iterator const_iterator;
226 /// Descriptions - A list of GlobalOptionDescriptions.
227 container_type Descriptions;
228 /// HasSink - Should the emitter generate a "cl::sink" option?
231 const GlobalOptionDescription& FindOption(const std::string& OptName) const {
232 const_iterator I = Descriptions.find(OptName);
233 if (I != Descriptions.end())
236 throw OptName + ": no such option!";
239 // Support for STL-style iteration
240 const_iterator begin() const { return Descriptions.begin(); }
241 const_iterator end() const { return Descriptions.end(); }
245 // Tool-local option description.
247 // Properties without arguments are implemented as flags.
248 namespace ToolOptionDescriptionFlags {
249 enum ToolOptionDescriptionFlags { StopCompilation = 0x1,
250 Forward = 0x2, UnpackValues = 0x4};
252 namespace OptionPropertyType {
253 enum OptionPropertyType { AppendCmd };
256 typedef std::pair<OptionPropertyType::OptionPropertyType, std::string>
258 typedef SmallVector<OptionProperty, 4> OptionPropertyList;
260 struct ToolOptionDescription : public OptionDescription {
262 OptionPropertyList Props;
264 // StringMap can only store DefaultConstructible objects
265 ToolOptionDescription() : OptionDescription(), Flags(0) {}
267 ToolOptionDescription (OptionType::OptionType t, const std::string& n)
268 : OptionDescription(t, n)
271 // Various boolean properties
272 bool isStopCompilation() const {
273 return Flags & ToolOptionDescriptionFlags::StopCompilation;
275 void setStopCompilation() {
276 Flags |= ToolOptionDescriptionFlags::StopCompilation;
279 bool isForward() const {
280 return Flags & ToolOptionDescriptionFlags::Forward;
283 Flags |= ToolOptionDescriptionFlags::Forward;
286 bool isUnpackValues() const {
287 return Flags & ToolOptionDescriptionFlags::UnpackValues;
289 void setUnpackValues() {
290 Flags |= ToolOptionDescriptionFlags::UnpackValues;
293 void AddProperty (OptionPropertyType::OptionPropertyType t,
294 const std::string& val)
296 Props.push_back(std::make_pair(t, val));
300 typedef StringMap<ToolOptionDescription> ToolOptionDescriptions;
302 // Tool information record
304 namespace ToolFlags {
305 enum ToolFlags { Join = 0x1, Sink = 0x2 };
308 struct ToolProperties : public RefCountedBase<ToolProperties> {
311 std::string InLanguage;
312 std::string OutLanguage;
313 std::string OutputSuffix;
315 ToolOptionDescriptions OptDescs;
317 // Various boolean properties
318 void setSink() { Flags |= ToolFlags::Sink; }
319 bool isSink() const { return Flags & ToolFlags::Sink; }
320 void setJoin() { Flags |= ToolFlags::Join; }
321 bool isJoin() const { return Flags & ToolFlags::Join; }
323 // Default ctor here is needed because StringMap can only store
324 // DefaultConstructible objects
325 ToolProperties() : Flags(0) {}
326 ToolProperties (const std::string& n) : Name(n), Flags(0) {}
330 /// ToolPropertiesList - A list of Tool information records
331 /// IntrusiveRefCntPtrs are used here because StringMap has no copy
332 /// constructor (and we want to avoid copying ToolProperties anyway).
333 typedef std::vector<IntrusiveRefCntPtr<ToolProperties> > ToolPropertiesList;
336 /// CollectProperties - Function object for iterating over a list of
337 /// tool property records.
338 class CollectProperties {
341 /// Implementation details
343 /// PropertyHandler - a function that extracts information
344 /// about a given tool property from its DAG representation
345 typedef void (CollectProperties::*PropertyHandler)(const DagInit*);
347 /// PropertyHandlerMap - A map from property names to property
349 typedef StringMap<PropertyHandler> PropertyHandlerMap;
351 /// OptionPropertyHandler - a function that extracts information
352 /// about a given option property from its DAG representation.
353 typedef void (CollectProperties::* OptionPropertyHandler)
354 (const DagInit*, GlobalOptionDescription &);
356 /// OptionPropertyHandlerMap - A map from option property names to
357 /// option property handlers
358 typedef StringMap<OptionPropertyHandler> OptionPropertyHandlerMap;
360 // Static maps from strings to CollectProperties methods("handlers")
361 static PropertyHandlerMap propertyHandlers_;
362 static OptionPropertyHandlerMap optionPropertyHandlers_;
363 static bool staticMembersInitialized_;
366 /// This is where the information is stored
368 /// toolProps_ - Properties of the current Tool.
369 ToolProperties& toolProps_;
370 /// optDescs_ - OptionDescriptions table (used to register options
372 GlobalOptionDescriptions& optDescs_;
376 explicit CollectProperties (ToolProperties& p, GlobalOptionDescriptions& d)
377 : toolProps_(p), optDescs_(d)
379 if (!staticMembersInitialized_) {
380 // Init tool property handlers
381 propertyHandlers_["cmd_line"] = &CollectProperties::onCmdLine;
382 propertyHandlers_["in_language"] = &CollectProperties::onInLanguage;
383 propertyHandlers_["join"] = &CollectProperties::onJoin;
384 propertyHandlers_["out_language"] = &CollectProperties::onOutLanguage;
385 propertyHandlers_["output_suffix"] = &CollectProperties::onOutputSuffix;
386 propertyHandlers_["parameter_option"]
387 = &CollectProperties::onParameter;
388 propertyHandlers_["parameter_list_option"] =
389 &CollectProperties::onParameterList;
390 propertyHandlers_["prefix_option"] = &CollectProperties::onPrefix;
391 propertyHandlers_["prefix_list_option"] =
392 &CollectProperties::onPrefixList;
393 propertyHandlers_["sink"] = &CollectProperties::onSink;
394 propertyHandlers_["switch_option"] = &CollectProperties::onSwitch;
396 // Init option property handlers
397 optionPropertyHandlers_["append_cmd"] = &CollectProperties::onAppendCmd;
398 optionPropertyHandlers_["forward"] = &CollectProperties::onForward;
399 optionPropertyHandlers_["help"] = &CollectProperties::onHelp;
400 optionPropertyHandlers_["required"] = &CollectProperties::onRequired;
401 optionPropertyHandlers_["stop_compilation"] =
402 &CollectProperties::onStopCompilation;
403 optionPropertyHandlers_["unpack_values"] =
404 &CollectProperties::onUnpackValues;
406 staticMembersInitialized_ = true;
410 /// operator() - Gets called for every tool property; Just forwards
411 /// to the corresponding property handler.
412 void operator() (Init* i) {
413 const DagInit& d = InitPtrToDagInitRef(i);
414 const std::string& property_name = d.getOperator()->getAsString();
415 PropertyHandlerMap::iterator method
416 = propertyHandlers_.find(property_name);
418 if (method != propertyHandlers_.end()) {
419 PropertyHandler h = method->second;
423 throw "Unknown tool property: " + property_name + "!";
429 /// Property handlers --
430 /// Functions that extract information about tool properties from
431 /// DAG representation.
433 void onCmdLine (const DagInit* d) {
434 checkNumberOfArguments(d, 1);
435 toolProps_.CmdLine = d->getArg(0);
438 void onInLanguage (const DagInit* d) {
439 checkNumberOfArguments(d, 1);
440 toolProps_.InLanguage = InitPtrToString(d->getArg(0));
443 void onJoin (const DagInit* d) {
444 checkNumberOfArguments(d, 0);
445 toolProps_.setJoin();
448 void onOutLanguage (const DagInit* d) {
449 checkNumberOfArguments(d, 1);
450 toolProps_.OutLanguage = InitPtrToString(d->getArg(0));
453 void onOutputSuffix (const DagInit* d) {
454 checkNumberOfArguments(d, 1);
455 toolProps_.OutputSuffix = InitPtrToString(d->getArg(0));
458 void onSink (const DagInit* d) {
459 checkNumberOfArguments(d, 0);
460 optDescs_.HasSink = true;
461 toolProps_.setSink();
464 void onSwitch (const DagInit* d) {
465 addOption(d, OptionType::Switch);
468 void onParameter (const DagInit* d) {
469 addOption(d, OptionType::Parameter);
472 void onParameterList (const DagInit* d) {
473 addOption(d, OptionType::ParameterList);
476 void onPrefix (const DagInit* d) {
477 addOption(d, OptionType::Prefix);
480 void onPrefixList (const DagInit* d) {
481 addOption(d, OptionType::PrefixList);
484 /// Option property handlers --
485 /// Methods that handle properties that are common for all types of
486 /// options (like append_cmd, stop_compilation)
488 void onAppendCmd (const DagInit* d, GlobalOptionDescription& o) {
489 checkNumberOfArguments(d, 1);
490 std::string const& cmd = InitPtrToString(d->getArg(0));
492 toolProps_.OptDescs[o.Name].AddProperty(OptionPropertyType::AppendCmd, cmd);
495 void onForward (const DagInit* d, GlobalOptionDescription& o) {
496 checkNumberOfArguments(d, 0);
497 toolProps_.OptDescs[o.Name].setForward();
500 void onHelp (const DagInit* d, GlobalOptionDescription& o) {
501 checkNumberOfArguments(d, 1);
502 const std::string& help_message = InitPtrToString(d->getArg(0));
504 o.Help = help_message;
507 void onRequired (const DagInit* d, GlobalOptionDescription& o) {
508 checkNumberOfArguments(d, 0);
512 void onStopCompilation (const DagInit* d, GlobalOptionDescription& o) {
513 checkNumberOfArguments(d, 0);
514 if (o.Type != OptionType::Switch)
515 throw std::string("Only options of type Switch can stop compilation!");
516 toolProps_.OptDescs[o.Name].setStopCompilation();
519 void onUnpackValues (const DagInit* d, GlobalOptionDescription& o) {
520 checkNumberOfArguments(d, 0);
521 toolProps_.OptDescs[o.Name].setUnpackValues();
526 // Add an option of type t
527 void addOption (const DagInit* d, OptionType::OptionType t) {
528 checkNumberOfArguments(d, 2);
529 const std::string& name = InitPtrToString(d->getArg(0));
531 GlobalOptionDescription o(t, name);
532 toolProps_.OptDescs[name].Type = t;
533 toolProps_.OptDescs[name].Name = name;
534 processOptionProperties(d, o);
535 insertDescription(o);
538 // Insert new GlobalOptionDescription into GlobalOptionDescriptions list
539 void insertDescription (const GlobalOptionDescription& o)
541 if (optDescs_.Descriptions.count(o.Name)) {
542 GlobalOptionDescription& D = optDescs_.Descriptions[o.Name];
546 optDescs_.Descriptions[o.Name] = o;
550 /// processOptionProperties - Go through the list of option
551 /// properties and call a corresponding handler for each.
554 /// name - option name
555 /// d - option property list
556 void processOptionProperties (const DagInit* d, GlobalOptionDescription& o) {
557 // First argument is option name
558 checkNumberOfArguments(d, 2);
560 for (unsigned B = 1, E = d->getNumArgs(); B!=E; ++B) {
561 const DagInit& option_property
562 = InitPtrToDagInitRef(d->getArg(B));
563 const std::string& option_property_name
564 = option_property.getOperator()->getAsString();
565 OptionPropertyHandlerMap::iterator method
566 = optionPropertyHandlers_.find(option_property_name);
568 if (method != optionPropertyHandlers_.end()) {
569 OptionPropertyHandler h = method->second;
570 (this->*h)(&option_property, o);
573 throw "Unknown option property: " + option_property_name + "!";
579 // Static members of CollectProperties
580 CollectProperties::PropertyHandlerMap
581 CollectProperties::propertyHandlers_;
583 CollectProperties::OptionPropertyHandlerMap
584 CollectProperties::optionPropertyHandlers_;
586 bool CollectProperties::staticMembersInitialized_ = false;
589 /// CollectToolProperties - Gather information from the parsed
590 /// TableGen data (basically a wrapper for the CollectProperties
591 /// function object).
592 void CollectToolProperties (RecordVector::const_iterator B,
593 RecordVector::const_iterator E,
594 ToolPropertiesList& TPList,
595 GlobalOptionDescriptions& OptDescs)
597 // Iterate over a properties list of every Tool definition
599 RecordVector::value_type T = *B;
600 ListInit* PropList = T->getValueAsListInit("properties");
602 IntrusiveRefCntPtr<ToolProperties>
603 ToolProps(new ToolProperties(T->getName()));
605 std::for_each(PropList->begin(), PropList->end(),
606 CollectProperties(*ToolProps, OptDescs));
607 TPList.push_back(ToolProps);
611 /// EmitCaseTest1Arg - Helper function used by
612 /// EmitCaseConstructHandler.
613 bool EmitCaseTest1Arg(const std::string& TestName,
615 const GlobalOptionDescriptions& OptDescs,
617 checkNumberOfArguments(&d, 1);
618 const std::string& OptName = InitPtrToString(d.getArg(0));
619 if (TestName == "switch_on") {
620 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
621 if (OptDesc.Type != OptionType::Switch)
622 throw OptName + ": incorrect option type!";
623 O << OptDesc.GenVariableName();
625 } else if (TestName == "input_languages_contain") {
626 O << "InLangs.count(\"" << OptName << "\") != 0";
633 /// EmitCaseTest2Args - Helper function used by
634 /// EmitCaseConstructHandler.
635 bool EmitCaseTest2Args(const std::string& TestName,
637 const char* IndentLevel,
638 const GlobalOptionDescriptions& OptDescs,
640 checkNumberOfArguments(&d, 2);
641 const std::string& OptName = InitPtrToString(d.getArg(0));
642 const std::string& OptArg = InitPtrToString(d.getArg(1));
643 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
645 if (TestName == "parameter_equals") {
646 if (OptDesc.Type != OptionType::Parameter
647 && OptDesc.Type != OptionType::Prefix)
648 throw OptName + ": incorrect option type!";
649 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
652 else if (TestName == "element_in_list") {
653 if (OptDesc.Type != OptionType::ParameterList
654 && OptDesc.Type != OptionType::PrefixList)
655 throw OptName + ": incorrect option type!";
656 const std::string& VarName = OptDesc.GenVariableName();
657 O << "std::find(" << VarName << ".begin(),\n"
658 << IndentLevel << Indent1 << VarName << ".end(), \""
659 << OptArg << "\") != " << VarName << ".end()";
666 // Forward declaration.
667 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
668 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
669 const GlobalOptionDescriptions& OptDescs,
672 /// EmitLogicalOperationTest - Helper function used by
673 /// EmitCaseConstructHandler.
674 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
675 const char* IndentLevel,
676 const GlobalOptionDescriptions& OptDescs,
679 for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
680 const DagInit& InnerTest = InitPtrToDagInitRef(d.getArg(j));
681 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
682 if (j != NumArgs - 1)
683 O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
689 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
690 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
691 const GlobalOptionDescriptions& OptDescs,
693 const std::string& TestName = d.getOperator()->getAsString();
695 if (TestName == "and")
696 EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
697 else if (TestName == "or")
698 EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
699 else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
701 else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
704 throw TestName + ": unknown edge property!";
707 // Emit code that handles the 'case' construct.
708 // Takes a function object that should emit code for every case clause.
709 // Callback's type is
710 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
711 template <typename F>
712 void EmitCaseConstructHandler(const DagInit* d, const char* IndentLevel,
714 const GlobalOptionDescriptions& OptDescs,
716 assert(d->getOperator()->getAsString() == "case");
718 for (unsigned i = 0, numArgs = d->getNumArgs(); i != numArgs; ++i) {
719 const DagInit& Test = InitPtrToDagInitRef(d->getArg(i));
721 if (Test.getOperator()->getAsString() == "default") {
723 throw std::string("The 'default' clause should be the last in the"
724 "'case' construct!");
725 O << IndentLevel << "else {\n";
728 O << IndentLevel << "if (";
729 EmitCaseTest(Test, IndentLevel, OptDescs, O);
735 throw "Case construct handler: no corresponding action "
736 "found for the test " + Test.getAsString() + '!';
738 Callback(d->getArg(i), IndentLevel, O);
739 O << IndentLevel << "}\n";
743 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
744 /// implement EmitOptionPropertyHandlingCode(). Emits code for
745 /// handling the (forward) option property.
746 void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D,
749 case OptionType::Switch:
750 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
752 case OptionType::Parameter:
753 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
754 O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n";
756 case OptionType::Prefix:
757 O << Indent3 << "vec.push_back(\"-" << D.Name << "\" + "
758 << D.GenVariableName() << ");\n";
760 case OptionType::PrefixList:
761 O << Indent3 << "for (" << D.GenTypeDeclaration()
762 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
763 << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
764 << Indent4 << "vec.push_back(\"-" << D.Name << "\" + "
767 case OptionType::ParameterList:
768 O << Indent3 << "for (" << D.GenTypeDeclaration()
769 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
770 << Indent3 << "E = " << D.GenVariableName()
771 << ".end() ; B != E; ++B) {\n"
772 << Indent4 << "vec.push_back(\"-" << D.Name << "\");\n"
773 << Indent4 << "vec.push_back(*B);\n"
779 // A helper function used by EmitOptionPropertyHandlingCode() that
780 // tells us whether we should emit any code at all.
781 bool ToolOptionHasInterestingProperties(const ToolOptionDescription& D) {
782 if (!D.isForward() && !D.isUnpackValues() && D.Props.empty())
787 /// EmitOptionPropertyHandlingCode - Helper function used by
788 /// EmitGenerateActionMethod(). Emits code that handles option
790 void EmitOptionPropertyHandlingCode (const ToolOptionDescription& D,
793 if (!ToolOptionHasInterestingProperties(D))
795 // Start of the if-clause.
796 O << Indent2 << "if (";
797 if (D.Type == OptionType::Switch)
798 O << D.GenVariableName();
800 O << '!' << D.GenVariableName() << ".empty()";
804 // Handle option properties that take an argument.
805 for (OptionPropertyList::const_iterator B = D.Props.begin(),
806 E = D.Props.end(); B!=E; ++B) {
807 const OptionProperty& val = *B;
810 // (append_cmd cmd) property
811 case OptionPropertyType::AppendCmd:
812 O << Indent3 << "vec.push_back(\"" << val.second << "\");\n";
814 // Other properties with argument
822 // (forward) property
824 EmitForwardOptionPropertyHandlingCode(D, O);
826 // (unpack_values) property
827 if (D.isUnpackValues()) {
828 if (IsListOptionType(D.Type)) {
829 O << Indent3 << "for (" << D.GenTypeDeclaration()
830 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
831 << Indent3 << "E = " << D.GenVariableName()
832 << ".end(); B != E; ++B)\n"
833 << Indent4 << "llvm::SplitString(*B, vec, \",\");\n";
835 else if (D.Type == OptionType::Prefix || D.Type == OptionType::Parameter){
836 O << Indent3 << "llvm::SplitString("
837 << D.GenVariableName() << ", vec, \",\");\n";
840 throw std::string("Switches can't have unpack_values property!");
844 // End of the if-clause.
845 O << Indent2 << "}\n";
848 /// SubstituteSpecialCommands - Perform string substitution for $CALL
849 /// and $ENV. Helper function used by EmitCmdLineVecFill().
850 std::string SubstituteSpecialCommands(const std::string& cmd) {
851 if (cmd.find("$CALL(") == 0) {
853 throw std::string("$CALL invocation: empty argument list!");
854 return std::string("hooks::") + (cmd.c_str() + 6) + "()";
856 else if (cmd.find("$ENV(") == 0) {
858 throw std::string("$ENV invocation: empty argument list!");
859 return std::string("std::getenv(\"") + (cmd.c_str() + 5) + "\")";
862 throw "Unknown special command: " + cmd;
866 /// EmitCmdLineVecFill - Emit code that fills in the command line
867 /// vector. Helper function used by EmitGenerateActionMethod().
868 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
869 bool Version, const char* IndentLevel,
872 SplitString(InitPtrToString(CmdLine), StrVec, ") ");
874 throw "Tool " + ToolName + " has empty command line!";
876 StrVector::const_iterator I = StrVec.begin();
878 for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
879 const std::string& cmd = *I;
881 if (cmd.at(0) == '$') {
882 if (cmd == "$INFILE") {
884 O << "for (PathVector::const_iterator B = inFiles.begin()"
885 << ", E = inFiles.end();\n"
886 << IndentLevel << "B != E; ++B)\n"
887 << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
889 O << "vec.push_back(inFile.toString());\n";
891 else if (cmd == "$OUTFILE") {
892 O << "vec.push_back(outFile.toString());\n";
895 O << "vec.push_back(" << SubstituteSpecialCommands(cmd) << ");\n";
899 O << "vec.push_back(\"" << cmd << "\");\n";
902 O << IndentLevel << "ret = Action("
903 << ((StrVec[0][0] == '$') ? SubstituteSpecialCommands(StrVec[0])
904 : "\"" + StrVec[0] + "\"")
908 /// EmitCmdLineVecFillCallback - A function object wrapper around
909 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
910 /// argument to EmitCaseConstructHandler().
911 class EmitCmdLineVecFillCallback {
913 const std::string& ToolName;
915 EmitCmdLineVecFillCallback(bool Ver, const std::string& TN)
916 : Version(Ver), ToolName(TN) {}
918 void operator()(const Init* Statement, const char* IndentLevel,
919 std::ostream& O) const
921 EmitCmdLineVecFill(Statement, ToolName, Version,
922 (std::string(IndentLevel) + Indent1).c_str(), O);
926 // EmitGenerateActionMethod - Emit one of two versions of the
927 // Tool::GenerateAction() method.
928 void EmitGenerateActionMethod (const ToolProperties& P,
929 const GlobalOptionDescriptions& OptDescs,
930 bool Version, std::ostream& O) {
932 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
934 O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
936 O << Indent2 << "const sys::Path& outFile,\n"
937 << Indent2 << "const InputLanguagesSet& InLangs) const\n"
939 << Indent2 << "Action ret;\n"
940 << Indent2 << "std::vector<std::string> vec;\n";
942 // cmd_line is either a string or a 'case' construct.
943 if (typeid(*P.CmdLine) == typeid(StringInit))
944 EmitCmdLineVecFill(P.CmdLine, P.Name, Version, Indent2, O);
946 EmitCaseConstructHandler(&InitPtrToDagInitRef(P.CmdLine), Indent2,
947 EmitCmdLineVecFillCallback(Version, P.Name),
950 // For every understood option, emit handling code.
951 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
952 E = P.OptDescs.end(); B != E; ++B) {
953 const ToolOptionDescription& val = B->second;
954 EmitOptionPropertyHandlingCode(val, O);
957 // Handle the Sink property.
959 O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
960 << Indent3 << "vec.insert(vec.end(), "
961 << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
965 O << Indent2 << "return ret;\n"
966 << Indent1 << "}\n\n";
969 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
970 /// a given Tool class.
971 void EmitGenerateActionMethods (const ToolProperties& P,
972 const GlobalOptionDescriptions& OptDescs,
975 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
976 << Indent2 << "const llvm::sys::Path& outFile,\n"
977 << Indent2 << "const InputLanguagesSet& InLangs) const\n"
979 << Indent2 << "throw std::runtime_error(\"" << P.Name
980 << " is not a Join tool!\");\n"
981 << Indent1 << "}\n\n";
983 EmitGenerateActionMethod(P, OptDescs, true, O);
985 EmitGenerateActionMethod(P, OptDescs, false, O);
988 /// EmitIsLastMethod - Emit the IsLast() method for a given Tool
990 void EmitIsLastMethod (const ToolProperties& P, std::ostream& O) {
991 O << Indent1 << "bool IsLast() const {\n"
992 << Indent2 << "bool last = false;\n";
994 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
995 E = P.OptDescs.end(); B != E; ++B) {
996 const ToolOptionDescription& val = B->second;
998 if (val.isStopCompilation())
1000 << "if (" << val.GenVariableName()
1001 << ")\n" << Indent3 << "last = true;\n";
1004 O << Indent2 << "return last;\n"
1005 << Indent1 << "}\n\n";
1008 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1009 /// methods for a given Tool class.
1010 void EmitInOutLanguageMethods (const ToolProperties& P, std::ostream& O) {
1011 O << Indent1 << "const char* InputLanguage() const {\n"
1012 << Indent2 << "return \"" << P.InLanguage << "\";\n"
1013 << Indent1 << "}\n\n";
1015 O << Indent1 << "const char* OutputLanguage() const {\n"
1016 << Indent2 << "return \"" << P.OutLanguage << "\";\n"
1017 << Indent1 << "}\n\n";
1020 /// EmitOutputSuffixMethod - Emit the OutputSuffix() method for a
1021 /// given Tool class.
1022 void EmitOutputSuffixMethod (const ToolProperties& P, std::ostream& O) {
1023 O << Indent1 << "const char* OutputSuffix() const {\n"
1024 << Indent2 << "return \"" << P.OutputSuffix << "\";\n"
1025 << Indent1 << "}\n\n";
1028 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1029 void EmitNameMethod (const ToolProperties& P, std::ostream& O) {
1030 O << Indent1 << "const char* Name() const {\n"
1031 << Indent2 << "return \"" << P.Name << "\";\n"
1032 << Indent1 << "}\n\n";
1035 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1037 void EmitIsJoinMethod (const ToolProperties& P, std::ostream& O) {
1038 O << Indent1 << "bool IsJoin() const {\n";
1040 O << Indent2 << "return true;\n";
1042 O << Indent2 << "return false;\n";
1043 O << Indent1 << "}\n\n";
1046 /// EmitToolClassDefinition - Emit a Tool class definition.
1047 void EmitToolClassDefinition (const ToolProperties& P,
1048 const GlobalOptionDescriptions& OptDescs,
1050 if (P.Name == "root")
1054 O << "class " << P.Name << " : public ";
1059 O << " {\npublic:\n";
1061 EmitNameMethod(P, O);
1062 EmitInOutLanguageMethods(P, O);
1063 EmitOutputSuffixMethod(P, O);
1064 EmitIsJoinMethod(P, O);
1065 EmitGenerateActionMethods(P, OptDescs, O);
1066 EmitIsLastMethod(P, O);
1068 // Close class definition
1072 /// EmitOptionDescriptions - Iterate over a list of option
1073 /// descriptions and emit registration code.
1074 void EmitOptionDescriptions (const GlobalOptionDescriptions& descs,
1077 // Emit static cl::Option variables
1078 for (GlobalOptionDescriptions::const_iterator B = descs.begin(),
1079 E = descs.end(); B!=E; ++B) {
1080 const GlobalOptionDescription& val = B->second;
1082 O << val.GenTypeDeclaration() << ' '
1083 << val.GenVariableName()
1084 << "(\"" << val.Name << '\"';
1086 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1087 O << ", cl::Prefix";
1089 if (val.isRequired()) {
1091 case OptionType::PrefixList:
1092 case OptionType::ParameterList:
1093 O << ", cl::OneOrMore";
1096 O << ", cl::Required";
1100 O << ", cl::desc(\"" << val.Help << "\"));\n";
1104 O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
1109 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1110 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1112 // Get the relevant field out of RecordKeeper
1113 Record* LangMapRecord = Records.getDef("LanguageMap");
1115 throw std::string("Language map definition not found!");
1117 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1118 if (!LangsToSuffixesList)
1119 throw std::string("Error in the language map definition!");
1122 O << "void llvmc::PopulateLanguageMap(LanguageMap& language_map) {\n";
1124 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1125 Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1127 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1128 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1130 for (unsigned i = 0; i < Suffixes->size(); ++i)
1131 O << Indent1 << "language_map[\""
1132 << InitPtrToString(Suffixes->getElement(i))
1133 << "\"] = \"" << Lang << "\";\n";
1139 /// FillInToolToLang - Fills in two tables that map tool names to
1140 /// (input, output) languages. Used by the typechecker.
1141 void FillInToolToLang (const ToolPropertiesList& TPList,
1142 StringMap<std::string>& ToolToInLang,
1143 StringMap<std::string>& ToolToOutLang) {
1144 for (ToolPropertiesList::const_iterator B = TPList.begin(), E = TPList.end();
1146 const ToolProperties& P = *(*B);
1147 ToolToInLang[P.Name] = P.InLanguage;
1148 ToolToOutLang[P.Name] = P.OutLanguage;
1152 /// TypecheckGraph - Check that names for output and input languages
1153 /// on all edges do match.
1154 // TOFIX: check for cycles.
1155 // TOFIX: check for multiple default edges.
1156 void TypecheckGraph (Record* CompilationGraph,
1157 const ToolPropertiesList& TPList) {
1158 StringMap<std::string> ToolToInLang;
1159 StringMap<std::string> ToolToOutLang;
1161 FillInToolToLang(TPList, ToolToInLang, ToolToOutLang);
1162 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1163 StringMap<std::string>::iterator IAE = ToolToInLang.end();
1164 StringMap<std::string>::iterator IBE = ToolToOutLang.end();
1166 for (unsigned i = 0; i < edges->size(); ++i) {
1167 Record* Edge = edges->getElementAsRecord(i);
1168 Record* A = Edge->getValueAsDef("a");
1169 Record* B = Edge->getValueAsDef("b");
1170 StringMap<std::string>::iterator IA = ToolToOutLang.find(A->getName());
1171 StringMap<std::string>::iterator IB = ToolToInLang.find(B->getName());
1173 throw A->getName() + ": no such tool!";
1175 throw B->getName() + ": no such tool!";
1176 if (A->getName() != "root" && IA->second != IB->second)
1177 throw "Edge " + A->getName() + "->" + B->getName()
1178 + ": output->input language mismatch";
1179 if (B->getName() == "root")
1180 throw std::string("Edges back to the root are not allowed!");
1184 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1185 /// by EmitEdgeClass().
1186 void IncDecWeight (const Init* i, const char* IndentLevel,
1188 const DagInit& d = InitPtrToDagInitRef(i);
1189 const std::string& OpName = d.getOperator()->getAsString();
1191 if (OpName == "inc_weight")
1192 O << IndentLevel << Indent1 << "ret += ";
1193 else if (OpName == "dec_weight")
1194 O << IndentLevel << Indent1 << "ret -= ";
1196 throw "Unknown operator in edge properties list: " + OpName + '!';
1198 if (d.getNumArgs() > 0)
1199 O << InitPtrToInt(d.getArg(0)) << ";\n";
1205 /// EmitEdgeClass - Emit a single Edge# class.
1206 void EmitEdgeClass (unsigned N, const std::string& Target,
1207 DagInit* Case, const GlobalOptionDescriptions& OptDescs,
1210 // Class constructor.
1211 O << "class Edge" << N << ": public Edge {\n"
1213 << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1216 // Function Weight().
1217 << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1218 << Indent2 << "unsigned ret = 0;\n";
1220 // Handle the 'case' construct.
1221 EmitCaseConstructHandler(Case, Indent2, IncDecWeight, OptDescs, O);
1223 O << Indent2 << "return ret;\n"
1224 << Indent1 << "};\n\n};\n\n";
1227 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1228 void EmitEdgeClasses (Record* CompilationGraph,
1229 const GlobalOptionDescriptions& OptDescs,
1231 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1233 for (unsigned i = 0; i < edges->size(); ++i) {
1234 Record* Edge = edges->getElementAsRecord(i);
1235 Record* B = Edge->getValueAsDef("b");
1236 DagInit* Weight = Edge->getValueAsDag("weight");
1238 if (isDagEmpty(Weight))
1241 EmitEdgeClass(i, B->getName(), Weight, OptDescs, O);
1245 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1247 void EmitPopulateCompilationGraph (Record* CompilationGraph,
1250 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1253 O << "void llvmc::PopulateCompilationGraph(CompilationGraph& G) {\n"
1254 << Indent1 << "PopulateLanguageMap(G.ExtsToLangs);\n\n";
1258 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1260 throw std::string("No tool definitions found!");
1262 for (RecordVector::iterator B = Tools.begin(), E = Tools.end(); B != E; ++B) {
1263 const std::string& Name = (*B)->getName();
1265 O << Indent1 << "G.insertNode(new "
1266 << Name << "());\n";
1272 for (unsigned i = 0; i < edges->size(); ++i) {
1273 Record* Edge = edges->getElementAsRecord(i);
1274 Record* A = Edge->getValueAsDef("a");
1275 Record* B = Edge->getValueAsDef("b");
1276 DagInit* Weight = Edge->getValueAsDag("weight");
1278 O << Indent1 << "G.insertEdge(\"" << A->getName() << "\", ";
1280 if (isDagEmpty(Weight))
1281 O << "new SimpleEdge(\"" << B->getName() << "\")";
1283 O << "new Edge" << i << "()";
1291 /// ExtractHookNames - Extract the hook names from all instances of
1292 /// $CALL(HookName) in the provided command line string. Helper
1293 /// function used by FillInHookNames().
1294 void ExtractHookNames(const Init* CmdLine, StrVector& HookNames) {
1296 llvm::SplitString(InitPtrToString(CmdLine), cmds, ") ");
1297 for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1299 const std::string& cmd = *B;
1300 if (cmd.find("$CALL(") == 0) {
1301 if (cmd.size() == 6)
1302 throw std::string("$CALL invocation: empty argument list!");
1303 HookNames.push_back(std::string(cmd.c_str() + 6));
1308 /// FillInHookNames - Actually extract the hook names from all command
1309 /// line strings. Helper function used by EmitHookDeclarations().
1310 void FillInHookNames(const ToolPropertiesList& TPList,
1311 StrVector& HookNames) {
1312 for (ToolPropertiesList::const_iterator B = TPList.begin(),
1313 E = TPList.end(); B != E; ++B) {
1314 const ToolProperties& P = *(*B);
1317 if (typeid(*P.CmdLine) == typeid(StringInit)) {
1318 // This is a string.
1319 ExtractHookNames(P.CmdLine, HookNames);
1322 // This is a 'case' construct.
1323 const DagInit& d = InitPtrToDagInitRef(P.CmdLine);
1325 for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
1328 ExtractHookNames(*B, HookNames);
1335 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1336 /// property records and emit hook function declaration for each
1337 /// instance of $CALL(HookName).
1338 void EmitHookDeclarations(const ToolPropertiesList& ToolProps,
1340 StrVector HookNames;
1341 FillInHookNames(ToolProps, HookNames);
1342 if (HookNames.empty())
1344 std::sort(HookNames.begin(), HookNames.end());
1345 StrVector::const_iterator E = std::unique(HookNames.begin(), HookNames.end());
1347 O << "namespace hooks {\n";
1348 for (StrVector::const_iterator B = HookNames.begin(); B != E; ++B)
1349 O << Indent1 << "std::string " << *B << "();\n";
1354 // End of anonymous namespace
1357 /// run - The back-end entry point.
1358 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1360 // Emit file header.
1361 EmitSourceFileHeader("LLVMC Configuration Library", O);
1363 // Get a list of all defined Tools.
1364 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1366 throw std::string("No tool definitions found!");
1368 // Gather information from the Tool description dags.
1369 ToolPropertiesList tool_props;
1370 GlobalOptionDescriptions opt_descs;
1371 CollectToolProperties(Tools.begin(), Tools.end(), tool_props, opt_descs);
1373 // Emit global option registration code.
1374 EmitOptionDescriptions(opt_descs, O);
1376 // Emit hook declarations.
1377 EmitHookDeclarations(tool_props, O);
1379 // Emit PopulateLanguageMap() function
1380 // (a language map maps from file extensions to language names).
1381 EmitPopulateLanguageMap(Records, O);
1383 // Emit Tool classes.
1384 for (ToolPropertiesList::const_iterator B = tool_props.begin(),
1385 E = tool_props.end(); B!=E; ++B)
1386 EmitToolClassDefinition(*(*B), opt_descs, O);
1388 Record* CompilationGraphRecord = Records.getDef("CompilationGraph");
1389 if (!CompilationGraphRecord)
1390 throw std::string("Compilation graph description not found!");
1392 // Typecheck the compilation graph.
1393 TypecheckGraph(CompilationGraphRecord, tool_props);
1395 // Emit Edge# classes.
1396 EmitEdgeClasses(CompilationGraphRecord, opt_descs, O);
1398 // Emit PopulateCompilationGraph() function.
1399 EmitPopulateCompilationGraph(CompilationGraphRecord, O);