xref: /freebsd/contrib/llvm-project/llvm/lib/ExecutionEngine/RuntimeDyld/RuntimeDyldCheckerImpl.h (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
10b57cec5SDimitry Andric //===-- RuntimeDyldCheckerImpl.h -- RuntimeDyld test framework --*- C++ -*-===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric 
90b57cec5SDimitry Andric #ifndef LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDCHECKERIMPL_H
100b57cec5SDimitry Andric #define LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDCHECKERIMPL_H
110b57cec5SDimitry Andric 
120b57cec5SDimitry Andric #include "RuntimeDyldImpl.h"
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric namespace llvm {
150b57cec5SDimitry Andric 
160b57cec5SDimitry Andric class RuntimeDyldCheckerImpl {
170b57cec5SDimitry Andric   friend class RuntimeDyldChecker;
180b57cec5SDimitry Andric   friend class RuntimeDyldCheckerExprEval;
190b57cec5SDimitry Andric 
200b57cec5SDimitry Andric   using IsSymbolValidFunction =
210b57cec5SDimitry Andric     RuntimeDyldChecker::IsSymbolValidFunction;
220b57cec5SDimitry Andric   using GetSymbolInfoFunction = RuntimeDyldChecker::GetSymbolInfoFunction;
230b57cec5SDimitry Andric   using GetSectionInfoFunction = RuntimeDyldChecker::GetSectionInfoFunction;
240b57cec5SDimitry Andric   using GetStubInfoFunction = RuntimeDyldChecker::GetStubInfoFunction;
250b57cec5SDimitry Andric   using GetGOTInfoFunction = RuntimeDyldChecker::GetGOTInfoFunction;
260b57cec5SDimitry Andric 
270b57cec5SDimitry Andric public:
280b57cec5SDimitry Andric   RuntimeDyldCheckerImpl(
290b57cec5SDimitry Andric       IsSymbolValidFunction IsSymbolValid, GetSymbolInfoFunction GetSymbolInfo,
300b57cec5SDimitry Andric       GetSectionInfoFunction GetSectionInfo, GetStubInfoFunction GetStubInfo,
310b57cec5SDimitry Andric       GetGOTInfoFunction GetGOTInfo, support::endianness Endianness,
320b57cec5SDimitry Andric       MCDisassembler *Disassembler, MCInstPrinter *InstPrinter,
330b57cec5SDimitry Andric       llvm::raw_ostream &ErrStream);
340b57cec5SDimitry Andric 
350b57cec5SDimitry Andric   bool check(StringRef CheckExpr) const;
360b57cec5SDimitry Andric   bool checkAllRulesInBuffer(StringRef RulePrefix, MemoryBuffer *MemBuf) const;
370b57cec5SDimitry Andric 
380b57cec5SDimitry Andric private:
390b57cec5SDimitry Andric 
400b57cec5SDimitry Andric   // StubMap typedefs.
410b57cec5SDimitry Andric 
420b57cec5SDimitry Andric   Expected<JITSymbolResolver::LookupResult>
430b57cec5SDimitry Andric   lookup(const JITSymbolResolver::LookupSet &Symbols) const;
440b57cec5SDimitry Andric 
450b57cec5SDimitry Andric   bool isSymbolValid(StringRef Symbol) const;
460b57cec5SDimitry Andric   uint64_t getSymbolLocalAddr(StringRef Symbol) const;
470b57cec5SDimitry Andric   uint64_t getSymbolRemoteAddr(StringRef Symbol) const;
480b57cec5SDimitry Andric   uint64_t readMemoryAtAddr(uint64_t Addr, unsigned Size) const;
490b57cec5SDimitry Andric 
500b57cec5SDimitry Andric   StringRef getSymbolContent(StringRef Symbol) const;
510b57cec5SDimitry Andric 
520b57cec5SDimitry Andric   std::pair<uint64_t, std::string> getSectionAddr(StringRef FileName,
530b57cec5SDimitry Andric                                                   StringRef SectionName,
540b57cec5SDimitry Andric                                                   bool IsInsideLoad) const;
550b57cec5SDimitry Andric 
560b57cec5SDimitry Andric   std::pair<uint64_t, std::string>
570b57cec5SDimitry Andric   getStubOrGOTAddrFor(StringRef StubContainerName, StringRef Symbol,
580b57cec5SDimitry Andric                       bool IsInsideLoad, bool IsStubAddr) const;
590b57cec5SDimitry Andric 
60*bdd1243dSDimitry Andric   std::optional<uint64_t> getSectionLoadAddress(void *LocalAddr) const;
610b57cec5SDimitry Andric 
620b57cec5SDimitry Andric   IsSymbolValidFunction IsSymbolValid;
630b57cec5SDimitry Andric   GetSymbolInfoFunction GetSymbolInfo;
640b57cec5SDimitry Andric   GetSectionInfoFunction GetSectionInfo;
650b57cec5SDimitry Andric   GetStubInfoFunction GetStubInfo;
660b57cec5SDimitry Andric   GetGOTInfoFunction GetGOTInfo;
670b57cec5SDimitry Andric   support::endianness Endianness;
680b57cec5SDimitry Andric   MCDisassembler *Disassembler;
690b57cec5SDimitry Andric   MCInstPrinter *InstPrinter;
700b57cec5SDimitry Andric   llvm::raw_ostream &ErrStream;
710b57cec5SDimitry Andric };
720b57cec5SDimitry Andric }
730b57cec5SDimitry Andric 
740b57cec5SDimitry Andric #endif
75