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.
70 lines
2.0 KiB
C++
70 lines
2.0 KiB
C++
#pragma once
|
|
|
|
//
|
|
// This file is distributed under the MIT License. See LICENSE.md for details.
|
|
//
|
|
|
|
#include <string>
|
|
|
|
#include "revng/Support/BasicBlockID.h"
|
|
|
|
class MetaAddress;
|
|
namespace model {
|
|
class Binary;
|
|
}
|
|
namespace yield {
|
|
class Function;
|
|
}
|
|
|
|
namespace yield::ptml {
|
|
|
|
std::string functionAssembly(const yield::Function &InternalFunction,
|
|
const model::Binary &Binary);
|
|
std::string controlFlowNode(const BasicBlockID &BasicBlockAddress,
|
|
const yield::Function &Function,
|
|
const model::Binary &Binary);
|
|
|
|
/// Emits a PTML containing a function name marked as a definition (it can be
|
|
/// jumped to).
|
|
///
|
|
/// For example,
|
|
/// ```html
|
|
/// <div data-token="call-graph.function"
|
|
/// data-location-definition="$FUNCTION_LOCATION">
|
|
/// $FUNCTION_NAME
|
|
/// </div>
|
|
/// ```
|
|
std::string functionNameDefinition(const MetaAddress &FunctionEntryPoint,
|
|
const model::Binary &Binary);
|
|
|
|
/// Emits a PTML containing a function name marked as a reference
|
|
/// (it can be used to jump to any definition of the same function).
|
|
///
|
|
/// For example,
|
|
/// ```html
|
|
/// <div data-token="call-graph.function"
|
|
/// data-location-references="$FUNCTION_LOCATION">
|
|
/// $FUNCTION_NAME
|
|
/// </div>
|
|
/// ```
|
|
std::string functionLink(const MetaAddress &FunctionEntryPoint,
|
|
const model::Binary &Binary);
|
|
|
|
/// Emits a PTML containing a function name marked as a reference
|
|
/// \see functionLink
|
|
///
|
|
/// The only difference is that it uses a distinct token type to let clients
|
|
/// display it in a visually distinct way.
|
|
///
|
|
/// For example,
|
|
/// ```html
|
|
/// <div data-token="call-graph.shallow-function-link"
|
|
/// data-location-references="$FUNCTION_LOCATION">
|
|
/// $FUNCTION_NAME
|
|
/// </div>
|
|
/// ```
|
|
std::string shallowFunctionLink(const MetaAddress &FunctionEntryPoint,
|
|
const model::Binary &Binary);
|
|
|
|
} // namespace yield::ptml
|