LLVM学习笔记（9）

来源：互联网发布：商业数据保密协议范本编辑：程序博客网时间：2024/06/05 05:47

3. TableGen生成的代码

3.1. 概述

在编译LLVM时，首先会调用TableGen解析TD文件，产生C++源代码，然后这些C++源代码与LLVM的其他源代码一起被编译为LLVM执行文件。需要解析哪些TD文件是由LLVM/lib/target/target下的Cmakelists.txt文件指定。比如X86机器使用的TD文件有：

tablegen(LLVM X86GenRegisterInfo.inc-gen-register-info)

tablegen(LLVMX86GenDisassemblerTables.inc -gen-disassembler)

tablegen(LLVMX86GenInstrInfo.inc -gen-instr-info)

tablegen(LLVMX86GenAsmWriter.inc -gen-asm-writer)

tablegen(LLVMX86GenAsmWriter1.inc -gen-asm-writer -asmwriternum=1)

tablegen(LLVMX86GenAsmMatcher.inc -gen-asm-matcher)

tablegen(LLVMX86GenDAGISel.inc -gen-dag-isel)

tablegen(LLVMX86GenFastISel.inc -gen-fast-isel)

tablegen(LLVMX86GenCallingConv.inc -gen-callingconv)

tablegen(LLVMX86GenSubtargetInfo.inc -gen-subtarget)

括号中最后一项是tablegen的命令行选项，第一项是输出的文件。

TableGen本身是一个进程，因此它的入口是一个main函数（TableGen.cpp）。

174 int main(int argc, char **argv) {

175 sys::PrintStackTraceOnErrorSignal();

176 PrettyStackTraceProgram X(argc, argv);

177 cl::ParseCommandLineOptions(argc, argv);

178

179 return TableGenMain(argv[0], &LLVMTableGenMain);

180 }

177行的cl::ParseCommandLineOptions是LLVM里的通用命令行选项解析方法。它所支持的命令行选项是可以动态指定的。因此，它适用于一切需要解析命令行选项的地方。这里，我们不深入其细节。

在TableGenMain定义中，OutputFilename，DependFilename，InputFilename以及IncludeDirs也都是命令行选项对象（它们声明在tablegen目录下的main.cpp中，与TableGen.cpp中声明的命令行选项一起构成TableGen可用的命令行选项，并由177行的ParseCommandLineOptions完成解析。LLVM的代码有许多这样“神奇的”代码。简而言之，这里利用了C++构造函数在TableGen启动时将这些命令行选项对象注册到解析器中）。

73 int llvm::TableGenMain(char*argv0, TableGenMainFn *MainFn) {

74 RecordKeeper Records;

76 // Parse theinput file.

77 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =

78 MemoryBuffer::getFileOrSTDIN(InputFilename);

79 if (std::error_code EC = FileOrErr.getError()){

80 errs() << "Could not open inputfile '" << InputFilename

81 << "': " <<EC.message() << "\n";

82 return 1;

83 }

85 // Tell SrcMgrabout this buffer, which is what TGParser will pick up.

86 SrcMgr.AddNewSourceBuffer(std::move(*FileOrErr),SMLoc());

88 // Record thelocation of the include directory so that the lexer can find

89 // it later.

90 SrcMgr.setIncludeDirs(IncludeDirs);

92 TGParser Parser(SrcMgr, Records);

94 if (Parser.ParseFile())

95 return 1;

97 std::error_code EC;

98 tool_output_file Out(OutputFilename, EC,sys::fs::F_Text);

99 if (EC) {

100 errs() << argv0 << ":error opening " << OutputFilename << ":"

101 << EC.message() <<"\n";

102 return 1;

103 }

104 if (!DependFilename.empty()) {

105 if (int Ret = createDependencyFile(Parser,argv0))

106 returnRet;

107 }

108

109 if (MainFn(Out.os(), Records))

110 return 1;

111

112 if (ErrorsPrinted > 0) {

113 errs() << argv0 << ":" << ErrorsPrinted << " errors.\n";

114 return 1;

115 }

116

117 // Declaresuccess.

118 Out.keep();

119 return 0;

120 }

92行的TGParser实例就是TD描述文件的解析器，94行调用其ParseFile方法对指定的TD文件进行解析。注意在92行传入的Records，它是一个RecordKeeper实例（74行）。在TD文件中所有的class，def都将解析为LLVM的Record对象，并记录在这个RecordKeeper实例中。109行的MainFn在前面被绑定到LLVMTableGenMain，它将根据TD文件解析的结果产生LLVM源代码。它是我们学习的重点。

94 bool LLVMTableGenMain(raw_ostream&OS, RecordKeeper &Records) {

95 switch(Action) {

96 casePrintRecords:

97 OS << Records; // Noargument, dump all contents

98 break;

99 caseGenEmitter:

100 EmitCodeEmitter(Records, OS);

101 break;

102 case GenRegisterInfo:

103 EmitRegisterInfo(Records, OS);

104 break;

105 caseGenInstrInfo:

106 EmitInstrInfo(Records, OS);

107 break;

108 caseGenCallingConv:

109 EmitCallingConv(Records, OS);

110 break;

111 caseGenAsmWriter:

112 EmitAsmWriter(Records, OS);

113 break;

114 caseGenAsmMatcher:

115 EmitAsmMatcher(Records, OS);

116 break;

117 caseGenDisassembler:

118 EmitDisassembler(Records, OS);

119 break;

120 caseGenPseudoLowering:

121 EmitPseudoLowering(Records, OS);

122 break;

123 caseGenDAGISel:

124 EmitDAGISel(Records, OS);

125 break;

126 caseGenDFAPacketizer:

127 EmitDFAPacketizer(Records, OS);

128 break;

129 caseGenFastISel:

130 EmitFastISel(Records, OS);

131 break;

132 caseGenSubtarget:

133 EmitSubtarget(Records, OS);

134 break;

135 caseGenIntrinsic:

136 EmitIntrinsics(Records, OS);

137 break;

138 caseGenTgtIntrinsic:

139 EmitIntrinsics(Records, OS, true);

140 break;

141 case GenOptParserDefs:

142 EmitOptParser(Records, OS);

143 break;

144 casePrintEnums:

145 {

146 for (Record*Rec : Records.getAllDerivedDefinitions(Class))

147 OS << Rec->getName() <<", ";

148 OS << "\n";

149 break;

150 }

151 casePrintSets:

152 {

153 SetTheory Sets;

154 Sets.addFieldExpander("Set","Elements");

155 for (Record*Rec : Records.getAllDerivedDefinitions("Set")) {

156 OS << Rec->getName() <<" = [";

157 conststd::vector<Record*> *Elts = Sets.expand(Rec);

158 assert(Elts&& "Couldn't expand Set instance");

159 for(Record *Elt : *Elts)

160 OS << ' ' <<Elt->getName();

161 OS << " ]\n";

162 }

163 break;

164 }

165 caseGenCTags:

166 EmitCTags(Records, OS);

167 break;

168 }

169

170 return false;

171 }

95行的Action就是在TableGen.cpp中声明的命令行选项对象，它长成这个样子：

48 cl::opt<ActionType>

49 Action(cl::desc("Action toperform:"),

50 cl::values(clEnumValN(PrintRecords,"print-records",

51 "Print all records tostdout (default)"),

52 clEnumValN(GenEmitter,"gen-emitter",

53 "Generatemachine code emitter"),

54 clEnumValN(GenRegisterInfo,"gen-register-info",

55 "Generateregisters and register classes info"),

56 clEnumValN(GenInstrInfo,"gen-instr-info",

57 "Generateinstruction descriptions"),

58 clEnumValN(GenCallingConv,"gen-callingconv",

59 "Generatecalling convention descriptions"),

60 clEnumValN(GenAsmWriter,"gen-asm-writer",

61 "Generateassembly writer"),

62 clEnumValN(GenDisassembler,"gen-disassembler",

63 "Generatedisassembler"),

64 clEnumValN(GenPseudoLowering, "gen-pseudo-lowering",

65 "Generatepseudo instruction lowering"),

66 clEnumValN(GenAsmMatcher,"gen-asm-matcher",

67 "Generateassembly instruction matcher"),

68 clEnumValN(GenDAGISel,"gen-dag-isel",

69 "Generate aDAG instruction selector"),

70 clEnumValN(GenDFAPacketizer, "gen-dfa-packetizer",

71 "GenerateDFA Packetizer for VLIW targets"),

72 clEnumValN(GenFastISel,"gen-fast-isel",

73 "Generate a\"fast\" instruction selector"),

74 clEnumValN(GenSubtarget,"gen-subtarget",

75 "Generatesubtarget enumerations"),

76 clEnumValN(GenIntrinsic,"gen-intrinsic",

77 "Generateintrinsic information"),

78 clEnumValN(GenTgtIntrinsic,"gen-tgt-intrinsic",

79 "Generatetarget intrinsic information"),

80 clEnumValN(PrintEnums,"print-enums",

81 "Print enumvalues for a class"),

82 clEnumValN(PrintSets,"print-sets",

83 "Printexpanded sets for testing DAG exprs"),

84 clEnumValN(GenOptParserDefs,"gen-opt-parser-defs",

85 "Generateoption definitions"),

86 clEnumValN(GenCTags,"gen-ctags",

87 "Generatectags-compatible index"),

88 clEnumValEnd));

这里我们不深入其中的细节（否则要花不少时间），只要知道，如果出现了其中一个选项，比如-gen-intrinsic，Action的值就会被设置为对应的枚举值，即GenIntrinsic。95行的switch语句根据这个枚举值调用对应的处理方法。注意，80行以下是一些调试选项。

3.2. TD文件的解析结果

前面说过dag，bit，string，int与list这些类型的对象只允许出现在class，multiclass，def，defm及foreach等声明里。因此，一个TD文件由一系列class，multiclass，def，defm等构成。在解析过程中，LLVM对这些定义一一构建一个Record实例。而在class，multiclass，def，defm定义中出现的各个域，则构建为对应的Init派生对象，保存在相应的Record实例中。

Record实例的匹配，以及在Record实例中查找指定的域是通过名字匹配来完成的。

所有Record实例都记录在TableGenMain的局部变量Records中，其方法getAllDerivedDefinitions(ClassName)返回所有从ClassName派生的def或defm对象。

下面我们将选取对代码生成、指令选择最为紧要的TableGen生成代码，研究其产生的过程，及结果。

0 0