include/llvm/Target/SubtargetFeature.h

   1 //===-- llvm/Target/SubtargetFeature.h - CPU characteristics ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by James M. Laskey and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines and manages user or tool specified CPU characteristics.
  11 // The intent is to be able to package specific features that should or should
  12 // not be used on a specific target processor.  A tool, such as llc, could, as
  13 // as example, gather chip info from the command line, a long with features
  14 // that should be used on that chip.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_TARGET_SUBTARGETFEATURE_H
  19 #define LLVM_TARGET_SUBTARGETFEATURE_H
  20
  21 #include <string>
  22 #include <vector>
  23 #include <iosfwd>
  24 #include "llvm/Support/DataTypes.h"
  25
  26 namespace llvm {
  27
  28 //===----------------------------------------------------------------------===//
  29 ///
  30 /// SubtargetFeatureKV - Used to provide key value pairs for feature and
  31 /// CPU bit flags.
  32 //
  33 struct SubtargetFeatureKV {
  34   const char *Key;                      // K-V key string
  35   const char *Desc;                     // Help descriptor
  36   uint32_t Value;                       // K-V integer value
  37
  38   // Compare routine for std binary search
  39   bool operator<(const SubtargetFeatureKV &S) const {
  40     return strcmp(Key, S.Key) < 0;
  41   }
  42 };
  43
  44 //===----------------------------------------------------------------------===//
  45 ///
  46 /// SubtargetInfoKV - Used to provide key value pairs for CPU and arbitrary
  47 /// pointers.
  48 //
  49 struct SubtargetInfoKV {
  50   const char *Key;                      // K-V key string
  51   void *Value;                          // K-V pointer value
  52
  53   // Compare routine for std binary search
  54   bool operator<(const SubtargetInfoKV &S) const {
  55     return strcmp(Key, S.Key) < 0;
  56   }
  57 };
  58
  59 //===----------------------------------------------------------------------===//
  60 ///
  61 /// SubtargetFeatures - Manages the enabling and disabling of subtarget
  62 /// specific features.  Features are encoded as a string of the form
  63 ///   "cpu,+attr1,+attr2,-attr3,...,+attrN"
  64 /// A comma separates each feature from the next (all lowercase.)
  65 /// The first feature is always the CPU subtype (eg. pentiumm).  If the CPU
  66 /// value is "generic" then the CPU subtype should be generic for the target.
  67 /// Each of the remaining features is prefixed with + or - indicating whether
  68 /// that feature should be enabled or disabled contrary to the cpu
  69 /// specification.
  70 ///
  71
  72 class SubtargetFeatures {
  73   std::vector<std::string> Features;    // Subtarget features as a vector
  74 public:
  75   SubtargetFeatures(const std::string &Initial = std::string());
  76
  77   /// Features string accessors.
  78   std::string getString() const;
  79   void setString(const std::string &Initial);
  80
  81   /// Set the CPU string.  Replaces previous setting.  Setting to "" clears CPU.
  82   void setCPU(const std::string &String);
  83
  84   /// Get the CPU string.
  85   const std::string &getCPU() const { return Features[0]; }
  86
  87   /// Setting CPU string only if no string is set.
  88   void setCPUIfNone(const std::string &String);
  89
  90   /// Adding Features.
  91   void AddFeature(const std::string &String, bool IsEnabled = true);
  92
  93   /// Get feature bits.
  94   uint32_t getBits(const SubtargetFeatureKV *CPUTable,
  95                          size_t CPUTableSize,
  96                    const SubtargetFeatureKV *FeatureTable,
  97                          size_t FeatureTableSize);
  98
  99   /// Get info pointer
 100   void *getInfo(const SubtargetInfoKV *Table, size_t TableSize);
 101
 102   /// Print feature string.
 103   void print(std::ostream &OS) const;
 104
 105   // Dump feature info.
 106   void dump() const;
 107 };
 108
 109 } // End namespace llvm
 110
 111 #endif