mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Alessandro Di Federico
f68b7866b3
This commit introduces `BasicBlockID` as the unique identifier for a `efa::BasicBlock` into the CFG. A `BasicBlockID` is defined by a `MetaAddress` plus an incremental integer. This enables us to have multiple instances of the same block in a single function, which is particularly useful when inlining multiple times the same function. Apart from this, the commit also does the following: * It drops representing `MetaAddress`es a `structs` in the IR. This created several issues related to ABI. We now represent them as strings. * It defines more functions in `support.h`, instead of defining prototypes by hand in `CodeGenerator.cpp` and the like. Specifically, `unknownPC` and `raise_exception_helper`. We also introduce a C "constructor" for `PlainMetaAddress`. * It significantly reduces the API of `GeneratedCodeBasicInfo`, which was supposed to be put on a diet since a long time. Specifically, many jump target related methods have been moved to free functions in `IRHelpers.h`. Also `GCBI::getSuccessors` has been pushed into its only user, `PruneRetSuccessors`, to prevent further usage of a deprecated API. In the future, it would be nice to drop it entirely. * It introduces `efa::BasicBlock::InlinedFrom`. * Introduce an enum to represent named argument indices for `newpc`. This enables us to more effectively manipulate its argument list. * It improves the verification and error reporting for `efa::FunctionMetadata`. * Update tests. This commit is preliminary to another piece of work to improve the generality of inlining beyond the simple "fake function" scenario, for which the feature was originally conceived.
88 lines
2.2 KiB
C++
88 lines
2.2 KiB
C++
#pragma once
|
|
|
|
//
|
|
// This file is distributed under the MIT License. See LICENSE.md for details.
|
|
//
|
|
|
|
#include <cstdint>
|
|
#include <string>
|
|
|
|
#include "revng/Support/MetaAddress.h"
|
|
|
|
class BasicBlockID {
|
|
private:
|
|
MetaAddress Start = MetaAddress::invalid();
|
|
uint64_t InliningIndex = 0;
|
|
|
|
public:
|
|
explicit BasicBlockID() = default;
|
|
explicit BasicBlockID(const MetaAddress &Start) : Start(Start) {}
|
|
explicit BasicBlockID(const MetaAddress &Start, uint64_t Index) :
|
|
Start(Start), InliningIndex(Index) {
|
|
revng_assert(verify());
|
|
}
|
|
/// Create an invalid BasicBlockID
|
|
static constexpr BasicBlockID invalid() { return BasicBlockID(); }
|
|
|
|
public:
|
|
const MetaAddress &start() const { return Start; }
|
|
uint64_t inliningIndex() const { return InliningIndex; }
|
|
const MetaAddress ¬InlinedAddress() const {
|
|
revng_assert(InliningIndex == 0);
|
|
return start();
|
|
}
|
|
|
|
public:
|
|
[[nodiscard]] bool isInlined() const { return InliningIndex != 0; }
|
|
[[nodiscard]] bool isValid() const { return Start.isValid(); }
|
|
|
|
public:
|
|
static BasicBlockID fromString(llvm::StringRef Text);
|
|
std::string toString() const;
|
|
|
|
static BasicBlockID fromValue(llvm::Value *V);
|
|
llvm::Constant *toValue(llvm::Module *M) const;
|
|
|
|
public:
|
|
/// @{
|
|
constexpr bool operator==(const BasicBlockID &Other) const {
|
|
return tie() == Other.tie();
|
|
}
|
|
|
|
constexpr bool operator!=(const BasicBlockID &Other) const {
|
|
return not(*this == Other);
|
|
}
|
|
|
|
constexpr bool operator<(const BasicBlockID &Other) const {
|
|
return tie() < Other.tie();
|
|
}
|
|
constexpr bool operator<=(const BasicBlockID &Other) const {
|
|
return tie() <= Other.tie();
|
|
}
|
|
constexpr bool operator>(const BasicBlockID &Other) const {
|
|
return tie() > Other.tie();
|
|
}
|
|
constexpr bool operator>=(const BasicBlockID &Other) const {
|
|
return tie() >= Other.tie();
|
|
}
|
|
|
|
/// @}
|
|
|
|
public:
|
|
[[nodiscard]] bool verify() const {
|
|
if (Start.isInvalid()) {
|
|
return InliningIndex == 0;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
private:
|
|
using Tied = std::tuple<const MetaAddress &, const uint64_t &>;
|
|
constexpr Tied tie() const { return std::tie(Start, InliningIndex); }
|
|
};
|
|
|
|
template<>
|
|
struct KeyedObjectTraits<BasicBlockID>
|
|
: public IdentityKeyedObjectTraits<BasicBlockID> {};
|