summaryrefslogtreecommitdiff
path: root/include/llvm/Target/TargetRegistry.h
blob: 0e46526f5f876d9a5f0aca80c9f7a5e25db21e9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
//===-- Target/TargetRegistry.h - Target Registration -----------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file exposes the TargetRegistry interface, which tools can use to access
// the appropriate target specific classes (TargetMachine, AsmPrinter, etc.)
// which have been registered.
//
// Target specific class implementations should register themselves using the
// appropriate TargetRegistry interfaces.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_TARGET_TARGETREGISTRY_H
#define LLVM_TARGET_TARGETREGISTRY_H

#include <string>
#include <cassert>

namespace llvm {
  class FunctionPass;
  class Module;
  class TargetMachine;
  class formatted_raw_ostream;

  /// Target - Wrapper for Target specific information.
  ///
  /// For registration purposes, this is a POD type so that targets can be
  /// registered without the use of static constructors.
  ///
  /// Targets should implement a single global instance of this class (which
  /// will be zero initialized), and pass that instance to the TargetRegistry as
  /// part of their initialization.
  class Target {
  private:
    typedef unsigned (*TripleMatchQualityFnTy)(const std::string &TT);
    typedef unsigned (*ModuleMatchQualityFnTy)(const Module &M);
    typedef unsigned (*JITMatchQualityFnTy)();

    typedef TargetMachine *(*TargetMachineCtorTy)(const Module &, 
                                                  const std::string &);
    typedef FunctionPass *(*AsmPrinterCtorTy)(formatted_raw_ostream &,
                                              TargetMachine &,
                                              bool);

    friend struct TargetRegistry;

    /// Next - The next registered target in the linked list, maintained by the
    /// TargetRegistry.
    Target *Next;

    /// TripleMatchQualityFn - The target function for rating the match quality
    /// of a triple.
    TripleMatchQualityFnTy TripleMatchQualityFn;

    /// ModuleMatchQualityFn - The target function for rating the match quality
    /// of a module.
    ModuleMatchQualityFnTy ModuleMatchQualityFn;

    /// JITMatchQualityFn - The target function for rating the match quality
    /// with the host.
    JITMatchQualityFnTy JITMatchQualityFn;

    /// Name - The target name.
    const char *Name;

    /// ShortDesc - A short description of the target.
    const char *ShortDesc;

    /// TargetMachineCtorFn - Construction function for this target's
    /// TargetMachine, if registered.
    TargetMachineCtorTy TargetMachineCtorFn;

    /// AsmPrinterCtorFn - Construction function for this target's AsmPrinter,
    /// if registered.
    AsmPrinterCtorTy AsmPrinterCtorFn;

  public:
    /// getName - Get the target name.
    const char *getName() const { return Name; }

    /// getShortDescription - Get a short description of the target.
    const char *getShortDescription() const { return ShortDesc; }

    /// createTargetMachine - Create a target specific machine implementation.
    TargetMachine *createTargetMachine(const Module &M,
                                       const std::string &Features) const {
      if (!TargetMachineCtorFn)
        return 0;
      return TargetMachineCtorFn(M, Features);
    }

    /// createAsmPrinter - Create a target specific assembly printer pass.
    FunctionPass *createAsmPrinter(formatted_raw_ostream &OS,
                                   TargetMachine &M,
                                   bool Verbose) const {
      if (!AsmPrinterCtorFn)
        return 0;
      return AsmPrinterCtorFn(OS, M, Verbose);
    }
  };

  /// TargetRegistry - Generic interface to target specific features.
  //
  // FIXME: Provide Target* iterator.
  struct TargetRegistry {
    /// @name Registry Access
    /// @{

    /// getClosestStaticTargetForTriple - Given a target triple, pick the most
    /// capable target for that triple.
    static const Target *getClosestStaticTargetForTriple(const std::string &TT,
                                                         std::string &Error);

    /// getClosestStaticTargetForModule - Given an LLVM module, pick the best
    /// target that is compatible with the module.  If no close target can be
    /// found, this returns null and sets the Error string to a reason.
    static const Target *getClosestStaticTargetForModule(const Module &M,
                                                        std::string &Error);

    /// getClosestTargetForJIT - Pick the best target that is compatible with
    /// the current host.  If no close target can be found, this returns null
    /// and sets the Error string to a reason.
    //
    // FIXME: Do we still need this interface, clients can always look for the
    // match for the host triple.
    static const Target *getClosestTargetForJIT(std::string &Error);

    /// @}
    /// @name Target Registration
    /// @{

    /// RegisterTarget - Register the given target.
    /// 
    /// Clients are responsible for ensuring that registration doesn't occur
    /// while another thread is attempting to access the registry. Typically
    /// this is done by initializing all targets at program startup.
    ///
    /// @param T - The target being registered.
    /// @param Name - The target name. This should be a static string.
    /// @param ShortDesc - A short target description. This should be a static
    /// string. 
    /// @param TQualityFn - The triple match quality computation function for
    /// this target.
    /// @param MQualityFn - The module match quality computation function for
    /// this target.
    /// @param JITMatchQualityFn - The JIT match quality computation function
    /// for this target.
    static void RegisterTarget(Target &T,
                               const char *Name,
                               const char *ShortDesc,
                               Target::TripleMatchQualityFnTy TQualityFn,
                               Target::ModuleMatchQualityFnTy MQualityFn,
                               Target::JITMatchQualityFnTy JITQualityFn);
                               
    /// RegisterTargetMachine - Register a TargetMachine implementation for the
    /// given target.
    /// 
    /// Clients are responsible for ensuring that registration doesn't occur
    /// while another thread is attempting to access the registry. Typically
    /// this is done by initializing all targets at program startup.
    /// 
    /// @param T - The target being registered.
    /// @param Fn - A function to construct a TargetMachine for the target.
    static void RegisterTargetMachine(Target &T, 
                                      Target::TargetMachineCtorTy Fn) {
      assert(!T.TargetMachineCtorFn && "Constructor already registered!");
      T.TargetMachineCtorFn = Fn;
    }

    /// RegisterAsmPrinter - Register an AsmPrinter implementation for the given
    /// target.
    /// 
    /// Clients are responsible for ensuring that registration doesn't occur
    /// while another thread is attempting to access the registry. Typically
    /// this is done by initializing all targets at program startup.
    ///
    /// @param T - The target being registered.
    /// @param Fn - A function to construct an AsmPrinter for the target.
    static void RegisterAsmPrinter(Target &T, Target::AsmPrinterCtorTy Fn) {
      assert(!T.AsmPrinterCtorFn && "Constructor already registered!");
      T.AsmPrinterCtorFn = Fn;
    }

    /// @}
  };

}

#endif