Files
2025-10-31 17:25:03 +01:00

138 lines
4.0 KiB
C++

#pragma once
//
// This file is distributed under the MIT License. See LICENSE.md for details.
//
#include <initializer_list>
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/raw_ostream.h"
#include "revng/Pipeline/Container.h"
#include "revng/Pipeline/ContainerSet.h"
#include "revng/Pipeline/Global.h"
#include "revng/Pipeline/GlobalsMap.h"
#include "revng/Pipeline/KindsRegistry.h"
#include "revng/Storage/Path.h"
#include "revng/Support/Assert.h"
#include "revng/Support/Error.h"
namespace pipeline {
extern Logger ExplanationLogger;
extern Logger CommandLogger;
/// A class that contains every object that has a lifetime longer than a
/// pipeline.
///
/// This includes the kinds and the NamedGlobals that will be available in that
/// context.
class Context {
private:
GlobalsMap Globals;
uint64_t CommitIndex = 0;
llvm::StringMap<std::any> Contexts;
KindsRegistry TheKindRegistry;
llvm::StringMap<const pipeline::ContainerSet::value_type *>
ReadOnlyContainers;
private:
explicit Context(KindsRegistry Registry) :
TheKindRegistry(std::move(Registry)) {}
public:
Context();
public:
static Context fromRegistry(KindsRegistry Registry) {
return Context(std::move(Registry));
}
public:
const KindsRegistry &getKindsRegistry() const { return TheKindRegistry; }
template<typename T>
llvm::Expected<T *> getGlobal(llvm::StringRef Name) const {
return Globals.get<T>(Name);
}
template<typename T, typename... ArgsT>
void addGlobal(llvm::StringRef Name, ArgsT &&...Args) {
Globals.emplace<T>(Name, std::forward<T>(Args)...);
}
void bumpCommitIndex() { CommitIndex += 1; }
uint64_t getCommitIndex() const { return CommitIndex; }
template<typename T>
void addExternalContext(llvm::StringRef Name, T &ToAdd) {
Contexts.try_emplace(Name, std::make_any<T *>(&ToAdd));
}
template<typename T>
llvm::Expected<T *> getExternalContext(llvm::StringRef Name) const {
auto Iter = Contexts.find(Name);
if (Iter == Contexts.end()) {
auto *Message = "pipeline loader context did not contain the object ";
return revng::createError(Message + Name);
}
auto *Casted = std::any_cast<T *>(Iter->second);
if (Casted == nullptr) {
auto *Message = "pipeline loader was requested to cast %s to the wrong "
"type";
return revng::createError(Message, Name.str().c_str());
}
return Casted;
}
const GlobalsMap &getGlobals() const { return Globals; }
GlobalsMap &getGlobals() { return Globals; }
void addReadOnlyContainer(llvm::StringRef Name,
const ContainerSet::value_type &Entry) {
ReadOnlyContainers[Name] = &Entry;
}
bool containsReadOnlyContainer(llvm::StringRef Name) const {
auto It = ReadOnlyContainers.find(Name);
return It != ReadOnlyContainers.end() and It->second->second != nullptr;
}
bool hasRegisteredReadOnlyContainer(llvm::StringRef Name) const {
return ReadOnlyContainers.find(Name) != ReadOnlyContainers.end();
}
template<typename ContainerType>
const ContainerType &getReadOnlyContainer(llvm::StringRef Name) const {
revng_assert(containsReadOnlyContainer(Name));
auto *ToReturn = &*ReadOnlyContainers.find(Name)->second->second;
revng_assert(llvm::isa<ContainerType>(ToReturn));
return *llvm::cast<ContainerType>(ToReturn);
}
public:
llvm::Error store(const revng::DirectoryPath &Path) const;
llvm::Error load(const revng::DirectoryPath &Path);
public:
void collectReadFields(const TargetInContainer &Target,
llvm::StringMap<PathTargetBimap> &Out) const {
Globals.collectReadFields(Target, Out);
}
void clearAndResume() const { Globals.clearAndResume(); }
void pushReadFields() const { Globals.pushReadFields(); }
void popReadFields() const { Globals.popReadFields(); }
void stopTracking() const { Globals.stopTracking(); }
};
} // namespace pipeline