utils/TableGen/X86ModRMFilters.h

   1 //===- X86ModRMFilters.h - Disassembler ModR/M filterss ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file is part of the X86 Disassembler Emitter.
  11 // It contains ModR/M filters that determine which values of the ModR/M byte
  12 //  are valid for a partiuclar instruction.
  13 // Documentation for the disassembler emitter in general can be found in
  14 //  X86DisasemblerEmitter.h.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef X86MODRMFILTERS_H
  19 #define X86MODRMFILTERS_H
  20
  21 #include "llvm/Support/DataTypes.h"
  22
  23 namespace llvm {
  24
  25 namespace X86Disassembler {
  26
  27 /// ModRMFilter - Abstract base class for clases that recognize patterns in
  28 ///   ModR/M bytes.
  29 class ModRMFilter {
  30   virtual void anchor();
  31 public:
  32   /// Destructor    - Override as necessary.
  33   virtual ~ModRMFilter() { }
  34
  35   /// isDumb        - Indicates whether this filter returns the same value for
  36   ///                 any value of the ModR/M byte.
  37   ///
  38   /// @result       - True if the filter returns the same value for any ModR/M
  39   ///                 byte; false if not.
  40   virtual bool isDumb() const { return false; }
  41
  42   /// accepts       - Indicates whether the filter accepts a particular ModR/M
  43   ///                 byte value.
  44   ///
  45   /// @result       - True if the filter accepts the ModR/M byte; false if not.
  46   virtual bool accepts(uint8_t modRM) const = 0;
  47 };
  48
  49 /// DumbFilter - Accepts any ModR/M byte.  Used for instructions that do not
  50 ///   require a ModR/M byte or instructions where the entire ModR/M byte is used
  51 ///   for operands.
  52 class DumbFilter : public ModRMFilter {
  53   virtual void anchor();
  54 public:
  55   bool isDumb() const {
  56     return true;
  57   }
  58
  59   bool accepts(uint8_t modRM) const {
  60     return true;
  61   }
  62 };
  63
  64 /// ModFilter - Filters based on the mod bits [bits 7-6] of the ModR/M byte.
  65 ///   Some instructions are classified based on whether they are 11 or anything
  66 ///   else.  This filter performs that classification.
  67 class ModFilter : public ModRMFilter {
  68   virtual void anchor();
  69   bool R;
  70 public:
  71   /// Constructor
  72   ///
  73   /// \param r        True if the mod bits of the ModR/M byte must be 11; false
  74   ///                 otherwise.  The name r derives from the fact that the mod
  75   ///                 bits indicate whether the R/M bits [bits 2-0] signify a
  76   ///                 register or a memory operand.
  77   ModFilter(bool r) :
  78     ModRMFilter(),
  79     R(r) {
  80   }
  81
  82   bool accepts(uint8_t modRM) const {
  83     return (R == ((modRM & 0xc0) == 0xc0));
  84   }
  85 };
  86
  87 /// AddRegEscapeFilter - Some escape opcodes have one of the register operands
  88 ///   added to the ModR/M byte, meaning that a range of eight ModR/M values
  89 ///   maps to a single instruction.  Such instructions require the ModR/M byte
  90 ///   to fall between 0xc0 and 0xff.
  91 class AddRegEscapeFilter : public ModRMFilter {
  92   virtual void anchor();
  93   uint8_t ModRM;
  94 public:
  95   /// Constructor
  96   ///
  97   /// \param modRM The value of the ModR/M byte when the register operand
  98   ///              refers to the first register in the register set.
  99   AddRegEscapeFilter(uint8_t modRM) : ModRM(modRM) {
 100   }
 101
 102   bool accepts(uint8_t modRM) const {
 103     return (modRM >= ModRM && modRM < ModRM + 8);
 104   }
 105 };
 106
 107 /// ExtendedFilter - Extended opcodes are classified based on the value of the
 108 ///   mod field [bits 7-6] and the value of the nnn field [bits 5-3].
 109 class ExtendedFilter : public ModRMFilter {
 110   virtual void anchor();
 111   bool R;
 112   uint8_t NNN;
 113 public:
 114   /// Constructor
 115   ///
 116   /// \param r   True if the mod field must be set to 11; false otherwise.
 117   ///            The name is explained at ModFilter.
 118   /// \param nnn The required value of the nnn field.
 119   ExtendedFilter(bool r, uint8_t nnn) :
 120     ModRMFilter(),
 121     R(r),
 122     NNN(nnn) {
 123   }
 124
 125   bool accepts(uint8_t modRM) const {
 126     return (((R  && ((modRM & 0xc0) == 0xc0)) ||
 127              (!R && ((modRM & 0xc0) != 0xc0))) &&
 128             (((modRM & 0x38) >> 3) == NNN));
 129   }
 130 };
 131
 132 /// ExactFilter - The occasional extended opcode (such as VMCALL or MONITOR)
 133 ///   requires the ModR/M byte to have a specific value.
 134 class ExactFilter : public ModRMFilter {
 135   virtual void anchor();
 136   uint8_t ModRM;
 137 public:
 138   /// Constructor
 139   ///
 140   /// \param modRM The required value of the full ModR/M byte.
 141   ExactFilter(uint8_t modRM) :
 142     ModRMFilter(),
 143     ModRM(modRM) {
 144   }
 145
 146   bool accepts(uint8_t modRM) const {
 147     return (ModRM == modRM);
 148   }
 149 };
 150
 151 } // namespace X86Disassembler
 152
 153 } // namespace llvm
 154
 155 #endif