Files
revng-revng/include/revng/Yield/CallGraphs/CallGraphSlices.h
Alessandro Di Federico f68b7866b3 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-23 14:51:10 +01:00

50 lines
1.7 KiB
C++

#pragma once
//
// This file is distributed under the MIT License. See LICENSE.md for details.
//
#include "revng/Yield/Graph.h"
class MetaAddress;
namespace yield::calls {
/// Produces a forwards facing slice of the graph starting from a single node.
///
/// Such a slice guarantees that:
/// - Only nodes forward-reachable from the `SlicePoint` are present.
/// - A node can have at most one predecessor, fake "reference" nodes without
/// trees are added in place of some real node to guarantee that, for example:
///
/// ```
/// A -> B || ||
/// A -> C || A - C - D ||
/// B -> C || \ / ||
/// C -> D || B ||
/// ```
/// becomes
/// ```
/// A -> B || ||
/// A -> C || A - C - D ||
/// B -> C' || \ ||
/// C -> D || B - C' ||
/// ```
/// where `C'` is a fake node added to reference the `C` subtree without
/// being connected to it.
/// - There are no backwards facing edges (the targets of those are also
/// replaced by fake "reference" nodes).
///
/// \note: this makes a copy of the graph, as such `Input` is not affected.
Graph makeCalleeTree(const Graph &Input,
const BasicBlockID &SlicePoint = BasicBlockID());
/// Produces a backwards facing slice of the graph starting from a single node.
///
/// It is exactly the same as \see makeCalleeTree except it works in
/// the opposite direction (it makes sure all the predecessors are preserved).
Graph makeCallerTree(const Graph &Input,
const BasicBlockID &SlicePoint = BasicBlockID());
} // namespace yield::calls