mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2025-02-01 05:01:59 +01:00
efc9f3486a
This patch introduces new APIs to support resource tracking and removal in Orc. It is intended as a thread-safe generalization of the removeModule concept from OrcV1. Clients can now create ResourceTracker objects (using JITDylib::createResourceTracker) to track resources for each MaterializationUnit (code, data, aliases, absolute symbols, etc.) added to the JIT. Every MaterializationUnit will be associated with a ResourceTracker, and ResourceTrackers can be re-used for multiple MaterializationUnits. Each JITDylib has a default ResourceTracker that will be used for MaterializationUnits added to that JITDylib if no ResourceTracker is explicitly specified. Two operations can be performed on ResourceTrackers: transferTo and remove. The transferTo operation transfers tracking of the resources to a different ResourceTracker object, allowing ResourceTrackers to be merged to reduce administrative overhead (the source tracker is invalidated in the process). The remove operation removes all resources associated with a ResourceTracker, including any symbols defined by MaterializationUnits associated with the tracker, and also invalidates the tracker. These operations are thread safe, and should work regardless of the the state of the MaterializationUnits. In the case of resource transfer any existing resources associated with the source tracker will be transferred to the destination tracker, and all future resources for those units will be automatically associated with the destination tracker. In the case of resource removal all already-allocated resources will be deallocated, any if any program representations associated with the tracker have not been compiled yet they will be destroyed. If any program representations are currently being compiled then they will be prevented from completing: their MaterializationResponsibility will return errors on any attempt to update the JIT state. Clients (usually Layer writers) wishing to track resources can implement the ResourceManager API to receive notifications when ResourceTrackers are transferred or removed. The MaterializationResponsibility::withResourceKeyDo method can be used to create associations between the key for a ResourceTracker and an allocated resource in a thread-safe way. RTDyldObjectLinkingLayer and ObjectLinkingLayer are updated to use the ResourceManager API to enable tracking and removal of memory allocated by the JIT linker. The new JITDylib::clear method can be used to trigger removal of every ResourceTracker associated with the JITDylib (note that this will only remove resources for the JITDylib, it does not run static destructors). This patch includes unit tests showing basic usage. A follow-up patch will update the Kaleidoscope and BuildingAJIT tutorial series to OrcV2 and will use this API to release code associated with anonymous expressions.
108 lines
3.5 KiB
C++
108 lines
3.5 KiB
C++
//===---- llvm-jitlink.h - Session and format-specific decls ----*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// llvm-jitlink Session class and tool utilities.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_TOOLS_LLVM_JITLINK_LLVM_JITLINK_H
|
|
#define LLVM_TOOLS_LLVM_JITLINK_LLVM_JITLINK_H
|
|
|
|
#include "llvm/ADT/Optional.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
#include "llvm/ADT/Triple.h"
|
|
#include "llvm/ExecutionEngine/Orc/Core.h"
|
|
#include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
|
|
#include "llvm/ExecutionEngine/Orc/TargetProcessControl.h"
|
|
#include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/Regex.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
#include <vector>
|
|
|
|
namespace llvm {
|
|
|
|
struct Session;
|
|
|
|
/// ObjectLinkingLayer with additional support for symbol promotion.
|
|
class LLVMJITLinkObjectLinkingLayer : public orc::ObjectLinkingLayer {
|
|
public:
|
|
using orc::ObjectLinkingLayer::add;
|
|
|
|
LLVMJITLinkObjectLinkingLayer(Session &S,
|
|
jitlink::JITLinkMemoryManager &MemMgr);
|
|
|
|
Error add(orc::ResourceTrackerSP RT,
|
|
std::unique_ptr<MemoryBuffer> O) override;
|
|
|
|
private:
|
|
Session &S;
|
|
};
|
|
|
|
struct Session {
|
|
orc::ExecutionSession ES;
|
|
std::unique_ptr<orc::TargetProcessControl> TPC;
|
|
orc::JITDylib *MainJD;
|
|
LLVMJITLinkObjectLinkingLayer ObjLayer;
|
|
std::vector<orc::JITDylib *> JDSearchOrder;
|
|
|
|
~Session();
|
|
|
|
static Expected<std::unique_ptr<Session>> Create(Triple TT);
|
|
void dumpSessionInfo(raw_ostream &OS);
|
|
void modifyPassConfig(const Triple &FTT,
|
|
jitlink::PassConfiguration &PassConfig);
|
|
|
|
using MemoryRegionInfo = RuntimeDyldChecker::MemoryRegionInfo;
|
|
|
|
struct FileInfo {
|
|
StringMap<MemoryRegionInfo> SectionInfos;
|
|
StringMap<MemoryRegionInfo> StubInfos;
|
|
StringMap<MemoryRegionInfo> GOTEntryInfos;
|
|
};
|
|
|
|
using SymbolInfoMap = StringMap<MemoryRegionInfo>;
|
|
using FileInfoMap = StringMap<FileInfo>;
|
|
|
|
Expected<FileInfo &> findFileInfo(StringRef FileName);
|
|
Expected<MemoryRegionInfo &> findSectionInfo(StringRef FileName,
|
|
StringRef SectionName);
|
|
Expected<MemoryRegionInfo &> findStubInfo(StringRef FileName,
|
|
StringRef TargetName);
|
|
Expected<MemoryRegionInfo &> findGOTEntryInfo(StringRef FileName,
|
|
StringRef TargetName);
|
|
|
|
bool isSymbolRegistered(StringRef Name);
|
|
Expected<MemoryRegionInfo &> findSymbolInfo(StringRef SymbolName,
|
|
Twine ErrorMsgStem);
|
|
|
|
SymbolInfoMap SymbolInfos;
|
|
FileInfoMap FileInfos;
|
|
uint64_t SizeBeforePruning = 0;
|
|
uint64_t SizeAfterFixups = 0;
|
|
|
|
StringSet<> HarnessFiles;
|
|
StringSet<> HarnessExternals;
|
|
StringSet<> HarnessDefinitions;
|
|
DenseMap<StringRef, StringRef> CanonicalWeakDefs;
|
|
|
|
private:
|
|
Session(Triple TT, uint64_t PageSize, Error &Err);
|
|
};
|
|
|
|
/// Record symbols, GOT entries, stubs, and sections for ELF file.
|
|
Error registerELFGraphInfo(Session &S, jitlink::LinkGraph &G);
|
|
|
|
/// Record symbols, GOT entries, stubs, and sections for MachO file.
|
|
Error registerMachOGraphInfo(Session &S, jitlink::LinkGraph &G);
|
|
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_TOOLS_LLVM_JITLINK_LLVM_JITLINK_H
|