include/llvm/ExecutionEngine/RuntimeDyldChecker.h

   1 //===---- RuntimeDyldChecker.h - RuntimeDyld tester framework -----*- 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 #ifndef LLVM_RUNTIMEDYLDCHECKER_H
  11 #define LLVM_RUNTIMEDYLDCHECKER_H
  12
  13 #include "llvm/ADT/StringRef.h"
  14
  15 namespace llvm {
  16
  17 class MCDisassembler;
  18 class MemoryBuffer;
  19 class MCInstPrinter;
  20 class RuntimeDyld;
  21 class RuntimeDyldCheckerImpl;
  22 class raw_ostream;
  23
  24 /// \brief RuntimeDyld invariant checker for verifying that RuntimeDyld has
  25 ///        correctly applied relocations.
  26 ///
  27 /// The RuntimeDyldChecker class evaluates expressions against an attached
  28 /// RuntimeDyld instance to verify that relocations have been applied
  29 /// correctly.
  30 ///
  31 /// The expression language supports basic pointer arithmetic and bit-masking,
  32 /// and has limited disassembler integration for accessing instruction
  33 /// operands and the next PC (program counter) address for each instruction.
  34 ///
  35 /// The language syntax is:
  36 ///
  37 /// check = expr '=' expr
  38 ///
  39 /// expr = binary_expr
  40 ///      | sliceable_expr
  41 ///
  42 /// sliceable_expr = '*{' number '}' load_addr_expr [slice]
  43 ///                | '(' expr ')' [slice]
  44 ///                | ident_expr [slice]
  45 ///                | number [slice]
  46 ///
  47 /// slice = '[' high-bit-index ':' low-bit-index ']'
  48 ///
  49 /// load_addr_expr = symbol
  50 ///                | '(' symbol '+' number ')'
  51 ///                | '(' symbol '-' number ')'
  52 ///
  53 /// ident_expr = 'decode_operand' '(' symbol ',' operand-index ')'
  54 ///            | 'next_pc'        '(' symbol ')'
  55 ///            | symbol
  56 ///
  57 /// binary_expr = expr '+' expr
  58 ///             | expr '-' expr
  59 ///             | expr '&' expr
  60 ///             | expr '|' expr
  61 ///             | expr '<<' expr
  62 ///             | expr '>>' expr
  63 ///
  64 class RuntimeDyldChecker {
  65 public:
  66   RuntimeDyldChecker(RuntimeDyld &RTDyld, MCDisassembler *Disassembler,
  67                      MCInstPrinter *InstPrinter, raw_ostream &ErrStream);
  68   ~RuntimeDyldChecker();
  69
  70   /// \brief Check a single expression against the attached RuntimeDyld
  71   ///        instance.
  72   bool check(StringRef CheckExpr) const;
  73
  74   /// \brief Scan the given memory buffer for lines beginning with the string
  75   ///        in RulePrefix. The remainder of the line is passed to the check
  76   ///        method to be evaluated as an expression.
  77   bool checkAllRulesInBuffer(StringRef RulePrefix, MemoryBuffer *MemBuf) const;
  78
  79 private:
  80   std::unique_ptr<RuntimeDyldCheckerImpl> Impl;
  81 };
  82
  83 } // end namespace llvm
  84
  85 #endif // LLVM_RUNTIMEDYLDCHECKER_H