utils/TableGen/TableGenBackends.h

   1 //===- TableGenBackends.h - Declarations for LLVM TableGen Backends -------===//
   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 declarations for all of the LLVM TableGen
  10 // backends. A "TableGen backend" is just a function. See below for a
  11 // precise description.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_UTILS_TABLEGEN_TABLEGENBACKENDS_H
  16 #define LLVM_UTILS_TABLEGEN_TABLEGENBACKENDS_H
  17
  18 // A TableGen backend is a function that looks like
  19 //
  20 //    EmitFoo(RecordKeeper &RK, raw_ostream &OS /*, anything else you need */ )
  21 //
  22 // What you do inside of that function is up to you, but it will usually
  23 // involve generating C++ code to the provided raw_ostream.
  24 //
  25 // The RecordKeeper is just a top-level container for an in-memory
  26 // representation of the data encoded in the TableGen file. What a TableGen
  27 // backend does is walk around that in-memory representation and generate
  28 // stuff based on the information it contains.
  29 //
  30 // The in-memory representation is a node-graph (think of it like JSON but
  31 // with a richer ontology of types), where the nodes are subclasses of
  32 // Record. The methods `getClass`, `getDef` are the basic interface to
  33 // access the node-graph.  RecordKeeper also provides a handy method
  34 // `getAllDerivedDefinitions`. Consult "include/llvm/TableGen/Record.h" for
  35 // the exact interfaces provided by Record's and RecordKeeper.
  36 //
  37 // A common pattern for TableGen backends is for the EmitFoo function to
  38 // instantiate a class which holds some context for the generation process,
  39 // and then have most of the work happen in that class's methods. This
  40 // pattern partly has historical roots in the previous TableGen backend API
  41 // that involved a class and an invocation like `FooEmitter(RK).run(OS)`.
  42 //
  43 // Remember to wrap private things in an anonymous namespace. For most
  44 // backends, this means that the EmitFoo function is the only thing not in
  45 // the anonymous namespace.
  46
  47
  48 // FIXME: Reorganize TableGen so that build dependencies can be more
  49 // accurately expressed. Currently, touching any of the emitters (or
  50 // anything that they transitively depend on) causes everything dependent
  51 // on TableGen to be rebuilt (this includes all the targets!). Perhaps have
  52 // a standalone TableGen binary and have the backends be loadable modules
  53 // of some sort; then the dependency could be expressed as being on the
  54 // module, and all the modules would have a common dependency on the
  55 // TableGen binary with as few dependencies as possible on the rest of
  56 // LLVM.
  57
  58
  59 namespace llvm {
  60
  61 class raw_ostream;
  62 class RecordKeeper;
  63
  64 void EmitIntrinsicEnums(RecordKeeper &RK, raw_ostream &OS,
  65                         bool TargetOnly = false);
  66 void EmitIntrinsicImpl(RecordKeeper &RK, raw_ostream &OS,
  67                        bool TargetOnly = false);
  68 void EmitAsmMatcher(RecordKeeper &RK, raw_ostream &OS);
  69 void EmitAsmWriter(RecordKeeper &RK, raw_ostream &OS);
  70 void EmitCallingConv(RecordKeeper &RK, raw_ostream &OS);
  71 void EmitCodeEmitter(RecordKeeper &RK, raw_ostream &OS);
  72 void EmitDAGISel(RecordKeeper &RK, raw_ostream &OS);
  73 void EmitDFAPacketizer(RecordKeeper &RK, raw_ostream &OS);
  74 void EmitDisassembler(RecordKeeper &RK, raw_ostream &OS);
  75 void EmitFastISel(RecordKeeper &RK, raw_ostream &OS);
  76 void EmitInstrInfo(RecordKeeper &RK, raw_ostream &OS);
  77 void EmitInstrDocs(RecordKeeper &RK, raw_ostream &OS);
  78 void EmitPseudoLowering(RecordKeeper &RK, raw_ostream &OS);
  79 void EmitCompressInst(RecordKeeper &RK, raw_ostream &OS);
  80 void EmitRegisterInfo(RecordKeeper &RK, raw_ostream &OS);
  81 void EmitSubtarget(RecordKeeper &RK, raw_ostream &OS);
  82 void EmitMapTable(RecordKeeper &RK, raw_ostream &OS);
  83 void EmitOptParser(RecordKeeper &RK, raw_ostream &OS);
  84 void EmitCTags(RecordKeeper &RK, raw_ostream &OS);
  85 void EmitAttributes(RecordKeeper &RK, raw_ostream &OS);
  86 void EmitSearchableTables(RecordKeeper &RK, raw_ostream &OS);
  87 void EmitGlobalISel(RecordKeeper &RK, raw_ostream &OS);
  88 void EmitX86EVEX2VEXTables(RecordKeeper &RK, raw_ostream &OS);
  89 void EmitX86FoldTables(RecordKeeper &RK, raw_ostream &OS);
  90 void EmitRegisterBank(RecordKeeper &RK, raw_ostream &OS);
  91 void EmitExegesis(RecordKeeper &RK, raw_ostream &OS);
  92
  93 } // End llvm namespace
  94
  95 #endif