1 //===- TableGen.cpp - Top-Level TableGen implementation for Clang ---------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains the main function for Clang's TableGen.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "TableGenBackends.h" // Declares all backends.
14 #include "ASTTableGen.h"
15 #include "llvm/Support/CommandLine.h"
16 #include "llvm/Support/PrettyStackTrace.h"
17 #include "llvm/Support/Signals.h"
18 #include "llvm/TableGen/Error.h"
19 #include "llvm/TableGen/Main.h"
20 #include "llvm/TableGen/Record.h"
21 
22 using namespace llvm;
23 using namespace clang;
24 
25 enum ActionType {
26   PrintRecords,
27   DumpJSON,
28   GenClangAttrClasses,
29   GenClangAttrParserStringSwitches,
30   GenClangAttrSubjectMatchRulesParserStringSwitches,
31   GenClangAttrImpl,
32   GenClangAttrList,
33   GenClangAttrSubjectMatchRuleList,
34   GenClangAttrPCHRead,
35   GenClangAttrPCHWrite,
36   GenClangAttrHasAttributeImpl,
37   GenClangAttrSpellingListIndex,
38   GenClangAttrASTVisitor,
39   GenClangAttrTemplateInstantiate,
40   GenClangAttrParsedAttrList,
41   GenClangAttrParsedAttrImpl,
42   GenClangAttrParsedAttrKinds,
43   GenClangAttrTextNodeDump,
44   GenClangAttrNodeTraverse,
45   GenClangBasicReader,
46   GenClangBasicWriter,
47   GenClangDiagsDefs,
48   GenClangDiagGroups,
49   GenClangDiagsIndexName,
50   GenClangCommentNodes,
51   GenClangDeclNodes,
52   GenClangStmtNodes,
53   GenClangTypeNodes,
54   GenClangTypeReader,
55   GenClangTypeWriter,
56   GenClangOpcodes,
57   GenClangSACheckers,
58   GenClangCommentHTMLTags,
59   GenClangCommentHTMLTagsProperties,
60   GenClangCommentHTMLNamedCharacterReferences,
61   GenClangCommentCommandInfo,
62   GenClangCommentCommandList,
63   GenClangOpenCLBuiltins,
64   GenArmNeon,
65   GenArmFP16,
66   GenArmNeonSema,
67   GenArmNeonTest,
68   GenArmMveHeader,
69   GenArmMveBuiltinDef,
70   GenArmMveBuiltinSema,
71   GenArmMveBuiltinCG,
72   GenArmMveBuiltinAliases,
73   GenArmCdeHeader,
74   GenArmCdeBuiltinDef,
75   GenArmCdeBuiltinSema,
76   GenArmCdeBuiltinCG,
77   GenArmCdeBuiltinAliases,
78   GenAttrDocs,
79   GenDiagDocs,
80   GenOptDocs,
81   GenDataCollectors,
82   GenTestPragmaAttributeSupportedAttributes
83 };
84 
85 namespace {
86 cl::opt<ActionType> Action(
87     cl::desc("Action to perform:"),
88     cl::values(
89         clEnumValN(PrintRecords, "print-records",
90                    "Print all records to stdout (default)"),
91         clEnumValN(DumpJSON, "dump-json",
92                    "Dump all records as machine-readable JSON"),
93         clEnumValN(GenClangAttrClasses, "gen-clang-attr-classes",
94                    "Generate clang attribute clases"),
95         clEnumValN(GenClangAttrParserStringSwitches,
96                    "gen-clang-attr-parser-string-switches",
97                    "Generate all parser-related attribute string switches"),
98         clEnumValN(GenClangAttrSubjectMatchRulesParserStringSwitches,
99                    "gen-clang-attr-subject-match-rules-parser-string-switches",
100                    "Generate all parser-related attribute subject match rule"
101                    "string switches"),
102         clEnumValN(GenClangAttrImpl, "gen-clang-attr-impl",
103                    "Generate clang attribute implementations"),
104         clEnumValN(GenClangAttrList, "gen-clang-attr-list",
105                    "Generate a clang attribute list"),
106         clEnumValN(GenClangAttrSubjectMatchRuleList,
107                    "gen-clang-attr-subject-match-rule-list",
108                    "Generate a clang attribute subject match rule list"),
109         clEnumValN(GenClangAttrPCHRead, "gen-clang-attr-pch-read",
110                    "Generate clang PCH attribute reader"),
111         clEnumValN(GenClangAttrPCHWrite, "gen-clang-attr-pch-write",
112                    "Generate clang PCH attribute writer"),
113         clEnumValN(GenClangAttrHasAttributeImpl,
114                    "gen-clang-attr-has-attribute-impl",
115                    "Generate a clang attribute spelling list"),
116         clEnumValN(GenClangAttrSpellingListIndex,
117                    "gen-clang-attr-spelling-index",
118                    "Generate a clang attribute spelling index"),
119         clEnumValN(GenClangAttrASTVisitor, "gen-clang-attr-ast-visitor",
120                    "Generate a recursive AST visitor for clang attributes"),
121         clEnumValN(GenClangAttrTemplateInstantiate,
122                    "gen-clang-attr-template-instantiate",
123                    "Generate a clang template instantiate code"),
124         clEnumValN(GenClangAttrParsedAttrList,
125                    "gen-clang-attr-parsed-attr-list",
126                    "Generate a clang parsed attribute list"),
127         clEnumValN(GenClangAttrParsedAttrImpl,
128                    "gen-clang-attr-parsed-attr-impl",
129                    "Generate the clang parsed attribute helpers"),
130         clEnumValN(GenClangAttrParsedAttrKinds,
131                    "gen-clang-attr-parsed-attr-kinds",
132                    "Generate a clang parsed attribute kinds"),
133         clEnumValN(GenClangAttrTextNodeDump, "gen-clang-attr-text-node-dump",
134                    "Generate clang attribute text node dumper"),
135         clEnumValN(GenClangAttrNodeTraverse, "gen-clang-attr-node-traverse",
136                    "Generate clang attribute traverser"),
137         clEnumValN(GenClangDiagsDefs, "gen-clang-diags-defs",
138                    "Generate Clang diagnostics definitions"),
139         clEnumValN(GenClangDiagGroups, "gen-clang-diag-groups",
140                    "Generate Clang diagnostic groups"),
141         clEnumValN(GenClangDiagsIndexName, "gen-clang-diags-index-name",
142                    "Generate Clang diagnostic name index"),
143         clEnumValN(GenClangBasicReader, "gen-clang-basic-reader",
144                    "Generate Clang BasicReader classes"),
145         clEnumValN(GenClangBasicWriter, "gen-clang-basic-writer",
146                    "Generate Clang BasicWriter classes"),
147         clEnumValN(GenClangCommentNodes, "gen-clang-comment-nodes",
148                    "Generate Clang AST comment nodes"),
149         clEnumValN(GenClangDeclNodes, "gen-clang-decl-nodes",
150                    "Generate Clang AST declaration nodes"),
151         clEnumValN(GenClangStmtNodes, "gen-clang-stmt-nodes",
152                    "Generate Clang AST statement nodes"),
153         clEnumValN(GenClangTypeNodes, "gen-clang-type-nodes",
154                    "Generate Clang AST type nodes"),
155         clEnumValN(GenClangTypeReader, "gen-clang-type-reader",
156                    "Generate Clang AbstractTypeReader class"),
157         clEnumValN(GenClangTypeWriter, "gen-clang-type-writer",
158                    "Generate Clang AbstractTypeWriter class"),
159         clEnumValN(GenClangOpcodes, "gen-clang-opcodes",
160                    "Generate Clang constexpr interpreter opcodes"),
161         clEnumValN(GenClangSACheckers, "gen-clang-sa-checkers",
162                    "Generate Clang Static Analyzer checkers"),
163         clEnumValN(GenClangCommentHTMLTags, "gen-clang-comment-html-tags",
164                    "Generate efficient matchers for HTML tag "
165                    "names that are used in documentation comments"),
166         clEnumValN(GenClangCommentHTMLTagsProperties,
167                    "gen-clang-comment-html-tags-properties",
168                    "Generate efficient matchers for HTML tag "
169                    "properties"),
170         clEnumValN(GenClangCommentHTMLNamedCharacterReferences,
171                    "gen-clang-comment-html-named-character-references",
172                    "Generate function to translate named character "
173                    "references to UTF-8 sequences"),
174         clEnumValN(GenClangCommentCommandInfo, "gen-clang-comment-command-info",
175                    "Generate command properties for commands that "
176                    "are used in documentation comments"),
177         clEnumValN(GenClangCommentCommandList, "gen-clang-comment-command-list",
178                    "Generate list of commands that are used in "
179                    "documentation comments"),
180         clEnumValN(GenClangOpenCLBuiltins, "gen-clang-opencl-builtins",
181                    "Generate OpenCL builtin declaration handlers"),
182         clEnumValN(GenArmNeon, "gen-arm-neon", "Generate arm_neon.h for clang"),
183         clEnumValN(GenArmFP16, "gen-arm-fp16", "Generate arm_fp16.h for clang"),
184         clEnumValN(GenArmNeonSema, "gen-arm-neon-sema",
185                    "Generate ARM NEON sema support for clang"),
186         clEnumValN(GenArmNeonTest, "gen-arm-neon-test",
187                    "Generate ARM NEON tests for clang"),
188         clEnumValN(GenArmMveHeader, "gen-arm-mve-header",
189                    "Generate arm_mve.h for clang"),
190         clEnumValN(GenArmMveBuiltinDef, "gen-arm-mve-builtin-def",
191                    "Generate ARM MVE builtin definitions for clang"),
192         clEnumValN(GenArmMveBuiltinSema, "gen-arm-mve-builtin-sema",
193                    "Generate ARM MVE builtin sema checks for clang"),
194         clEnumValN(GenArmMveBuiltinCG, "gen-arm-mve-builtin-codegen",
195                    "Generate ARM MVE builtin code-generator for clang"),
196         clEnumValN(GenArmMveBuiltinAliases, "gen-arm-mve-builtin-aliases",
197                    "Generate list of valid ARM MVE builtin aliases for clang"),
198         clEnumValN(GenArmCdeHeader, "gen-arm-cde-header",
199                    "Generate arm_cde.h for clang"),
200         clEnumValN(GenArmCdeBuiltinDef, "gen-arm-cde-builtin-def",
201                    "Generate ARM CDE builtin definitions for clang"),
202         clEnumValN(GenArmCdeBuiltinSema, "gen-arm-cde-builtin-sema",
203                    "Generate ARM CDE builtin sema checks for clang"),
204         clEnumValN(GenArmCdeBuiltinCG, "gen-arm-cde-builtin-codegen",
205                    "Generate ARM CDE builtin code-generator for clang"),
206         clEnumValN(GenArmCdeBuiltinAliases, "gen-arm-cde-builtin-aliases",
207                    "Generate list of valid ARM CDE builtin aliases for clang"),
208         clEnumValN(GenAttrDocs, "gen-attr-docs",
209                    "Generate attribute documentation"),
210         clEnumValN(GenDiagDocs, "gen-diag-docs",
211                    "Generate diagnostic documentation"),
212         clEnumValN(GenOptDocs, "gen-opt-docs", "Generate option documentation"),
213         clEnumValN(GenDataCollectors, "gen-clang-data-collectors",
214                    "Generate data collectors for AST nodes"),
215         clEnumValN(GenTestPragmaAttributeSupportedAttributes,
216                    "gen-clang-test-pragma-attribute-supported-attributes",
217                    "Generate a list of attributes supported by #pragma clang "
218                    "attribute for testing purposes")));
219 
220 cl::opt<std::string>
221 ClangComponent("clang-component",
222                cl::desc("Only use warnings from specified component"),
223                cl::value_desc("component"), cl::Hidden);
224 
225 bool ClangTableGenMain(raw_ostream &OS, RecordKeeper &Records) {
226   switch (Action) {
227   case PrintRecords:
228     OS << Records;           // No argument, dump all contents
229     break;
230   case DumpJSON:
231     EmitJSON(Records, OS);
232     break;
233   case GenClangAttrClasses:
234     EmitClangAttrClass(Records, OS);
235     break;
236   case GenClangAttrParserStringSwitches:
237     EmitClangAttrParserStringSwitches(Records, OS);
238     break;
239   case GenClangAttrSubjectMatchRulesParserStringSwitches:
240     EmitClangAttrSubjectMatchRulesParserStringSwitches(Records, OS);
241     break;
242   case GenClangAttrImpl:
243     EmitClangAttrImpl(Records, OS);
244     break;
245   case GenClangAttrList:
246     EmitClangAttrList(Records, OS);
247     break;
248   case GenClangAttrSubjectMatchRuleList:
249     EmitClangAttrSubjectMatchRuleList(Records, OS);
250     break;
251   case GenClangAttrPCHRead:
252     EmitClangAttrPCHRead(Records, OS);
253     break;
254   case GenClangAttrPCHWrite:
255     EmitClangAttrPCHWrite(Records, OS);
256     break;
257   case GenClangAttrHasAttributeImpl:
258     EmitClangAttrHasAttrImpl(Records, OS);
259     break;
260   case GenClangAttrSpellingListIndex:
261     EmitClangAttrSpellingListIndex(Records, OS);
262     break;
263   case GenClangAttrASTVisitor:
264     EmitClangAttrASTVisitor(Records, OS);
265     break;
266   case GenClangAttrTemplateInstantiate:
267     EmitClangAttrTemplateInstantiate(Records, OS);
268     break;
269   case GenClangAttrParsedAttrList:
270     EmitClangAttrParsedAttrList(Records, OS);
271     break;
272   case GenClangAttrParsedAttrImpl:
273     EmitClangAttrParsedAttrImpl(Records, OS);
274     break;
275   case GenClangAttrParsedAttrKinds:
276     EmitClangAttrParsedAttrKinds(Records, OS);
277     break;
278   case GenClangAttrTextNodeDump:
279     EmitClangAttrTextNodeDump(Records, OS);
280     break;
281   case GenClangAttrNodeTraverse:
282     EmitClangAttrNodeTraverse(Records, OS);
283     break;
284   case GenClangDiagsDefs:
285     EmitClangDiagsDefs(Records, OS, ClangComponent);
286     break;
287   case GenClangDiagGroups:
288     EmitClangDiagGroups(Records, OS);
289     break;
290   case GenClangDiagsIndexName:
291     EmitClangDiagsIndexName(Records, OS);
292     break;
293   case GenClangCommentNodes:
294     EmitClangASTNodes(Records, OS, CommentNodeClassName, "");
295     break;
296   case GenClangDeclNodes:
297     EmitClangASTNodes(Records, OS, DeclNodeClassName, "Decl");
298     EmitClangDeclContext(Records, OS);
299     break;
300   case GenClangStmtNodes:
301     EmitClangASTNodes(Records, OS, StmtNodeClassName, "");
302     break;
303   case GenClangTypeNodes:
304     EmitClangTypeNodes(Records, OS);
305     break;
306   case GenClangTypeReader:
307     EmitClangTypeReader(Records, OS);
308     break;
309   case GenClangTypeWriter:
310     EmitClangTypeWriter(Records, OS);
311     break;
312   case GenClangBasicReader:
313     EmitClangBasicReader(Records, OS);
314     break;
315   case GenClangBasicWriter:
316     EmitClangBasicWriter(Records, OS);
317     break;
318   case GenClangOpcodes:
319     EmitClangOpcodes(Records, OS);
320     break;
321   case GenClangSACheckers:
322     EmitClangSACheckers(Records, OS);
323     break;
324   case GenClangCommentHTMLTags:
325     EmitClangCommentHTMLTags(Records, OS);
326     break;
327   case GenClangCommentHTMLTagsProperties:
328     EmitClangCommentHTMLTagsProperties(Records, OS);
329     break;
330   case GenClangCommentHTMLNamedCharacterReferences:
331     EmitClangCommentHTMLNamedCharacterReferences(Records, OS);
332     break;
333   case GenClangCommentCommandInfo:
334     EmitClangCommentCommandInfo(Records, OS);
335     break;
336   case GenClangCommentCommandList:
337     EmitClangCommentCommandList(Records, OS);
338     break;
339   case GenClangOpenCLBuiltins:
340     EmitClangOpenCLBuiltins(Records, OS);
341     break;
342   case GenArmNeon:
343     EmitNeon(Records, OS);
344     break;
345   case GenArmFP16:
346     EmitFP16(Records, OS);
347     break;
348   case GenArmNeonSema:
349     EmitNeonSema(Records, OS);
350     break;
351   case GenArmNeonTest:
352     EmitNeonTest(Records, OS);
353     break;
354   case GenArmMveHeader:
355     EmitMveHeader(Records, OS);
356     break;
357   case GenArmMveBuiltinDef:
358     EmitMveBuiltinDef(Records, OS);
359     break;
360   case GenArmMveBuiltinSema:
361     EmitMveBuiltinSema(Records, OS);
362     break;
363   case GenArmMveBuiltinCG:
364     EmitMveBuiltinCG(Records, OS);
365     break;
366   case GenArmMveBuiltinAliases:
367     EmitMveBuiltinAliases(Records, OS);
368     break;
369   case GenArmCdeHeader:
370     EmitCdeHeader(Records, OS);
371     break;
372   case GenArmCdeBuiltinDef:
373     EmitCdeBuiltinDef(Records, OS);
374     break;
375   case GenArmCdeBuiltinSema:
376     EmitCdeBuiltinSema(Records, OS);
377     break;
378   case GenArmCdeBuiltinCG:
379     EmitCdeBuiltinCG(Records, OS);
380     break;
381   case GenArmCdeBuiltinAliases:
382     EmitCdeBuiltinAliases(Records, OS);
383     break;
384   case GenAttrDocs:
385     EmitClangAttrDocs(Records, OS);
386     break;
387   case GenDiagDocs:
388     EmitClangDiagDocs(Records, OS);
389     break;
390   case GenOptDocs:
391     EmitClangOptDocs(Records, OS);
392     break;
393   case GenDataCollectors:
394     EmitClangDataCollectors(Records, OS);
395     break;
396   case GenTestPragmaAttributeSupportedAttributes:
397     EmitTestPragmaAttributeSupportedAttributes(Records, OS);
398     break;
399   }
400 
401   return false;
402 }
403 }
404 
405 int main(int argc, char **argv) {
406   sys::PrintStackTraceOnErrorSignal(argv[0]);
407   PrettyStackTraceProgram X(argc, argv);
408   cl::ParseCommandLineOptions(argc, argv);
409 
410   llvm_shutdown_obj Y;
411 
412   return TableGenMain(argv[0], &ClangTableGenMain);
413 }
414 
415 #ifdef __has_feature
416 #if __has_feature(address_sanitizer)
417 #include <sanitizer/lsan_interface.h>
418 // Disable LeakSanitizer for this binary as it has too many leaks that are not
419 // very interesting to fix. See compiler-rt/include/sanitizer/lsan_interface.h .
420 int __lsan_is_turned_off() { return 1; }
421 #endif  // __has_feature(address_sanitizer)
422 #endif  // defined(__has_feature)
423