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 || 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 /// oneOf - Does the input string contain this character?
122 bool oneOf(const char* lst, char c) {
130 template <class I, class S>
131 void checkedIncrement(I& P, I E, S ErrorString) {
137 //===----------------------------------------------------------------------===//
138 /// Back-end specific code
141 /// OptionType - One of six different option types. See the
142 /// documentation for detailed description of differences.
143 namespace OptionType {
144 enum OptionType { Alias, Switch, Parameter, ParameterList,
147 bool IsList (OptionType t) {
148 return (t == ParameterList || t == PrefixList);
151 bool IsSwitch (OptionType t) {
152 return (t == Switch);
155 bool IsParameter (OptionType t) {
156 return (t == Parameter || t == Prefix);
161 OptionType::OptionType stringToOptionType(const std::string& T) {
162 if (T == "alias_option")
163 return OptionType::Alias;
164 else if (T == "switch_option")
165 return OptionType::Switch;
166 else if (T == "parameter_option")
167 return OptionType::Parameter;
168 else if (T == "parameter_list_option")
169 return OptionType::ParameterList;
170 else if (T == "prefix_option")
171 return OptionType::Prefix;
172 else if (T == "prefix_list_option")
173 return OptionType::PrefixList;
175 throw "Unknown option type: " + T + '!';
178 namespace OptionDescriptionFlags {
179 enum OptionDescriptionFlags { Required = 0x1, Hidden = 0x2,
180 ReallyHidden = 0x4, Extern = 0x8,
181 OneOrMore = 0x10, ZeroOrOne = 0x20 };
184 /// OptionDescription - Represents data contained in a single
185 /// OptionList entry.
186 struct OptionDescription {
187 OptionType::OptionType Type;
193 OptionDescription(OptionType::OptionType t = OptionType::Switch,
194 const std::string& n = "",
195 const std::string& h = DefaultHelpString)
196 : Type(t), Name(n), Flags(0x0), Help(h), MultiVal(1)
199 /// GenTypeDeclaration - Returns the C++ variable type of this
201 const char* GenTypeDeclaration() const;
203 /// GenVariableName - Returns the variable name used in the
204 /// generated C++ code.
205 std::string GenVariableName() const;
207 /// Merge - Merge two option descriptions.
208 void Merge (const OptionDescription& other);
210 // Misc convenient getters/setters.
212 bool isAlias() const;
214 bool isMultiVal() const;
216 bool isExtern() const;
219 bool isRequired() const;
222 bool isOneOrMore() const;
225 bool isZeroOrOne() const;
228 bool isHidden() const;
231 bool isReallyHidden() const;
232 void setReallyHidden();
236 void OptionDescription::Merge (const OptionDescription& other)
238 if (other.Type != Type)
239 throw "Conflicting definitions for the option " + Name + "!";
241 if (Help == other.Help || Help == DefaultHelpString)
243 else if (other.Help != DefaultHelpString) {
244 llvm::cerr << "Warning: several different help strings"
245 " defined for option " + Name + "\n";
248 Flags |= other.Flags;
251 bool OptionDescription::isAlias() const {
252 return Type == OptionType::Alias;
255 bool OptionDescription::isMultiVal() const {
259 bool OptionDescription::isExtern() const {
260 return Flags & OptionDescriptionFlags::Extern;
262 void OptionDescription::setExtern() {
263 Flags |= OptionDescriptionFlags::Extern;
266 bool OptionDescription::isRequired() const {
267 return Flags & OptionDescriptionFlags::Required;
269 void OptionDescription::setRequired() {
270 Flags |= OptionDescriptionFlags::Required;
273 bool OptionDescription::isOneOrMore() const {
274 return Flags & OptionDescriptionFlags::OneOrMore;
276 void OptionDescription::setOneOrMore() {
277 Flags |= OptionDescriptionFlags::OneOrMore;
280 bool OptionDescription::isZeroOrOne() const {
281 return Flags & OptionDescriptionFlags::ZeroOrOne;
283 void OptionDescription::setZeroOrOne() {
284 Flags |= OptionDescriptionFlags::ZeroOrOne;
287 bool OptionDescription::isHidden() const {
288 return Flags & OptionDescriptionFlags::Hidden;
290 void OptionDescription::setHidden() {
291 Flags |= OptionDescriptionFlags::Hidden;
294 bool OptionDescription::isReallyHidden() const {
295 return Flags & OptionDescriptionFlags::ReallyHidden;
297 void OptionDescription::setReallyHidden() {
298 Flags |= OptionDescriptionFlags::ReallyHidden;
301 const char* OptionDescription::GenTypeDeclaration() const {
303 case OptionType::Alias:
305 case OptionType::PrefixList:
306 case OptionType::ParameterList:
307 return "cl::list<std::string>";
308 case OptionType::Switch:
309 return "cl::opt<bool>";
310 case OptionType::Parameter:
311 case OptionType::Prefix:
313 return "cl::opt<std::string>";
317 std::string OptionDescription::GenVariableName() const {
318 const std::string& EscapedName = EscapeVariableName(Name);
320 case OptionType::Alias:
321 return "AutoGeneratedAlias_" + EscapedName;
322 case OptionType::PrefixList:
323 case OptionType::ParameterList:
324 return "AutoGeneratedList_" + EscapedName;
325 case OptionType::Switch:
326 return "AutoGeneratedSwitch_" + EscapedName;
327 case OptionType::Prefix:
328 case OptionType::Parameter:
330 return "AutoGeneratedParameter_" + EscapedName;
334 /// OptionDescriptions - An OptionDescription array plus some helper
336 class OptionDescriptions {
337 typedef StringMap<OptionDescription> container_type;
339 /// Descriptions - A list of OptionDescriptions.
340 container_type Descriptions;
343 /// FindOption - exception-throwing wrapper for find().
344 const OptionDescription& FindOption(const std::string& OptName) const;
346 /// insertDescription - Insert new OptionDescription into
347 /// OptionDescriptions list
348 void InsertDescription (const OptionDescription& o);
350 // Support for STL-style iteration
351 typedef container_type::const_iterator const_iterator;
352 const_iterator begin() const { return Descriptions.begin(); }
353 const_iterator end() const { return Descriptions.end(); }
356 const OptionDescription&
357 OptionDescriptions::FindOption(const std::string& OptName) const
359 const_iterator I = Descriptions.find(OptName);
360 if (I != Descriptions.end())
363 throw OptName + ": no such option!";
366 void OptionDescriptions::InsertDescription (const OptionDescription& o)
368 container_type::iterator I = Descriptions.find(o.Name);
369 if (I != Descriptions.end()) {
370 OptionDescription& D = I->second;
374 Descriptions[o.Name] = o;
378 /// HandlerTable - A base class for function objects implemented as
379 /// 'tables of handlers'.
383 // Implementation details.
386 typedef void (T::* Handler) (const DagInit*);
387 /// HandlerMap - A map from property names to property handlers
388 typedef StringMap<Handler> HandlerMap;
390 static HandlerMap Handlers_;
391 static bool staticMembersInitialized_;
396 HandlerTable(T* cp) : childPtr(cp)
399 /// operator() - Just forwards to the corresponding property
401 void operator() (Init* i) {
402 const DagInit& property = InitPtrToDag(i);
403 const std::string& property_name = property.getOperator()->getAsString();
404 typename HandlerMap::iterator method = Handlers_.find(property_name);
406 if (method != Handlers_.end()) {
407 Handler h = method->second;
408 (childPtr->*h)(&property);
411 throw "No handler found for property " + property_name + "!";
415 void AddHandler(const char* Property, Handler Handl) {
416 Handlers_[Property] = Handl;
420 template <class T> typename HandlerTable<T>::HandlerMap
421 HandlerTable<T>::Handlers_;
422 template <class T> bool HandlerTable<T>::staticMembersInitialized_ = false;
425 /// CollectOptionProperties - Function object for iterating over an
426 /// option property list.
427 class CollectOptionProperties : public HandlerTable<CollectOptionProperties> {
430 /// optDescs_ - OptionDescriptions table. This is where the
431 /// information is stored.
432 OptionDescription& optDesc_;
436 explicit CollectOptionProperties(OptionDescription& OD)
437 : HandlerTable<CollectOptionProperties>(this), optDesc_(OD)
439 if (!staticMembersInitialized_) {
440 AddHandler("extern", &CollectOptionProperties::onExtern);
441 AddHandler("help", &CollectOptionProperties::onHelp);
442 AddHandler("hidden", &CollectOptionProperties::onHidden);
443 AddHandler("multi_val", &CollectOptionProperties::onMultiVal);
444 AddHandler("one_or_more", &CollectOptionProperties::onOneOrMore);
445 AddHandler("really_hidden", &CollectOptionProperties::onReallyHidden);
446 AddHandler("required", &CollectOptionProperties::onRequired);
447 AddHandler("zero_or_one", &CollectOptionProperties::onZeroOrOne);
449 staticMembersInitialized_ = true;
455 /// Option property handlers --
456 /// Methods that handle option properties such as (help) or (hidden).
458 void onExtern (const DagInit* d) {
459 checkNumberOfArguments(d, 0);
460 optDesc_.setExtern();
463 void onHelp (const DagInit* d) {
464 checkNumberOfArguments(d, 1);
465 optDesc_.Help = InitPtrToString(d->getArg(0));
468 void onHidden (const DagInit* d) {
469 checkNumberOfArguments(d, 0);
470 optDesc_.setHidden();
473 void onReallyHidden (const DagInit* d) {
474 checkNumberOfArguments(d, 0);
475 optDesc_.setReallyHidden();
478 void onRequired (const DagInit* d) {
479 checkNumberOfArguments(d, 0);
480 if (optDesc_.isOneOrMore())
481 throw std::string("An option can't have both (required) "
482 "and (one_or_more) properties!");
483 optDesc_.setRequired();
486 void onOneOrMore (const DagInit* d) {
487 checkNumberOfArguments(d, 0);
488 if (optDesc_.isRequired() || optDesc_.isZeroOrOne())
489 throw std::string("Only one of (required), (zero_or_one) or "
490 "(one_or_more) properties is allowed!");
491 if (!OptionType::IsList(optDesc_.Type))
492 llvm::cerr << "Warning: specifying the 'one_or_more' property "
493 "on a non-list option will have no effect.\n";
494 optDesc_.setOneOrMore();
497 void onZeroOrOne (const DagInit* d) {
498 checkNumberOfArguments(d, 0);
499 if (optDesc_.isRequired() || optDesc_.isOneOrMore())
500 throw std::string("Only one of (required), (zero_or_one) or "
501 "(one_or_more) properties is allowed!");
502 if (!OptionType::IsList(optDesc_.Type))
503 llvm::cerr << "Warning: specifying the 'zero_or_one' property"
504 "on a non-list option will have no effect.\n";
505 optDesc_.setZeroOrOne();
508 void onMultiVal (const DagInit* d) {
509 checkNumberOfArguments(d, 1);
510 int val = InitPtrToInt(d->getArg(0));
512 throw std::string("Error in the 'multi_val' property: "
513 "the value must be greater than 1!");
514 if (!OptionType::IsList(optDesc_.Type))
515 throw std::string("The multi_val property is valid only "
517 optDesc_.MultiVal = val;
522 /// AddOption - A function object that is applied to every option
523 /// description. Used by CollectOptionDescriptions.
526 OptionDescriptions& OptDescs_;
529 explicit AddOption(OptionDescriptions& OD) : OptDescs_(OD)
532 void operator()(const Init* i) {
533 const DagInit& d = InitPtrToDag(i);
534 checkNumberOfArguments(&d, 1);
536 const OptionType::OptionType Type =
537 stringToOptionType(d.getOperator()->getAsString());
538 const std::string& Name = InitPtrToString(d.getArg(0));
540 OptionDescription OD(Type, Name);
543 checkNumberOfArguments(&d, 2);
546 // Aliases store the aliased option name in the 'Help' field.
547 OD.Help = InitPtrToString(d.getArg(1));
549 else if (!OD.isExtern()) {
550 processOptionProperties(&d, OD);
552 OptDescs_.InsertDescription(OD);
556 /// processOptionProperties - Go through the list of option
557 /// properties and call a corresponding handler for each.
558 static void processOptionProperties (const DagInit* d, OptionDescription& o) {
559 checkNumberOfArguments(d, 2);
560 DagInit::const_arg_iterator B = d->arg_begin();
561 // Skip the first argument: it's always the option name.
563 std::for_each(B, d->arg_end(), CollectOptionProperties(o));
568 /// CollectOptionDescriptions - Collects option properties from all
570 void CollectOptionDescriptions (RecordVector::const_iterator B,
571 RecordVector::const_iterator E,
572 OptionDescriptions& OptDescs)
574 // For every OptionList:
576 RecordVector::value_type T = *B;
577 // Throws an exception if the value does not exist.
578 ListInit* PropList = T->getValueAsListInit("options");
580 // For every option description in this list:
581 // collect the information and
582 std::for_each(PropList->begin(), PropList->end(), AddOption(OptDescs));
586 // Tool information record
588 namespace ToolFlags {
589 enum ToolFlags { Join = 0x1, Sink = 0x2 };
592 struct ToolDescription : public RefCountedBase<ToolDescription> {
596 StrVector InLanguage;
597 std::string OutLanguage;
598 std::string OutputSuffix;
601 // Various boolean properties
602 void setSink() { Flags |= ToolFlags::Sink; }
603 bool isSink() const { return Flags & ToolFlags::Sink; }
604 void setJoin() { Flags |= ToolFlags::Join; }
605 bool isJoin() const { return Flags & ToolFlags::Join; }
607 // Default ctor here is needed because StringMap can only store
608 // DefaultConstructible objects
609 ToolDescription() : CmdLine(0), Actions(0), Flags(0) {}
610 ToolDescription (const std::string& n)
611 : Name(n), CmdLine(0), Actions(0), Flags(0)
615 /// ToolDescriptions - A list of Tool information records.
616 typedef std::vector<IntrusiveRefCntPtr<ToolDescription> > ToolDescriptions;
619 /// CollectToolProperties - Function object for iterating over a list of
620 /// tool property records.
621 class CollectToolProperties : public HandlerTable<CollectToolProperties> {
624 /// toolDesc_ - Properties of the current Tool. This is where the
625 /// information is stored.
626 ToolDescription& toolDesc_;
630 explicit CollectToolProperties (ToolDescription& d)
631 : HandlerTable<CollectToolProperties>(this) , toolDesc_(d)
633 if (!staticMembersInitialized_) {
635 AddHandler("actions", &CollectToolProperties::onActions);
636 AddHandler("cmd_line", &CollectToolProperties::onCmdLine);
637 AddHandler("in_language", &CollectToolProperties::onInLanguage);
638 AddHandler("join", &CollectToolProperties::onJoin);
639 AddHandler("out_language", &CollectToolProperties::onOutLanguage);
640 AddHandler("output_suffix", &CollectToolProperties::onOutputSuffix);
641 AddHandler("sink", &CollectToolProperties::onSink);
643 staticMembersInitialized_ = true;
649 /// Property handlers --
650 /// Functions that extract information about tool properties from
651 /// DAG representation.
653 void onActions (const DagInit* d) {
654 checkNumberOfArguments(d, 1);
655 Init* Case = d->getArg(0);
656 if (typeid(*Case) != typeid(DagInit) ||
657 static_cast<DagInit*>(Case)->getOperator()->getAsString() != "case")
659 std::string("The argument to (actions) should be a 'case' construct!");
660 toolDesc_.Actions = Case;
663 void onCmdLine (const DagInit* d) {
664 checkNumberOfArguments(d, 1);
665 toolDesc_.CmdLine = d->getArg(0);
668 void onInLanguage (const DagInit* d) {
669 checkNumberOfArguments(d, 1);
670 Init* arg = d->getArg(0);
672 // Find out the argument's type.
673 if (typeid(*arg) == typeid(StringInit)) {
675 toolDesc_.InLanguage.push_back(InitPtrToString(arg));
679 const ListInit& lst = InitPtrToList(arg);
680 StrVector& out = toolDesc_.InLanguage;
682 // Copy strings to the output vector.
683 for (ListInit::const_iterator B = lst.begin(), E = lst.end();
685 out.push_back(InitPtrToString(*B));
688 // Remove duplicates.
689 std::sort(out.begin(), out.end());
690 StrVector::iterator newE = std::unique(out.begin(), out.end());
691 out.erase(newE, out.end());
695 void onJoin (const DagInit* d) {
696 checkNumberOfArguments(d, 0);
700 void onOutLanguage (const DagInit* d) {
701 checkNumberOfArguments(d, 1);
702 toolDesc_.OutLanguage = InitPtrToString(d->getArg(0));
705 void onOutputSuffix (const DagInit* d) {
706 checkNumberOfArguments(d, 1);
707 toolDesc_.OutputSuffix = InitPtrToString(d->getArg(0));
710 void onSink (const DagInit* d) {
711 checkNumberOfArguments(d, 0);
717 /// CollectToolDescriptions - Gather information about tool properties
718 /// from the parsed TableGen data (basically a wrapper for the
719 /// CollectToolProperties function object).
720 void CollectToolDescriptions (RecordVector::const_iterator B,
721 RecordVector::const_iterator E,
722 ToolDescriptions& ToolDescs)
724 // Iterate over a properties list of every Tool definition
726 const Record* T = *B;
727 // Throws an exception if the value does not exist.
728 ListInit* PropList = T->getValueAsListInit("properties");
730 IntrusiveRefCntPtr<ToolDescription>
731 ToolDesc(new ToolDescription(T->getName()));
733 std::for_each(PropList->begin(), PropList->end(),
734 CollectToolProperties(*ToolDesc));
735 ToolDescs.push_back(ToolDesc);
739 /// FillInEdgeVector - Merge all compilation graph definitions into
740 /// one single edge list.
741 void FillInEdgeVector(RecordVector::const_iterator B,
742 RecordVector::const_iterator E, RecordVector& Out) {
743 for (; B != E; ++B) {
744 const ListInit* edges = (*B)->getValueAsListInit("edges");
746 for (unsigned i = 0; i < edges->size(); ++i)
747 Out.push_back(edges->getElementAsRecord(i));
751 /// CalculatePriority - Calculate the priority of this plugin.
752 int CalculatePriority(RecordVector::const_iterator B,
753 RecordVector::const_iterator E) {
756 total += static_cast<int>((*B)->getValueAsInt("priority"));
761 /// NotInGraph - Helper function object for FilterNotInGraph.
764 const llvm::StringSet<>& ToolsInGraph_;
767 NotInGraph(const llvm::StringSet<>& ToolsInGraph)
768 : ToolsInGraph_(ToolsInGraph)
771 bool operator()(const IntrusiveRefCntPtr<ToolDescription>& x) {
772 return (ToolsInGraph_.count(x->Name) == 0);
776 /// FilterNotInGraph - Filter out from ToolDescs all Tools not
777 /// mentioned in the compilation graph definition.
778 void FilterNotInGraph (const RecordVector& EdgeVector,
779 ToolDescriptions& ToolDescs) {
781 // List all tools mentioned in the graph.
782 llvm::StringSet<> ToolsInGraph;
784 for (RecordVector::const_iterator B = EdgeVector.begin(),
785 E = EdgeVector.end(); B != E; ++B) {
787 const Record* Edge = *B;
788 const std::string& NodeA = Edge->getValueAsString("a");
789 const std::string& NodeB = Edge->getValueAsString("b");
792 ToolsInGraph.insert(NodeA);
793 ToolsInGraph.insert(NodeB);
796 // Filter ToolPropertiesList.
797 ToolDescriptions::iterator new_end =
798 std::remove_if(ToolDescs.begin(), ToolDescs.end(),
799 NotInGraph(ToolsInGraph));
800 ToolDescs.erase(new_end, ToolDescs.end());
803 /// FillInToolToLang - Fills in two tables that map tool names to
804 /// (input, output) languages. Helper function used by TypecheckGraph().
805 void FillInToolToLang (const ToolDescriptions& ToolDescs,
806 StringMap<StringSet<> >& ToolToInLang,
807 StringMap<std::string>& ToolToOutLang) {
808 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
809 E = ToolDescs.end(); B != E; ++B) {
810 const ToolDescription& D = *(*B);
811 for (StrVector::const_iterator B = D.InLanguage.begin(),
812 E = D.InLanguage.end(); B != E; ++B)
813 ToolToInLang[D.Name].insert(*B);
814 ToolToOutLang[D.Name] = D.OutLanguage;
818 /// TypecheckGraph - Check that names for output and input languages
819 /// on all edges do match. This doesn't do much when the information
820 /// about the whole graph is not available (i.e. when compiling most
822 void TypecheckGraph (const RecordVector& EdgeVector,
823 const ToolDescriptions& ToolDescs) {
824 StringMap<StringSet<> > ToolToInLang;
825 StringMap<std::string> ToolToOutLang;
827 FillInToolToLang(ToolDescs, ToolToInLang, ToolToOutLang);
828 StringMap<std::string>::iterator IAE = ToolToOutLang.end();
829 StringMap<StringSet<> >::iterator IBE = ToolToInLang.end();
831 for (RecordVector::const_iterator B = EdgeVector.begin(),
832 E = EdgeVector.end(); B != E; ++B) {
833 const Record* Edge = *B;
834 const std::string& NodeA = Edge->getValueAsString("a");
835 const std::string& NodeB = Edge->getValueAsString("b");
836 StringMap<std::string>::iterator IA = ToolToOutLang.find(NodeA);
837 StringMap<StringSet<> >::iterator IB = ToolToInLang.find(NodeB);
839 if (NodeA != "root") {
840 if (IA != IAE && IB != IBE && IB->second.count(IA->second) == 0)
841 throw "Edge " + NodeA + "->" + NodeB
842 + ": output->input language mismatch";
846 throw std::string("Edges back to the root are not allowed!");
850 /// WalkCase - Walks the 'case' expression DAG and invokes
851 /// TestCallback on every test, and StatementCallback on every
852 /// statement. Handles 'case' nesting, but not the 'and' and 'or'
854 // TODO: Re-implement EmitCaseConstructHandler on top of this function?
855 template <typename F1, typename F2>
856 void WalkCase(Init* Case, F1 TestCallback, F2 StatementCallback) {
857 const DagInit& d = InitPtrToDag(Case);
859 for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
862 if (even && dynamic_cast<DagInit*>(arg)
863 && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case")
864 WalkCase(arg, TestCallback, StatementCallback);
868 StatementCallback(arg);
873 /// ExtractOptionNames - A helper function object used by
874 /// CheckForSuperfluousOptions() to walk the 'case' DAG.
875 class ExtractOptionNames {
876 llvm::StringSet<>& OptionNames_;
878 void processDag(const Init* Statement) {
879 const DagInit& Stmt = InitPtrToDag(Statement);
880 const std::string& ActionName = Stmt.getOperator()->getAsString();
881 if (ActionName == "forward" || ActionName == "forward_as" ||
882 ActionName == "unpack_values" || ActionName == "switch_on" ||
883 ActionName == "parameter_equals" || ActionName == "element_in_list" ||
884 ActionName == "not_empty" || ActionName == "empty") {
885 checkNumberOfArguments(&Stmt, 1);
886 const std::string& Name = InitPtrToString(Stmt.getArg(0));
887 OptionNames_.insert(Name);
889 else if (ActionName == "and" || ActionName == "or") {
890 for (unsigned i = 0, NumArgs = Stmt.getNumArgs(); i < NumArgs; ++i) {
891 this->processDag(Stmt.getArg(i));
897 ExtractOptionNames(llvm::StringSet<>& OptionNames) : OptionNames_(OptionNames)
900 void operator()(const Init* Statement) {
901 if (typeid(*Statement) == typeid(ListInit)) {
902 const ListInit& DagList = *static_cast<const ListInit*>(Statement);
903 for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
905 this->processDag(*B);
908 this->processDag(Statement);
913 /// CheckForSuperfluousOptions - Check that there are no side
914 /// effect-free options (specified only in the OptionList). Otherwise,
915 /// output a warning.
916 void CheckForSuperfluousOptions (const RecordVector& Edges,
917 const ToolDescriptions& ToolDescs,
918 const OptionDescriptions& OptDescs) {
919 llvm::StringSet<> nonSuperfluousOptions;
921 // Add all options mentioned in the ToolDesc.Actions to the set of
922 // non-superfluous options.
923 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
924 E = ToolDescs.end(); B != E; ++B) {
925 const ToolDescription& TD = *(*B);
926 ExtractOptionNames Callback(nonSuperfluousOptions);
928 WalkCase(TD.Actions, Callback, Callback);
931 // Add all options mentioned in the 'case' clauses of the
932 // OptionalEdges of the compilation graph to the set of
933 // non-superfluous options.
934 for (RecordVector::const_iterator B = Edges.begin(), E = Edges.end();
936 const Record* Edge = *B;
937 DagInit* Weight = Edge->getValueAsDag("weight");
939 if (!isDagEmpty(Weight))
940 WalkCase(Weight, ExtractOptionNames(nonSuperfluousOptions), Id());
943 // Check that all options in OptDescs belong to the set of
944 // non-superfluous options.
945 for (OptionDescriptions::const_iterator B = OptDescs.begin(),
946 E = OptDescs.end(); B != E; ++B) {
947 const OptionDescription& Val = B->second;
948 if (!nonSuperfluousOptions.count(Val.Name)
949 && Val.Type != OptionType::Alias)
950 llvm::cerr << "Warning: option '-" << Val.Name << "' has no effect! "
951 "Probable cause: this option is specified only in the OptionList.\n";
955 /// EmitCaseTest1Arg - Helper function used by
956 /// EmitCaseConstructHandler.
957 bool EmitCaseTest1Arg(const std::string& TestName,
959 const OptionDescriptions& OptDescs,
961 checkNumberOfArguments(&d, 1);
962 const std::string& OptName = InitPtrToString(d.getArg(0));
964 if (TestName == "switch_on") {
965 const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
966 if (!OptionType::IsSwitch(OptDesc.Type))
967 throw OptName + ": incorrect option type - should be a switch!";
968 O << OptDesc.GenVariableName();
970 } else if (TestName == "input_languages_contain") {
971 O << "InLangs.count(\"" << OptName << "\") != 0";
973 } else if (TestName == "in_language") {
974 // This works only for single-argument Tool::GenerateAction. Join
975 // tools can process several files in different languages simultaneously.
977 // TODO: make this work with Edge::Weight (if possible).
978 O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"';
980 } else if (TestName == "not_empty" || TestName == "empty") {
981 const char* Test = (TestName == "empty") ? "" : "!";
983 if (OptName == "o") {
984 O << Test << "OutputFilename.empty()";
988 const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
989 if (OptionType::IsSwitch(OptDesc.Type))
991 + ": incorrect option type - should be a list or parameter!";
992 O << Test << OptDesc.GenVariableName() << ".empty()";
1000 /// EmitCaseTest2Args - Helper function used by
1001 /// EmitCaseConstructHandler.
1002 bool EmitCaseTest2Args(const std::string& TestName,
1004 const char* IndentLevel,
1005 const OptionDescriptions& OptDescs,
1007 checkNumberOfArguments(&d, 2);
1008 const std::string& OptName = InitPtrToString(d.getArg(0));
1009 const std::string& OptArg = InitPtrToString(d.getArg(1));
1010 const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
1012 if (TestName == "parameter_equals") {
1013 if (!OptionType::IsParameter(OptDesc.Type))
1014 throw OptName + ": incorrect option type - should be a parameter!";
1015 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
1018 else if (TestName == "element_in_list") {
1019 if (!OptionType::IsList(OptDesc.Type))
1020 throw OptName + ": incorrect option type - should be a list!";
1021 const std::string& VarName = OptDesc.GenVariableName();
1022 O << "std::find(" << VarName << ".begin(),\n"
1023 << IndentLevel << Indent1 << VarName << ".end(), \""
1024 << OptArg << "\") != " << VarName << ".end()";
1031 // Forward declaration.
1032 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
1033 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
1034 const OptionDescriptions& OptDescs,
1037 /// EmitLogicalOperationTest - Helper function used by
1038 /// EmitCaseConstructHandler.
1039 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
1040 const char* IndentLevel,
1041 const OptionDescriptions& OptDescs,
1044 for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
1045 const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
1046 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
1047 if (j != NumArgs - 1)
1048 O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
1054 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
1055 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
1056 const OptionDescriptions& OptDescs,
1058 const std::string& TestName = d.getOperator()->getAsString();
1060 if (TestName == "and")
1061 EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
1062 else if (TestName == "or")
1063 EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
1064 else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
1066 else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
1069 throw TestName + ": unknown edge property!";
1072 // Emit code that handles the 'case' construct.
1073 // Takes a function object that should emit code for every case clause.
1074 // Callback's type is
1075 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
1076 template <typename F>
1077 void EmitCaseConstructHandler(const Init* Dag, const char* IndentLevel,
1078 F Callback, bool EmitElseIf,
1079 const OptionDescriptions& OptDescs,
1081 const DagInit* d = &InitPtrToDag(Dag);
1082 if (d->getOperator()->getAsString() != "case")
1083 throw std::string("EmitCaseConstructHandler should be invoked"
1084 " only on 'case' expressions!");
1086 unsigned numArgs = d->getNumArgs();
1087 if (d->getNumArgs() < 2)
1088 throw "There should be at least one clause in the 'case' expression:\n"
1091 for (unsigned i = 0; i != numArgs; ++i) {
1092 const DagInit& Test = InitPtrToDag(d->getArg(i));
1095 if (Test.getOperator()->getAsString() == "default") {
1097 throw std::string("The 'default' clause should be the last in the"
1098 "'case' construct!");
1099 O << IndentLevel << "else {\n";
1102 O << IndentLevel << ((i != 0 && EmitElseIf) ? "else if (" : "if (");
1103 EmitCaseTest(Test, IndentLevel, OptDescs, O);
1107 // Emit the corresponding statement.
1110 throw "Case construct handler: no corresponding action "
1111 "found for the test " + Test.getAsString() + '!';
1113 Init* arg = d->getArg(i);
1114 const DagInit* nd = dynamic_cast<DagInit*>(arg);
1115 if (nd && (nd->getOperator()->getAsString() == "case")) {
1116 // Handle the nested 'case'.
1117 EmitCaseConstructHandler(nd, (std::string(IndentLevel) + Indent1).c_str(),
1118 Callback, EmitElseIf, OptDescs, O);
1121 Callback(arg, (std::string(IndentLevel) + Indent1).c_str(), O);
1123 O << IndentLevel << "}\n";
1127 /// TokenizeCmdline - converts from "$CALL(HookName, 'Arg1', 'Arg2')/path" to
1128 /// ["$CALL(", "HookName", "Arg1", "Arg2", ")/path"] .
1129 /// Helper function used by EmitCmdLineVecFill and.
1130 void TokenizeCmdline(const std::string& CmdLine, StrVector& Out) {
1131 const char* Delimiters = " \t\n\v\f\r";
1133 { Normal, SpecialCommand, InsideSpecialCommand, InsideQuotationMarks }
1137 std::string::size_type B = CmdLine.find_first_not_of(Delimiters),
1139 if (B == std::string::npos)
1140 throw "Empty command-line string!";
1141 for (; B != E; ++B) {
1142 char cur_ch = CmdLine[B];
1146 if (cur_ch == '$') {
1147 cur_st = SpecialCommand;
1150 if (oneOf(Delimiters, cur_ch)) {
1152 B = CmdLine.find_first_not_of(Delimiters, B);
1153 if (B == std::string::npos) {
1164 case SpecialCommand:
1165 if (oneOf(Delimiters, cur_ch)) {
1170 if (cur_ch == '(') {
1172 cur_st = InsideSpecialCommand;
1177 case InsideSpecialCommand:
1178 if (oneOf(Delimiters, cur_ch)) {
1181 if (cur_ch == '\'') {
1182 cur_st = InsideQuotationMarks;
1186 if (cur_ch == ')') {
1190 if (cur_ch == ',') {
1196 case InsideQuotationMarks:
1197 if (cur_ch == '\'') {
1198 cur_st = InsideSpecialCommand;
1204 Out.back().push_back(cur_ch);
1208 /// SubstituteSpecialCommands - Perform string substitution for $CALL
1209 /// and $ENV. Helper function used by EmitCmdLineVecFill().
1210 StrVector::const_iterator SubstituteSpecialCommands
1211 (StrVector::const_iterator Pos, StrVector::const_iterator End, std::ostream& O)
1214 const std::string& cmd = *Pos;
1216 if (cmd == "$CALL") {
1217 checkedIncrement(Pos, End, "Syntax error in $CALL invocation!");
1218 const std::string& CmdName = *Pos;
1221 throw std::string("$CALL invocation: empty argument list!");
1224 O << CmdName << "(";
1227 bool firstIteration = true;
1229 checkedIncrement(Pos, End, "Syntax error in $CALL invocation!");
1230 const std::string& Arg = *Pos;
1231 assert(Arg.size() != 0);
1237 firstIteration = false;
1241 O << '"' << Arg << '"';
1247 else if (cmd == "$ENV") {
1248 checkedIncrement(Pos, End, "Syntax error in $ENV invocation!");
1249 const std::string& EnvName = *Pos;
1252 throw "$ENV invocation: empty argument list!";
1254 O << "checkCString(std::getenv(\"";
1258 checkedIncrement(Pos, End, "Syntax error in $ENV invocation!");
1261 throw "Unknown special command: " + cmd;
1264 const std::string& Leftover = *Pos;
1265 assert(Leftover.at(0) == ')');
1266 if (Leftover.size() != 1)
1267 O << " + std::string(\"" << (Leftover.c_str() + 1) << "\")";
1272 /// EmitCmdLineVecFill - Emit code that fills in the command line
1273 /// vector. Helper function used by EmitGenerateActionMethod().
1274 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
1275 bool IsJoin, const char* IndentLevel,
1278 TokenizeCmdline(InitPtrToString(CmdLine), StrVec);
1281 throw "Tool " + ToolName + " has empty command line!";
1283 StrVector::const_iterator I = StrVec.begin(), E = StrVec.end();
1285 // If there is a hook invocation on the place of the first command, skip it.
1286 assert(!StrVec[0].empty());
1287 if (StrVec[0][0] == '$') {
1288 while (I != E && (*I)[0] != ')' )
1291 // Skip the ')' symbol.
1298 for (; I != E; ++I) {
1299 const std::string& cmd = *I;
1300 assert(!cmd.empty());
1302 if (cmd.at(0) == '$') {
1303 if (cmd == "$INFILE") {
1305 O << "for (PathVector::const_iterator B = inFiles.begin()"
1306 << ", E = inFiles.end();\n"
1307 << IndentLevel << "B != E; ++B)\n"
1308 << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
1310 O << "vec.push_back(inFile.toString());\n";
1312 else if (cmd == "$OUTFILE") {
1313 O << "vec.push_back(out_file);\n";
1316 O << "vec.push_back(";
1317 I = SubstituteSpecialCommands(I, E, O);
1322 O << "vec.push_back(\"" << cmd << "\");\n";
1325 O << IndentLevel << "cmd = ";
1327 if (StrVec[0][0] == '$')
1328 SubstituteSpecialCommands(StrVec.begin(), StrVec.end(), O);
1330 O << '"' << StrVec[0] << '"';
1334 /// EmitCmdLineVecFillCallback - A function object wrapper around
1335 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
1336 /// argument to EmitCaseConstructHandler().
1337 class EmitCmdLineVecFillCallback {
1339 const std::string& ToolName;
1341 EmitCmdLineVecFillCallback(bool J, const std::string& TN)
1342 : IsJoin(J), ToolName(TN) {}
1344 void operator()(const Init* Statement, const char* IndentLevel,
1345 std::ostream& O) const
1347 EmitCmdLineVecFill(Statement, ToolName, IsJoin,
1352 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
1353 /// implement EmitActionHandler. Emits code for
1354 /// handling the (forward) and (forward_as) option properties.
1355 void EmitForwardOptionPropertyHandlingCode (const OptionDescription& D,
1357 const std::string& NewName,
1359 const std::string& Name = NewName.empty()
1364 case OptionType::Switch:
1365 O << Indent << "vec.push_back(\"" << Name << "\");\n";
1367 case OptionType::Parameter:
1368 O << Indent << "vec.push_back(\"" << Name << "\");\n";
1369 O << Indent << "vec.push_back(" << D.GenVariableName() << ");\n";
1371 case OptionType::Prefix:
1372 O << Indent << "vec.push_back(\"" << Name << "\" + "
1373 << D.GenVariableName() << ");\n";
1375 case OptionType::PrefixList:
1376 O << Indent << "for (" << D.GenTypeDeclaration()
1377 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1378 << Indent << "E = " << D.GenVariableName() << ".end(); B != E;) {\n"
1379 << Indent << Indent1 << "vec.push_back(\"" << Name << "\" + "
1381 << Indent << Indent1 << "++B;\n";
1383 for (int i = 1, j = D.MultiVal; i < j; ++i) {
1384 O << Indent << Indent1 << "vec.push_back(*B);\n"
1385 << Indent << Indent1 << "++B;\n";
1388 O << Indent << "}\n";
1390 case OptionType::ParameterList:
1391 O << Indent << "for (" << D.GenTypeDeclaration()
1392 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1393 << Indent << "E = " << D.GenVariableName()
1394 << ".end() ; B != E;) {\n"
1395 << Indent << Indent1 << "vec.push_back(\"" << Name << "\");\n";
1397 for (int i = 0, j = D.MultiVal; i < j; ++i) {
1398 O << Indent << Indent1 << "vec.push_back(*B);\n"
1399 << Indent << Indent1 << "++B;\n";
1402 O << Indent << "}\n";
1404 case OptionType::Alias:
1406 throw std::string("Aliases are not allowed in tool option descriptions!");
1410 /// EmitActionHandler - Emit code that handles actions. Used by
1411 /// EmitGenerateActionMethod() as an argument to
1412 /// EmitCaseConstructHandler().
1413 class EmitActionHandler {
1414 const OptionDescriptions& OptDescs;
1416 void processActionDag(const Init* Statement, const char* IndentLevel,
1417 std::ostream& O) const
1419 const DagInit& Dag = InitPtrToDag(Statement);
1420 const std::string& ActionName = Dag.getOperator()->getAsString();
1422 if (ActionName == "append_cmd") {
1423 checkNumberOfArguments(&Dag, 1);
1424 const std::string& Cmd = InitPtrToString(Dag.getArg(0));
1426 llvm::SplitString(Cmd, Out);
1428 for (StrVector::const_iterator B = Out.begin(), E = Out.end();
1430 O << IndentLevel << "vec.push_back(\"" << *B << "\");\n";
1432 else if (ActionName == "error") {
1433 O << IndentLevel << "throw std::runtime_error(\"" <<
1434 (Dag.getNumArgs() >= 1 ? InitPtrToString(Dag.getArg(0))
1438 else if (ActionName == "forward") {
1439 checkNumberOfArguments(&Dag, 1);
1440 const std::string& Name = InitPtrToString(Dag.getArg(0));
1441 EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1442 IndentLevel, "", O);
1444 else if (ActionName == "forward_as") {
1445 checkNumberOfArguments(&Dag, 2);
1446 const std::string& Name = InitPtrToString(Dag.getArg(0));
1447 const std::string& NewName = InitPtrToString(Dag.getArg(0));
1448 EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1449 IndentLevel, NewName, O);
1451 else if (ActionName == "output_suffix") {
1452 checkNumberOfArguments(&Dag, 1);
1453 const std::string& OutSuf = InitPtrToString(Dag.getArg(0));
1454 O << IndentLevel << "output_suffix = \"" << OutSuf << "\";\n";
1456 else if (ActionName == "stop_compilation") {
1457 O << IndentLevel << "stop_compilation = true;\n";
1459 else if (ActionName == "unpack_values") {
1460 checkNumberOfArguments(&Dag, 1);
1461 const std::string& Name = InitPtrToString(Dag.getArg(0));
1462 const OptionDescription& D = OptDescs.FindOption(Name);
1465 throw std::string("Can't use unpack_values with multi-valued options!");
1467 if (OptionType::IsList(D.Type)) {
1468 O << IndentLevel << "for (" << D.GenTypeDeclaration()
1469 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1470 << IndentLevel << "E = " << D.GenVariableName()
1471 << ".end(); B != E; ++B)\n"
1472 << IndentLevel << Indent1 << "llvm::SplitString(*B, vec, \",\");\n";
1474 else if (OptionType::IsParameter(D.Type)){
1475 O << Indent3 << "llvm::SplitString("
1476 << D.GenVariableName() << ", vec, \",\");\n";
1479 throw "Option '" + D.Name +
1480 "': switches can't have the 'unpack_values' property!";
1484 throw "Unknown action name: " + ActionName + "!";
1488 EmitActionHandler(const OptionDescriptions& OD)
1491 void operator()(const Init* Statement, const char* IndentLevel,
1492 std::ostream& O) const
1494 if (typeid(*Statement) == typeid(ListInit)) {
1495 const ListInit& DagList = *static_cast<const ListInit*>(Statement);
1496 for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
1498 this->processActionDag(*B, IndentLevel, O);
1501 this->processActionDag(Statement, IndentLevel, O);
1506 // EmitGenerateActionMethod - Emit one of two versions of the
1507 // Tool::GenerateAction() method.
1508 void EmitGenerateActionMethod (const ToolDescription& D,
1509 const OptionDescriptions& OptDescs,
1510 bool IsJoin, std::ostream& O) {
1512 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
1514 O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
1516 O << Indent2 << "bool HasChildren,\n"
1517 << Indent2 << "const llvm::sys::Path& TempDir,\n"
1518 << Indent2 << "const InputLanguagesSet& InLangs,\n"
1519 << Indent2 << "const LanguageMap& LangMap) const\n"
1521 << Indent2 << "std::string cmd;\n"
1522 << Indent2 << "std::vector<std::string> vec;\n"
1523 << Indent2 << "bool stop_compilation = !HasChildren;\n"
1524 << Indent2 << "const char* output_suffix = \"" << D.OutputSuffix << "\";\n"
1525 << Indent2 << "std::string out_file;\n\n";
1527 // For every understood option, emit handling code.
1529 EmitCaseConstructHandler(D.Actions, Indent2, EmitActionHandler(OptDescs),
1530 false, OptDescs, O);
1532 O << '\n' << Indent2
1533 << "out_file = OutFilename(" << (IsJoin ? "sys::Path(),\n" : "inFile,\n")
1534 << Indent3 << "TempDir, stop_compilation, output_suffix).toString();\n\n";
1536 // cmd_line is either a string or a 'case' construct.
1538 throw "Tool " + D.Name + " has no cmd_line property!";
1539 else if (typeid(*D.CmdLine) == typeid(StringInit))
1540 EmitCmdLineVecFill(D.CmdLine, D.Name, IsJoin, Indent2, O);
1542 EmitCaseConstructHandler(D.CmdLine, Indent2,
1543 EmitCmdLineVecFillCallback(IsJoin, D.Name),
1546 // Handle the Sink property.
1548 O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
1549 << Indent3 << "vec.insert(vec.end(), "
1550 << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
1551 << Indent2 << "}\n";
1554 O << Indent2 << "return Action(cmd, vec, stop_compilation, out_file);\n"
1555 << Indent1 << "}\n\n";
1558 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
1559 /// a given Tool class.
1560 void EmitGenerateActionMethods (const ToolDescription& ToolDesc,
1561 const OptionDescriptions& OptDescs,
1563 if (!ToolDesc.isJoin())
1564 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
1565 << Indent2 << "bool HasChildren,\n"
1566 << Indent2 << "const llvm::sys::Path& TempDir,\n"
1567 << Indent2 << "const InputLanguagesSet& InLangs,\n"
1568 << Indent2 << "const LanguageMap& LangMap) const\n"
1570 << Indent2 << "throw std::runtime_error(\"" << ToolDesc.Name
1571 << " is not a Join tool!\");\n"
1572 << Indent1 << "}\n\n";
1574 EmitGenerateActionMethod(ToolDesc, OptDescs, true, O);
1576 EmitGenerateActionMethod(ToolDesc, OptDescs, false, O);
1579 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1580 /// methods for a given Tool class.
1581 void EmitInOutLanguageMethods (const ToolDescription& D, std::ostream& O) {
1582 O << Indent1 << "const char** InputLanguages() const {\n"
1583 << Indent2 << "return InputLanguages_;\n"
1584 << Indent1 << "}\n\n";
1586 if (D.OutLanguage.empty())
1587 throw "Tool " + D.Name + " has no 'out_language' property!";
1589 O << Indent1 << "const char* OutputLanguage() const {\n"
1590 << Indent2 << "return \"" << D.OutLanguage << "\";\n"
1591 << Indent1 << "}\n\n";
1594 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1595 void EmitNameMethod (const ToolDescription& D, std::ostream& O) {
1596 O << Indent1 << "const char* Name() const {\n"
1597 << Indent2 << "return \"" << D.Name << "\";\n"
1598 << Indent1 << "}\n\n";
1601 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1603 void EmitIsJoinMethod (const ToolDescription& D, std::ostream& O) {
1604 O << Indent1 << "bool IsJoin() const {\n";
1606 O << Indent2 << "return true;\n";
1608 O << Indent2 << "return false;\n";
1609 O << Indent1 << "}\n\n";
1612 /// EmitStaticMemberDefinitions - Emit static member definitions for a
1613 /// given Tool class.
1614 void EmitStaticMemberDefinitions(const ToolDescription& D, std::ostream& O) {
1615 if (D.InLanguage.empty())
1616 throw "Tool " + D.Name + " has no 'in_language' property!";
1618 O << "const char* " << D.Name << "::InputLanguages_[] = {";
1619 for (StrVector::const_iterator B = D.InLanguage.begin(),
1620 E = D.InLanguage.end(); B != E; ++B)
1621 O << '\"' << *B << "\", ";
1625 /// EmitToolClassDefinition - Emit a Tool class definition.
1626 void EmitToolClassDefinition (const ToolDescription& D,
1627 const OptionDescriptions& OptDescs,
1629 if (D.Name == "root")
1633 O << "class " << D.Name << " : public ";
1639 O << "{\nprivate:\n"
1640 << Indent1 << "static const char* InputLanguages_[];\n\n";
1643 EmitNameMethod(D, O);
1644 EmitInOutLanguageMethods(D, O);
1645 EmitIsJoinMethod(D, O);
1646 EmitGenerateActionMethods(D, OptDescs, O);
1648 // Close class definition
1651 EmitStaticMemberDefinitions(D, O);
1655 /// EmitOptionDefintions - Iterate over a list of option descriptions
1656 /// and emit registration code.
1657 void EmitOptionDefintions (const OptionDescriptions& descs,
1658 bool HasSink, bool HasExterns,
1661 std::vector<OptionDescription> Aliases;
1663 // Emit static cl::Option variables.
1664 for (OptionDescriptions::const_iterator B = descs.begin(),
1665 E = descs.end(); B!=E; ++B) {
1666 const OptionDescription& val = B->second;
1668 if (val.Type == OptionType::Alias) {
1669 Aliases.push_back(val);
1676 O << val.GenTypeDeclaration() << ' '
1677 << val.GenVariableName();
1679 if (val.isExtern()) {
1684 O << "(\"" << val.Name << '\"';
1686 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1687 O << ", cl::Prefix";
1689 if (val.isRequired()) {
1690 if (OptionType::IsList(val.Type) && !val.isMultiVal())
1691 O << ", cl::OneOrMore";
1693 O << ", cl::Required";
1695 else if (val.isOneOrMore() && OptionType::IsList(val.Type)) {
1696 O << ", cl::OneOrMore";
1698 else if (val.isZeroOrOne() && OptionType::IsList(val.Type)) {
1699 O << ", cl::ZeroOrOne";
1702 if (val.isReallyHidden()) {
1703 O << ", cl::ReallyHidden";
1705 else if (val.isHidden()) {
1706 O << ", cl::Hidden";
1709 if (val.MultiVal > 1)
1710 O << ", cl::multi_val(" << val.MultiVal << ")";
1712 if (!val.Help.empty())
1713 O << ", cl::desc(\"" << val.Help << "\")";
1718 // Emit the aliases (they should go after all the 'proper' options).
1719 for (std::vector<OptionDescription>::const_iterator
1720 B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
1721 const OptionDescription& val = *B;
1723 O << val.GenTypeDeclaration() << ' '
1724 << val.GenVariableName()
1725 << "(\"" << val.Name << '\"';
1727 const OptionDescription& D = descs.FindOption(val.Help);
1728 O << ", cl::aliasopt(" << D.GenVariableName() << ")";
1730 O << ", cl::desc(\"" << "An alias for -" + val.Help << "\"));\n";
1733 // Emit the sink option.
1735 O << (HasExterns ? "extern cl" : "cl")
1736 << "::list<std::string> " << SinkOptionName
1737 << (HasExterns ? ";\n" : "(cl::Sink);\n");
1742 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1743 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1746 O << "void PopulateLanguageMapLocal(LanguageMap& langMap) {\n";
1748 // Get the relevant field out of RecordKeeper
1749 const Record* LangMapRecord = Records.getDef("LanguageMap");
1751 // It is allowed for a plugin to have no language map.
1752 if (LangMapRecord) {
1754 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1755 if (!LangsToSuffixesList)
1756 throw std::string("Error in the language map definition!");
1758 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1759 const Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1761 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1762 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1764 for (unsigned i = 0; i < Suffixes->size(); ++i)
1765 O << Indent1 << "langMap[\""
1766 << InitPtrToString(Suffixes->getElement(i))
1767 << "\"] = \"" << Lang << "\";\n";
1774 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1775 /// by EmitEdgeClass().
1776 void IncDecWeight (const Init* i, const char* IndentLevel,
1778 const DagInit& d = InitPtrToDag(i);
1779 const std::string& OpName = d.getOperator()->getAsString();
1781 if (OpName == "inc_weight") {
1782 O << IndentLevel << "ret += ";
1784 else if (OpName == "dec_weight") {
1785 O << IndentLevel << "ret -= ";
1787 else if (OpName == "error") {
1788 O << IndentLevel << "throw std::runtime_error(\"" <<
1789 (d.getNumArgs() >= 1 ? InitPtrToString(d.getArg(0))
1796 throw "Unknown operator in edge properties list: " + OpName + '!' +
1797 "\nOnly 'inc_weight', 'dec_weight' and 'error' are allowed.";
1799 if (d.getNumArgs() > 0)
1800 O << InitPtrToInt(d.getArg(0)) << ";\n";
1806 /// EmitEdgeClass - Emit a single Edge# class.
1807 void EmitEdgeClass (unsigned N, const std::string& Target,
1808 DagInit* Case, const OptionDescriptions& OptDescs,
1811 // Class constructor.
1812 O << "class Edge" << N << ": public Edge {\n"
1814 << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1817 // Function Weight().
1818 << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1819 << Indent2 << "unsigned ret = 0;\n";
1821 // Handle the 'case' construct.
1822 EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
1824 O << Indent2 << "return ret;\n"
1825 << Indent1 << "};\n\n};\n\n";
1828 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1829 void EmitEdgeClasses (const RecordVector& EdgeVector,
1830 const OptionDescriptions& OptDescs,
1833 for (RecordVector::const_iterator B = EdgeVector.begin(),
1834 E = EdgeVector.end(); B != E; ++B) {
1835 const Record* Edge = *B;
1836 const std::string& NodeB = Edge->getValueAsString("b");
1837 DagInit* Weight = Edge->getValueAsDag("weight");
1839 if (!isDagEmpty(Weight))
1840 EmitEdgeClass(i, NodeB, Weight, OptDescs, O);
1845 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1847 void EmitPopulateCompilationGraph (const RecordVector& EdgeVector,
1848 const ToolDescriptions& ToolDescs,
1851 O << "void PopulateCompilationGraphLocal(CompilationGraph& G) {\n";
1853 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1854 E = ToolDescs.end(); B != E; ++B)
1855 O << Indent1 << "G.insertNode(new " << (*B)->Name << "());\n";
1862 for (RecordVector::const_iterator B = EdgeVector.begin(),
1863 E = EdgeVector.end(); B != E; ++B) {
1864 const Record* Edge = *B;
1865 const std::string& NodeA = Edge->getValueAsString("a");
1866 const std::string& NodeB = Edge->getValueAsString("b");
1867 DagInit* Weight = Edge->getValueAsDag("weight");
1869 O << Indent1 << "G.insertEdge(\"" << NodeA << "\", ";
1871 if (isDagEmpty(Weight))
1872 O << "new SimpleEdge(\"" << NodeB << "\")";
1874 O << "new Edge" << i << "()";
1883 /// ExtractHookNames - Extract the hook names from all instances of
1884 /// $CALL(HookName) in the provided command line string. Helper
1885 /// function used by FillInHookNames().
1886 class ExtractHookNames {
1887 llvm::StringMap<unsigned>& HookNames_;
1889 ExtractHookNames(llvm::StringMap<unsigned>& HookNames)
1890 : HookNames_(HookNames) {}
1892 void operator()(const Init* CmdLine) {
1894 TokenizeCmdline(InitPtrToString(CmdLine), cmds);
1895 for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1897 const std::string& cmd = *B;
1899 if (cmd == "$CALL") {
1900 unsigned NumArgs = 0;
1901 checkedIncrement(B, E, "Syntax error in $CALL invocation!");
1902 const std::string& HookName = *B;
1905 if (HookName.at(0) == ')')
1906 throw "$CALL invoked with no arguments!";
1908 while (++B != E && B->at(0) != ')') {
1912 StringMap<unsigned>::const_iterator H = HookNames_.find(HookName);
1914 if (H != HookNames_.end() && H->second != NumArgs)
1915 throw "Overloading of hooks is not allowed. Overloaded hook: "
1918 HookNames_[HookName] = NumArgs;
1925 /// FillInHookNames - Actually extract the hook names from all command
1926 /// line strings. Helper function used by EmitHookDeclarations().
1927 void FillInHookNames(const ToolDescriptions& ToolDescs,
1928 llvm::StringMap<unsigned>& HookNames)
1930 // For all command lines:
1931 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1932 E = ToolDescs.end(); B != E; ++B) {
1933 const ToolDescription& D = *(*B);
1936 if (dynamic_cast<StringInit*>(D.CmdLine))
1937 // This is a string.
1938 ExtractHookNames(HookNames).operator()(D.CmdLine);
1940 // This is a 'case' construct.
1941 WalkCase(D.CmdLine, Id(), ExtractHookNames(HookNames));
1945 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1946 /// property records and emit hook function declaration for each
1947 /// instance of $CALL(HookName).
1948 void EmitHookDeclarations(const ToolDescriptions& ToolDescs, std::ostream& O) {
1949 llvm::StringMap<unsigned> HookNames;
1951 FillInHookNames(ToolDescs, HookNames);
1952 if (HookNames.empty())
1955 O << "namespace hooks {\n";
1956 for (StringMap<unsigned>::const_iterator B = HookNames.begin(),
1957 E = HookNames.end(); B != E; ++B) {
1958 O << Indent1 << "std::string " << B->first() << "(";
1960 for (unsigned i = 0, j = B->second; i < j; ++i) {
1961 O << "const char* Arg" << i << (i+1 == j ? "" : ", ");
1969 /// EmitRegisterPlugin - Emit code to register this plugin.
1970 void EmitRegisterPlugin(int Priority, std::ostream& O) {
1971 O << "struct Plugin : public llvmc::BasePlugin {\n\n"
1972 << Indent1 << "int Priority() const { return " << Priority << "; }\n\n"
1973 << Indent1 << "void PopulateLanguageMap(LanguageMap& langMap) const\n"
1974 << Indent1 << "{ PopulateLanguageMapLocal(langMap); }\n\n"
1976 << "void PopulateCompilationGraph(CompilationGraph& graph) const\n"
1977 << Indent1 << "{ PopulateCompilationGraphLocal(graph); }\n"
1980 << "static llvmc::RegisterPlugin<Plugin> RP;\n\n";
1983 /// EmitIncludes - Emit necessary #include directives and some
1984 /// additional declarations.
1985 void EmitIncludes(std::ostream& O) {
1986 O << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n"
1987 << "#include \"llvm/CompilerDriver/Plugin.h\"\n"
1988 << "#include \"llvm/CompilerDriver/Tool.h\"\n\n"
1990 << "#include \"llvm/ADT/StringExtras.h\"\n"
1991 << "#include \"llvm/Support/CommandLine.h\"\n\n"
1993 << "#include <cstdlib>\n"
1994 << "#include <stdexcept>\n\n"
1996 << "using namespace llvm;\n"
1997 << "using namespace llvmc;\n\n"
1999 << "extern cl::opt<std::string> OutputFilename;\n\n"
2001 << "inline const char* checkCString(const char* s)\n"
2002 << "{ return s == NULL ? \"\" : s; }\n\n";
2006 /// PluginData - Holds all information about a plugin.
2008 OptionDescriptions OptDescs;
2011 ToolDescriptions ToolDescs;
2016 /// HasSink - Go through the list of tool descriptions and check if
2017 /// there are any with the 'sink' property set.
2018 bool HasSink(const ToolDescriptions& ToolDescs) {
2019 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
2020 E = ToolDescs.end(); B != E; ++B)
2027 /// HasExterns - Go through the list of option descriptions and check
2028 /// if there are any external options.
2029 bool HasExterns(const OptionDescriptions& OptDescs) {
2030 for (OptionDescriptions::const_iterator B = OptDescs.begin(),
2031 E = OptDescs.end(); B != E; ++B)
2032 if (B->second.isExtern())
2038 /// CollectPluginData - Collect tool and option properties,
2039 /// compilation graph edges and plugin priority from the parse tree.
2040 void CollectPluginData (const RecordKeeper& Records, PluginData& Data) {
2041 // Collect option properties.
2042 const RecordVector& OptionLists =
2043 Records.getAllDerivedDefinitions("OptionList");
2044 CollectOptionDescriptions(OptionLists.begin(), OptionLists.end(),
2047 // Collect tool properties.
2048 const RecordVector& Tools = Records.getAllDerivedDefinitions("Tool");
2049 CollectToolDescriptions(Tools.begin(), Tools.end(), Data.ToolDescs);
2050 Data.HasSink = HasSink(Data.ToolDescs);
2051 Data.HasExterns = HasExterns(Data.OptDescs);
2053 // Collect compilation graph edges.
2054 const RecordVector& CompilationGraphs =
2055 Records.getAllDerivedDefinitions("CompilationGraph");
2056 FillInEdgeVector(CompilationGraphs.begin(), CompilationGraphs.end(),
2059 // Calculate the priority of this plugin.
2060 const RecordVector& Priorities =
2061 Records.getAllDerivedDefinitions("PluginPriority");
2062 Data.Priority = CalculatePriority(Priorities.begin(), Priorities.end());
2065 /// CheckPluginData - Perform some sanity checks on the collected data.
2066 void CheckPluginData(PluginData& Data) {
2067 // Filter out all tools not mentioned in the compilation graph.
2068 FilterNotInGraph(Data.Edges, Data.ToolDescs);
2070 // Typecheck the compilation graph.
2071 TypecheckGraph(Data.Edges, Data.ToolDescs);
2073 // Check that there are no options without side effects (specified
2074 // only in the OptionList).
2075 CheckForSuperfluousOptions(Data.Edges, Data.ToolDescs, Data.OptDescs);
2079 void EmitPluginCode(const PluginData& Data, std::ostream& O) {
2080 // Emit file header.
2083 // Emit global option registration code.
2084 EmitOptionDefintions(Data.OptDescs, Data.HasSink, Data.HasExterns, O);
2086 // Emit hook declarations.
2087 EmitHookDeclarations(Data.ToolDescs, O);
2089 O << "namespace {\n\n";
2091 // Emit PopulateLanguageMap() function
2092 // (a language map maps from file extensions to language names).
2093 EmitPopulateLanguageMap(Records, O);
2095 // Emit Tool classes.
2096 for (ToolDescriptions::const_iterator B = Data.ToolDescs.begin(),
2097 E = Data.ToolDescs.end(); B!=E; ++B)
2098 EmitToolClassDefinition(*(*B), Data.OptDescs, O);
2100 // Emit Edge# classes.
2101 EmitEdgeClasses(Data.Edges, Data.OptDescs, O);
2103 // Emit PopulateCompilationGraph() function.
2104 EmitPopulateCompilationGraph(Data.Edges, Data.ToolDescs, O);
2106 // Emit code for plugin registration.
2107 EmitRegisterPlugin(Data.Priority, O);
2109 O << "} // End anonymous namespace.\n";
2114 // End of anonymous namespace
2117 /// run - The back-end entry point.
2118 void LLVMCConfigurationEmitter::run (std::ostream &O) {
2122 CollectPluginData(Records, Data);
2123 CheckPluginData(Data);
2125 EmitSourceFileHeader("LLVMC Configuration Library", O);
2126 EmitPluginCode(Data, O);
2128 } catch (std::exception& Error) {
2129 throw Error.what() + std::string(" - usually this means a syntax error.");