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