1 //===- LLVMCConfigurationEmitter.cpp - Generate LLVMC config ----*- C++ -*-===//
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/ADT/StringSet.h"
22 #include "llvm/Support/Streams.h"
33 //===----------------------------------------------------------------------===//
36 typedef std::vector<Record*> RecordVector;
37 typedef std::vector<std::string> StrVector;
39 //===----------------------------------------------------------------------===//
42 // Indentation strings.
43 const char * Indent1 = " ";
44 const char * Indent2 = " ";
45 const char * Indent3 = " ";
46 const char * Indent4 = " ";
48 // Default help string.
49 const char * DefaultHelpString = "NO HELP MESSAGE PROVIDED";
51 // Name for the "sink" option.
52 const char * SinkOptionName = "AutoGeneratedSinkOption";
54 //===----------------------------------------------------------------------===//
57 int InitPtrToInt(const Init* ptr) {
58 const IntInit& val = dynamic_cast<const IntInit&>(*ptr);
59 return val.getValue();
62 const std::string& InitPtrToString(const Init* ptr) {
63 const StringInit& val = dynamic_cast<const StringInit&>(*ptr);
64 return val.getValue();
67 const ListInit& InitPtrToList(const Init* ptr) {
68 const ListInit& val = dynamic_cast<const ListInit&>(*ptr);
72 const DagInit& InitPtrToDag(const Init* ptr) {
73 const DagInit& val = dynamic_cast<const DagInit&>(*ptr);
77 // checkNumberOfArguments - Ensure that the number of args in d is
78 // less than or equal to min_arguments, otherwise throw an exception.
79 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
80 if (d->getNumArgs() < min_arguments)
81 throw "Property " + d->getOperator()->getAsString()
82 + " has too few arguments!";
85 // isDagEmpty - is this DAG marked with an empty marker?
86 bool isDagEmpty (const DagInit* d) {
87 return d->getOperator()->getAsString() == "empty";
90 //===----------------------------------------------------------------------===//
91 /// Back-end specific code
93 // A command-line option can have one of the following types:
95 // Alias - an alias for another option.
97 // Switch - a simple switch without arguments, e.g. -O2
99 // Parameter - an option that takes one(and only one) argument, e.g. -o file,
102 // ParameterList - same as Parameter, but more than one occurence
103 // of the option is allowed, e.g. -lm -lpthread
105 // Prefix - argument is everything after the prefix,
106 // e.g. -Wa,-foo,-bar, -DNAME=VALUE
108 // PrefixList - same as Prefix, but more than one option occurence is
111 namespace OptionType {
112 enum OptionType { Alias, Switch,
113 Parameter, ParameterList, Prefix, PrefixList};
116 bool IsListOptionType (OptionType::OptionType t) {
117 return (t == OptionType::ParameterList || t == OptionType::PrefixList);
120 // Code duplication here is necessary because one option can affect
121 // several tools and those tools may have different actions associated
122 // with this option. GlobalOptionDescriptions are used to generate
123 // the option registration code, while ToolOptionDescriptions are used
124 // to generate tool-specific code.
126 /// OptionDescription - Base class for option descriptions.
127 struct OptionDescription {
128 OptionType::OptionType Type;
131 OptionDescription(OptionType::OptionType t = OptionType::Switch,
132 const std::string& n = "")
136 const char* GenTypeDeclaration() const {
138 case OptionType::Alias:
140 case OptionType::PrefixList:
141 case OptionType::ParameterList:
142 return "cl::list<std::string>";
143 case OptionType::Switch:
144 return "cl::opt<bool>";
145 case OptionType::Parameter:
146 case OptionType::Prefix:
148 return "cl::opt<std::string>";
152 // Escape commas and other symbols not allowed in the C++ variable
153 // names. Makes it possible to use options with names like "Wa,"
154 // (useful for prefix options).
155 std::string EscapeVariableName(const std::string& Var) const {
157 for (unsigned i = 0; i != Var.size(); ++i) {
158 char cur_char = Var[i];
159 if (cur_char == ',') {
162 else if (cur_char == '+') {
165 else if (cur_char == ',') {
169 ret.push_back(cur_char);
175 std::string GenVariableName() const {
176 const std::string& EscapedName = EscapeVariableName(Name);
178 case OptionType::Alias:
179 return "AutoGeneratedAlias" + EscapedName;
180 case OptionType::Switch:
181 return "AutoGeneratedSwitch" + EscapedName;
182 case OptionType::Prefix:
183 return "AutoGeneratedPrefix" + EscapedName;
184 case OptionType::PrefixList:
185 return "AutoGeneratedPrefixList" + EscapedName;
186 case OptionType::Parameter:
187 return "AutoGeneratedParameter" + EscapedName;
188 case OptionType::ParameterList:
190 return "AutoGeneratedParameterList" + EscapedName;
196 // Global option description.
198 namespace GlobalOptionDescriptionFlags {
199 enum GlobalOptionDescriptionFlags { Required = 0x1 };
202 struct GlobalOptionDescription : public OptionDescription {
206 // We need to provide a default constructor because
207 // StringMap can only store DefaultConstructible objects.
208 GlobalOptionDescription() : OptionDescription(), Flags(0)
211 GlobalOptionDescription (OptionType::OptionType t, const std::string& n,
212 const std::string& h = DefaultHelpString)
213 : OptionDescription(t, n), Help(h), Flags(0)
216 bool isRequired() const {
217 return Flags & GlobalOptionDescriptionFlags::Required;
220 Flags |= GlobalOptionDescriptionFlags::Required;
223 /// Merge - Merge two option descriptions.
224 void Merge (const GlobalOptionDescription& other)
226 if (other.Type != Type)
227 throw "Conflicting definitions for the option " + Name + "!";
229 if (Help == DefaultHelpString)
231 else if (other.Help != DefaultHelpString) {
232 llvm::cerr << "Warning: more than one help string defined for option "
236 Flags |= other.Flags;
240 /// GlobalOptionDescriptions - A GlobalOptionDescription array
241 /// together with some flags affecting generation of option
243 struct GlobalOptionDescriptions {
244 typedef StringMap<GlobalOptionDescription> container_type;
245 typedef container_type::const_iterator const_iterator;
247 /// Descriptions - A list of GlobalOptionDescriptions.
248 container_type Descriptions;
249 /// HasSink - Should the emitter generate a "cl::sink" option?
252 /// FindOption - exception-throwing wrapper for find().
253 const GlobalOptionDescription& FindOption(const std::string& OptName) const {
254 const_iterator I = Descriptions.find(OptName);
255 if (I != Descriptions.end())
258 throw OptName + ": no such option!";
261 /// insertDescription - Insert new GlobalOptionDescription into
262 /// GlobalOptionDescriptions list
263 void insertDescription (const GlobalOptionDescription& o)
265 container_type::iterator I = Descriptions.find(o.Name);
266 if (I != Descriptions.end()) {
267 GlobalOptionDescription& D = I->second;
271 Descriptions[o.Name] = o;
275 // Support for STL-style iteration
276 const_iterator begin() const { return Descriptions.begin(); }
277 const_iterator end() const { return Descriptions.end(); }
281 // Tool-local option description.
283 // Properties without arguments are implemented as flags.
284 namespace ToolOptionDescriptionFlags {
285 enum ToolOptionDescriptionFlags { StopCompilation = 0x1,
286 Forward = 0x2, UnpackValues = 0x4};
288 namespace OptionPropertyType {
289 enum OptionPropertyType { AppendCmd, ForwardAs, OutputSuffix };
292 typedef std::pair<OptionPropertyType::OptionPropertyType, std::string>
294 typedef SmallVector<OptionProperty, 4> OptionPropertyList;
296 struct ToolOptionDescription : public OptionDescription {
298 OptionPropertyList Props;
300 // StringMap can only store DefaultConstructible objects
301 ToolOptionDescription() : OptionDescription(), Flags(0) {}
303 ToolOptionDescription (OptionType::OptionType t, const std::string& n)
304 : OptionDescription(t, n)
307 // Various boolean properties
308 bool isStopCompilation() const {
309 return Flags & ToolOptionDescriptionFlags::StopCompilation;
311 void setStopCompilation() {
312 Flags |= ToolOptionDescriptionFlags::StopCompilation;
315 bool isForward() const {
316 return Flags & ToolOptionDescriptionFlags::Forward;
319 Flags |= ToolOptionDescriptionFlags::Forward;
322 bool isUnpackValues() const {
323 return Flags & ToolOptionDescriptionFlags::UnpackValues;
325 void setUnpackValues() {
326 Flags |= ToolOptionDescriptionFlags::UnpackValues;
329 void AddProperty (OptionPropertyType::OptionPropertyType t,
330 const std::string& val)
332 Props.push_back(std::make_pair(t, val));
336 typedef StringMap<ToolOptionDescription> ToolOptionDescriptions;
338 // Tool information record
340 namespace ToolFlags {
341 enum ToolFlags { Join = 0x1, Sink = 0x2 };
344 struct ToolProperties : public RefCountedBase<ToolProperties> {
347 StrVector InLanguage;
348 std::string OutLanguage;
349 std::string OutputSuffix;
351 ToolOptionDescriptions OptDescs;
353 // Various boolean properties
354 void setSink() { Flags |= ToolFlags::Sink; }
355 bool isSink() const { return Flags & ToolFlags::Sink; }
356 void setJoin() { Flags |= ToolFlags::Join; }
357 bool isJoin() const { return Flags & ToolFlags::Join; }
359 // Default ctor here is needed because StringMap can only store
360 // DefaultConstructible objects
361 ToolProperties() : CmdLine(0), Flags(0) {}
362 ToolProperties (const std::string& n) : Name(n), CmdLine(0), Flags(0) {}
366 /// ToolPropertiesList - A list of Tool information records
367 /// IntrusiveRefCntPtrs are used here because StringMap has no copy
368 /// constructor (and we want to avoid copying ToolProperties anyway).
369 typedef std::vector<IntrusiveRefCntPtr<ToolProperties> > ToolPropertiesList;
372 /// CollectOptionProperties - Function object for iterating over a
373 /// list (usually, a DAG) of option property records.
374 class CollectOptionProperties {
376 // Implementation details.
378 /// OptionPropertyHandler - a function that extracts information
379 /// about a given option property from its DAG representation.
380 typedef void (CollectOptionProperties::* OptionPropertyHandler)
383 /// OptionPropertyHandlerMap - A map from option property names to
384 /// option property handlers
385 typedef StringMap<OptionPropertyHandler> OptionPropertyHandlerMap;
387 static OptionPropertyHandlerMap optionPropertyHandlers_;
388 static bool staticMembersInitialized_;
390 /// This is where the information is stored
392 /// toolProps_ - Properties of the current Tool.
393 ToolProperties* toolProps_;
394 /// optDescs_ - OptionDescriptions table (used to register options
396 GlobalOptionDescription& optDesc_;
400 explicit CollectOptionProperties(ToolProperties* TP,
401 GlobalOptionDescription& OD)
402 : toolProps_(TP), optDesc_(OD)
404 if (!staticMembersInitialized_) {
405 optionPropertyHandlers_["append_cmd"] =
406 &CollectOptionProperties::onAppendCmd;
407 optionPropertyHandlers_["forward"] =
408 &CollectOptionProperties::onForward;
409 optionPropertyHandlers_["forward_as"] =
410 &CollectOptionProperties::onForwardAs;
411 optionPropertyHandlers_["help"] =
412 &CollectOptionProperties::onHelp;
413 optionPropertyHandlers_["output_suffix"] =
414 &CollectOptionProperties::onOutputSuffix;
415 optionPropertyHandlers_["required"] =
416 &CollectOptionProperties::onRequired;
417 optionPropertyHandlers_["stop_compilation"] =
418 &CollectOptionProperties::onStopCompilation;
419 optionPropertyHandlers_["unpack_values"] =
420 &CollectOptionProperties::onUnpackValues;
422 staticMembersInitialized_ = true;
426 /// operator() - Gets called for every option property; Just forwards
427 /// to the corresponding property handler.
428 void operator() (Init* i) {
429 const DagInit& option_property = InitPtrToDag(i);
430 const std::string& option_property_name
431 = option_property.getOperator()->getAsString();
432 OptionPropertyHandlerMap::iterator method
433 = optionPropertyHandlers_.find(option_property_name);
435 if (method != optionPropertyHandlers_.end()) {
436 OptionPropertyHandler h = method->second;
437 (this->*h)(&option_property);
440 throw "Unknown option property: " + option_property_name + "!";
446 /// Option property handlers --
447 /// Methods that handle properties that are common for all types of
448 /// options (like append_cmd, stop_compilation)
450 void onAppendCmd (const DagInit* d) {
451 checkNumberOfArguments(d, 1);
453 const std::string& cmd = InitPtrToString(d->getArg(0));
455 toolProps_->OptDescs[optDesc_.Name].
456 AddProperty(OptionPropertyType::AppendCmd, cmd);
459 void onOutputSuffix (const DagInit* d) {
460 checkNumberOfArguments(d, 1);
462 const std::string& suf = InitPtrToString(d->getArg(0));
464 if (toolProps_->OptDescs[optDesc_.Name].Type != OptionType::Switch)
465 throw "Option " + optDesc_.Name
466 + " can't have 'output_suffix' property since it isn't a switch!";
468 toolProps_->OptDescs[optDesc_.Name].AddProperty
469 (OptionPropertyType::OutputSuffix, suf);
472 void onForward (const DagInit* d) {
473 checkNumberOfArguments(d, 0);
475 toolProps_->OptDescs[optDesc_.Name].setForward();
478 void onForwardAs (const DagInit* d) {
479 checkNumberOfArguments(d, 1);
481 const std::string& cmd = InitPtrToString(d->getArg(0));
483 toolProps_->OptDescs[optDesc_.Name].
484 AddProperty(OptionPropertyType::ForwardAs, cmd);
487 void onHelp (const DagInit* d) {
488 checkNumberOfArguments(d, 1);
489 const std::string& help_message = InitPtrToString(d->getArg(0));
491 optDesc_.Help = help_message;
494 void onRequired (const DagInit* d) {
495 checkNumberOfArguments(d, 0);
497 optDesc_.setRequired();
500 void onStopCompilation (const DagInit* d) {
501 checkNumberOfArguments(d, 0);
503 if (optDesc_.Type != OptionType::Switch)
504 throw std::string("Only options of type Switch can stop compilation!");
505 toolProps_->OptDescs[optDesc_.Name].setStopCompilation();
508 void onUnpackValues (const DagInit* d) {
509 checkNumberOfArguments(d, 0);
511 toolProps_->OptDescs[optDesc_.Name].setUnpackValues();
516 /// checkToolProps - Throw an error if toolProps_ == 0.
517 void checkToolProps(const DagInit* d) {
519 throw "Option property " + d->getOperator()->getAsString()
520 + " can't be used in this context";
525 CollectOptionProperties::OptionPropertyHandlerMap
526 CollectOptionProperties::optionPropertyHandlers_;
528 bool CollectOptionProperties::staticMembersInitialized_ = false;
531 /// processOptionProperties - Go through the list of option
532 /// properties and call a corresponding handler for each.
533 void processOptionProperties (const DagInit* d, ToolProperties* t,
534 GlobalOptionDescription& o) {
535 checkNumberOfArguments(d, 2);
536 DagInit::const_arg_iterator B = d->arg_begin();
537 // Skip the first argument: it's always the option name.
539 std::for_each(B, d->arg_end(), CollectOptionProperties(t, o));
542 /// AddOption - A function object wrapper for
543 /// processOptionProperties. Used by CollectProperties and
544 /// CollectPropertiesFromOptionList.
547 GlobalOptionDescriptions& OptDescs_;
548 ToolProperties* ToolProps_;
551 explicit AddOption(GlobalOptionDescriptions& OD, ToolProperties* TP = 0)
552 : OptDescs_(OD), ToolProps_(TP)
555 void operator()(const Init* i) {
556 const DagInit& d = InitPtrToDag(i);
557 checkNumberOfArguments(&d, 2);
559 const OptionType::OptionType Type =
560 getOptionType(d.getOperator()->getAsString());
561 const std::string& Name = InitPtrToString(d.getArg(0));
563 GlobalOptionDescription OD(Type, Name);
564 if (Type != OptionType::Alias) {
565 processOptionProperties(&d, ToolProps_, OD);
567 ToolProps_->OptDescs[Name].Type = Type;
568 ToolProps_->OptDescs[Name].Name = Name;
572 OD.Help = InitPtrToString(d.getArg(1));
574 OptDescs_.insertDescription(OD);
578 OptionType::OptionType getOptionType(const std::string& T) const {
579 if (T == "alias_option")
580 return OptionType::Alias;
581 else if (T == "switch_option")
582 return OptionType::Switch;
583 else if (T == "parameter_option")
584 return OptionType::Parameter;
585 else if (T == "parameter_list_option")
586 return OptionType::ParameterList;
587 else if (T == "prefix_option")
588 return OptionType::Prefix;
589 else if (T == "prefix_list_option")
590 return OptionType::PrefixList;
592 throw "Unknown option type: " + T + '!';
597 /// CollectProperties - Function object for iterating over a list of
598 /// tool property records.
599 class CollectProperties {
602 // Implementation details
604 /// PropertyHandler - a function that extracts information
605 /// about a given tool property from its DAG representation
606 typedef void (CollectProperties::*PropertyHandler)(const DagInit*);
608 /// PropertyHandlerMap - A map from property names to property
610 typedef StringMap<PropertyHandler> PropertyHandlerMap;
612 // Static maps from strings to CollectProperties methods("handlers")
613 static PropertyHandlerMap propertyHandlers_;
614 static bool staticMembersInitialized_;
617 /// This is where the information is stored
619 /// toolProps_ - Properties of the current Tool.
620 ToolProperties& toolProps_;
621 /// optDescs_ - OptionDescriptions table (used to register options
623 GlobalOptionDescriptions& optDescs_;
627 explicit CollectProperties (ToolProperties& p, GlobalOptionDescriptions& d)
628 : toolProps_(p), optDescs_(d)
630 if (!staticMembersInitialized_) {
631 propertyHandlers_["cmd_line"] = &CollectProperties::onCmdLine;
632 propertyHandlers_["in_language"] = &CollectProperties::onInLanguage;
633 propertyHandlers_["join"] = &CollectProperties::onJoin;
634 propertyHandlers_["out_language"] = &CollectProperties::onOutLanguage;
635 propertyHandlers_["output_suffix"] = &CollectProperties::onOutputSuffix;
636 propertyHandlers_["parameter_option"]
637 = &CollectProperties::addOption;
638 propertyHandlers_["parameter_list_option"] =
639 &CollectProperties::addOption;
640 propertyHandlers_["prefix_option"] = &CollectProperties::addOption;
641 propertyHandlers_["prefix_list_option"] =
642 &CollectProperties::addOption;
643 propertyHandlers_["sink"] = &CollectProperties::onSink;
644 propertyHandlers_["switch_option"] = &CollectProperties::addOption;
645 propertyHandlers_["alias_option"] = &CollectProperties::addOption;
647 staticMembersInitialized_ = true;
651 /// operator() - Gets called for every tool property; Just forwards
652 /// to the corresponding property handler.
653 void operator() (Init* i) {
654 const DagInit& d = InitPtrToDag(i);
655 const std::string& property_name = d.getOperator()->getAsString();
656 PropertyHandlerMap::iterator method
657 = propertyHandlers_.find(property_name);
659 if (method != propertyHandlers_.end()) {
660 PropertyHandler h = method->second;
664 throw "Unknown tool property: " + property_name + "!";
670 /// Property handlers --
671 /// Functions that extract information about tool properties from
672 /// DAG representation.
674 void onCmdLine (const DagInit* d) {
675 checkNumberOfArguments(d, 1);
676 toolProps_.CmdLine = d->getArg(0);
679 void onInLanguage (const DagInit* d) {
680 checkNumberOfArguments(d, 1);
681 Init* arg = d->getArg(0);
683 // Find out the argument's type.
684 if (typeid(*arg) == typeid(StringInit)) {
686 toolProps_.InLanguage.push_back(InitPtrToString(arg));
690 const ListInit& lst = InitPtrToList(arg);
691 StrVector& out = toolProps_.InLanguage;
693 // Copy strings to the output vector.
694 for (ListInit::const_iterator B = lst.begin(), E = lst.end();
696 out.push_back(InitPtrToString(*B));
699 // Remove duplicates.
700 std::sort(out.begin(), out.end());
701 StrVector::iterator newE = std::unique(out.begin(), out.end());
702 out.erase(newE, out.end());
706 void onJoin (const DagInit* d) {
707 checkNumberOfArguments(d, 0);
708 toolProps_.setJoin();
711 void onOutLanguage (const DagInit* d) {
712 checkNumberOfArguments(d, 1);
713 toolProps_.OutLanguage = InitPtrToString(d->getArg(0));
716 void onOutputSuffix (const DagInit* d) {
717 checkNumberOfArguments(d, 1);
718 toolProps_.OutputSuffix = InitPtrToString(d->getArg(0));
721 void onSink (const DagInit* d) {
722 checkNumberOfArguments(d, 0);
723 optDescs_.HasSink = true;
724 toolProps_.setSink();
727 // Just forwards to the AddOption function object. Somewhat
728 // non-optimal, but avoids code duplication.
729 void addOption (const DagInit* d) {
730 checkNumberOfArguments(d, 2);
731 AddOption(optDescs_, &toolProps_)(d);
736 // Defintions of static members of CollectProperties.
737 CollectProperties::PropertyHandlerMap CollectProperties::propertyHandlers_;
738 bool CollectProperties::staticMembersInitialized_ = false;
741 /// CollectToolProperties - Gather information about tool properties
742 /// from the parsed TableGen data (basically a wrapper for the
743 /// CollectProperties function object).
744 void CollectToolProperties (RecordVector::const_iterator B,
745 RecordVector::const_iterator E,
746 ToolPropertiesList& TPList,
747 GlobalOptionDescriptions& OptDescs)
749 // Iterate over a properties list of every Tool definition
752 // Throws an exception if the value does not exist.
753 ListInit* PropList = T->getValueAsListInit("properties");
755 IntrusiveRefCntPtr<ToolProperties>
756 ToolProps(new ToolProperties(T->getName()));
758 std::for_each(PropList->begin(), PropList->end(),
759 CollectProperties(*ToolProps, OptDescs));
760 TPList.push_back(ToolProps);
765 /// CollectPropertiesFromOptionList - Gather information about
766 /// *global* option properties from the OptionList.
767 void CollectPropertiesFromOptionList (RecordVector::const_iterator B,
768 RecordVector::const_iterator E,
769 GlobalOptionDescriptions& OptDescs)
771 // Iterate over a properties list of every Tool definition
773 RecordVector::value_type T = *B;
774 // Throws an exception if the value does not exist.
775 ListInit* PropList = T->getValueAsListInit("options");
777 std::for_each(PropList->begin(), PropList->end(), AddOption(OptDescs));
781 /// CheckForSuperfluousOptions - Check that there are no side
782 /// effect-free options (specified only in the OptionList). Otherwise,
783 /// output a warning.
784 void CheckForSuperfluousOptions (const ToolPropertiesList& TPList,
785 const GlobalOptionDescriptions& OptDescs) {
786 llvm::StringSet<> nonSuperfluousOptions;
788 // Add all options mentioned in the TPList to the set of
789 // non-superfluous options.
790 for (ToolPropertiesList::const_iterator B = TPList.begin(),
791 E = TPList.end(); B != E; ++B) {
792 const ToolProperties& TP = *(*B);
793 for (ToolOptionDescriptions::const_iterator B = TP.OptDescs.begin(),
794 E = TP.OptDescs.end(); B != E; ++B) {
795 nonSuperfluousOptions.insert(B->first());
799 // Check that all options in OptDescs belong to the set of
800 // non-superfluous options.
801 for (GlobalOptionDescriptions::const_iterator B = OptDescs.begin(),
802 E = OptDescs.end(); B != E; ++B) {
803 const GlobalOptionDescription& Val = B->second;
804 if (!nonSuperfluousOptions.count(Val.Name)
805 && Val.Type != OptionType::Alias)
806 cerr << "Warning: option '-" << Val.Name << "' has no effect! "
807 "Probable cause: this option is specified only in the OptionList.\n";
811 /// EmitCaseTest1Arg - Helper function used by
812 /// EmitCaseConstructHandler.
813 bool EmitCaseTest1Arg(const std::string& TestName,
815 const GlobalOptionDescriptions& OptDescs,
817 checkNumberOfArguments(&d, 1);
818 const std::string& OptName = InitPtrToString(d.getArg(0));
819 if (TestName == "switch_on") {
820 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
821 if (OptDesc.Type != OptionType::Switch)
822 throw OptName + ": incorrect option type!";
823 O << OptDesc.GenVariableName();
825 } else if (TestName == "input_languages_contain") {
826 O << "InLangs.count(\"" << OptName << "\") != 0";
828 } else if (TestName == "in_language") {
829 // This works only for single-argument Tool::GenerateAction. Join
830 // tools can process several files in different languages simultaneously.
832 // TODO: make this work with Edge::Weight (if possible).
833 O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"';
835 } else if (TestName == "not_empty") {
836 if (OptName == "o") {
837 O << "!OutputFilename.empty()";
841 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
842 if (OptDesc.Type == OptionType::Switch)
843 throw OptName + ": incorrect option type!";
844 O << '!' << OptDesc.GenVariableName() << ".empty()";
852 /// EmitCaseTest2Args - Helper function used by
853 /// EmitCaseConstructHandler.
854 bool EmitCaseTest2Args(const std::string& TestName,
856 const char* IndentLevel,
857 const GlobalOptionDescriptions& OptDescs,
859 checkNumberOfArguments(&d, 2);
860 const std::string& OptName = InitPtrToString(d.getArg(0));
861 const std::string& OptArg = InitPtrToString(d.getArg(1));
862 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
864 if (TestName == "parameter_equals") {
865 if (OptDesc.Type != OptionType::Parameter
866 && OptDesc.Type != OptionType::Prefix)
867 throw OptName + ": incorrect option type!";
868 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
871 else if (TestName == "element_in_list") {
872 if (OptDesc.Type != OptionType::ParameterList
873 && OptDesc.Type != OptionType::PrefixList)
874 throw OptName + ": incorrect option type!";
875 const std::string& VarName = OptDesc.GenVariableName();
876 O << "std::find(" << VarName << ".begin(),\n"
877 << IndentLevel << Indent1 << VarName << ".end(), \""
878 << OptArg << "\") != " << VarName << ".end()";
885 // Forward declaration.
886 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
887 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
888 const GlobalOptionDescriptions& OptDescs,
891 /// EmitLogicalOperationTest - Helper function used by
892 /// EmitCaseConstructHandler.
893 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
894 const char* IndentLevel,
895 const GlobalOptionDescriptions& OptDescs,
898 for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
899 const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
900 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
901 if (j != NumArgs - 1)
902 O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
908 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
909 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
910 const GlobalOptionDescriptions& OptDescs,
912 const std::string& TestName = d.getOperator()->getAsString();
914 if (TestName == "and")
915 EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
916 else if (TestName == "or")
917 EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
918 else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
920 else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
923 throw TestName + ": unknown edge property!";
926 // Emit code that handles the 'case' construct.
927 // Takes a function object that should emit code for every case clause.
928 // Callback's type is
929 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
930 template <typename F>
931 void EmitCaseConstructHandler(const DagInit* d, const char* IndentLevel,
932 F Callback, bool EmitElseIf,
933 const GlobalOptionDescriptions& OptDescs,
935 assert(d->getOperator()->getAsString() == "case");
937 unsigned numArgs = d->getNumArgs();
938 if (d->getNumArgs() < 2)
939 throw "There should be at least one clause in the 'case' expression:\n"
942 for (unsigned i = 0; i != numArgs; ++i) {
943 const DagInit& Test = InitPtrToDag(d->getArg(i));
946 if (Test.getOperator()->getAsString() == "default") {
948 throw std::string("The 'default' clause should be the last in the"
949 "'case' construct!");
950 O << IndentLevel << "else {\n";
953 O << IndentLevel << ((i != 0 && EmitElseIf) ? "else if (" : "if (");
954 EmitCaseTest(Test, IndentLevel, OptDescs, O);
958 // Emit the corresponding statement.
961 throw "Case construct handler: no corresponding action "
962 "found for the test " + Test.getAsString() + '!';
964 Init* arg = d->getArg(i);
965 if (dynamic_cast<DagInit*>(arg)
966 && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case") {
967 EmitCaseConstructHandler(static_cast<DagInit*>(arg),
968 (std::string(IndentLevel) + Indent1).c_str(),
969 Callback, EmitElseIf, OptDescs, O);
972 Callback(arg, IndentLevel, O);
974 O << IndentLevel << "}\n";
978 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
979 /// implement EmitOptionPropertyHandlingCode(). Emits code for
980 /// handling the (forward) and (forward_as) option properties.
981 void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D,
982 const std::string& NewName,
984 const std::string& Name = NewName.empty()
989 case OptionType::Switch:
990 O << Indent3 << "vec.push_back(\"" << Name << "\");\n";
992 case OptionType::Parameter:
993 O << Indent3 << "vec.push_back(\"" << Name << "\");\n";
994 O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n";
996 case OptionType::Prefix:
997 O << Indent3 << "vec.push_back(\"" << Name << "\" + "
998 << D.GenVariableName() << ");\n";
1000 case OptionType::PrefixList:
1001 O << Indent3 << "for (" << D.GenTypeDeclaration()
1002 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1003 << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
1004 << Indent4 << "vec.push_back(\"" << Name << "\" + "
1007 case OptionType::ParameterList:
1008 O << Indent3 << "for (" << D.GenTypeDeclaration()
1009 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1010 << Indent3 << "E = " << D.GenVariableName()
1011 << ".end() ; B != E; ++B) {\n"
1012 << Indent4 << "vec.push_back(\"" << Name << "\");\n"
1013 << Indent4 << "vec.push_back(*B);\n"
1014 << Indent3 << "}\n";
1016 case OptionType::Alias:
1018 throw std::string("Aliases are not allowed in tool option descriptions!");
1022 // ToolOptionHasInterestingProperties - A helper function used by
1023 // EmitOptionPropertyHandlingCode() that tells us whether we should
1024 // emit any property handling code at all.
1025 bool ToolOptionHasInterestingProperties(const ToolOptionDescription& D) {
1027 for (OptionPropertyList::const_iterator B = D.Props.begin(),
1028 E = D.Props.end(); B != E; ++B) {
1029 const OptionProperty& OptProp = *B;
1030 if (OptProp.first == OptionPropertyType::AppendCmd
1031 || OptProp.first == OptionPropertyType::ForwardAs)
1034 if (D.isForward() || D.isUnpackValues())
1039 /// EmitOptionPropertyHandlingCode - Helper function used by
1040 /// EmitGenerateActionMethod(). Emits code that handles option
1042 void EmitOptionPropertyHandlingCode (const ToolOptionDescription& D,
1045 if (!ToolOptionHasInterestingProperties(D))
1047 // Start of the if-clause.
1048 O << Indent2 << "if (";
1049 if (D.Type == OptionType::Switch)
1050 O << D.GenVariableName();
1052 O << '!' << D.GenVariableName() << ".empty()";
1056 // Handle option properties that take an argument.
1057 for (OptionPropertyList::const_iterator B = D.Props.begin(),
1058 E = D.Props.end(); B!=E; ++B) {
1059 const OptionProperty& val = *B;
1061 switch (val.first) {
1062 // (append_cmd cmd) property
1063 case OptionPropertyType::AppendCmd:
1064 O << Indent3 << "vec.push_back(\"" << val.second << "\");\n";
1066 // (forward_as) property
1067 case OptionPropertyType::ForwardAs:
1068 EmitForwardOptionPropertyHandlingCode(D, val.second, O);
1070 // Other properties with argument
1078 // (forward) property
1080 EmitForwardOptionPropertyHandlingCode(D, "", O);
1082 // (unpack_values) property
1083 if (D.isUnpackValues()) {
1084 if (IsListOptionType(D.Type)) {
1085 O << Indent3 << "for (" << D.GenTypeDeclaration()
1086 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1087 << Indent3 << "E = " << D.GenVariableName()
1088 << ".end(); B != E; ++B)\n"
1089 << Indent4 << "llvm::SplitString(*B, vec, \",\");\n";
1091 else if (D.Type == OptionType::Prefix || D.Type == OptionType::Parameter){
1092 O << Indent3 << "llvm::SplitString("
1093 << D.GenVariableName() << ", vec, \",\");\n";
1096 throw std::string("Switches can't have unpack_values property!");
1100 // End of the if-clause.
1101 O << Indent2 << "}\n";
1104 /// SubstituteSpecialCommands - Perform string substitution for $CALL
1105 /// and $ENV. Helper function used by EmitCmdLineVecFill().
1106 std::string SubstituteSpecialCommands(const std::string& cmd) {
1107 size_t cparen = cmd.find(")");
1110 if (cmd.find("$CALL(") == 0) {
1111 if (cmd.size() == 6)
1112 throw std::string("$CALL invocation: empty argument list!");
1115 ret += std::string(cmd.begin() + 6, cmd.begin() + cparen);
1118 else if (cmd.find("$ENV(") == 0) {
1119 if (cmd.size() == 5)
1120 throw std::string("$ENV invocation: empty argument list!");
1122 ret += "std::getenv(\"";
1123 ret += std::string(cmd.begin() + 5, cmd.begin() + cparen);
1127 throw "Unknown special command: " + cmd;
1130 if (cmd.begin() + cparen + 1 != cmd.end()) {
1131 ret += " + std::string(\"";
1132 ret += (cmd.c_str() + cparen + 1);
1139 /// EmitCmdLineVecFill - Emit code that fills in the command line
1140 /// vector. Helper function used by EmitGenerateActionMethod().
1141 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
1142 bool Version, const char* IndentLevel,
1145 SplitString(InitPtrToString(CmdLine), StrVec);
1147 throw "Tool " + ToolName + " has empty command line!";
1149 StrVector::const_iterator I = StrVec.begin();
1151 for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
1152 const std::string& cmd = *I;
1154 if (cmd.at(0) == '$') {
1155 if (cmd == "$INFILE") {
1157 O << "for (PathVector::const_iterator B = inFiles.begin()"
1158 << ", E = inFiles.end();\n"
1159 << IndentLevel << "B != E; ++B)\n"
1160 << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
1162 O << "vec.push_back(inFile.toString());\n";
1164 else if (cmd == "$OUTFILE") {
1165 O << "vec.push_back(outFile.toString());\n";
1168 O << "vec.push_back(" << SubstituteSpecialCommands(cmd);
1173 O << "vec.push_back(\"" << cmd << "\");\n";
1176 O << IndentLevel << "cmd = "
1177 << ((StrVec[0][0] == '$') ? SubstituteSpecialCommands(StrVec[0])
1178 : "\"" + StrVec[0] + "\"")
1182 /// EmitCmdLineVecFillCallback - A function object wrapper around
1183 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
1184 /// argument to EmitCaseConstructHandler().
1185 class EmitCmdLineVecFillCallback {
1187 const std::string& ToolName;
1189 EmitCmdLineVecFillCallback(bool Ver, const std::string& TN)
1190 : Version(Ver), ToolName(TN) {}
1192 void operator()(const Init* Statement, const char* IndentLevel,
1193 std::ostream& O) const
1195 EmitCmdLineVecFill(Statement, ToolName, Version,
1196 (std::string(IndentLevel) + Indent1).c_str(), O);
1200 // EmitGenerateActionMethod - Emit one of two versions of the
1201 // Tool::GenerateAction() method.
1202 void EmitGenerateActionMethod (const ToolProperties& P,
1203 const GlobalOptionDescriptions& OptDescs,
1204 bool Version, std::ostream& O) {
1206 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
1208 O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
1210 O << Indent2 << "const sys::Path& outFile,\n"
1211 << Indent2 << "const InputLanguagesSet& InLangs,\n"
1212 << Indent2 << "const LanguageMap& LangMap) const\n"
1214 << Indent2 << "const char* cmd;\n"
1215 << Indent2 << "std::vector<std::string> vec;\n";
1217 // cmd_line is either a string or a 'case' construct.
1218 if (typeid(*P.CmdLine) == typeid(StringInit))
1219 EmitCmdLineVecFill(P.CmdLine, P.Name, Version, Indent2, O);
1221 EmitCaseConstructHandler(&InitPtrToDag(P.CmdLine), Indent2,
1222 EmitCmdLineVecFillCallback(Version, P.Name),
1225 // For every understood option, emit handling code.
1226 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1227 E = P.OptDescs.end(); B != E; ++B) {
1228 const ToolOptionDescription& val = B->second;
1229 EmitOptionPropertyHandlingCode(val, O);
1232 // Handle the Sink property.
1234 O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
1235 << Indent3 << "vec.insert(vec.end(), "
1236 << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
1237 << Indent2 << "}\n";
1240 O << Indent2 << "return Action(cmd, vec);\n"
1241 << Indent1 << "}\n\n";
1244 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
1245 /// a given Tool class.
1246 void EmitGenerateActionMethods (const ToolProperties& P,
1247 const GlobalOptionDescriptions& OptDescs,
1250 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
1251 << Indent2 << "const llvm::sys::Path& outFile,\n"
1252 << Indent2 << "const InputLanguagesSet& InLangs,\n"
1253 << Indent2 << "const LanguageMap& LangMap) const\n"
1255 << Indent2 << "throw std::runtime_error(\"" << P.Name
1256 << " is not a Join tool!\");\n"
1257 << Indent1 << "}\n\n";
1259 EmitGenerateActionMethod(P, OptDescs, true, O);
1261 EmitGenerateActionMethod(P, OptDescs, false, O);
1264 /// EmitIsLastMethod - Emit the IsLast() method for a given Tool
1266 void EmitIsLastMethod (const ToolProperties& P, std::ostream& O) {
1267 O << Indent1 << "bool IsLast() const {\n"
1268 << Indent2 << "bool last = false;\n";
1270 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1271 E = P.OptDescs.end(); B != E; ++B) {
1272 const ToolOptionDescription& val = B->second;
1274 if (val.isStopCompilation())
1276 << "if (" << val.GenVariableName()
1277 << ")\n" << Indent3 << "last = true;\n";
1280 O << Indent2 << "return last;\n"
1281 << Indent1 << "}\n\n";
1284 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1285 /// methods for a given Tool class.
1286 void EmitInOutLanguageMethods (const ToolProperties& P, std::ostream& O) {
1287 O << Indent1 << "const char** InputLanguages() const {\n"
1288 << Indent2 << "return InputLanguages_;\n"
1289 << Indent1 << "}\n\n";
1291 O << Indent1 << "const char* OutputLanguage() const {\n"
1292 << Indent2 << "return \"" << P.OutLanguage << "\";\n"
1293 << Indent1 << "}\n\n";
1296 /// EmitOutputSuffixMethod - Emit the OutputSuffix() method for a
1297 /// given Tool class.
1298 void EmitOutputSuffixMethod (const ToolProperties& P, std::ostream& O) {
1299 O << Indent1 << "const char* OutputSuffix() const {\n"
1300 << Indent2 << "const char* ret = \"" << P.OutputSuffix << "\";\n";
1302 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1303 E = P.OptDescs.end(); B != E; ++B) {
1304 const ToolOptionDescription& OptDesc = B->second;
1305 for (OptionPropertyList::const_iterator B = OptDesc.Props.begin(),
1306 E = OptDesc.Props.end(); B != E; ++B) {
1307 const OptionProperty& OptProp = *B;
1308 if (OptProp.first == OptionPropertyType::OutputSuffix) {
1309 O << Indent2 << "if (" << OptDesc.GenVariableName() << ")\n"
1310 << Indent3 << "ret = \"" << OptProp.second << "\";\n";
1315 O << Indent2 << "return ret;\n"
1316 << Indent1 << "}\n\n";
1319 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1320 void EmitNameMethod (const ToolProperties& P, std::ostream& O) {
1321 O << Indent1 << "const char* Name() const {\n"
1322 << Indent2 << "return \"" << P.Name << "\";\n"
1323 << Indent1 << "}\n\n";
1326 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1328 void EmitIsJoinMethod (const ToolProperties& P, std::ostream& O) {
1329 O << Indent1 << "bool IsJoin() const {\n";
1331 O << Indent2 << "return true;\n";
1333 O << Indent2 << "return false;\n";
1334 O << Indent1 << "}\n\n";
1337 /// EmitStaticMemberDefinitions - Emit static member definitions for a
1338 /// given Tool class.
1339 void EmitStaticMemberDefinitions(const ToolProperties& P, std::ostream& O) {
1340 O << "const char* " << P.Name << "::InputLanguages_[] = {";
1341 for (StrVector::const_iterator B = P.InLanguage.begin(),
1342 E = P.InLanguage.end(); B != E; ++B)
1343 O << '\"' << *B << "\", ";
1347 /// EmitToolClassDefinition - Emit a Tool class definition.
1348 void EmitToolClassDefinition (const ToolProperties& P,
1349 const GlobalOptionDescriptions& OptDescs,
1351 if (P.Name == "root")
1355 O << "class " << P.Name << " : public ";
1361 O << "{\nprivate:\n"
1362 << Indent1 << "static const char* InputLanguages_[];\n\n";
1365 EmitNameMethod(P, O);
1366 EmitInOutLanguageMethods(P, O);
1367 EmitOutputSuffixMethod(P, O);
1368 EmitIsJoinMethod(P, O);
1369 EmitGenerateActionMethods(P, OptDescs, O);
1370 EmitIsLastMethod(P, O);
1372 // Close class definition
1375 EmitStaticMemberDefinitions(P, O);
1379 /// EmitOptionDescriptions - Iterate over a list of option
1380 /// descriptions and emit registration code.
1381 void EmitOptionDescriptions (const GlobalOptionDescriptions& descs,
1384 std::vector<GlobalOptionDescription> Aliases;
1386 // Emit static cl::Option variables.
1387 for (GlobalOptionDescriptions::const_iterator B = descs.begin(),
1388 E = descs.end(); B!=E; ++B) {
1389 const GlobalOptionDescription& val = B->second;
1391 if (val.Type == OptionType::Alias) {
1392 Aliases.push_back(val);
1396 O << val.GenTypeDeclaration() << ' '
1397 << val.GenVariableName()
1398 << "(\"" << val.Name << '\"';
1400 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1401 O << ", cl::Prefix";
1403 if (val.isRequired()) {
1405 case OptionType::PrefixList:
1406 case OptionType::ParameterList:
1407 O << ", cl::OneOrMore";
1410 O << ", cl::Required";
1414 if (!val.Help.empty())
1415 O << ", cl::desc(\"" << val.Help << "\")";
1420 // Emit the aliases (they should go after all the 'proper' options).
1421 for (std::vector<GlobalOptionDescription>::const_iterator
1422 B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
1423 const GlobalOptionDescription& val = *B;
1425 O << val.GenTypeDeclaration() << ' '
1426 << val.GenVariableName()
1427 << "(\"" << val.Name << '\"';
1429 GlobalOptionDescriptions::container_type
1430 ::const_iterator F = descs.Descriptions.find(val.Help);
1431 if (F != descs.Descriptions.end())
1432 O << ", cl::aliasopt(" << F->second.GenVariableName() << ")";
1434 throw val.Name + ": alias to an unknown option!";
1436 O << ", cl::desc(\"" << "An alias for -" + val.Help << "\"));\n";
1439 // Emit the sink option.
1441 O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
1446 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1447 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1449 // Get the relevant field out of RecordKeeper
1450 Record* LangMapRecord = Records.getDef("LanguageMap");
1452 throw std::string("Language map definition not found!");
1454 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1455 if (!LangsToSuffixesList)
1456 throw std::string("Error in the language map definition!");
1459 O << "namespace {\n\n";
1460 O << "void PopulateLanguageMapLocal(LanguageMap& langMap) {\n";
1462 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1463 Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1465 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1466 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1468 for (unsigned i = 0; i < Suffixes->size(); ++i)
1469 O << Indent1 << "langMap[\""
1470 << InitPtrToString(Suffixes->getElement(i))
1471 << "\"] = \"" << Lang << "\";\n";
1477 /// FillInToolToLang - Fills in two tables that map tool names to
1478 /// (input, output) languages. Used by the typechecker.
1479 void FillInToolToLang (const ToolPropertiesList& TPList,
1480 StringMap<StringSet<> >& ToolToInLang,
1481 StringMap<std::string>& ToolToOutLang) {
1482 for (ToolPropertiesList::const_iterator B = TPList.begin(), E = TPList.end();
1484 const ToolProperties& P = *(*B);
1485 for (StrVector::const_iterator B = P.InLanguage.begin(),
1486 E = P.InLanguage.end(); B != E; ++B)
1487 ToolToInLang[P.Name].insert(*B);
1488 ToolToOutLang[P.Name] = P.OutLanguage;
1492 /// TypecheckGraph - Check that names for output and input languages
1493 /// on all edges do match.
1494 // TOFIX: It would be nice if this function also checked for cycles
1495 // and multiple default edges in the graph (better error
1496 // reporting). Unfortunately, it is awkward to do right now because
1497 // our intermediate representation is not sufficiently
1498 // sophisticated. Algorithms like these require a real graph instead of
1500 void TypecheckGraph (Record* CompilationGraph,
1501 const ToolPropertiesList& TPList) {
1502 StringMap<StringSet<> > ToolToInLang;
1503 StringMap<std::string> ToolToOutLang;
1505 FillInToolToLang(TPList, ToolToInLang, ToolToOutLang);
1506 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1507 StringMap<std::string>::iterator IAE = ToolToOutLang.end();
1508 StringMap<StringSet<> >::iterator IBE = ToolToInLang.end();
1510 for (unsigned i = 0; i < edges->size(); ++i) {
1511 Record* Edge = edges->getElementAsRecord(i);
1512 Record* A = Edge->getValueAsDef("a");
1513 Record* B = Edge->getValueAsDef("b");
1514 StringMap<std::string>::iterator IA = ToolToOutLang.find(A->getName());
1515 StringMap<StringSet<> >::iterator IB = ToolToInLang.find(B->getName());
1517 throw A->getName() + ": no such tool!";
1519 throw B->getName() + ": no such tool!";
1520 if (A->getName() != "root" && IB->second.count(IA->second) == 0)
1521 throw "Edge " + A->getName() + "->" + B->getName()
1522 + ": output->input language mismatch";
1523 if (B->getName() == "root")
1524 throw std::string("Edges back to the root are not allowed!");
1528 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1529 /// by EmitEdgeClass().
1530 void IncDecWeight (const Init* i, const char* IndentLevel,
1532 const DagInit& d = InitPtrToDag(i);
1533 const std::string& OpName = d.getOperator()->getAsString();
1535 if (OpName == "inc_weight")
1536 O << IndentLevel << Indent1 << "ret += ";
1537 else if (OpName == "dec_weight")
1538 O << IndentLevel << Indent1 << "ret -= ";
1540 throw "Unknown operator in edge properties list: " + OpName + '!';
1542 if (d.getNumArgs() > 0)
1543 O << InitPtrToInt(d.getArg(0)) << ";\n";
1549 /// EmitEdgeClass - Emit a single Edge# class.
1550 void EmitEdgeClass (unsigned N, const std::string& Target,
1551 DagInit* Case, const GlobalOptionDescriptions& OptDescs,
1554 // Class constructor.
1555 O << "class Edge" << N << ": public Edge {\n"
1557 << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1560 // Function Weight().
1561 << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1562 << Indent2 << "unsigned ret = 0;\n";
1564 // Handle the 'case' construct.
1565 EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
1567 O << Indent2 << "return ret;\n"
1568 << Indent1 << "};\n\n};\n\n";
1571 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1572 void EmitEdgeClasses (Record* CompilationGraph,
1573 const GlobalOptionDescriptions& OptDescs,
1575 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1577 for (unsigned i = 0; i < edges->size(); ++i) {
1578 Record* Edge = edges->getElementAsRecord(i);
1579 Record* B = Edge->getValueAsDef("b");
1580 DagInit* Weight = Edge->getValueAsDag("weight");
1582 if (isDagEmpty(Weight))
1585 EmitEdgeClass(i, B->getName(), Weight, OptDescs, O);
1589 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1591 void EmitPopulateCompilationGraph (Record* CompilationGraph,
1594 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1597 O << "namespace {\n\n";
1598 O << "void PopulateCompilationGraphLocal(CompilationGraph& G) {\n";
1602 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1604 throw std::string("No tool definitions found!");
1606 for (RecordVector::iterator B = Tools.begin(), E = Tools.end(); B != E; ++B) {
1607 const std::string& Name = (*B)->getName();
1609 O << Indent1 << "G.insertNode(new "
1610 << Name << "());\n";
1616 for (unsigned i = 0; i < edges->size(); ++i) {
1617 Record* Edge = edges->getElementAsRecord(i);
1618 Record* A = Edge->getValueAsDef("a");
1619 Record* B = Edge->getValueAsDef("b");
1620 DagInit* Weight = Edge->getValueAsDag("weight");
1622 O << Indent1 << "G.insertEdge(\"" << A->getName() << "\", ";
1624 if (isDagEmpty(Weight))
1625 O << "new SimpleEdge(\"" << B->getName() << "\")";
1627 O << "new Edge" << i << "()";
1635 /// ExtractHookNames - Extract the hook names from all instances of
1636 /// $CALL(HookName) in the provided command line string. Helper
1637 /// function used by FillInHookNames().
1638 void ExtractHookNames(const Init* CmdLine, StrVector& HookNames) {
1640 llvm::SplitString(InitPtrToString(CmdLine), cmds);
1641 for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1643 const std::string& cmd = *B;
1644 if (cmd.find("$CALL(") == 0) {
1645 if (cmd.size() == 6)
1646 throw std::string("$CALL invocation: empty argument list!");
1647 HookNames.push_back(std::string(cmd.begin() + 6,
1648 cmd.begin() + cmd.find(")")));
1653 /// ExtractHookNamesFromCaseConstruct - Extract hook names from the
1654 /// 'case' expression, handle nesting. Helper function used by
1655 /// FillInHookNames().
1656 void ExtractHookNamesFromCaseConstruct(Init* Case, StrVector& HookNames) {
1657 const DagInit& d = InitPtrToDag(Case);
1659 for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
1662 if (even && dynamic_cast<DagInit*>(arg)
1663 && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case")
1664 ExtractHookNamesFromCaseConstruct(arg, HookNames);
1666 ExtractHookNames(arg, HookNames);
1671 /// FillInHookNames - Actually extract the hook names from all command
1672 /// line strings. Helper function used by EmitHookDeclarations().
1673 void FillInHookNames(const ToolPropertiesList& TPList,
1674 StrVector& HookNames) {
1675 // For all command lines:
1676 for (ToolPropertiesList::const_iterator B = TPList.begin(),
1677 E = TPList.end(); B != E; ++B) {
1678 const ToolProperties& P = *(*B);
1681 if (dynamic_cast<StringInit*>(P.CmdLine))
1682 // This is a string.
1683 ExtractHookNames(P.CmdLine, HookNames);
1685 // This is a 'case' construct.
1686 ExtractHookNamesFromCaseConstruct(P.CmdLine, HookNames);
1690 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1691 /// property records and emit hook function declaration for each
1692 /// instance of $CALL(HookName).
1693 void EmitHookDeclarations(const ToolPropertiesList& ToolProps,
1695 StrVector HookNames;
1696 FillInHookNames(ToolProps, HookNames);
1697 if (HookNames.empty())
1699 std::sort(HookNames.begin(), HookNames.end());
1700 StrVector::const_iterator E = std::unique(HookNames.begin(), HookNames.end());
1702 O << "namespace hooks {\n";
1703 for (StrVector::const_iterator B = HookNames.begin(); B != E; ++B)
1704 O << Indent1 << "std::string " << *B << "();\n";
1709 /// EmitRegisterPlugin - Emit code to register this plugin.
1710 void EmitRegisterPlugin(std::ostream& O) {
1711 O << "namespace {\n\n"
1712 << "struct Plugin : public llvmc::BasePlugin {\n"
1713 << Indent1 << "void PopulateLanguageMap(LanguageMap& langMap) const\n"
1714 << Indent1 << "{ PopulateLanguageMapLocal(langMap); }\n\n"
1716 << "void PopulateCompilationGraph(CompilationGraph& graph) const\n"
1717 << Indent1 << "{ PopulateCompilationGraphLocal(graph); }\n"
1720 << "static llvmc::RegisterPlugin<Plugin> RP;\n\n}\n\n";
1723 /// EmitInclude - Emit necessary #include directives.
1724 void EmitIncludes(std::ostream& O) {
1725 O << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n"
1726 << "#include \"llvm/CompilerDriver/Plugin.h\"\n"
1727 << "#include \"llvm/CompilerDriver/Tool.h\"\n\n"
1729 << "#include \"llvm/ADT/StringExtras.h\"\n"
1730 << "#include \"llvm/Support/CommandLine.h\"\n\n"
1732 << "#include <cstdlib>\n"
1733 << "#include <stdexcept>\n\n"
1735 << "using namespace llvm;\n"
1736 << "using namespace llvmc;\n\n"
1738 << "extern cl::opt<std::string> OutputFilename;\n\n";
1741 // End of anonymous namespace
1744 /// run - The back-end entry point.
1745 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1748 // Emit file header.
1749 EmitSourceFileHeader("LLVMC Configuration Library", O);
1752 // Get a list of all defined Tools.
1753 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1755 throw std::string("No tool definitions found!");
1757 // Gather information from the Tool description dags.
1758 ToolPropertiesList tool_props;
1759 GlobalOptionDescriptions opt_descs;
1760 CollectToolProperties(Tools.begin(), Tools.end(), tool_props, opt_descs);
1762 RecordVector OptionLists = Records.getAllDerivedDefinitions("OptionList");
1763 CollectPropertiesFromOptionList(OptionLists.begin(), OptionLists.end(),
1766 // Check that there are no options without side effects (specified
1767 // only in the OptionList).
1768 CheckForSuperfluousOptions(tool_props, opt_descs);
1770 // Emit global option registration code.
1771 EmitOptionDescriptions(opt_descs, O);
1773 // Emit hook declarations.
1774 EmitHookDeclarations(tool_props, O);
1776 // Emit PopulateLanguageMap() function
1777 // (a language map maps from file extensions to language names).
1778 EmitPopulateLanguageMap(Records, O);
1780 // Emit Tool classes.
1781 for (ToolPropertiesList::const_iterator B = tool_props.begin(),
1782 E = tool_props.end(); B!=E; ++B)
1783 EmitToolClassDefinition(*(*B), opt_descs, O);
1785 Record* CompilationGraphRecord = Records.getDef("CompilationGraph");
1786 if (!CompilationGraphRecord)
1787 throw std::string("Compilation graph description not found!");
1789 // Typecheck the compilation graph.
1790 TypecheckGraph(CompilationGraphRecord, tool_props);
1792 // Emit Edge# classes.
1793 EmitEdgeClasses(CompilationGraphRecord, opt_descs, O);
1795 // Emit PopulateCompilationGraph() function.
1796 EmitPopulateCompilationGraph(CompilationGraphRecord, O);
1798 // Emit code for plugin registration.
1799 EmitRegisterPlugin(O);
1802 } catch (std::exception& Error) {
1803 throw Error.what() + std::string(" - usually this means a syntax error.");