1 //===---- RuntimeDyldChecker.h - RuntimeDyld tester framework -----*- C++ -*-=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_EXECUTIONENGINE_RUNTIMEDYLDCHECKER_H
11 #define LLVM_EXECUTIONENGINE_RUNTIMEDYLDCHECKER_H
13 #include "llvm/ADT/StringRef.h"
21 class RuntimeDyldCheckerImpl;
24 /// \brief RuntimeDyld invariant checker for verifying that RuntimeDyld has
25 /// correctly applied relocations.
27 /// The RuntimeDyldChecker class evaluates expressions against an attached
28 /// RuntimeDyld instance to verify that relocations have been applied
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.
35 /// The language syntax is:
37 /// check = expr '=' expr
39 /// expr = binary_expr
42 /// sliceable_expr = '*{' number '}' load_addr_expr [slice]
43 /// | '(' expr ')' [slice]
44 /// | ident_expr [slice]
47 /// slice = '[' high-bit-index ':' low-bit-index ']'
49 /// load_addr_expr = symbol
50 /// | '(' symbol '+' number ')'
51 /// | '(' symbol '-' number ')'
53 /// ident_expr = 'decode_operand' '(' symbol ',' operand-index ')'
54 /// | 'next_pc' '(' symbol ')'
57 /// binary_expr = expr '+' expr
64 class RuntimeDyldChecker {
66 RuntimeDyldChecker(RuntimeDyld &RTDyld, MCDisassembler *Disassembler,
67 MCInstPrinter *InstPrinter, raw_ostream &ErrStream);
68 ~RuntimeDyldChecker();
70 // \brief Get the associated RTDyld instance.
71 RuntimeDyld& getRTDyld();
73 // \brief Get the associated RTDyld instance.
74 const RuntimeDyld& getRTDyld() const;
76 /// \brief Check a single expression against the attached RuntimeDyld
78 bool check(StringRef CheckExpr) const;
80 /// \brief Scan the given memory buffer for lines beginning with the string
81 /// in RulePrefix. The remainder of the line is passed to the check
82 /// method to be evaluated as an expression.
83 bool checkAllRulesInBuffer(StringRef RulePrefix, MemoryBuffer *MemBuf) const;
85 /// \brief Returns the address of the requested section (or an error message
86 /// in the second element of the pair if the address cannot be found).
88 /// if 'LinkerAddress' is true, this returns the address of the section
89 /// within the linker's memory. If 'LinkerAddress' is false it returns the
90 /// address within the target process (i.e. the load address).
91 std::pair<uint64_t, std::string> getSectionAddr(StringRef FileName,
92 StringRef SectionName,
96 std::unique_ptr<RuntimeDyldCheckerImpl> Impl;
99 } // end namespace llvm