6024e5c395
clang 20.0.0 (based on r547379) from build 12806354. Bug: http://b/379133546 Test: N/A Change-Id: I2eb8938af55d809de674be63cb30cf27e801862b Upstream-Commit: ad834e67b1105d15ef907f6255d4c96e8e733f57
108 lines
4.2 KiB
C++
108 lines
4.2 KiB
C++
//===---- DebugObjectManagerPlugin.h - JITLink debug objects ---*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// ObjectLinkingLayer plugin for emitting debug objects.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_EXECUTIONENGINE_ORC_DEBUGOBJECTMANAGERPLUGIN_H
|
|
#define LLVM_EXECUTIONENGINE_ORC_DEBUGOBJECTMANAGERPLUGIN_H
|
|
|
|
#include "llvm/ExecutionEngine/JITLink/JITLink.h"
|
|
#include "llvm/ExecutionEngine/Orc/Core.h"
|
|
#include "llvm/ExecutionEngine/Orc/EPCDebugObjectRegistrar.h"
|
|
#include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/Memory.h"
|
|
#include "llvm/Support/MemoryBufferRef.h"
|
|
#include "llvm/TargetParser/Triple.h"
|
|
|
|
#include <functional>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <mutex>
|
|
|
|
namespace llvm {
|
|
namespace orc {
|
|
|
|
class DebugObject;
|
|
|
|
/// Creates and manages DebugObjects for JITLink artifacts.
|
|
///
|
|
/// DebugObjects are created when linking for a MaterializationResponsibility
|
|
/// starts. They are pending as long as materialization is in progress.
|
|
///
|
|
/// There can only be one pending DebugObject per MaterializationResponsibility.
|
|
/// If materialization fails, pending DebugObjects are discarded.
|
|
///
|
|
/// Once executable code for the MaterializationResponsibility is emitted, the
|
|
/// corresponding DebugObject is finalized to target memory and the provided
|
|
/// DebugObjectRegistrar is notified. Ownership of DebugObjects remains with the
|
|
/// plugin.
|
|
///
|
|
class DebugObjectManagerPlugin : public ObjectLinkingLayer::Plugin {
|
|
public:
|
|
// DEPRECATED - Please specify options explicitly
|
|
DebugObjectManagerPlugin(ExecutionSession &ES,
|
|
std::unique_ptr<DebugObjectRegistrar> Target);
|
|
|
|
/// Create the plugin to submit DebugObjects for JITLink artifacts. For all
|
|
/// options the recommended setting is true.
|
|
///
|
|
/// RequireDebugSections:
|
|
/// Submit debug objects to the executor only if they contain actual debug
|
|
/// info. Turning this off may allow minimal debugging based on raw symbol
|
|
/// names. Note that this may cause significant memory and transport
|
|
/// overhead for objects built with a release configuration.
|
|
///
|
|
/// AutoRegisterCode:
|
|
/// Notify the debugger for each new debug object. This is a good default
|
|
/// mode, but it may cause significant overhead when adding many modules in
|
|
/// sequence. When turning this off, the user has to issue the call to
|
|
/// __jit_debug_register_code() on the executor side manually.
|
|
///
|
|
DebugObjectManagerPlugin(ExecutionSession &ES,
|
|
std::unique_ptr<DebugObjectRegistrar> Target,
|
|
bool RequireDebugSections, bool AutoRegisterCode);
|
|
~DebugObjectManagerPlugin();
|
|
|
|
void notifyMaterializing(MaterializationResponsibility &MR,
|
|
jitlink::LinkGraph &G, jitlink::JITLinkContext &Ctx,
|
|
MemoryBufferRef InputObject) override;
|
|
|
|
Error notifyEmitted(MaterializationResponsibility &MR) override;
|
|
Error notifyFailed(MaterializationResponsibility &MR) override;
|
|
Error notifyRemovingResources(JITDylib &JD, ResourceKey K) override;
|
|
|
|
void notifyTransferringResources(JITDylib &JD, ResourceKey DstKey,
|
|
ResourceKey SrcKey) override;
|
|
|
|
void modifyPassConfig(MaterializationResponsibility &MR,
|
|
jitlink::LinkGraph &LG,
|
|
jitlink::PassConfiguration &PassConfig) override;
|
|
|
|
private:
|
|
ExecutionSession &ES;
|
|
|
|
using OwnedDebugObject = std::unique_ptr<DebugObject>;
|
|
std::map<MaterializationResponsibility *, OwnedDebugObject> PendingObjs;
|
|
std::map<ResourceKey, std::vector<OwnedDebugObject>> RegisteredObjs;
|
|
|
|
std::mutex PendingObjsLock;
|
|
std::mutex RegisteredObjsLock;
|
|
|
|
std::unique_ptr<DebugObjectRegistrar> Target;
|
|
bool RequireDebugSections;
|
|
bool AutoRegisterCode;
|
|
};
|
|
|
|
} // namespace orc
|
|
} // namespace llvm
|
|
|
|
#endif // LLVM_EXECUTIONENGINE_ORC_DEBUGOBJECTMANAGERPLUGIN_H
|