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, OutputSuffix };
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_["output_suffix"] =
401 &CollectProperties::onOutputSuffixOptionProp;
402 optionPropertyHandlers_["required"] = &CollectProperties::onRequired;
403 optionPropertyHandlers_["stop_compilation"] =
404 &CollectProperties::onStopCompilation;
405 optionPropertyHandlers_["unpack_values"] =
406 &CollectProperties::onUnpackValues;
408 staticMembersInitialized_ = true;
412 /// operator() - Gets called for every tool property; Just forwards
413 /// to the corresponding property handler.
414 void operator() (Init* i) {
415 const DagInit& d = InitPtrToDagInitRef(i);
416 const std::string& property_name = d.getOperator()->getAsString();
417 PropertyHandlerMap::iterator method
418 = propertyHandlers_.find(property_name);
420 if (method != propertyHandlers_.end()) {
421 PropertyHandler h = method->second;
425 throw "Unknown tool property: " + property_name + "!";
431 /// Property handlers --
432 /// Functions that extract information about tool properties from
433 /// DAG representation.
435 void onCmdLine (const DagInit* d) {
436 checkNumberOfArguments(d, 1);
437 toolProps_.CmdLine = d->getArg(0);
440 void onInLanguage (const DagInit* d) {
441 checkNumberOfArguments(d, 1);
442 toolProps_.InLanguage = InitPtrToString(d->getArg(0));
445 void onJoin (const DagInit* d) {
446 checkNumberOfArguments(d, 0);
447 toolProps_.setJoin();
450 void onOutLanguage (const DagInit* d) {
451 checkNumberOfArguments(d, 1);
452 toolProps_.OutLanguage = InitPtrToString(d->getArg(0));
455 void onOutputSuffix (const DagInit* d) {
456 checkNumberOfArguments(d, 1);
457 toolProps_.OutputSuffix = InitPtrToString(d->getArg(0));
460 void onSink (const DagInit* d) {
461 checkNumberOfArguments(d, 0);
462 optDescs_.HasSink = true;
463 toolProps_.setSink();
466 void onSwitch (const DagInit* d) {
467 addOption(d, OptionType::Switch);
470 void onParameter (const DagInit* d) {
471 addOption(d, OptionType::Parameter);
474 void onParameterList (const DagInit* d) {
475 addOption(d, OptionType::ParameterList);
478 void onPrefix (const DagInit* d) {
479 addOption(d, OptionType::Prefix);
482 void onPrefixList (const DagInit* d) {
483 addOption(d, OptionType::PrefixList);
486 /// Option property handlers --
487 /// Methods that handle properties that are common for all types of
488 /// options (like append_cmd, stop_compilation)
490 void onAppendCmd (const DagInit* d, GlobalOptionDescription& o) {
491 checkNumberOfArguments(d, 1);
492 const std::string& cmd = InitPtrToString(d->getArg(0));
494 toolProps_.OptDescs[o.Name].AddProperty(OptionPropertyType::AppendCmd, cmd);
497 void onOutputSuffixOptionProp (const DagInit* d, GlobalOptionDescription& o) {
498 checkNumberOfArguments(d, 1);
499 const std::string& suf = InitPtrToString(d->getArg(0));
501 if (toolProps_.OptDescs[o.Name].Type != OptionType::Switch)
502 throw "Option " + o.Name
503 + " can't have 'output_suffix' property since it isn't a switch!";
505 toolProps_.OptDescs[o.Name].AddProperty
506 (OptionPropertyType::OutputSuffix, suf);
509 void onForward (const DagInit* d, GlobalOptionDescription& o) {
510 checkNumberOfArguments(d, 0);
511 toolProps_.OptDescs[o.Name].setForward();
514 void onHelp (const DagInit* d, GlobalOptionDescription& o) {
515 checkNumberOfArguments(d, 1);
516 const std::string& help_message = InitPtrToString(d->getArg(0));
518 o.Help = help_message;
521 void onRequired (const DagInit* d, GlobalOptionDescription& o) {
522 checkNumberOfArguments(d, 0);
526 void onStopCompilation (const DagInit* d, GlobalOptionDescription& o) {
527 checkNumberOfArguments(d, 0);
528 if (o.Type != OptionType::Switch)
529 throw std::string("Only options of type Switch can stop compilation!");
530 toolProps_.OptDescs[o.Name].setStopCompilation();
533 void onUnpackValues (const DagInit* d, GlobalOptionDescription& o) {
534 checkNumberOfArguments(d, 0);
535 toolProps_.OptDescs[o.Name].setUnpackValues();
540 // Add an option of type t
541 void addOption (const DagInit* d, OptionType::OptionType t) {
542 checkNumberOfArguments(d, 2);
543 const std::string& name = InitPtrToString(d->getArg(0));
545 GlobalOptionDescription o(t, name);
546 toolProps_.OptDescs[name].Type = t;
547 toolProps_.OptDescs[name].Name = name;
548 processOptionProperties(d, o);
549 insertDescription(o);
552 // Insert new GlobalOptionDescription into GlobalOptionDescriptions list
553 void insertDescription (const GlobalOptionDescription& o)
555 if (optDescs_.Descriptions.count(o.Name)) {
556 GlobalOptionDescription& D = optDescs_.Descriptions[o.Name];
560 optDescs_.Descriptions[o.Name] = o;
564 /// processOptionProperties - Go through the list of option
565 /// properties and call a corresponding handler for each.
568 /// name - option name
569 /// d - option property list
570 void processOptionProperties (const DagInit* d, GlobalOptionDescription& o) {
571 // First argument is option name
572 checkNumberOfArguments(d, 2);
574 for (unsigned B = 1, E = d->getNumArgs(); B!=E; ++B) {
575 const DagInit& option_property
576 = InitPtrToDagInitRef(d->getArg(B));
577 const std::string& option_property_name
578 = option_property.getOperator()->getAsString();
579 OptionPropertyHandlerMap::iterator method
580 = optionPropertyHandlers_.find(option_property_name);
582 if (method != optionPropertyHandlers_.end()) {
583 OptionPropertyHandler h = method->second;
584 (this->*h)(&option_property, o);
587 throw "Unknown option property: " + option_property_name + "!";
593 // Static members of CollectProperties
594 CollectProperties::PropertyHandlerMap
595 CollectProperties::propertyHandlers_;
597 CollectProperties::OptionPropertyHandlerMap
598 CollectProperties::optionPropertyHandlers_;
600 bool CollectProperties::staticMembersInitialized_ = false;
603 /// CollectToolProperties - Gather information from the parsed
604 /// TableGen data (basically a wrapper for the CollectProperties
605 /// function object).
606 void CollectToolProperties (RecordVector::const_iterator B,
607 RecordVector::const_iterator E,
608 ToolPropertiesList& TPList,
609 GlobalOptionDescriptions& OptDescs)
611 // Iterate over a properties list of every Tool definition
613 RecordVector::value_type T = *B;
614 ListInit* PropList = T->getValueAsListInit("properties");
616 IntrusiveRefCntPtr<ToolProperties>
617 ToolProps(new ToolProperties(T->getName()));
619 std::for_each(PropList->begin(), PropList->end(),
620 CollectProperties(*ToolProps, OptDescs));
621 TPList.push_back(ToolProps);
625 /// EmitCaseTest1Arg - Helper function used by
626 /// EmitCaseConstructHandler.
627 bool EmitCaseTest1Arg(const std::string& TestName,
629 const GlobalOptionDescriptions& OptDescs,
631 checkNumberOfArguments(&d, 1);
632 const std::string& OptName = InitPtrToString(d.getArg(0));
633 if (TestName == "switch_on") {
634 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
635 if (OptDesc.Type != OptionType::Switch)
636 throw OptName + ": incorrect option type!";
637 O << OptDesc.GenVariableName();
639 } else if (TestName == "input_languages_contain") {
640 O << "InLangs.count(\"" << OptName << "\") != 0";
647 /// EmitCaseTest2Args - Helper function used by
648 /// EmitCaseConstructHandler.
649 bool EmitCaseTest2Args(const std::string& TestName,
651 const char* IndentLevel,
652 const GlobalOptionDescriptions& OptDescs,
654 checkNumberOfArguments(&d, 2);
655 const std::string& OptName = InitPtrToString(d.getArg(0));
656 const std::string& OptArg = InitPtrToString(d.getArg(1));
657 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
659 if (TestName == "parameter_equals") {
660 if (OptDesc.Type != OptionType::Parameter
661 && OptDesc.Type != OptionType::Prefix)
662 throw OptName + ": incorrect option type!";
663 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
666 else if (TestName == "element_in_list") {
667 if (OptDesc.Type != OptionType::ParameterList
668 && OptDesc.Type != OptionType::PrefixList)
669 throw OptName + ": incorrect option type!";
670 const std::string& VarName = OptDesc.GenVariableName();
671 O << "std::find(" << VarName << ".begin(),\n"
672 << IndentLevel << Indent1 << VarName << ".end(), \""
673 << OptArg << "\") != " << VarName << ".end()";
680 // Forward declaration.
681 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
682 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
683 const GlobalOptionDescriptions& OptDescs,
686 /// EmitLogicalOperationTest - Helper function used by
687 /// EmitCaseConstructHandler.
688 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
689 const char* IndentLevel,
690 const GlobalOptionDescriptions& OptDescs,
693 for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
694 const DagInit& InnerTest = InitPtrToDagInitRef(d.getArg(j));
695 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
696 if (j != NumArgs - 1)
697 O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
703 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
704 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
705 const GlobalOptionDescriptions& OptDescs,
707 const std::string& TestName = d.getOperator()->getAsString();
709 if (TestName == "and")
710 EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
711 else if (TestName == "or")
712 EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
713 else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
715 else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
718 throw TestName + ": unknown edge property!";
721 // Emit code that handles the 'case' construct.
722 // Takes a function object that should emit code for every case clause.
723 // Callback's type is
724 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
725 template <typename F>
726 void EmitCaseConstructHandler(const DagInit* d, const char* IndentLevel,
727 const F& Callback, bool DefaultRequired,
728 const GlobalOptionDescriptions& OptDescs,
730 assert(d->getOperator()->getAsString() == "case");
732 bool DefaultProvided = false;
733 unsigned numArgs = d->getNumArgs();
734 if (d->getNumArgs() < 2)
735 throw "There should be at least one clause in the 'case' expression:\n"
738 for (unsigned i = 0; i != numArgs; ++i) {
739 const DagInit& Test = InitPtrToDagInitRef(d->getArg(i));
742 if (Test.getOperator()->getAsString() == "default") {
743 DefaultProvided = true;
745 throw std::string("The 'default' clause should be the last in the"
746 "'case' construct!");
747 O << IndentLevel << "else {\n";
750 O << IndentLevel << "if (";
751 EmitCaseTest(Test, IndentLevel, OptDescs, O);
755 // Emit the corresponding statement.
758 throw "Case construct handler: no corresponding action "
759 "found for the test " + Test.getAsString() + '!';
761 Callback(d->getArg(i), IndentLevel, O);
762 O << IndentLevel << "}\n";
765 if (DefaultRequired && !DefaultProvided)
766 throw "Case expression: the 'default' clause is required in this case:\n"
770 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
771 /// implement EmitOptionPropertyHandlingCode(). Emits code for
772 /// handling the (forward) option property.
773 void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D,
776 case OptionType::Switch:
777 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
779 case OptionType::Parameter:
780 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
781 O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n";
783 case OptionType::Prefix:
784 O << Indent3 << "vec.push_back(\"-" << D.Name << "\" + "
785 << D.GenVariableName() << ");\n";
787 case OptionType::PrefixList:
788 O << Indent3 << "for (" << D.GenTypeDeclaration()
789 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
790 << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
791 << Indent4 << "vec.push_back(\"-" << D.Name << "\" + "
794 case OptionType::ParameterList:
795 O << Indent3 << "for (" << D.GenTypeDeclaration()
796 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
797 << Indent3 << "E = " << D.GenVariableName()
798 << ".end() ; B != E; ++B) {\n"
799 << Indent4 << "vec.push_back(\"-" << D.Name << "\");\n"
800 << Indent4 << "vec.push_back(*B);\n"
806 // ToolOptionHasInterestingProperties - A helper function used by
807 // EmitOptionPropertyHandlingCode() that tells us whether we should
808 // emit any property handling code at all.
809 bool ToolOptionHasInterestingProperties(const ToolOptionDescription& D) {
811 for (OptionPropertyList::const_iterator B = D.Props.begin(),
812 E = D.Props.end(); B != E; ++B) {
813 const OptionProperty& OptProp = *B;
814 if (OptProp.first == OptionPropertyType::AppendCmd)
817 if (D.isForward() || D.isUnpackValues())
822 /// EmitOptionPropertyHandlingCode - Helper function used by
823 /// EmitGenerateActionMethod(). Emits code that handles option
825 void EmitOptionPropertyHandlingCode (const ToolOptionDescription& D,
828 if (!ToolOptionHasInterestingProperties(D))
830 // Start of the if-clause.
831 O << Indent2 << "if (";
832 if (D.Type == OptionType::Switch)
833 O << D.GenVariableName();
835 O << '!' << D.GenVariableName() << ".empty()";
839 // Handle option properties that take an argument.
840 for (OptionPropertyList::const_iterator B = D.Props.begin(),
841 E = D.Props.end(); B!=E; ++B) {
842 const OptionProperty& val = *B;
845 // (append_cmd cmd) property
846 case OptionPropertyType::AppendCmd:
847 O << Indent3 << "vec.push_back(\"" << val.second << "\");\n";
849 // Other properties with argument
857 // (forward) property
859 EmitForwardOptionPropertyHandlingCode(D, O);
861 // (unpack_values) property
862 if (D.isUnpackValues()) {
863 if (IsListOptionType(D.Type)) {
864 O << Indent3 << "for (" << D.GenTypeDeclaration()
865 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
866 << Indent3 << "E = " << D.GenVariableName()
867 << ".end(); B != E; ++B)\n"
868 << Indent4 << "llvm::SplitString(*B, vec, \",\");\n";
870 else if (D.Type == OptionType::Prefix || D.Type == OptionType::Parameter){
871 O << Indent3 << "llvm::SplitString("
872 << D.GenVariableName() << ", vec, \",\");\n";
875 throw std::string("Switches can't have unpack_values property!");
879 // End of the if-clause.
880 O << Indent2 << "}\n";
883 /// SubstituteSpecialCommands - Perform string substitution for $CALL
884 /// and $ENV. Helper function used by EmitCmdLineVecFill().
885 std::string SubstituteSpecialCommands(const std::string& cmd) {
886 size_t cparen = cmd.find(")");
889 if (cmd.find("$CALL(") == 0) {
891 throw std::string("$CALL invocation: empty argument list!");
894 ret += std::string(cmd.begin() + 6, cmd.begin() + cparen);
897 else if (cmd.find("$ENV(") == 0) {
899 throw std::string("$ENV invocation: empty argument list!");
901 ret += "std::getenv(\"";
902 ret += std::string(cmd.begin() + 5, cmd.begin() + cparen);
906 throw "Unknown special command: " + cmd;
909 if (cmd.begin() + cparen + 1 != cmd.end()) {
910 ret += " + std::string(\"";
911 ret += (cmd.c_str() + cparen + 1);
918 /// EmitCmdLineVecFill - Emit code that fills in the command line
919 /// vector. Helper function used by EmitGenerateActionMethod().
920 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
921 bool Version, const char* IndentLevel,
924 SplitString(InitPtrToString(CmdLine), StrVec);
926 throw "Tool " + ToolName + " has empty command line!";
928 StrVector::const_iterator I = StrVec.begin();
930 for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
931 const std::string& cmd = *I;
933 if (cmd.at(0) == '$') {
934 if (cmd == "$INFILE") {
936 O << "for (PathVector::const_iterator B = inFiles.begin()"
937 << ", E = inFiles.end();\n"
938 << IndentLevel << "B != E; ++B)\n"
939 << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
941 O << "vec.push_back(inFile.toString());\n";
943 else if (cmd == "$OUTFILE") {
944 O << "vec.push_back(outFile.toString());\n";
947 O << "vec.push_back(" << SubstituteSpecialCommands(cmd);
952 O << "vec.push_back(\"" << cmd << "\");\n";
955 O << IndentLevel << "ret = Action("
956 << ((StrVec[0][0] == '$') ? SubstituteSpecialCommands(StrVec[0])
957 : "\"" + StrVec[0] + "\"")
961 /// EmitCmdLineVecFillCallback - A function object wrapper around
962 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
963 /// argument to EmitCaseConstructHandler().
964 class EmitCmdLineVecFillCallback {
966 const std::string& ToolName;
968 EmitCmdLineVecFillCallback(bool Ver, const std::string& TN)
969 : Version(Ver), ToolName(TN) {}
971 void operator()(const Init* Statement, const char* IndentLevel,
972 std::ostream& O) const
974 EmitCmdLineVecFill(Statement, ToolName, Version,
975 (std::string(IndentLevel) + Indent1).c_str(), O);
979 // EmitGenerateActionMethod - Emit one of two versions of the
980 // Tool::GenerateAction() method.
981 void EmitGenerateActionMethod (const ToolProperties& P,
982 const GlobalOptionDescriptions& OptDescs,
983 bool Version, std::ostream& O) {
985 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
987 O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
989 O << Indent2 << "const sys::Path& outFile,\n"
990 << Indent2 << "const InputLanguagesSet& InLangs) const\n"
992 << Indent2 << "Action ret;\n"
993 << Indent2 << "std::vector<std::string> vec;\n";
995 // cmd_line is either a string or a 'case' construct.
996 if (typeid(*P.CmdLine) == typeid(StringInit))
997 EmitCmdLineVecFill(P.CmdLine, P.Name, Version, Indent2, O);
999 EmitCaseConstructHandler(&InitPtrToDagInitRef(P.CmdLine), Indent2,
1000 EmitCmdLineVecFillCallback(Version, P.Name),
1003 // For every understood option, emit handling code.
1004 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1005 E = P.OptDescs.end(); B != E; ++B) {
1006 const ToolOptionDescription& val = B->second;
1007 EmitOptionPropertyHandlingCode(val, O);
1010 // Handle the Sink property.
1012 O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
1013 << Indent3 << "vec.insert(vec.end(), "
1014 << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
1015 << Indent2 << "}\n";
1018 O << Indent2 << "return ret;\n"
1019 << Indent1 << "}\n\n";
1022 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
1023 /// a given Tool class.
1024 void EmitGenerateActionMethods (const ToolProperties& P,
1025 const GlobalOptionDescriptions& OptDescs,
1028 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
1029 << Indent2 << "const llvm::sys::Path& outFile,\n"
1030 << Indent2 << "const InputLanguagesSet& InLangs) const\n"
1032 << Indent2 << "throw std::runtime_error(\"" << P.Name
1033 << " is not a Join tool!\");\n"
1034 << Indent1 << "}\n\n";
1036 EmitGenerateActionMethod(P, OptDescs, true, O);
1038 EmitGenerateActionMethod(P, OptDescs, false, O);
1041 /// EmitIsLastMethod - Emit the IsLast() method for a given Tool
1043 void EmitIsLastMethod (const ToolProperties& P, std::ostream& O) {
1044 O << Indent1 << "bool IsLast() const {\n"
1045 << Indent2 << "bool last = false;\n";
1047 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1048 E = P.OptDescs.end(); B != E; ++B) {
1049 const ToolOptionDescription& val = B->second;
1051 if (val.isStopCompilation())
1053 << "if (" << val.GenVariableName()
1054 << ")\n" << Indent3 << "last = true;\n";
1057 O << Indent2 << "return last;\n"
1058 << Indent1 << "}\n\n";
1061 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1062 /// methods for a given Tool class.
1063 void EmitInOutLanguageMethods (const ToolProperties& P, std::ostream& O) {
1064 O << Indent1 << "const char* InputLanguage() const {\n"
1065 << Indent2 << "return \"" << P.InLanguage << "\";\n"
1066 << Indent1 << "}\n\n";
1068 O << Indent1 << "const char* OutputLanguage() const {\n"
1069 << Indent2 << "return \"" << P.OutLanguage << "\";\n"
1070 << Indent1 << "}\n\n";
1073 /// EmitOutputSuffixMethod - Emit the OutputSuffix() method for a
1074 /// given Tool class.
1075 void EmitOutputSuffixMethod (const ToolProperties& P, std::ostream& O) {
1076 O << Indent1 << "const char* OutputSuffix() const {\n"
1077 << Indent2 << "const char* ret = \"" << P.OutputSuffix << "\";\n";
1079 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1080 E = P.OptDescs.end(); B != E; ++B) {
1081 const ToolOptionDescription& OptDesc = B->second;
1082 for (OptionPropertyList::const_iterator B = OptDesc.Props.begin(),
1083 E = OptDesc.Props.end(); B != E; ++B) {
1084 const OptionProperty& OptProp = *B;
1085 if (OptProp.first == OptionPropertyType::OutputSuffix) {
1086 O << Indent2 << "if (" << OptDesc.GenVariableName() << ")\n"
1087 << Indent3 << "ret = \"" << OptProp.second << "\";\n";
1092 O << Indent2 << "return ret;\n"
1093 << Indent1 << "}\n\n";
1096 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1097 void EmitNameMethod (const ToolProperties& P, std::ostream& O) {
1098 O << Indent1 << "const char* Name() const {\n"
1099 << Indent2 << "return \"" << P.Name << "\";\n"
1100 << Indent1 << "}\n\n";
1103 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1105 void EmitIsJoinMethod (const ToolProperties& P, std::ostream& O) {
1106 O << Indent1 << "bool IsJoin() const {\n";
1108 O << Indent2 << "return true;\n";
1110 O << Indent2 << "return false;\n";
1111 O << Indent1 << "}\n\n";
1114 /// EmitToolClassDefinition - Emit a Tool class definition.
1115 void EmitToolClassDefinition (const ToolProperties& P,
1116 const GlobalOptionDescriptions& OptDescs,
1118 if (P.Name == "root")
1122 O << "class " << P.Name << " : public ";
1127 O << " {\npublic:\n";
1129 EmitNameMethod(P, O);
1130 EmitInOutLanguageMethods(P, O);
1131 EmitOutputSuffixMethod(P, O);
1132 EmitIsJoinMethod(P, O);
1133 EmitGenerateActionMethods(P, OptDescs, O);
1134 EmitIsLastMethod(P, O);
1136 // Close class definition
1140 /// EmitOptionDescriptions - Iterate over a list of option
1141 /// descriptions and emit registration code.
1142 void EmitOptionDescriptions (const GlobalOptionDescriptions& descs,
1145 // Emit static cl::Option variables
1146 for (GlobalOptionDescriptions::const_iterator B = descs.begin(),
1147 E = descs.end(); B!=E; ++B) {
1148 const GlobalOptionDescription& val = B->second;
1150 O << val.GenTypeDeclaration() << ' '
1151 << val.GenVariableName()
1152 << "(\"" << val.Name << '\"';
1154 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1155 O << ", cl::Prefix";
1157 if (val.isRequired()) {
1159 case OptionType::PrefixList:
1160 case OptionType::ParameterList:
1161 O << ", cl::OneOrMore";
1164 O << ", cl::Required";
1168 O << ", cl::desc(\"" << val.Help << "\"));\n";
1172 O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
1177 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1178 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1180 // Get the relevant field out of RecordKeeper
1181 Record* LangMapRecord = Records.getDef("LanguageMap");
1183 throw std::string("Language map definition not found!");
1185 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1186 if (!LangsToSuffixesList)
1187 throw std::string("Error in the language map definition!");
1190 O << "void llvmc::PopulateLanguageMap(LanguageMap& language_map) {\n";
1192 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1193 Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1195 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1196 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1198 for (unsigned i = 0; i < Suffixes->size(); ++i)
1199 O << Indent1 << "language_map[\""
1200 << InitPtrToString(Suffixes->getElement(i))
1201 << "\"] = \"" << Lang << "\";\n";
1207 /// FillInToolToLang - Fills in two tables that map tool names to
1208 /// (input, output) languages. Used by the typechecker.
1209 void FillInToolToLang (const ToolPropertiesList& TPList,
1210 StringMap<std::string>& ToolToInLang,
1211 StringMap<std::string>& ToolToOutLang) {
1212 for (ToolPropertiesList::const_iterator B = TPList.begin(), E = TPList.end();
1214 const ToolProperties& P = *(*B);
1215 ToolToInLang[P.Name] = P.InLanguage;
1216 ToolToOutLang[P.Name] = P.OutLanguage;
1220 /// TypecheckGraph - Check that names for output and input languages
1221 /// on all edges do match.
1222 // TOFIX: check for cycles.
1223 // TOFIX: check for multiple default edges.
1224 void TypecheckGraph (Record* CompilationGraph,
1225 const ToolPropertiesList& TPList) {
1226 StringMap<std::string> ToolToInLang;
1227 StringMap<std::string> ToolToOutLang;
1229 FillInToolToLang(TPList, ToolToInLang, ToolToOutLang);
1230 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1231 StringMap<std::string>::iterator IAE = ToolToInLang.end();
1232 StringMap<std::string>::iterator IBE = ToolToOutLang.end();
1234 for (unsigned i = 0; i < edges->size(); ++i) {
1235 Record* Edge = edges->getElementAsRecord(i);
1236 Record* A = Edge->getValueAsDef("a");
1237 Record* B = Edge->getValueAsDef("b");
1238 StringMap<std::string>::iterator IA = ToolToOutLang.find(A->getName());
1239 StringMap<std::string>::iterator IB = ToolToInLang.find(B->getName());
1241 throw A->getName() + ": no such tool!";
1243 throw B->getName() + ": no such tool!";
1244 if (A->getName() != "root" && IA->second != IB->second)
1245 throw "Edge " + A->getName() + "->" + B->getName()
1246 + ": output->input language mismatch";
1247 if (B->getName() == "root")
1248 throw std::string("Edges back to the root are not allowed!");
1252 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1253 /// by EmitEdgeClass().
1254 void IncDecWeight (const Init* i, const char* IndentLevel,
1256 const DagInit& d = InitPtrToDagInitRef(i);
1257 const std::string& OpName = d.getOperator()->getAsString();
1259 if (OpName == "inc_weight")
1260 O << IndentLevel << Indent1 << "ret += ";
1261 else if (OpName == "dec_weight")
1262 O << IndentLevel << Indent1 << "ret -= ";
1264 throw "Unknown operator in edge properties list: " + OpName + '!';
1266 if (d.getNumArgs() > 0)
1267 O << InitPtrToInt(d.getArg(0)) << ";\n";
1273 /// EmitEdgeClass - Emit a single Edge# class.
1274 void EmitEdgeClass (unsigned N, const std::string& Target,
1275 DagInit* Case, const GlobalOptionDescriptions& OptDescs,
1278 // Class constructor.
1279 O << "class Edge" << N << ": public Edge {\n"
1281 << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1284 // Function Weight().
1285 << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1286 << Indent2 << "unsigned ret = 0;\n";
1288 // Handle the 'case' construct.
1289 EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
1291 O << Indent2 << "return ret;\n"
1292 << Indent1 << "};\n\n};\n\n";
1295 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1296 void EmitEdgeClasses (Record* CompilationGraph,
1297 const GlobalOptionDescriptions& OptDescs,
1299 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1301 for (unsigned i = 0; i < edges->size(); ++i) {
1302 Record* Edge = edges->getElementAsRecord(i);
1303 Record* B = Edge->getValueAsDef("b");
1304 DagInit* Weight = Edge->getValueAsDag("weight");
1306 if (isDagEmpty(Weight))
1309 EmitEdgeClass(i, B->getName(), Weight, OptDescs, O);
1313 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1315 void EmitPopulateCompilationGraph (Record* CompilationGraph,
1318 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1321 O << "void llvmc::PopulateCompilationGraph(CompilationGraph& G) {\n"
1322 << Indent1 << "PopulateLanguageMap(G.ExtsToLangs);\n\n";
1326 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1328 throw std::string("No tool definitions found!");
1330 for (RecordVector::iterator B = Tools.begin(), E = Tools.end(); B != E; ++B) {
1331 const std::string& Name = (*B)->getName();
1333 O << Indent1 << "G.insertNode(new "
1334 << Name << "());\n";
1340 for (unsigned i = 0; i < edges->size(); ++i) {
1341 Record* Edge = edges->getElementAsRecord(i);
1342 Record* A = Edge->getValueAsDef("a");
1343 Record* B = Edge->getValueAsDef("b");
1344 DagInit* Weight = Edge->getValueAsDag("weight");
1346 O << Indent1 << "G.insertEdge(\"" << A->getName() << "\", ";
1348 if (isDagEmpty(Weight))
1349 O << "new SimpleEdge(\"" << B->getName() << "\")";
1351 O << "new Edge" << i << "()";
1359 /// ExtractHookNames - Extract the hook names from all instances of
1360 /// $CALL(HookName) in the provided command line string. Helper
1361 /// function used by FillInHookNames().
1362 void ExtractHookNames(const Init* CmdLine, StrVector& HookNames) {
1364 llvm::SplitString(InitPtrToString(CmdLine), cmds);
1365 for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1367 const std::string& cmd = *B;
1368 if (cmd.find("$CALL(") == 0) {
1369 if (cmd.size() == 6)
1370 throw std::string("$CALL invocation: empty argument list!");
1371 HookNames.push_back(std::string(cmd.begin() + 6,
1372 cmd.begin() + cmd.find(")")));
1377 /// FillInHookNames - Actually extract the hook names from all command
1378 /// line strings. Helper function used by EmitHookDeclarations().
1379 void FillInHookNames(const ToolPropertiesList& TPList,
1380 StrVector& HookNames) {
1381 for (ToolPropertiesList::const_iterator B = TPList.begin(),
1382 E = TPList.end(); B != E; ++B) {
1383 const ToolProperties& P = *(*B);
1386 if (typeid(*P.CmdLine) == typeid(StringInit)) {
1387 // This is a string.
1388 ExtractHookNames(P.CmdLine, HookNames);
1391 // This is a 'case' construct.
1392 const DagInit& d = InitPtrToDagInitRef(P.CmdLine);
1394 for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
1397 ExtractHookNames(*B, HookNames);
1404 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1405 /// property records and emit hook function declaration for each
1406 /// instance of $CALL(HookName).
1407 void EmitHookDeclarations(const ToolPropertiesList& ToolProps,
1409 StrVector HookNames;
1410 FillInHookNames(ToolProps, HookNames);
1411 if (HookNames.empty())
1413 std::sort(HookNames.begin(), HookNames.end());
1414 StrVector::const_iterator E = std::unique(HookNames.begin(), HookNames.end());
1416 O << "namespace hooks {\n";
1417 for (StrVector::const_iterator B = HookNames.begin(); B != E; ++B)
1418 O << Indent1 << "std::string " << *B << "();\n";
1423 // End of anonymous namespace
1426 /// run - The back-end entry point.
1427 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1429 // Emit file header.
1430 EmitSourceFileHeader("LLVMC Configuration Library", O);
1432 // Get a list of all defined Tools.
1433 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1435 throw std::string("No tool definitions found!");
1437 // Gather information from the Tool description dags.
1438 ToolPropertiesList tool_props;
1439 GlobalOptionDescriptions opt_descs;
1440 CollectToolProperties(Tools.begin(), Tools.end(), tool_props, opt_descs);
1442 // Emit global option registration code.
1443 EmitOptionDescriptions(opt_descs, O);
1445 // Emit hook declarations.
1446 EmitHookDeclarations(tool_props, O);
1448 // Emit PopulateLanguageMap() function
1449 // (a language map maps from file extensions to language names).
1450 EmitPopulateLanguageMap(Records, O);
1452 // Emit Tool classes.
1453 for (ToolPropertiesList::const_iterator B = tool_props.begin(),
1454 E = tool_props.end(); B!=E; ++B)
1455 EmitToolClassDefinition(*(*B), opt_descs, O);
1457 Record* CompilationGraphRecord = Records.getDef("CompilationGraph");
1458 if (!CompilationGraphRecord)
1459 throw std::string("Compilation graph description not found!");
1461 // Typecheck the compilation graph.
1462 TypecheckGraph(CompilationGraphRecord, tool_props);
1464 // Emit Edge# classes.
1465 EmitEdgeClasses(CompilationGraphRecord, opt_descs, O);
1467 // Emit PopulateCompilationGraph() function.
1468 EmitPopulateCompilationGraph(CompilationGraphRecord, O);