Files
Alessandro Di Federico c7f8f3302d Introduce BasicBlockID
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.
2023-02-21 15:09:15 +01:00

114 lines
3.2 KiB
C++

#pragma once
//
// This file is distributed under the MIT License. See LICENSE.md for details.
//
#include "revng/ADT/MutableSet.h"
#include "revng/EarlyFunctionAnalysis/FunctionEdgeBase.h"
#include "revng/Model/Binary.h"
#include "revng/Model/FunctionAttribute.h"
#include "revng/Model/VerifyHelper.h"
/* TUPLE-TREE-YAML
name: CallEdge
doc: A CFG edge to represent function calls (direct, indirect and tail calls)
type: struct
inherits: FunctionEdgeBase
fields:
- name: DynamicFunction
doc: |
Name of the dynamic function being called, or empty if not a dynamic call
type: string
optional: true
- name: IsTailCall
doc: Is this a tail call?
type: bool
optional: true
- name: Attributes
doc: |
Attributes for this function
Note: To have the effective list of attributes for this call site, you
have to add attributes on the called function.
TODO: switch to std::set
sequence:
type: MutableSet
elementType: model::FunctionAttribute::Values
optional: true
TUPLE-TREE-YAML */
#include "revng/EarlyFunctionAnalysis/Generated/Early/CallEdge.h"
class efa::CallEdge : public efa::generated::CallEdge {
private:
static constexpr const FunctionEdgeType::Values
AssociatedType = FunctionEdgeType::FunctionCall;
public:
using generated::CallEdge::CallEdge;
CallEdge() : efa::generated::CallEdge() { Type() = AssociatedType; }
CallEdge(BasicBlockID Destination, FunctionEdgeType::Values Type) :
efa::generated::CallEdge() {
this->Destination() = Destination;
this->Type() = Type;
}
public:
static bool classof(const FunctionEdgeBase *A) { return classof(A->key()); }
static bool classof(const Key &K) {
return std::get<0>(K) == FunctionEdgeBaseKind::CallEdge;
}
public:
bool hasAttribute(const model::Binary &Binary,
model::FunctionAttribute::Values Attribute) const {
using namespace model;
if (Attributes().count(Attribute) != 0)
return true;
if (const auto *CalleeAttributes = calleeAttributes(Binary))
return CalleeAttributes->count(Attribute) != 0;
else
return false;
}
MutableSet<model::FunctionAttribute::Values>
attributes(const model::Binary &Binary) const {
MutableSet<model::FunctionAttribute::Values> Result;
auto Inserter = Result.batch_insert();
for (auto &Attribute : Attributes())
Inserter.insert(Attribute);
if (const auto *CalleeAttributes = calleeAttributes(Binary))
for (auto &Attribute : *CalleeAttributes)
Inserter.insert(Attribute);
return Result;
}
public:
bool verify() const debug_function;
bool verify(bool Assert) const debug_function;
bool verify(model::VerifyHelper &VH) const;
void dump() const debug_function;
private:
const MutableSet<model::FunctionAttribute::Values> *
calleeAttributes(const model::Binary &Binary) const {
if (not DynamicFunction().empty()) {
const auto &F = Binary.ImportedDynamicFunctions().at(DynamicFunction());
return &F.Attributes();
} else if (Destination().isValid()) {
return &Binary.Functions().at(Destination().start()).Attributes();
} else {
return nullptr;
}
}
};
#include "revng/EarlyFunctionAnalysis/Generated/Late/CallEdge.h"