1 //===- LLVMCConfigurationEmitter.cpp - Generate LLVMC config --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open
6 // Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend is responsible for emitting LLVMC configuration code.
12 //===----------------------------------------------------------------------===//
14 #include "LLVMCConfigurationEmitter.h"
17 #include "llvm/ADT/IntrusiveRefCntPtr.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/Support/Streams.h"
32 //===----------------------------------------------------------------------===//
35 typedef std::vector<Record*> RecordVector;
36 typedef std::vector<std::string> StrVector;
38 //===----------------------------------------------------------------------===//
41 // Indentation strings.
42 const char * Indent1 = " ";
43 const char * Indent2 = " ";
44 const char * Indent3 = " ";
45 const char * Indent4 = " ";
47 // Default help string.
48 const char * DefaultHelpString = "NO HELP MESSAGE PROVIDED";
50 // Name for the "sink" option.
51 const char * SinkOptionName = "AutoGeneratedSinkOption";
53 //===----------------------------------------------------------------------===//
56 std::string InitPtrToString(Init* ptr) {
57 StringInit& val = dynamic_cast<StringInit&>(*ptr);
58 return val.getValue();
61 int InitPtrToInt(Init* ptr) {
62 IntInit& val = dynamic_cast<IntInit&>(*ptr);
63 return val.getValue();
66 const DagInit& InitPtrToDagInitRef(Init* ptr) {
67 DagInit& val = dynamic_cast<DagInit&>(*ptr);
71 // checkNumberOfArguments - Ensure that the number of args in d is
72 // less than or equal to min_arguments, otherwise throw an exception.
73 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
74 if (d->getNumArgs() < min_arguments)
75 throw "Property " + d->getOperator()->getAsString()
76 + " has too few arguments!";
79 // isDagEmpty - is this DAG marked with an empty marker?
80 bool isDagEmpty (const DagInit* d) {
81 return d->getOperator()->getAsString() == "empty";
84 //===----------------------------------------------------------------------===//
85 /// Back-end specific code
87 // A command-line option can have one of the following types:
89 // Switch - a simple switch w/o arguments, e.g. -O2
91 // Parameter - an option that takes one(and only one) argument, e.g. -o file,
94 // ParameterList - same as Parameter, but more than one occurence
95 // of the option is allowed, e.g. -lm -lpthread
97 // Prefix - argument is everything after the prefix,
98 // e.g. -Wa,-foo,-bar, -DNAME=VALUE
100 // PrefixList - same as Prefix, but more than one option occurence is
103 namespace OptionType {
104 enum OptionType { Switch, Parameter, ParameterList, Prefix, PrefixList};
107 bool IsListOptionType (OptionType::OptionType t) {
108 return (t == OptionType::ParameterList || t == OptionType::PrefixList);
111 // Code duplication here is necessary because one option can affect
112 // several tools and those tools may have different actions associated
113 // with this option. GlobalOptionDescriptions are used to generate
114 // the option registration code, while ToolOptionDescriptions are used
115 // to generate tool-specific code.
117 /// OptionDescription - Base class for option descriptions.
118 struct OptionDescription {
119 OptionType::OptionType Type;
122 OptionDescription(OptionType::OptionType t = OptionType::Switch,
123 const std::string& n = "")
127 const char* GenTypeDeclaration() const {
129 case OptionType::PrefixList:
130 case OptionType::ParameterList:
131 return "cl::list<std::string>";
132 case OptionType::Switch:
133 return "cl::opt<bool>";
134 case OptionType::Parameter:
135 case OptionType::Prefix:
137 return "cl::opt<std::string>";
141 // Escape commas and other symbols not allowed in the C++ variable
142 // names. Makes it possible to use options with names like "Wa,"
143 // (useful for prefix options).
144 std::string EscapeVariableName(const std::string& Var) const {
146 for (unsigned i = 0; i != Var.size(); ++i) {
151 ret.push_back(Var[i]);
157 std::string GenVariableName() const {
158 const std::string& EscapedName = EscapeVariableName(Name);
160 case OptionType::Switch:
161 return "AutoGeneratedSwitch" + EscapedName;
162 case OptionType::Prefix:
163 return "AutoGeneratedPrefix" + EscapedName;
164 case OptionType::PrefixList:
165 return "AutoGeneratedPrefixList" + EscapedName;
166 case OptionType::Parameter:
167 return "AutoGeneratedParameter" + EscapedName;
168 case OptionType::ParameterList:
170 return "AutoGeneratedParameterList" + EscapedName;
176 // Global option description.
178 namespace GlobalOptionDescriptionFlags {
179 enum GlobalOptionDescriptionFlags { Required = 0x1 };
182 struct GlobalOptionDescription : public OptionDescription {
186 // We need to provide a default constructor because
187 // StringMap can only store DefaultConstructible objects.
188 GlobalOptionDescription() : OptionDescription(), Flags(0)
191 GlobalOptionDescription (OptionType::OptionType t, const std::string& n)
192 : OptionDescription(t, n), Help(DefaultHelpString), Flags(0)
195 bool isRequired() const {
196 return Flags & GlobalOptionDescriptionFlags::Required;
199 Flags |= GlobalOptionDescriptionFlags::Required;
202 /// Merge - Merge two option descriptions.
203 void Merge (const GlobalOptionDescription& other)
205 if (other.Type != Type)
206 throw "Conflicting definitions for the option " + Name + "!";
208 if (Help == DefaultHelpString)
210 else if (other.Help != DefaultHelpString) {
211 llvm::cerr << "Warning: more than one help string defined for option "
215 Flags |= other.Flags;
219 /// GlobalOptionDescriptions - A GlobalOptionDescription array
220 /// together with some flags affecting generation of option
222 struct GlobalOptionDescriptions {
223 typedef StringMap<GlobalOptionDescription> container_type;
224 typedef container_type::const_iterator const_iterator;
226 /// Descriptions - A list of GlobalOptionDescriptions.
227 container_type Descriptions;
228 /// HasSink - Should the emitter generate a "cl::sink" option?
231 const GlobalOptionDescription& FindOption(const std::string& OptName) const {
232 const_iterator I = Descriptions.find(OptName);
233 if (I != Descriptions.end())
236 throw OptName + ": no such option!";
239 // Support for STL-style iteration
240 const_iterator begin() const { return Descriptions.begin(); }
241 const_iterator end() const { return Descriptions.end(); }
245 // Tool-local option description.
247 // Properties without arguments are implemented as flags.
248 namespace ToolOptionDescriptionFlags {
249 enum ToolOptionDescriptionFlags { StopCompilation = 0x1,
250 Forward = 0x2, UnpackValues = 0x4};
252 namespace OptionPropertyType {
253 enum OptionPropertyType { AppendCmd };
256 typedef std::pair<OptionPropertyType::OptionPropertyType, std::string>
258 typedef SmallVector<OptionProperty, 4> OptionPropertyList;
260 struct ToolOptionDescription : public OptionDescription {
262 OptionPropertyList Props;
264 // StringMap can only store DefaultConstructible objects
265 ToolOptionDescription() : OptionDescription(), Flags(0) {}
267 ToolOptionDescription (OptionType::OptionType t, const std::string& n)
268 : OptionDescription(t, n)
271 // Various boolean properties
272 bool isStopCompilation() const {
273 return Flags & ToolOptionDescriptionFlags::StopCompilation;
275 void setStopCompilation() {
276 Flags |= ToolOptionDescriptionFlags::StopCompilation;
279 bool isForward() const {
280 return Flags & ToolOptionDescriptionFlags::Forward;
283 Flags |= ToolOptionDescriptionFlags::Forward;
286 bool isUnpackValues() const {
287 return Flags & ToolOptionDescriptionFlags::UnpackValues;
289 void setUnpackValues() {
290 Flags |= ToolOptionDescriptionFlags::UnpackValues;
293 void AddProperty (OptionPropertyType::OptionPropertyType t,
294 const std::string& val)
296 Props.push_back(std::make_pair(t, val));
300 typedef StringMap<ToolOptionDescription> ToolOptionDescriptions;
302 // Tool information record
304 namespace ToolFlags {
305 enum ToolFlags { Join = 0x1, Sink = 0x2 };
308 struct ToolProperties : public RefCountedBase<ToolProperties> {
311 std::string InLanguage;
312 std::string OutLanguage;
313 std::string OutputSuffix;
315 ToolOptionDescriptions OptDescs;
317 // Various boolean properties
318 void setSink() { Flags |= ToolFlags::Sink; }
319 bool isSink() const { return Flags & ToolFlags::Sink; }
320 void setJoin() { Flags |= ToolFlags::Join; }
321 bool isJoin() const { return Flags & ToolFlags::Join; }
323 // Default ctor here is needed because StringMap can only store
324 // DefaultConstructible objects
325 ToolProperties() : Flags(0) {}
326 ToolProperties (const std::string& n) : Name(n), Flags(0) {}
330 /// ToolPropertiesList - A list of Tool information records
331 /// IntrusiveRefCntPtrs are used here because StringMap has no copy
332 /// constructor (and we want to avoid copying ToolProperties anyway).
333 typedef std::vector<IntrusiveRefCntPtr<ToolProperties> > ToolPropertiesList;
336 /// CollectProperties - Function object for iterating over a list of
337 /// tool property records.
338 class CollectProperties {
341 /// Implementation details
343 /// PropertyHandler - a function that extracts information
344 /// about a given tool property from its DAG representation
345 typedef void (CollectProperties::*PropertyHandler)(const DagInit*);
347 /// PropertyHandlerMap - A map from property names to property
349 typedef StringMap<PropertyHandler> PropertyHandlerMap;
351 /// OptionPropertyHandler - a function that extracts information
352 /// about a given option property from its DAG representation.
353 typedef void (CollectProperties::* OptionPropertyHandler)
354 (const DagInit*, GlobalOptionDescription &);
356 /// OptionPropertyHandlerMap - A map from option property names to
357 /// option property handlers
358 typedef StringMap<OptionPropertyHandler> OptionPropertyHandlerMap;
360 // Static maps from strings to CollectProperties methods("handlers")
361 static PropertyHandlerMap propertyHandlers_;
362 static OptionPropertyHandlerMap optionPropertyHandlers_;
363 static bool staticMembersInitialized_;
366 /// This is where the information is stored
368 /// toolProps_ - Properties of the current Tool.
369 ToolProperties& toolProps_;
370 /// optDescs_ - OptionDescriptions table (used to register options
372 GlobalOptionDescriptions& optDescs_;
376 explicit CollectProperties (ToolProperties& p, GlobalOptionDescriptions& d)
377 : toolProps_(p), optDescs_(d)
379 if (!staticMembersInitialized_) {
380 // Init tool property handlers
381 propertyHandlers_["cmd_line"] = &CollectProperties::onCmdLine;
382 propertyHandlers_["in_language"] = &CollectProperties::onInLanguage;
383 propertyHandlers_["join"] = &CollectProperties::onJoin;
384 propertyHandlers_["out_language"] = &CollectProperties::onOutLanguage;
385 propertyHandlers_["output_suffix"] = &CollectProperties::onOutputSuffix;
386 propertyHandlers_["parameter_option"]
387 = &CollectProperties::onParameter;
388 propertyHandlers_["parameter_list_option"] =
389 &CollectProperties::onParameterList;
390 propertyHandlers_["prefix_option"] = &CollectProperties::onPrefix;
391 propertyHandlers_["prefix_list_option"] =
392 &CollectProperties::onPrefixList;
393 propertyHandlers_["sink"] = &CollectProperties::onSink;
394 propertyHandlers_["switch_option"] = &CollectProperties::onSwitch;
396 // Init option property handlers
397 optionPropertyHandlers_["append_cmd"] = &CollectProperties::onAppendCmd;
398 optionPropertyHandlers_["forward"] = &CollectProperties::onForward;
399 optionPropertyHandlers_["help"] = &CollectProperties::onHelp;
400 optionPropertyHandlers_["required"] = &CollectProperties::onRequired;
401 optionPropertyHandlers_["stop_compilation"] =
402 &CollectProperties::onStopCompilation;
403 optionPropertyHandlers_["unpack_values"] =
404 &CollectProperties::onUnpackValues;
406 staticMembersInitialized_ = true;
410 /// operator() - Gets called for every tool property; Just forwards
411 /// to the corresponding property handler.
412 void operator() (Init* i) {
413 const DagInit& d = InitPtrToDagInitRef(i);
414 const std::string& property_name = d.getOperator()->getAsString();
415 PropertyHandlerMap::iterator method
416 = propertyHandlers_.find(property_name);
418 if (method != propertyHandlers_.end()) {
419 PropertyHandler h = method->second;
423 throw "Unknown tool property: " + property_name + "!";
429 /// Property handlers --
430 /// Functions that extract information about tool properties from
431 /// DAG representation.
433 void onCmdLine (const DagInit* d) {
434 checkNumberOfArguments(d, 1);
435 SplitString(InitPtrToString(d->getArg(0)), toolProps_.CmdLine);
436 if (toolProps_.CmdLine.empty())
437 throw "Tool " + toolProps_.Name + " has empty command line!";
440 void onInLanguage (const DagInit* d) {
441 checkNumberOfArguments(d, 1);
442 toolProps_.InLanguage = InitPtrToString(d->getArg(0));
445 void onJoin (const DagInit* d) {
446 checkNumberOfArguments(d, 0);
447 toolProps_.setJoin();
450 void onOutLanguage (const DagInit* d) {
451 checkNumberOfArguments(d, 1);
452 toolProps_.OutLanguage = InitPtrToString(d->getArg(0));
455 void onOutputSuffix (const DagInit* d) {
456 checkNumberOfArguments(d, 1);
457 toolProps_.OutputSuffix = InitPtrToString(d->getArg(0));
460 void onSink (const DagInit* d) {
461 checkNumberOfArguments(d, 0);
462 optDescs_.HasSink = true;
463 toolProps_.setSink();
466 void onSwitch (const DagInit* d) {
467 addOption(d, OptionType::Switch);
470 void onParameter (const DagInit* d) {
471 addOption(d, OptionType::Parameter);
474 void onParameterList (const DagInit* d) {
475 addOption(d, OptionType::ParameterList);
478 void onPrefix (const DagInit* d) {
479 addOption(d, OptionType::Prefix);
482 void onPrefixList (const DagInit* d) {
483 addOption(d, OptionType::PrefixList);
486 /// Option property handlers --
487 /// Methods that handle properties that are common for all types of
488 /// options (like append_cmd, stop_compilation)
490 void onAppendCmd (const DagInit* d, GlobalOptionDescription& o) {
491 checkNumberOfArguments(d, 1);
492 std::string const& cmd = InitPtrToString(d->getArg(0));
494 toolProps_.OptDescs[o.Name].AddProperty(OptionPropertyType::AppendCmd, cmd);
497 void onForward (const DagInit* d, GlobalOptionDescription& o) {
498 checkNumberOfArguments(d, 0);
499 toolProps_.OptDescs[o.Name].setForward();
502 void onHelp (const DagInit* d, GlobalOptionDescription& o) {
503 checkNumberOfArguments(d, 1);
504 const std::string& help_message = InitPtrToString(d->getArg(0));
506 o.Help = help_message;
509 void onRequired (const DagInit* d, GlobalOptionDescription& o) {
510 checkNumberOfArguments(d, 0);
514 void onStopCompilation (const DagInit* d, GlobalOptionDescription& o) {
515 checkNumberOfArguments(d, 0);
516 if (o.Type != OptionType::Switch)
517 throw std::string("Only options of type Switch can stop compilation!");
518 toolProps_.OptDescs[o.Name].setStopCompilation();
521 void onUnpackValues (const DagInit* d, GlobalOptionDescription& o) {
522 checkNumberOfArguments(d, 0);
523 toolProps_.OptDescs[o.Name].setUnpackValues();
528 // Add an option of type t
529 void addOption (const DagInit* d, OptionType::OptionType t) {
530 checkNumberOfArguments(d, 2);
531 const std::string& name = InitPtrToString(d->getArg(0));
533 GlobalOptionDescription o(t, name);
534 toolProps_.OptDescs[name].Type = t;
535 toolProps_.OptDescs[name].Name = name;
536 processOptionProperties(d, o);
537 insertDescription(o);
540 // Insert new GlobalOptionDescription into GlobalOptionDescriptions list
541 void insertDescription (const GlobalOptionDescription& o)
543 if (optDescs_.Descriptions.count(o.Name)) {
544 GlobalOptionDescription& D = optDescs_.Descriptions[o.Name];
548 optDescs_.Descriptions[o.Name] = o;
552 /// processOptionProperties - Go through the list of option
553 /// properties and call a corresponding handler for each.
556 /// name - option name
557 /// d - option property list
558 void processOptionProperties (const DagInit* d, GlobalOptionDescription& o) {
559 // First argument is option name
560 checkNumberOfArguments(d, 2);
562 for (unsigned B = 1, E = d->getNumArgs(); B!=E; ++B) {
563 const DagInit& option_property
564 = InitPtrToDagInitRef(d->getArg(B));
565 const std::string& option_property_name
566 = option_property.getOperator()->getAsString();
567 OptionPropertyHandlerMap::iterator method
568 = optionPropertyHandlers_.find(option_property_name);
570 if (method != optionPropertyHandlers_.end()) {
571 OptionPropertyHandler h = method->second;
572 (this->*h)(&option_property, o);
575 throw "Unknown option property: " + option_property_name + "!";
581 // Static members of CollectProperties
582 CollectProperties::PropertyHandlerMap
583 CollectProperties::propertyHandlers_;
585 CollectProperties::OptionPropertyHandlerMap
586 CollectProperties::optionPropertyHandlers_;
588 bool CollectProperties::staticMembersInitialized_ = false;
591 /// CollectToolProperties - Gather information from the parsed
592 /// TableGen data (basically a wrapper for the CollectProperties
593 /// function object).
594 void CollectToolProperties (RecordVector::const_iterator B,
595 RecordVector::const_iterator E,
596 ToolPropertiesList& TPList,
597 GlobalOptionDescriptions& OptDescs)
599 // Iterate over a properties list of every Tool definition
601 RecordVector::value_type T = *B;
602 ListInit* PropList = T->getValueAsListInit("properties");
604 IntrusiveRefCntPtr<ToolProperties>
605 ToolProps(new ToolProperties(T->getName()));
607 std::for_each(PropList->begin(), PropList->end(),
608 CollectProperties(*ToolProps, OptDescs));
609 TPList.push_back(ToolProps);
613 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
614 /// implement EmitOptionPropertyHandlingCode(). Emits code for
615 /// handling the (forward) option property.
616 void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D,
619 case OptionType::Switch:
620 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
622 case OptionType::Parameter:
623 O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
624 O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n";
626 case OptionType::Prefix:
627 O << Indent3 << "vec.push_back(\"-" << D.Name << "\" + "
628 << D.GenVariableName() << ");\n";
630 case OptionType::PrefixList:
631 O << Indent3 << "for (" << D.GenTypeDeclaration()
632 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
633 << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
634 << Indent4 << "vec.push_back(\"-" << D.Name << "\" + "
637 case OptionType::ParameterList:
638 O << Indent3 << "for (" << D.GenTypeDeclaration()
639 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
640 << Indent3 << "E = " << D.GenVariableName()
641 << ".end() ; B != E; ++B) {\n"
642 << Indent4 << "vec.push_back(\"-" << D.Name << "\");\n"
643 << Indent4 << "vec.push_back(*B);\n"
649 /// EmitOptionPropertyHandlingCode - Helper function used by
650 /// EmitGenerateActionMethod(). Emits code that handles option
652 void EmitOptionPropertyHandlingCode (const ToolProperties& P,
653 const ToolOptionDescription& D,
656 // Start of the if-clause.
657 O << Indent2 << "if (";
658 if (D.Type == OptionType::Switch)
659 O << D.GenVariableName();
661 O << '!' << D.GenVariableName() << ".empty()";
665 // Handle option properties that take an argument.
666 for (OptionPropertyList::const_iterator B = D.Props.begin(),
667 E = D.Props.end(); B!=E; ++B) {
668 const OptionProperty& val = *B;
671 // (append_cmd cmd) property
672 case OptionPropertyType::AppendCmd:
673 O << Indent3 << "vec.push_back(\"" << val.second << "\");\n";
675 // Other properties with argument
683 // (forward) property
685 EmitForwardOptionPropertyHandlingCode(D, O);
687 // (unpack_values) property
688 if (D.isUnpackValues()) {
689 if (IsListOptionType(D.Type)) {
690 O << Indent3 << "for (" << D.GenTypeDeclaration()
691 << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
692 << Indent3 << "E = " << D.GenVariableName()
693 << ".end(); B != E; ++B)\n"
694 << Indent4 << "llvm::SplitString(*B, vec, \",\");\n";
696 else if (D.Type == OptionType::Prefix || D.Type == OptionType::Parameter){
697 O << Indent3 << "llvm::SplitString("
698 << D.GenVariableName() << ", vec, \",\");\n";
701 // TOFIX: move this to the type-checking phase
702 throw std::string("Switches can't have unpack_values property!");
706 // End of the if-clause.
707 O << Indent2 << "}\n";
710 // EmitGenerateActionMethod - Emit one of two versions of the
711 // Tool::GenerateAction() method.
712 void EmitGenerateActionMethod (const ToolProperties& P, bool V, std::ostream& O)
715 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
717 O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
719 O << Indent2 << "const sys::Path& outFile) const\n"
721 << Indent2 << "std::vector<std::string> vec;\n";
723 // Parse CmdLine tool property
724 if(P.CmdLine.empty())
725 throw "Tool " + P.Name + " has empty command line!";
727 StrVector::const_iterator I = P.CmdLine.begin();
729 for (StrVector::const_iterator E = P.CmdLine.end(); I != E; ++I) {
730 const std::string& cmd = *I;
732 if (cmd == "$INFILE") {
734 O << "for (PathVector::const_iterator B = inFiles.begin()"
735 << ", E = inFiles.end();\n"
736 << Indent2 << "B != E; ++B)\n"
737 << Indent3 << "vec.push_back(B->toString());\n";
739 O << "vec.push_back(inFile.toString());\n";
741 else if (cmd == "$OUTFILE") {
742 O << "vec.push_back(outFile.toString());\n";
745 O << "vec.push_back(\"" << cmd << "\");\n";
749 // For every understood option, emit handling code.
750 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
751 E = P.OptDescs.end(); B != E; ++B) {
752 const ToolOptionDescription& val = B->second;
753 EmitOptionPropertyHandlingCode(P, val, O);
756 // Handle the Sink property.
758 O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
759 << Indent3 << "vec.insert(vec.end(), "
760 << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
764 O << Indent2 << "return Action(\"" << P.CmdLine.at(0) << "\", vec);\n"
765 << Indent1 << "}\n\n";
768 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
769 /// a given Tool class.
770 void EmitGenerateActionMethods (const ToolProperties& P, std::ostream& O) {
773 O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
774 << Indent2 << "const llvm::sys::Path& outFile) const\n"
776 << Indent2 << "throw std::runtime_error(\"" << P.Name
777 << " is not a Join tool!\");\n"
778 << Indent1 << "}\n\n";
780 EmitGenerateActionMethod(P, true, O);
782 EmitGenerateActionMethod(P, false, O);
785 /// EmitIsLastMethod - Emit the IsLast() method for a given Tool
787 void EmitIsLastMethod (const ToolProperties& P, std::ostream& O) {
788 O << Indent1 << "bool IsLast() const {\n"
789 << Indent2 << "bool last = false;\n";
791 for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
792 E = P.OptDescs.end(); B != E; ++B) {
793 const ToolOptionDescription& val = B->second;
795 if (val.isStopCompilation())
797 << "if (" << val.GenVariableName()
798 << ")\n" << Indent3 << "last = true;\n";
801 O << Indent2 << "return last;\n"
802 << Indent1 << "}\n\n";
805 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
806 /// methods for a given Tool class.
807 void EmitInOutLanguageMethods (const ToolProperties& P, std::ostream& O) {
808 O << Indent1 << "const char* InputLanguage() const {\n"
809 << Indent2 << "return \"" << P.InLanguage << "\";\n"
810 << Indent1 << "}\n\n";
812 O << Indent1 << "const char* OutputLanguage() const {\n"
813 << Indent2 << "return \"" << P.OutLanguage << "\";\n"
814 << Indent1 << "}\n\n";
817 /// EmitOutputSuffixMethod - Emit the OutputSuffix() method for a
818 /// given Tool class.
819 void EmitOutputSuffixMethod (const ToolProperties& P, std::ostream& O) {
820 O << Indent1 << "const char* OutputSuffix() const {\n"
821 << Indent2 << "return \"" << P.OutputSuffix << "\";\n"
822 << Indent1 << "}\n\n";
825 /// EmitNameMethod - Emit the Name() method for a given Tool class.
826 void EmitNameMethod (const ToolProperties& P, std::ostream& O) {
827 O << Indent1 << "const char* Name() const {\n"
828 << Indent2 << "return \"" << P.Name << "\";\n"
829 << Indent1 << "}\n\n";
832 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
834 void EmitIsJoinMethod (const ToolProperties& P, std::ostream& O) {
835 O << Indent1 << "bool IsJoin() const {\n";
837 O << Indent2 << "return true;\n";
839 O << Indent2 << "return false;\n";
840 O << Indent1 << "}\n\n";
843 /// EmitToolClassDefinition - Emit a Tool class definition.
844 void EmitToolClassDefinition (const ToolProperties& P, std::ostream& O) {
850 O << "class " << P.Name << " : public ";
855 O << " {\npublic:\n";
857 EmitNameMethod(P, O);
858 EmitInOutLanguageMethods(P, O);
859 EmitOutputSuffixMethod(P, O);
860 EmitIsJoinMethod(P, O);
861 EmitGenerateActionMethods(P, O);
862 EmitIsLastMethod(P, O);
864 // Close class definition
868 /// EmitOptionDescriptions - Iterate over a list of option
869 /// descriptions and emit registration code.
870 void EmitOptionDescriptions (const GlobalOptionDescriptions& descs,
873 // Emit static cl::Option variables
874 for (GlobalOptionDescriptions::const_iterator B = descs.begin(),
875 E = descs.end(); B!=E; ++B) {
876 const GlobalOptionDescription& val = B->second;
878 O << val.GenTypeDeclaration() << ' '
879 << val.GenVariableName()
880 << "(\"" << val.Name << '\"';
882 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
885 if (val.isRequired()) {
887 case OptionType::PrefixList:
888 case OptionType::ParameterList:
889 O << ", cl::OneOrMore";
892 O << ", cl::Required";
896 O << ", cl::desc(\"" << val.Help << "\"));\n";
900 O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
905 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
906 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
908 // Get the relevant field out of RecordKeeper
909 Record* LangMapRecord = Records.getDef("LanguageMap");
911 throw std::string("Language map definition not found!");
913 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
914 if (!LangsToSuffixesList)
915 throw std::string("Error in the language map definition!");
918 O << "void llvmc::PopulateLanguageMap(LanguageMap& language_map) {\n";
920 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
921 Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
923 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
924 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
926 for (unsigned i = 0; i < Suffixes->size(); ++i)
927 O << Indent1 << "language_map[\""
928 << InitPtrToString(Suffixes->getElement(i))
929 << "\"] = \"" << Lang << "\";\n";
935 /// FillInToolToLang - Fills in two tables that map tool names to
936 /// (input, output) languages. Used by the typechecker.
937 void FillInToolToLang (const ToolPropertiesList& TPList,
938 StringMap<std::string>& ToolToInLang,
939 StringMap<std::string>& ToolToOutLang) {
940 for (ToolPropertiesList::const_iterator B = TPList.begin(), E = TPList.end();
942 const ToolProperties& P = *(*B);
943 ToolToInLang[P.Name] = P.InLanguage;
944 ToolToOutLang[P.Name] = P.OutLanguage;
948 /// TypecheckGraph - Check that names for output and input languages
949 /// on all edges do match.
950 // TOFIX: check for cycles.
951 // TOFIX: check for multiple default edges.
952 void TypecheckGraph (Record* CompilationGraph,
953 const ToolPropertiesList& TPList) {
954 StringMap<std::string> ToolToInLang;
955 StringMap<std::string> ToolToOutLang;
957 FillInToolToLang(TPList, ToolToInLang, ToolToOutLang);
958 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
959 StringMap<std::string>::iterator IAE = ToolToInLang.end();
960 StringMap<std::string>::iterator IBE = ToolToOutLang.end();
962 for (unsigned i = 0; i < edges->size(); ++i) {
963 Record* Edge = edges->getElementAsRecord(i);
964 Record* A = Edge->getValueAsDef("a");
965 Record* B = Edge->getValueAsDef("b");
966 StringMap<std::string>::iterator IA = ToolToOutLang.find(A->getName());
967 StringMap<std::string>::iterator IB = ToolToInLang.find(B->getName());
969 throw A->getName() + ": no such tool!";
971 throw B->getName() + ": no such tool!";
972 if(A->getName() != "root" && IA->second != IB->second)
973 throw "Edge " + A->getName() + "->" + B->getName()
974 + ": output->input language mismatch";
975 if(B->getName() == "root")
976 throw std::string("Edges back to the root are not allowed!");
980 /// EmitCaseTest1Arg - Helper function used by
981 /// EmitCaseConstructHandler.
982 bool EmitCaseTest1Arg(const std::string& TestName,
984 const GlobalOptionDescriptions& OptDescs,
986 checkNumberOfArguments(&d, 1);
987 const std::string& OptName = InitPtrToString(d.getArg(0));
988 if (TestName == "switch_on") {
989 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
990 if (OptDesc.Type != OptionType::Switch)
991 throw OptName + ": incorrect option type!";
992 O << OptDesc.GenVariableName();
994 } else if (TestName == "input_languages_contain") {
995 O << "InLangs.count(\"" << OptName << "\") != 0";
1002 /// EmitCaseTest2Args - Helper function used by
1003 /// EmitCaseConstructHandler.
1004 bool EmitCaseTest2Args(const std::string& TestName,
1006 const char* IndentLevel,
1007 const GlobalOptionDescriptions& OptDescs,
1009 checkNumberOfArguments(&d, 2);
1010 const std::string& OptName = InitPtrToString(d.getArg(0));
1011 const std::string& OptArg = InitPtrToString(d.getArg(1));
1012 const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
1014 if (TestName == "parameter_equals") {
1015 if (OptDesc.Type != OptionType::Parameter
1016 && OptDesc.Type != OptionType::Prefix)
1017 throw OptName + ": incorrect option type!";
1018 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
1021 else if (TestName == "element_in_list") {
1022 if (OptDesc.Type != OptionType::ParameterList
1023 && OptDesc.Type != OptionType::PrefixList)
1024 throw OptName + ": incorrect option type!";
1025 const std::string& VarName = OptDesc.GenVariableName();
1026 O << "std::find(" << VarName << ".begin(),\n"
1027 << IndentLevel << Indent1 << VarName << ".end(), \""
1028 << OptArg << "\") != " << VarName << ".end()";
1035 // Forward declaration.
1036 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
1037 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
1038 const GlobalOptionDescriptions& OptDescs,
1041 /// EmitLogicalOperationTest - Helper function used by
1042 /// EmitCaseConstructHandler.
1043 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
1044 const char* IndentLevel,
1045 const GlobalOptionDescriptions& OptDescs,
1048 for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
1049 const DagInit& InnerTest = InitPtrToDagInitRef(d.getArg(j));
1050 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
1051 if (j != NumArgs - 1)
1052 O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
1058 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
1059 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
1060 const GlobalOptionDescriptions& OptDescs,
1062 const std::string& TestName = d.getOperator()->getAsString();
1064 if (TestName == "and")
1065 EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
1066 else if (TestName == "or")
1067 EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
1068 else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
1070 else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
1073 throw TestName + ": unknown edge property!";
1076 // Emit code that handles the 'case' construct.
1077 // Takes a function object that should emit code for every case clause.
1078 template <typename F>
1079 void EmitCaseConstructHandler(DagInit* d, const char* IndentLevel,
1081 const GlobalOptionDescriptions& OptDescs,
1083 assert(d->getOperator()->getAsString() == "case");
1085 for (DagInit::arg_iterator B = d->arg_begin(), E = d->arg_end();
1087 const DagInit& Test = InitPtrToDagInitRef(*B);
1088 O << IndentLevel << "if (";
1089 EmitCaseTest(Test, IndentLevel, OptDescs, O);
1094 throw "Case construct handler: no corresponding action "
1095 "found for the test " + Test.getAsString() + '!';
1097 const DagInit& Action = InitPtrToDagInitRef(*B);
1098 Callback(IndentLevel, Action, O);
1099 O << IndentLevel << "}\n";
1103 // Helper function passed to EmitCaseConstructHandler by EmitEdgeClass.
1104 void IncDecWeight(const char* IndentLevel,
1105 const DagInit& d, std::ostream& O) {
1106 const std::string& OpName = d.getOperator()->getAsString();
1108 if (OpName == "inc_weight")
1109 O << IndentLevel << Indent1 << "ret += ";
1110 else if (OpName == "dec_weight")
1111 O << IndentLevel << Indent1 << "ret -= ";
1113 throw "Unknown operator in edge properties list: " + OpName + '!';
1115 if (d.getNumArgs() > 0)
1116 O << InitPtrToInt(d.getArg(0)) << ";\n";
1122 /// EmitEdgeClass - Emit a single Edge# class.
1123 void EmitEdgeClass(unsigned N, const std::string& Target,
1124 DagInit* Case, const GlobalOptionDescriptions& OptDescs,
1127 // Class constructor.
1128 O << "class Edge" << N << ": public Edge {\n"
1130 << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1133 // Function Weight().
1134 << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1135 << Indent2 << "unsigned ret = 0;\n";
1137 // Handle the 'case' construct.
1138 EmitCaseConstructHandler(Case, Indent2, IncDecWeight, OptDescs, O);
1140 O << Indent2 << "return ret;\n"
1141 << Indent1 << "};\n\n};\n\n";
1144 // Emit Edge* classes that represent graph edges.
1145 void EmitEdgeClasses (Record* CompilationGraph,
1146 const GlobalOptionDescriptions& OptDescs,
1148 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1150 for (unsigned i = 0; i < edges->size(); ++i) {
1151 Record* Edge = edges->getElementAsRecord(i);
1152 Record* B = Edge->getValueAsDef("b");
1153 DagInit* Weight = Edge->getValueAsDag("weight");
1155 if (isDagEmpty(Weight))
1158 EmitEdgeClass(i, B->getName(), Weight, OptDescs, O);
1162 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1164 void EmitPopulateCompilationGraph (Record* CompilationGraph,
1167 ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1170 O << "void llvmc::PopulateCompilationGraph(CompilationGraph& G) {\n"
1171 << Indent1 << "PopulateLanguageMap(G.ExtsToLangs);\n\n";
1175 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1177 throw std::string("No tool definitions found!");
1179 for (RecordVector::iterator B = Tools.begin(), E = Tools.end(); B != E; ++B) {
1180 const std::string& Name = (*B)->getName();
1182 O << Indent1 << "G.insertNode(new "
1183 << Name << "());\n";
1189 for (unsigned i = 0; i < edges->size(); ++i) {
1190 Record* Edge = edges->getElementAsRecord(i);
1191 Record* A = Edge->getValueAsDef("a");
1192 Record* B = Edge->getValueAsDef("b");
1193 DagInit* Weight = Edge->getValueAsDag("weight");
1195 O << Indent1 << "G.insertEdge(\"" << A->getName() << "\", ";
1197 if (isDagEmpty(Weight))
1198 O << "new SimpleEdge(\"" << B->getName() << "\")";
1200 O << "new Edge" << i << "()";
1209 // End of anonymous namespace
1212 /// run - The back-end entry point.
1213 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1215 // Emit file header.
1216 EmitSourceFileHeader("LLVMC Configuration Library", O);
1218 // Get a list of all defined Tools.
1219 RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1221 throw std::string("No tool definitions found!");
1223 // Gather information from the Tool description dags.
1224 ToolPropertiesList tool_props;
1225 GlobalOptionDescriptions opt_descs;
1226 CollectToolProperties(Tools.begin(), Tools.end(), tool_props, opt_descs);
1228 // Emit global option registration code.
1229 EmitOptionDescriptions(opt_descs, O);
1231 // Emit PopulateLanguageMap() function
1232 // (a language map maps from file extensions to language names).
1233 EmitPopulateLanguageMap(Records, O);
1235 // Emit Tool classes.
1236 for (ToolPropertiesList::const_iterator B = tool_props.begin(),
1237 E = tool_props.end(); B!=E; ++B)
1238 EmitToolClassDefinition(*(*B), O);
1240 Record* CompilationGraphRecord = Records.getDef("CompilationGraph");
1241 if (!CompilationGraphRecord)
1242 throw std::string("Compilation graph description not found!");
1244 // Typecheck the compilation graph.
1245 TypecheckGraph(CompilationGraphRecord, tool_props);
1247 // Emit Edge# classes.
1248 EmitEdgeClasses(CompilationGraphRecord, opt_descs, O);
1250 // Emit PopulateCompilationGraph() function.
1251 EmitPopulateCompilationGraph(CompilationGraphRecord, O);