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"
35 //===----------------------------------------------------------------------===//
38 typedef std::vector<Record*> RecordVector;
39 typedef std::vector<std::string> StrVector;
41 //===----------------------------------------------------------------------===//
44 // Indentation strings.
45 const char * Indent1 = " ";
46 const char * Indent2 = " ";
47 const char * Indent3 = " ";
49 // Default help string.
50 const char * DefaultHelpString = "NO HELP MESSAGE PROVIDED";
52 // Name for the "sink" option.
53 const char * SinkOptionName = "AutoGeneratedSinkOption";
55 //===----------------------------------------------------------------------===//
58 /// Id - An 'identity' function object.
61 void operator()(const T&) const {
65 int InitPtrToInt(const Init* ptr) {
66 const IntInit& val = dynamic_cast<const IntInit&>(*ptr);
67 return val.getValue();
70 const std::string& InitPtrToString(const Init* ptr) {
71 const StringInit& val = dynamic_cast<const StringInit&>(*ptr);
72 return val.getValue();
75 const ListInit& InitPtrToList(const Init* ptr) {
76 const ListInit& val = dynamic_cast<const ListInit&>(*ptr);
80 const DagInit& InitPtrToDag(const Init* ptr) {
81 const DagInit& val = dynamic_cast<const DagInit&>(*ptr);
85 // checkNumberOfArguments - Ensure that the number of args in d is
86 // less than or equal to min_arguments, otherwise throw an exception.
87 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
88 if (d->getNumArgs() < min_arguments)
89 throw "Property " + d->getOperator()->getAsString()
90 + " has too few arguments!";
93 // isDagEmpty - is this DAG marked with an empty marker?
94 bool isDagEmpty (const DagInit* d) {
95 return d->getOperator()->getAsString() == "empty";
98 // EscapeVariableName - Escape commas and other symbols not allowed
99 // in the C++ variable names. Makes it possible to use options named
100 // like "Wa," (useful for prefix options).
101 std::string EscapeVariableName(const std::string& Var) {
103 for (unsigned i = 0; i != Var.size(); ++i) {
104 char cur_char = Var[i];
105 if (cur_char == ',') {
108 else if (cur_char == '+') {
111 else if (cur_char == '-') {
115 ret.push_back(cur_char);
121 //===----------------------------------------------------------------------===//
122 /// Back-end specific code
125 /// OptionType - One of six different option types. See the
126 /// documentation for detailed description of differences.
127 /// Extern* options are those that are defined in some other plugin.
128 namespace OptionType {
129 enum OptionType { Alias, Switch, Parameter, ParameterList,
131 ExternSwitch, ExternParameter, ExternList };
133 bool IsList (OptionType t) {
134 return (t == ParameterList || t == PrefixList || t == ExternList);
137 bool IsSwitch (OptionType t) {
138 return (t == Switch || t == ExternSwitch);
141 bool IsParameter (OptionType t) {
142 return (t == Parameter || t == Prefix || t == ExternParameter);
147 OptionType::OptionType stringToOptionType(const std::string& T) {
148 if (T == "alias_option")
149 return OptionType::Alias;
150 else if (T == "switch_option")
151 return OptionType::Switch;
152 else if (T == "parameter_option")
153 return OptionType::Parameter;
154 else if (T == "parameter_list_option")
155 return OptionType::ParameterList;
156 else if (T == "prefix_option")
157 return OptionType::Prefix;
158 else if (T == "prefix_list_option")
159 return OptionType::PrefixList;
160 else if (T == "extern_switch")
161 return OptionType::ExternSwitch;
162 else if (T == "extern_parameter")
163 return OptionType::ExternParameter;
164 else if (T == "extern_list")
165 return OptionType::ExternList;
167 throw "Unknown option type: " + T + '!';
170 namespace OptionDescriptionFlags {
171 enum OptionDescriptionFlags { Required = 0x1, Hidden = 0x2,
172 ReallyHidden = 0x4 };
175 /// OptionDescription - Represents data contained in a single
176 /// OptionList entry.
177 struct OptionDescription {
178 OptionType::OptionType Type;
183 OptionDescription(OptionType::OptionType t = OptionType::Switch,
184 const std::string& n = "",
185 const std::string& h = DefaultHelpString)
186 : Type(t), Name(n), Flags(0x0), Help(h)
189 /// GenTypeDeclaration - Returns the C++ variable type of this
191 const char* GenTypeDeclaration() const;
193 /// GenVariableName - Returns the variable name used in the
194 /// generated C++ code.
195 std::string GenVariableName() const;
197 /// Merge - Merge two option descriptions.
198 void Merge (const OptionDescription& other);
200 // Misc convenient getters/setters.
202 bool isAlias() const;
203 bool isExtern() const;
205 bool isRequired() const;
208 bool isHidden() const;
211 bool isReallyHidden() const;
212 void setReallyHidden();
215 void OptionDescription::Merge (const OptionDescription& other)
217 if (other.Type != Type)
218 throw "Conflicting definitions for the option " + Name + "!";
220 if (Help == other.Help || Help == DefaultHelpString)
222 else if (other.Help != DefaultHelpString) {
223 llvm::cerr << "Warning: several different help strings"
224 " defined for option " + Name + "\n";
227 Flags |= other.Flags;
230 bool OptionDescription::isAlias() const {
231 return Type == OptionType::Alias;
234 bool OptionDescription::isExtern() const {
235 return (Type == OptionType::ExternList || Type == OptionType::ExternParameter
236 || Type == OptionType::ExternSwitch);
239 bool OptionDescription::isRequired() const {
240 return Flags & OptionDescriptionFlags::Required;
242 void OptionDescription::setRequired() {
243 Flags |= OptionDescriptionFlags::Required;
246 bool OptionDescription::isHidden() const {
247 return Flags & OptionDescriptionFlags::Hidden;
249 void OptionDescription::setHidden() {
250 Flags |= OptionDescriptionFlags::Hidden;
253 bool OptionDescription::isReallyHidden() const {
254 return Flags & OptionDescriptionFlags::ReallyHidden;
256 void OptionDescription::setReallyHidden() {
257 Flags |= OptionDescriptionFlags::ReallyHidden;
260 const char* OptionDescription::GenTypeDeclaration() const {
262 case OptionType::Alias:
264 case OptionType::ExternList:
265 case OptionType::PrefixList:
266 case OptionType::ParameterList:
267 return "cl::list<std::string>";
268 case OptionType::Switch:
269 case OptionType::ExternSwitch:
270 return "cl::opt<bool>";
271 case OptionType::ExternParameter:
272 case OptionType::Parameter:
273 case OptionType::Prefix:
275 return "cl::opt<std::string>";
279 std::string OptionDescription::GenVariableName() const {
280 const std::string& EscapedName = EscapeVariableName(Name);
282 case OptionType::Alias:
283 return "AutoGeneratedAlias_" + EscapedName;
284 case OptionType::PrefixList:
285 case OptionType::ParameterList:
286 case OptionType::ExternList:
287 return "AutoGeneratedList_" + EscapedName;
288 case OptionType::ExternSwitch:
289 case OptionType::Switch:
290 return "AutoGeneratedSwitch_" + EscapedName;
291 case OptionType::ExternParameter:
292 case OptionType::Prefix:
293 case OptionType::Parameter:
295 return "AutoGeneratedParameter_" + EscapedName;
299 /// OptionDescriptions - An OptionDescription array plus some helper
301 class OptionDescriptions {
302 typedef StringMap<OptionDescription> container_type;
304 /// Descriptions - A list of OptionDescriptions.
305 container_type Descriptions;
308 /// FindOption - exception-throwing wrapper for find().
309 const OptionDescription& FindOption(const std::string& OptName) const;
311 /// insertDescription - Insert new OptionDescription into
312 /// OptionDescriptions list
313 void InsertDescription (const OptionDescription& o);
315 // Support for STL-style iteration
316 typedef container_type::const_iterator const_iterator;
317 const_iterator begin() const { return Descriptions.begin(); }
318 const_iterator end() const { return Descriptions.end(); }
321 const OptionDescription&
322 OptionDescriptions::FindOption(const std::string& OptName) const
324 const_iterator I = Descriptions.find(OptName);
325 if (I != Descriptions.end())
328 throw OptName + ": no such option!";
331 void OptionDescriptions::InsertDescription (const OptionDescription& o)
333 container_type::iterator I = Descriptions.find(o.Name);
334 if (I != Descriptions.end()) {
335 OptionDescription& D = I->second;
339 Descriptions[o.Name] = o;
343 /// HandlerTable - A base class for function objects implemented as
344 /// 'tables of handlers'.
348 // Implementation details.
351 typedef void (T::* Handler) (const DagInit*);
352 /// HandlerMap - A map from property names to property handlers
353 typedef StringMap<Handler> HandlerMap;
355 static HandlerMap Handlers_;
356 static bool staticMembersInitialized_;
361 HandlerTable(T* cp) : childPtr(cp)
364 /// operator() - Just forwards to the corresponding property
366 void operator() (Init* i) {
367 const DagInit& property = InitPtrToDag(i);
368 const std::string& property_name = property.getOperator()->getAsString();
369 typename HandlerMap::iterator method = Handlers_.find(property_name);
371 if (method != Handlers_.end()) {
372 Handler h = method->second;
373 (childPtr->*h)(&property);
376 throw "No handler found for property " + property_name + "!";
380 void AddHandler(const char* Property, Handler Handl) {
381 Handlers_[Property] = Handl;
385 template <class T> typename HandlerTable<T>::HandlerMap
386 HandlerTable<T>::Handlers_;
387 template <class T> bool HandlerTable<T>::staticMembersInitialized_ = false;
390 /// CollectOptionProperties - Function object for iterating over an
391 /// option property list.
392 class CollectOptionProperties : public HandlerTable<CollectOptionProperties> {
395 /// optDescs_ - OptionDescriptions table. This is where the
396 /// information is stored.
397 OptionDescription& optDesc_;
401 explicit CollectOptionProperties(OptionDescription& OD)
402 : HandlerTable<CollectOptionProperties>(this), optDesc_(OD)
404 if (!staticMembersInitialized_) {
405 AddHandler("help", &CollectOptionProperties::onHelp);
406 AddHandler("hidden", &CollectOptionProperties::onHidden);
407 AddHandler("really_hidden", &CollectOptionProperties::onReallyHidden);
408 AddHandler("required", &CollectOptionProperties::onRequired);
410 staticMembersInitialized_ = true;
416 /// Option property handlers --
417 /// Methods that handle option properties such as (help) or (hidden).
419 void onHelp (const DagInit* d) {
420 checkNumberOfArguments(d, 1);
421 const std::string& help_message = InitPtrToString(d->getArg(0));
422 optDesc_.Help = help_message;
425 void onHidden (const DagInit* d) {
426 checkNumberOfArguments(d, 0);
428 optDesc_.setHidden();
431 void onReallyHidden (const DagInit* d) {
432 checkNumberOfArguments(d, 0);
434 optDesc_.setReallyHidden();
437 void onRequired (const DagInit* d) {
438 checkNumberOfArguments(d, 0);
440 optDesc_.setRequired();
445 /// checkToolProps - Throw an error if toolProps_ == 0.
446 void checkToolProps(const DagInit* d) {
448 throw "Option property " + d->getOperator()->getAsString()
449 + " can't be used in this context";
454 /// AddOption - A function object that is applied to every option
455 /// description. Used by CollectOptionDescriptions.
458 OptionDescriptions& OptDescs_;
461 explicit AddOption(OptionDescriptions& OD) : OptDescs_(OD)
464 void operator()(const Init* i) {
465 const DagInit& d = InitPtrToDag(i);
466 checkNumberOfArguments(&d, 1);
468 const OptionType::OptionType Type =
469 stringToOptionType(d.getOperator()->getAsString());
470 const std::string& Name = InitPtrToString(d.getArg(0));
472 OptionDescription OD(Type, Name);
475 checkNumberOfArguments(&d, 2);
478 // Aliases store the aliased option name in the 'Help' field.
479 OD.Help = InitPtrToString(d.getArg(1));
481 else if (!OD.isExtern()) {
482 processOptionProperties(&d, OD);
484 OptDescs_.InsertDescription(OD);
488 /// processOptionProperties - Go through the list of option
489 /// properties and call a corresponding handler for each.
490 static void processOptionProperties (const DagInit* d, OptionDescription& o) {
491 checkNumberOfArguments(d, 2);
492 DagInit::const_arg_iterator B = d->arg_begin();
493 // Skip the first argument: it's always the option name.
495 std::for_each(B, d->arg_end(), CollectOptionProperties(o));
500 /// CollectOptionDescriptions - Collects option properties from all
502 void CollectOptionDescriptions (RecordVector::const_iterator B,
503 RecordVector::const_iterator E,
504 OptionDescriptions& OptDescs)
506 // For every OptionList:
508 RecordVector::value_type T = *B;
509 // Throws an exception if the value does not exist.
510 ListInit* PropList = T->getValueAsListInit("options");
512 // For every option description in this list:
513 // collect the information and
514 std::for_each(PropList->begin(), PropList->end(), AddOption(OptDescs));
518 // Tool information record
520 namespace ToolFlags {
521 enum ToolFlags { Join = 0x1, Sink = 0x2 };
524 struct ToolDescription : public RefCountedBase<ToolDescription> {
528 StrVector InLanguage;
529 std::string OutLanguage;
530 std::string OutputSuffix;
533 // Various boolean properties
534 void setSink() { Flags |= ToolFlags::Sink; }
535 bool isSink() const { return Flags & ToolFlags::Sink; }
536 void setJoin() { Flags |= ToolFlags::Join; }
537 bool isJoin() const { return Flags & ToolFlags::Join; }
539 // Default ctor here is needed because StringMap can only store
540 // DefaultConstructible objects
541 ToolDescription() : CmdLine(0), Actions(0), Flags(0) {}
542 ToolDescription (const std::string& n)
543 : Name(n), CmdLine(0), Actions(0), Flags(0)
547 /// ToolDescriptions - A list of Tool information records.
548 typedef std::vector<IntrusiveRefCntPtr<ToolDescription> > ToolDescriptions;
551 /// CollectToolProperties - Function object for iterating over a list of
552 /// tool property records.
553 class CollectToolProperties : public HandlerTable<CollectToolProperties> {
556 /// toolDesc_ - Properties of the current Tool. This is where the
557 /// information is stored.
558 ToolDescription& toolDesc_;
562 explicit CollectToolProperties (ToolDescription& d)
563 : HandlerTable<CollectToolProperties>(this) , toolDesc_(d)
565 if (!staticMembersInitialized_) {
567 AddHandler("actions", &CollectToolProperties::onActions);
568 AddHandler("cmd_line", &CollectToolProperties::onCmdLine);
569 AddHandler("in_language", &CollectToolProperties::onInLanguage);
570 AddHandler("join", &CollectToolProperties::onJoin);
571 AddHandler("out_language", &CollectToolProperties::onOutLanguage);
572 AddHandler("output_suffix", &CollectToolProperties::onOutputSuffix);
573 AddHandler("sink", &CollectToolProperties::onSink);
575 staticMembersInitialized_ = true;
581 /// Property handlers --
582 /// Functions that extract information about tool properties from
583 /// DAG representation.
585 void onActions (const DagInit* d) {
586 checkNumberOfArguments(d, 1);
587 Init* Case = d->getArg(0);
588 if (typeid(*Case) != typeid(DagInit) ||
589 static_cast<DagInit*>(Case)->getOperator()->getAsString() != "case")
591 std::string("The argument to (actions) should be a 'case' construct!");
592 toolDesc_.Actions = Case;
595 void onCmdLine (const DagInit* d) {
596 checkNumberOfArguments(d, 1);
597 toolDesc_.CmdLine = d->getArg(0);
600 void onInLanguage (const DagInit* d) {
601 checkNumberOfArguments(d, 1);
602 Init* arg = d->getArg(0);
604 // Find out the argument's type.
605 if (typeid(*arg) == typeid(StringInit)) {
607 toolDesc_.InLanguage.push_back(InitPtrToString(arg));
611 const ListInit& lst = InitPtrToList(arg);
612 StrVector& out = toolDesc_.InLanguage;
614 // Copy strings to the output vector.
615 for (ListInit::const_iterator B = lst.begin(), E = lst.end();
617 out.push_back(InitPtrToString(*B));
620 // Remove duplicates.
621 std::sort(out.begin(), out.end());
622 StrVector::iterator newE = std::unique(out.begin(), out.end());
623 out.erase(newE, out.end());
627 void onJoin (const DagInit* d) {
628 checkNumberOfArguments(d, 0);
632 void onOutLanguage (const DagInit* d) {
633 checkNumberOfArguments(d, 1);
634 toolDesc_.OutLanguage = InitPtrToString(d->getArg(0));
637 void onOutputSuffix (const DagInit* d) {
638 checkNumberOfArguments(d, 1);
639 toolDesc_.OutputSuffix = InitPtrToString(d->getArg(0));
642 void onSink (const DagInit* d) {
643 checkNumberOfArguments(d, 0);
650 /// CollectToolDescriptions - Gather information about tool properties
651 /// from the parsed TableGen data (basically a wrapper for the
652 /// CollectToolProperties function object).
653 void CollectToolDescriptions (RecordVector::const_iterator B,
654 RecordVector::const_iterator E,
655 ToolDescriptions& ToolDescs)
657 // Iterate over a properties list of every Tool definition
659 const Record* T = *B;
660 // Throws an exception if the value does not exist.
661 ListInit* PropList = T->getValueAsListInit("properties");
663 IntrusiveRefCntPtr<ToolDescription>
664 ToolDesc(new ToolDescription(T->getName()));
666 std::for_each(PropList->begin(), PropList->end(),
667 CollectToolProperties(*ToolDesc));
668 ToolDescs.push_back(ToolDesc);
672 /// FillInEdgeVector - Merge all compilation graph definitions into
673 /// one single edge list.
674 void FillInEdgeVector(RecordVector::const_iterator B,
675 RecordVector::const_iterator E, RecordVector& Out) {
676 for (; B != E; ++B) {
677 const ListInit* edges = (*B)->getValueAsListInit("edges");
679 for (unsigned i = 0; i < edges->size(); ++i)
680 Out.push_back(edges->getElementAsRecord(i));
684 /// CalculatePriority - Calculate the priority of this plugin.
685 int CalculatePriority(RecordVector::const_iterator B,
686 RecordVector::const_iterator E) {
689 total += static_cast<int>((*B)->getValueAsInt("priority"));
694 /// NotInGraph - Helper function object for FilterNotInGraph.
697 const llvm::StringSet<>& ToolsInGraph_;
700 NotInGraph(const llvm::StringSet<>& ToolsInGraph)
701 : ToolsInGraph_(ToolsInGraph)
704 bool operator()(const IntrusiveRefCntPtr<ToolDescription>& x) {
705 return (ToolsInGraph_.count(x->Name) == 0);
709 /// FilterNotInGraph - Filter out from ToolDescs all Tools not
710 /// mentioned in the compilation graph definition.
711 void FilterNotInGraph (const RecordVector& EdgeVector,
712 ToolDescriptions& ToolDescs) {
714 // List all tools mentioned in the graph.
715 llvm::StringSet<> ToolsInGraph;
717 for (RecordVector::const_iterator B = EdgeVector.begin(),
718 E = EdgeVector.end(); B != E; ++B) {
720 const Record* Edge = *B;
721 const std::string& NodeA = Edge->getValueAsString("a");
722 const std::string& NodeB = Edge->getValueAsString("b");
725 ToolsInGraph.insert(NodeA);
726 ToolsInGraph.insert(NodeB);
729 // Filter ToolPropertiesList.
730 ToolDescriptions::iterator new_end =
731 std::remove_if(ToolDescs.begin(), ToolDescs.end(),
732 NotInGraph(ToolsInGraph));
733 ToolDescs.erase(new_end, ToolDescs.end());
736 /// FillInToolToLang - Fills in two tables that map tool names to
737 /// (input, output) languages. Helper function used by TypecheckGraph().
738 void FillInToolToLang (const ToolDescriptions& ToolDescs,
739 StringMap<StringSet<> >& ToolToInLang,
740 StringMap<std::string>& ToolToOutLang) {
741 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
742 E = ToolDescs.end(); B != E; ++B) {
743 const ToolDescription& D = *(*B);
744 for (StrVector::const_iterator B = D.InLanguage.begin(),
745 E = D.InLanguage.end(); B != E; ++B)
746 ToolToInLang[D.Name].insert(*B);
747 ToolToOutLang[D.Name] = D.OutLanguage;
751 /// TypecheckGraph - Check that names for output and input languages
752 /// on all edges do match. This doesn't do much when the information
753 /// about the whole graph is not available (i.e. when compiling most
755 void TypecheckGraph (const RecordVector& EdgeVector,
756 const ToolDescriptions& ToolDescs) {
757 StringMap<StringSet<> > ToolToInLang;
758 StringMap<std::string> ToolToOutLang;
760 FillInToolToLang(ToolDescs, ToolToInLang, ToolToOutLang);
761 StringMap<std::string>::iterator IAE = ToolToOutLang.end();
762 StringMap<StringSet<> >::iterator IBE = ToolToInLang.end();
764 for (RecordVector::const_iterator B = EdgeVector.begin(),
765 E = EdgeVector.end(); B != E; ++B) {
766 const Record* Edge = *B;
767 const std::string& NodeA = Edge->getValueAsString("a");
768 const std::string& NodeB = Edge->getValueAsString("b");
769 StringMap<std::string>::iterator IA = ToolToOutLang.find(NodeA);
770 StringMap<StringSet<> >::iterator IB = ToolToInLang.find(NodeB);
772 if (NodeA != "root") {
773 if (IA != IAE && IB != IBE && IB->second.count(IA->second) == 0)
774 throw "Edge " + NodeA + "->" + NodeB
775 + ": output->input language mismatch";
779 throw std::string("Edges back to the root are not allowed!");
783 /// WalkCase - Walks the 'case' expression DAG and invokes
784 /// TestCallback on every test, and StatementCallback on every
785 /// statement. Handles 'case' nesting, but not the 'and' and 'or'
787 // TODO: Re-implement EmitCaseConstructHandler on top of this function?
788 template <typename F1, typename F2>
789 void WalkCase(Init* Case, F1 TestCallback, F2 StatementCallback) {
790 const DagInit& d = InitPtrToDag(Case);
792 for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
795 if (even && dynamic_cast<DagInit*>(arg)
796 && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case")
797 WalkCase(arg, TestCallback, StatementCallback);
801 StatementCallback(arg);
806 /// ExtractOptionNames - A helper function object used by
807 /// CheckForSuperfluousOptions() to walk the 'case' DAG.
808 class ExtractOptionNames {
809 llvm::StringSet<>& OptionNames_;
811 void processDag(const Init* Statement) {
812 const DagInit& Stmt = InitPtrToDag(Statement);
813 const std::string& ActionName = Stmt.getOperator()->getAsString();
814 if (ActionName == "forward" || ActionName == "forward_as" ||
815 ActionName == "unpack_values" || ActionName == "switch_on" ||
816 ActionName == "parameter_equals" || ActionName == "element_in_list" ||
817 ActionName == "not_empty") {
818 checkNumberOfArguments(&Stmt, 1);
819 const std::string& Name = InitPtrToString(Stmt.getArg(0));
820 OptionNames_.insert(Name);
822 else if (ActionName == "and" || ActionName == "or") {
823 for (unsigned i = 0, NumArgs = Stmt.getNumArgs(); i < NumArgs; ++i) {
824 this->processDag(Stmt.getArg(i));
830 ExtractOptionNames(llvm::StringSet<>& OptionNames) : OptionNames_(OptionNames)
833 void operator()(const Init* Statement) {
834 if (typeid(*Statement) == typeid(ListInit)) {
835 const ListInit& DagList = *static_cast<const ListInit*>(Statement);
836 for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
838 this->processDag(*B);
841 this->processDag(Statement);
846 /// CheckForSuperfluousOptions - Check that there are no side
847 /// effect-free options (specified only in the OptionList). Otherwise,
848 /// output a warning.
849 void CheckForSuperfluousOptions (const RecordVector& Edges,
850 const ToolDescriptions& ToolDescs,
851 const OptionDescriptions& OptDescs) {
852 llvm::StringSet<> nonSuperfluousOptions;
854 // Add all options mentioned in the ToolDesc.Actions to the set of
855 // non-superfluous options.
856 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
857 E = ToolDescs.end(); B != E; ++B) {
858 const ToolDescription& TD = *(*B);
859 ExtractOptionNames Callback(nonSuperfluousOptions);
861 WalkCase(TD.Actions, Callback, Callback);
864 // Add all options mentioned in the 'case' clauses of the
865 // OptionalEdges of the compilation graph to the set of
866 // non-superfluous options.
867 for (RecordVector::const_iterator B = Edges.begin(), E = Edges.end();
869 const Record* Edge = *B;
870 DagInit* Weight = Edge->getValueAsDag("weight");
872 if (!isDagEmpty(Weight))
873 WalkCase(Weight, ExtractOptionNames(nonSuperfluousOptions), Id());
876 // Check that all options in OptDescs belong to the set of
877 // non-superfluous options.
878 for (OptionDescriptions::const_iterator B = OptDescs.begin(),
879 E = OptDescs.end(); B != E; ++B) {
880 const OptionDescription& Val = B->second;
881 if (!nonSuperfluousOptions.count(Val.Name)
882 && Val.Type != OptionType::Alias)
883 llvm::cerr << "Warning: option '-" << Val.Name << "' has no effect! "
884 "Probable cause: this option is specified only in the OptionList.\n";
888 /// EmitCaseTest1Arg - Helper function used by
889 /// EmitCaseConstructHandler.
890 bool EmitCaseTest1Arg(const std::string& TestName,
892 const OptionDescriptions& OptDescs,
894 checkNumberOfArguments(&d, 1);
895 const std::string& OptName = InitPtrToString(d.getArg(0));
896 if (TestName == "switch_on") {
897 const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
898 if (!OptionType::IsSwitch(OptDesc.Type))
899 throw OptName + ": incorrect option type - should be a switch!";
900 O << OptDesc.GenVariableName();
902 } else if (TestName == "input_languages_contain") {
903 O << "InLangs.count(\"" << OptName << "\") != 0";
905 } else if (TestName == "in_language") {
906 // This works only for single-argument Tool::GenerateAction. Join
907 // tools can process several files in different languages simultaneously.
909 // TODO: make this work with Edge::Weight (if possible).
910 O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"';
912 } else if (TestName == "not_empty") {
913 if (OptName == "o") {
914 O << "!OutputFilename.empty()";
918 const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
919 if (OptionType::IsSwitch(OptDesc.Type))
921 + ": incorrect option type - should be a list or parameter!";
922 O << '!' << OptDesc.GenVariableName() << ".empty()";
930 /// EmitCaseTest2Args - Helper function used by
931 /// EmitCaseConstructHandler.
932 bool EmitCaseTest2Args(const std::string& TestName,
934 const char* IndentLevel,
935 const OptionDescriptions& OptDescs,
937 checkNumberOfArguments(&d, 2);
938 const std::string& OptName = InitPtrToString(d.getArg(0));
939 const std::string& OptArg = InitPtrToString(d.getArg(1));
940 const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
942 if (TestName == "parameter_equals") {
943 if (!OptionType::IsParameter(OptDesc.Type))
944 throw OptName + ": incorrect option type - should be a parameter!";
945 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
948 else if (TestName == "element_in_list") {
949 if (!OptionType::IsList(OptDesc.Type))
950 throw OptName + ": incorrect option type - should be a list!";
951 const std::string& VarName = OptDesc.GenVariableName();
952 O << "std::find(" << VarName << ".begin(),\n"
953 << IndentLevel << Indent1 << VarName << ".end(), \""
954 << OptArg << "\") != " << VarName << ".end()";
961 // Forward declaration.
962 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
963 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
964 const OptionDescriptions& OptDescs,
967 /// EmitLogicalOperationTest - Helper function used by
968 /// EmitCaseConstructHandler.
969 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
970 const char* IndentLevel,
971 const OptionDescriptions& OptDescs,
974 for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
975 const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
976 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
977 if (j != NumArgs - 1)
978 O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
984 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
985 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
986 const OptionDescriptions& OptDescs,
988 const std::string& TestName = d.getOperator()->getAsString();
990 if (TestName == "and")
991 EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
992 else if (TestName == "or")
993 EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
994 else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
996 else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
999 throw TestName + ": unknown edge property!";
1002 // Emit code that handles the 'case' construct.
1003 // Takes a function object that should emit code for every case clause.
1004 // Callback's type is
1005 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
1006 template <typename F>
1007 void EmitCaseConstructHandler(const Init* Dag, const char* IndentLevel,
1008 F Callback, bool EmitElseIf,
1009 const OptionDescriptions& OptDescs,
1011 const DagInit* d = &InitPtrToDag(Dag);
1012 if (d->getOperator()->getAsString() != "case")
1013 throw std::string("EmitCaseConstructHandler should be invoked"
1014 " only on 'case' expressions!");
1016 unsigned numArgs = d->getNumArgs();
1017 if (d->getNumArgs() < 2)
1018 throw "There should be at least one clause in the 'case' expression:\n"
1021 for (unsigned i = 0; i != numArgs; ++i) {
1022 const DagInit& Test = InitPtrToDag(d->getArg(i));
1025 if (Test.getOperator()->getAsString() == "default") {
1027 throw std::string("The 'default' clause should be the last in the"
1028 "'case' construct!");
1029 O << IndentLevel << "else {\n";
1032 O << IndentLevel << ((i != 0 && EmitElseIf) ? "else if (" : "if (");
1033 EmitCaseTest(Test, IndentLevel, OptDescs, O);
1037 // Emit the corresponding statement.
1040 throw "Case construct handler: no corresponding action "
1041 "found for the test " + Test.getAsString() + '!';
1043 Init* arg = d->getArg(i);
1044 const DagInit* nd = dynamic_cast<DagInit*>(arg);
1045 if (nd && (nd->getOperator()->getAsString() == "case")) {
1046 // Handle the nested 'case'.
1047 EmitCaseConstructHandler(nd, (std::string(IndentLevel) + Indent1).c_str(),
1048 Callback, EmitElseIf, OptDescs, O);
1051 Callback(arg, (std::string(IndentLevel) + Indent1).c_str(), O);
1053 O << IndentLevel << "}\n";
1057 /// SubstituteSpecialCommands - Perform string substitution for $CALL
1058 /// and $ENV. Helper function used by EmitCmdLineVecFill().
1059 std::string SubstituteSpecialCommands(const std::string& cmd) {
1060 size_t cparen = cmd.find(")");
1063 if (cmd.find("$CALL(") == 0) {
1064 if (cmd.size() == 6)
1065 throw std::string("$CALL invocation: empty argument list!");
1068 ret += std::string(cmd.begin() + 6, cmd.begin() + cparen);
1071 else if (cmd.find("$ENV(") == 0) {
1072 if (cmd.size() == 5)
1073 throw std::string("$ENV invocation: empty argument list!");
1075 ret += "checkCString(std::getenv(\"";
1076 ret += std::string(cmd.begin() + 5, cmd.begin() + cparen);
1080 throw "Unknown special command: " + cmd;
1083 if (cmd.begin() + cparen + 1 != cmd.end()) {
1084 ret += " + std::string(\"";
1085 ret += (cmd.c_str() + cparen + 1);
1092 /// EmitCmdLineVecFill - Emit code that fills in the command line
1093 /// vector. Helper function used by EmitGenerateActionMethod().
1094 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
1095 bool IsJoin, const char* IndentLevel,
1098 SplitString(InitPtrToString(CmdLine), StrVec);
1100 throw "Tool " + ToolName + " has empty command line!";
1102 StrVector::const_iterator I = StrVec.begin();
1104 for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
1105 const std::string& cmd = *I;
1107 if (cmd.at(0) == '$') {
1108 if (cmd == "$INFILE") {
1110 O << "for (PathVector::const_iterator B = inFiles.begin()"
1111 << ", E = inFiles.end();\n"
1112 << IndentLevel << "B != E; ++B)\n"
1113 << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
1115 O << "vec.push_back(inFile.toString());\n";
1117 else if (cmd == "$OUTFILE") {
1118 O << "vec.push_back(out_file);\n";
1121 O << "vec.push_back(" << SubstituteSpecialCommands(cmd);
1126 O << "vec.push_back(\"" << cmd << "\");\n";
1129 O << IndentLevel << "cmd = "
1130 << ((StrVec[0][0] == '$') ? SubstituteSpecialCommands(StrVec[0])
1131 : "\"" + StrVec[0] + "\"")
1135 /// EmitCmdLineVecFillCallback - A function object wrapper around
1136 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
1137 /// argument to EmitCaseConstructHandler().
1138 class EmitCmdLineVecFillCallback {
1140 const std::string& ToolName;
1142 EmitCmdLineVecFillCallback(bool J, const std::string& TN)
1143 : IsJoin(J), ToolName(TN) {}
1145 void operator()(const Init* Statement, const char* IndentLevel,
1146 std::ostream& O) const
1148 EmitCmdLineVecFill(Statement, ToolName, IsJoin,
1153 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
1154 /// implement EmitActionHandler. Emits code for
1155 /// handling the (forward) and (forward_as) option properties.
1156 void EmitForwardOptionPropertyHandlingCode (const OptionDescription& D,
1158 const std::string& NewName,
1160 const std::string& Name = NewName.empty()
1165 case OptionType::Switch:
1166 case OptionType::ExternSwitch:
1167 O << Indent << "vec.push_back(\"" << Name << "\");\n";
1169 case OptionType::Parameter:
1170 case OptionType::ExternParameter:
1171 O << Indent << "vec.push_back(\"" << Name << "\");\n";
1172 O << Indent << "vec.push_back(" << D.GenVariableName() << ");\n";
1174 case OptionType::Prefix:
1175 O << Indent << "vec.push_back(\"" << Name << "\" + "
1176 << D.GenVariableName() << ");\n";
1178 case OptionType::PrefixList:
1179 O << Indent << "for (" << D.GenTypeDeclaration()
1180 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1181 << Indent << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
1182 << Indent << Indent1 << "vec.push_back(\"" << Name << "\" + "
1185 case OptionType::ParameterList:
1186 case OptionType::ExternList:
1187 O << Indent << "for (" << D.GenTypeDeclaration()
1188 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1189 << Indent << "E = " << D.GenVariableName()
1190 << ".end() ; B != E; ++B) {\n"
1191 << Indent << Indent1 << "vec.push_back(\"" << Name << "\");\n"
1192 << Indent << Indent1 << "vec.push_back(*B);\n"
1195 case OptionType::Alias:
1197 throw std::string("Aliases are not allowed in tool option descriptions!");
1201 /// EmitActionHandler - Emit code that handles actions. Used by
1202 /// EmitGenerateActionMethod() as an argument to
1203 /// EmitCaseConstructHandler().
1204 class EmitActionHandler {
1205 const OptionDescriptions& OptDescs;
1207 void processActionDag(const Init* Statement, const char* IndentLevel,
1208 std::ostream& O) const
1210 const DagInit& Dag = InitPtrToDag(Statement);
1211 const std::string& ActionName = Dag.getOperator()->getAsString();
1213 if (ActionName == "append_cmd") {
1214 checkNumberOfArguments(&Dag, 1);
1215 const std::string& Cmd = InitPtrToString(Dag.getArg(0));
1216 O << IndentLevel << "vec.push_back(\"" << Cmd << "\");\n";
1218 else if (ActionName == "forward") {
1219 checkNumberOfArguments(&Dag, 1);
1220 const std::string& Name = InitPtrToString(Dag.getArg(0));
1221 EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1222 IndentLevel, "", O);
1224 else if (ActionName == "forward_as") {
1225 checkNumberOfArguments(&Dag, 2);
1226 const std::string& Name = InitPtrToString(Dag.getArg(0));
1227 const std::string& NewName = InitPtrToString(Dag.getArg(0));
1228 EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1229 IndentLevel, NewName, O);
1231 else if (ActionName == "output_suffix") {
1232 checkNumberOfArguments(&Dag, 1);
1233 const std::string& OutSuf = InitPtrToString(Dag.getArg(0));
1234 O << IndentLevel << "output_suffix = \"" << OutSuf << "\";\n";
1236 else if (ActionName == "stop_compilation") {
1237 O << IndentLevel << "stop_compilation = true;\n";
1239 else if (ActionName == "unpack_values") {
1240 checkNumberOfArguments(&Dag, 1);
1241 const std::string& Name = InitPtrToString(Dag.getArg(0));
1242 const OptionDescription& D = OptDescs.FindOption(Name);
1244 if (OptionType::IsList(D.Type)) {
1245 O << IndentLevel << "for (" << D.GenTypeDeclaration()
1246 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1247 << IndentLevel << "E = " << D.GenVariableName()
1248 << ".end(); B != E; ++B)\n"
1249 << IndentLevel << Indent1 << "llvm::SplitString(*B, vec, \",\");\n";
1251 else if (OptionType::IsParameter(D.Type)){
1252 O << Indent3 << "llvm::SplitString("
1253 << D.GenVariableName() << ", vec, \",\");\n";
1256 throw "Option '" + D.Name +
1257 "': switches can't have the 'unpack_values' property!";
1261 throw "Unknown action name: " + ActionName + "!";
1265 EmitActionHandler(const OptionDescriptions& OD)
1268 void operator()(const Init* Statement, const char* IndentLevel,
1269 std::ostream& O) const
1271 if (typeid(*Statement) == typeid(ListInit)) {
1272 const ListInit& DagList = *static_cast<const ListInit*>(Statement);
1273 for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
1275 this->processActionDag(*B, IndentLevel, O);
1278 this->processActionDag(Statement, IndentLevel, O);
1283 // EmitGenerateActionMethod - Emit one of two versions of the
1284 // Tool::GenerateAction() method.
1285 void EmitGenerateActionMethod (const ToolDescription& D,
1286 const OptionDescriptions& OptDescs,
1287 bool IsJoin, std::ostream& O) {
1289 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
1291 O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
1293 O << Indent2 << "bool HasChildren,\n"
1294 << Indent2 << "const llvm::sys::Path& TempDir,\n"
1295 << Indent2 << "const InputLanguagesSet& InLangs,\n"
1296 << Indent2 << "const LanguageMap& LangMap) const\n"
1298 << Indent2 << "std::string cmd;\n"
1299 << Indent2 << "std::vector<std::string> vec;\n"
1300 << Indent2 << "bool stop_compilation = !HasChildren;\n"
1301 << Indent2 << "const char* output_suffix = \"" << D.OutputSuffix << "\";\n"
1302 << Indent2 << "std::string out_file;\n\n";
1304 // For every understood option, emit handling code.
1306 EmitCaseConstructHandler(D.Actions, Indent2, EmitActionHandler(OptDescs),
1307 false, OptDescs, O);
1309 O << '\n' << Indent2
1310 << "out_file = OutFilename(" << (IsJoin ? "sys::Path(),\n" : "inFile,\n")
1311 << Indent3 << "TempDir, stop_compilation, output_suffix).toString();\n\n";
1313 // cmd_line is either a string or a 'case' construct.
1315 throw "Tool " + D.Name + " has no cmd_line property!";
1316 else if (typeid(*D.CmdLine) == typeid(StringInit))
1317 EmitCmdLineVecFill(D.CmdLine, D.Name, IsJoin, Indent2, O);
1319 EmitCaseConstructHandler(D.CmdLine, Indent2,
1320 EmitCmdLineVecFillCallback(IsJoin, D.Name),
1323 // Handle the Sink property.
1325 O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
1326 << Indent3 << "vec.insert(vec.end(), "
1327 << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
1328 << Indent2 << "}\n";
1331 O << Indent2 << "return Action(cmd, vec, stop_compilation, out_file);\n"
1332 << Indent1 << "}\n\n";
1335 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
1336 /// a given Tool class.
1337 void EmitGenerateActionMethods (const ToolDescription& ToolDesc,
1338 const OptionDescriptions& OptDescs,
1340 if (!ToolDesc.isJoin())
1341 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
1342 << Indent2 << "bool HasChildren,\n"
1343 << Indent2 << "const llvm::sys::Path& TempDir,\n"
1344 << Indent2 << "const InputLanguagesSet& InLangs,\n"
1345 << Indent2 << "const LanguageMap& LangMap) const\n"
1347 << Indent2 << "throw std::runtime_error(\"" << ToolDesc.Name
1348 << " is not a Join tool!\");\n"
1349 << Indent1 << "}\n\n";
1351 EmitGenerateActionMethod(ToolDesc, OptDescs, true, O);
1353 EmitGenerateActionMethod(ToolDesc, OptDescs, false, O);
1356 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1357 /// methods for a given Tool class.
1358 void EmitInOutLanguageMethods (const ToolDescription& D, std::ostream& O) {
1359 O << Indent1 << "const char** InputLanguages() const {\n"
1360 << Indent2 << "return InputLanguages_;\n"
1361 << Indent1 << "}\n\n";
1363 if (D.OutLanguage.empty())
1364 throw "Tool " + D.Name + " has no 'out_language' property!";
1366 O << Indent1 << "const char* OutputLanguage() const {\n"
1367 << Indent2 << "return \"" << D.OutLanguage << "\";\n"
1368 << Indent1 << "}\n\n";
1371 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1372 void EmitNameMethod (const ToolDescription& D, std::ostream& O) {
1373 O << Indent1 << "const char* Name() const {\n"
1374 << Indent2 << "return \"" << D.Name << "\";\n"
1375 << Indent1 << "}\n\n";
1378 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1380 void EmitIsJoinMethod (const ToolDescription& D, std::ostream& O) {
1381 O << Indent1 << "bool IsJoin() const {\n";
1383 O << Indent2 << "return true;\n";
1385 O << Indent2 << "return false;\n";
1386 O << Indent1 << "}\n\n";
1389 /// EmitStaticMemberDefinitions - Emit static member definitions for a
1390 /// given Tool class.
1391 void EmitStaticMemberDefinitions(const ToolDescription& D, std::ostream& O) {
1392 if (D.InLanguage.empty())
1393 throw "Tool " + D.Name + " has no 'in_language' property!";
1395 O << "const char* " << D.Name << "::InputLanguages_[] = {";
1396 for (StrVector::const_iterator B = D.InLanguage.begin(),
1397 E = D.InLanguage.end(); B != E; ++B)
1398 O << '\"' << *B << "\", ";
1402 /// EmitToolClassDefinition - Emit a Tool class definition.
1403 void EmitToolClassDefinition (const ToolDescription& D,
1404 const OptionDescriptions& OptDescs,
1406 if (D.Name == "root")
1410 O << "class " << D.Name << " : public ";
1416 O << "{\nprivate:\n"
1417 << Indent1 << "static const char* InputLanguages_[];\n\n";
1420 EmitNameMethod(D, O);
1421 EmitInOutLanguageMethods(D, O);
1422 EmitIsJoinMethod(D, O);
1423 EmitGenerateActionMethods(D, OptDescs, O);
1425 // Close class definition
1428 EmitStaticMemberDefinitions(D, O);
1432 /// EmitOptionDefintions - Iterate over a list of option descriptions
1433 /// and emit registration code.
1434 void EmitOptionDefintions (const OptionDescriptions& descs,
1435 bool HasSink, bool HasExterns,
1438 std::vector<OptionDescription> Aliases;
1440 // Emit static cl::Option variables.
1441 for (OptionDescriptions::const_iterator B = descs.begin(),
1442 E = descs.end(); B!=E; ++B) {
1443 const OptionDescription& val = B->second;
1445 if (val.Type == OptionType::Alias) {
1446 Aliases.push_back(val);
1453 O << val.GenTypeDeclaration() << ' '
1454 << val.GenVariableName();
1456 if (val.isExtern()) {
1461 O << "(\"" << val.Name << '\"';
1463 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1464 O << ", cl::Prefix";
1466 if (val.isRequired()) {
1468 case OptionType::PrefixList:
1469 case OptionType::ParameterList:
1470 O << ", cl::OneOrMore";
1473 O << ", cl::Required";
1477 if (val.isReallyHidden() || val.isHidden()) {
1478 if (val.isRequired())
1482 if (val.isReallyHidden())
1483 O << " cl::ReallyHidden";
1488 if (!val.Help.empty())
1489 O << ", cl::desc(\"" << val.Help << "\")";
1494 // Emit the aliases (they should go after all the 'proper' options).
1495 for (std::vector<OptionDescription>::const_iterator
1496 B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
1497 const OptionDescription& val = *B;
1499 O << val.GenTypeDeclaration() << ' '
1500 << val.GenVariableName()
1501 << "(\"" << val.Name << '\"';
1503 const OptionDescription& D = descs.FindOption(val.Help);
1504 O << ", cl::aliasopt(" << D.GenVariableName() << ")";
1506 O << ", cl::desc(\"" << "An alias for -" + val.Help << "\"));\n";
1509 // Emit the sink option.
1511 O << (HasExterns ? "extern cl" : "cl")
1512 << "::list<std::string> " << SinkOptionName
1513 << (HasExterns ? ";\n" : "(cl::Sink);\n");
1518 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1519 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1522 O << "namespace {\n\n";
1523 O << "void PopulateLanguageMapLocal(LanguageMap& langMap) {\n";
1525 // Get the relevant field out of RecordKeeper
1526 const Record* LangMapRecord = Records.getDef("LanguageMap");
1528 // It is allowed for a plugin to have no language map.
1529 if (LangMapRecord) {
1531 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1532 if (!LangsToSuffixesList)
1533 throw std::string("Error in the language map definition!");
1535 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1536 const Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1538 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1539 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1541 for (unsigned i = 0; i < Suffixes->size(); ++i)
1542 O << Indent1 << "langMap[\""
1543 << InitPtrToString(Suffixes->getElement(i))
1544 << "\"] = \"" << Lang << "\";\n";
1551 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1552 /// by EmitEdgeClass().
1553 void IncDecWeight (const Init* i, const char* IndentLevel,
1555 const DagInit& d = InitPtrToDag(i);
1556 const std::string& OpName = d.getOperator()->getAsString();
1558 if (OpName == "inc_weight")
1559 O << IndentLevel << "ret += ";
1560 else if (OpName == "dec_weight")
1561 O << IndentLevel << "ret -= ";
1563 throw "Unknown operator in edge properties list: " + OpName + '!';
1565 if (d.getNumArgs() > 0)
1566 O << InitPtrToInt(d.getArg(0)) << ";\n";
1572 /// EmitEdgeClass - Emit a single Edge# class.
1573 void EmitEdgeClass (unsigned N, const std::string& Target,
1574 DagInit* Case, const OptionDescriptions& OptDescs,
1577 // Class constructor.
1578 O << "class Edge" << N << ": public Edge {\n"
1580 << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1583 // Function Weight().
1584 << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1585 << Indent2 << "unsigned ret = 0;\n";
1587 // Handle the 'case' construct.
1588 EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
1590 O << Indent2 << "return ret;\n"
1591 << Indent1 << "};\n\n};\n\n";
1594 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1595 void EmitEdgeClasses (const RecordVector& EdgeVector,
1596 const OptionDescriptions& OptDescs,
1599 for (RecordVector::const_iterator B = EdgeVector.begin(),
1600 E = EdgeVector.end(); B != E; ++B) {
1601 const Record* Edge = *B;
1602 const std::string& NodeB = Edge->getValueAsString("b");
1603 DagInit* Weight = Edge->getValueAsDag("weight");
1605 if (!isDagEmpty(Weight))
1606 EmitEdgeClass(i, NodeB, Weight, OptDescs, O);
1611 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1613 void EmitPopulateCompilationGraph (const RecordVector& EdgeVector,
1614 const ToolDescriptions& ToolDescs,
1617 O << "namespace {\n\n";
1618 O << "void PopulateCompilationGraphLocal(CompilationGraph& G) {\n";
1620 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1621 E = ToolDescs.end(); B != E; ++B)
1622 O << Indent1 << "G.insertNode(new " << (*B)->Name << "());\n";
1629 for (RecordVector::const_iterator B = EdgeVector.begin(),
1630 E = EdgeVector.end(); B != E; ++B) {
1631 const Record* Edge = *B;
1632 const std::string& NodeA = Edge->getValueAsString("a");
1633 const std::string& NodeB = Edge->getValueAsString("b");
1634 DagInit* Weight = Edge->getValueAsDag("weight");
1636 O << Indent1 << "G.insertEdge(\"" << NodeA << "\", ";
1638 if (isDagEmpty(Weight))
1639 O << "new SimpleEdge(\"" << NodeB << "\")";
1641 O << "new Edge" << i << "()";
1650 /// ExtractHookNames - Extract the hook names from all instances of
1651 /// $CALL(HookName) in the provided command line string. Helper
1652 /// function used by FillInHookNames().
1653 class ExtractHookNames {
1654 llvm::StringSet<>& HookNames_;
1656 ExtractHookNames(llvm::StringSet<>& HookNames)
1657 : HookNames_(HookNames_) {}
1659 void operator()(const Init* CmdLine) {
1661 llvm::SplitString(InitPtrToString(CmdLine), cmds);
1662 for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1664 const std::string& cmd = *B;
1665 if (cmd.find("$CALL(") == 0) {
1666 if (cmd.size() == 6)
1667 throw std::string("$CALL invocation: empty argument list!");
1668 HookNames_.insert(std::string(cmd.begin() + 6,
1669 cmd.begin() + cmd.find(")")));
1675 /// FillInHookNames - Actually extract the hook names from all command
1676 /// line strings. Helper function used by EmitHookDeclarations().
1677 void FillInHookNames(const ToolDescriptions& ToolDescs,
1678 llvm::StringSet<>& HookNames)
1680 // For all command lines:
1681 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1682 E = ToolDescs.end(); B != E; ++B) {
1683 const ToolDescription& D = *(*B);
1686 if (dynamic_cast<StringInit*>(D.CmdLine))
1687 // This is a string.
1688 ExtractHookNames(HookNames).operator()(D.CmdLine);
1690 // This is a 'case' construct.
1691 WalkCase(D.CmdLine, Id(), ExtractHookNames(HookNames));
1695 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1696 /// property records and emit hook function declaration for each
1697 /// instance of $CALL(HookName).
1698 void EmitHookDeclarations(const ToolDescriptions& ToolDescs, std::ostream& O) {
1699 llvm::StringSet<> HookNames;
1700 FillInHookNames(ToolDescs, HookNames);
1701 if (HookNames.empty())
1704 O << "namespace hooks {\n";
1705 for (StringSet<>::const_iterator B = HookNames.begin(), E = HookNames.end();
1707 O << Indent1 << "std::string " << B->first() << "();\n";
1712 /// EmitRegisterPlugin - Emit code to register this plugin.
1713 void EmitRegisterPlugin(int Priority, std::ostream& O) {
1714 O << "namespace {\n\n"
1715 << "struct Plugin : public llvmc::BasePlugin {\n\n"
1716 << Indent1 << "int Priority() const { return " << Priority << "; }\n\n"
1717 << Indent1 << "void PopulateLanguageMap(LanguageMap& langMap) const\n"
1718 << Indent1 << "{ PopulateLanguageMapLocal(langMap); }\n\n"
1720 << "void PopulateCompilationGraph(CompilationGraph& graph) const\n"
1721 << Indent1 << "{ PopulateCompilationGraphLocal(graph); }\n"
1724 << "static llvmc::RegisterPlugin<Plugin> RP;\n\n}\n\n";
1727 /// EmitIncludes - Emit necessary #include directives and some
1728 /// additional declarations.
1729 void EmitIncludes(std::ostream& O) {
1730 O << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n"
1731 << "#include \"llvm/CompilerDriver/Plugin.h\"\n"
1732 << "#include \"llvm/CompilerDriver/Tool.h\"\n\n"
1734 << "#include \"llvm/ADT/StringExtras.h\"\n"
1735 << "#include \"llvm/Support/CommandLine.h\"\n\n"
1737 << "#include <cstdlib>\n"
1738 << "#include <stdexcept>\n\n"
1740 << "using namespace llvm;\n"
1741 << "using namespace llvmc;\n\n"
1743 << "extern cl::opt<std::string> OutputFilename;\n\n"
1745 << "inline const char* checkCString(const char* s)\n"
1746 << "{ return s == NULL ? \"\" : s; }\n\n";
1750 /// PluginData - Holds all information about a plugin.
1752 OptionDescriptions OptDescs;
1755 ToolDescriptions ToolDescs;
1760 /// HasSink - Go through the list of tool descriptions and check if
1761 /// there are any with the 'sink' property set.
1762 bool HasSink(const ToolDescriptions& ToolDescs) {
1763 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1764 E = ToolDescs.end(); B != E; ++B)
1771 /// HasExterns - Go through the list of option descriptions and check
1772 /// if there are any external options.
1773 bool HasExterns(const OptionDescriptions& OptDescs) {
1774 for (OptionDescriptions::const_iterator B = OptDescs.begin(),
1775 E = OptDescs.end(); B != E; ++B)
1776 if (B->second.isExtern())
1782 /// CollectPluginData - Collect tool and option properties,
1783 /// compilation graph edges and plugin priority from the parse tree.
1784 void CollectPluginData (const RecordKeeper& Records, PluginData& Data) {
1785 // Collect option properties.
1786 const RecordVector& OptionLists =
1787 Records.getAllDerivedDefinitions("OptionList");
1788 CollectOptionDescriptions(OptionLists.begin(), OptionLists.end(),
1791 // Collect tool properties.
1792 const RecordVector& Tools = Records.getAllDerivedDefinitions("Tool");
1793 CollectToolDescriptions(Tools.begin(), Tools.end(), Data.ToolDescs);
1794 Data.HasSink = HasSink(Data.ToolDescs);
1795 Data.HasExterns = HasExterns(Data.OptDescs);
1797 // Collect compilation graph edges.
1798 const RecordVector& CompilationGraphs =
1799 Records.getAllDerivedDefinitions("CompilationGraph");
1800 FillInEdgeVector(CompilationGraphs.begin(), CompilationGraphs.end(),
1803 // Calculate the priority of this plugin.
1804 const RecordVector& Priorities =
1805 Records.getAllDerivedDefinitions("PluginPriority");
1806 Data.Priority = CalculatePriority(Priorities.begin(), Priorities.end());
1809 /// CheckPluginData - Perform some sanity checks on the collected data.
1810 void CheckPluginData(PluginData& Data) {
1811 // Filter out all tools not mentioned in the compilation graph.
1812 FilterNotInGraph(Data.Edges, Data.ToolDescs);
1814 // Typecheck the compilation graph.
1815 TypecheckGraph(Data.Edges, Data.ToolDescs);
1817 // Check that there are no options without side effects (specified
1818 // only in the OptionList).
1819 CheckForSuperfluousOptions(Data.Edges, Data.ToolDescs, Data.OptDescs);
1823 void EmitPluginCode(const PluginData& Data, std::ostream& O) {
1824 // Emit file header.
1827 // Emit global option registration code.
1828 EmitOptionDefintions(Data.OptDescs, Data.HasSink, Data.HasExterns, O);
1830 // Emit hook declarations.
1831 EmitHookDeclarations(Data.ToolDescs, O);
1833 // Emit PopulateLanguageMap() function
1834 // (a language map maps from file extensions to language names).
1835 EmitPopulateLanguageMap(Records, O);
1837 // Emit Tool classes.
1838 for (ToolDescriptions::const_iterator B = Data.ToolDescs.begin(),
1839 E = Data.ToolDescs.end(); B!=E; ++B)
1840 EmitToolClassDefinition(*(*B), Data.OptDescs, O);
1842 // Emit Edge# classes.
1843 EmitEdgeClasses(Data.Edges, Data.OptDescs, O);
1845 // Emit PopulateCompilationGraph() function.
1846 EmitPopulateCompilationGraph(Data.Edges, Data.ToolDescs, O);
1848 // Emit code for plugin registration.
1849 EmitRegisterPlugin(Data.Priority, O);
1855 // End of anonymous namespace
1858 /// run - The back-end entry point.
1859 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1863 CollectPluginData(Records, Data);
1864 CheckPluginData(Data);
1866 EmitSourceFileHeader("LLVMC Configuration Library", O);
1867 EmitPluginCode(Data, O);
1869 } catch (std::exception& Error) {
1870 throw Error.what() + std::string(" - usually this means a syntax error.");