mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Giacomo Vercesi
a2b7d0e0bf
Add support for tracing onto the PipelineC. This is done by: 1. Creating wrapper functions for each PipelineC function with the script in `scripts/PipelineC_add_tracing.py`. These will call a special function called `wrap` which will ultimately call a method with a `_` prepended to the name 2. Conversion of all PipelineC methods in `PipelineC.cpp` to `static` and their rename with a `_` in front, in order for them to work with the wrapper function in (1) 3. Generation of 2 additional include files, one for types and one for functions, to be used by users of tracing files in order to have introspection. These steps allow the creation of a trace file with the use of the `REVNG_C_API_TRACE_PATH` environment variable. The traces can then be used in conjunction with the `revng trace run` and `revng trace inspect` commands.
121 lines
3.6 KiB
C++
121 lines
3.6 KiB
C++
//
|
|
// This file is distributed under the MIT License. See LICENSE.md for details.
|
|
//
|
|
|
|
#include "revng/PipelineC/PipelineC.h"
|
|
#include "revng/PipelineC/Tracing/Private.h"
|
|
#include "revng/PipelineC/Tracing/Trace.h"
|
|
#include "revng/Support/PathList.h"
|
|
#include "revng/Support/TemporaryFile.h"
|
|
|
|
#define BOOST_TEST_MODULE PipelineCTracing
|
|
bool init_unit_test();
|
|
#include "boost/test/unit_test.hpp"
|
|
|
|
#include "revng/UnitTestHelpers/UnitTestHelpers.h"
|
|
|
|
using namespace revng;
|
|
|
|
struct Fixture {
|
|
public:
|
|
Fixture() {
|
|
std::string RootPath = getCurrentRoot();
|
|
std::string LibPath = joinPath(RootPath,
|
|
"lib/librevngStringContainerLibrary.so");
|
|
std::string PipelinePath = joinPath(RootPath, "tests/pipeline/Tracing.yml");
|
|
|
|
std::vector<std::string> ArgvStorage = { "",
|
|
"-load=" + LibPath,
|
|
"-pipeline-path=" + PipelinePath };
|
|
std::vector<const char *> Argv;
|
|
for (std::string &Arg : ArgvStorage)
|
|
Argv.push_back(Arg.c_str());
|
|
|
|
rp_initialize(Argv.size(), Argv.data(), 0, {});
|
|
}
|
|
|
|
~Fixture() { rp_shutdown(); }
|
|
};
|
|
|
|
static void verifyTrace(tracing::Trace &Trace) {
|
|
BOOST_TEST(Trace.Version == 1ULL);
|
|
BOOST_TEST(Trace.Commands.size() == 5ULL);
|
|
BOOST_TEST(Trace.Commands[0].Name == "rp_manager_create");
|
|
BOOST_TEST(Trace.Commands[1].Name == "rp_manager_steps_count");
|
|
BOOST_TEST(Trace.Commands[2].Name == "rp_manager_get_step");
|
|
BOOST_TEST(Trace.Commands[3].Name == "rp_manager_get_step");
|
|
BOOST_TEST(Trace.Commands[4].Name == "rp_manager_destroy");
|
|
|
|
BOOST_TEST(Trace.Commands[0].Arguments.size() == 3ULL);
|
|
BOOST_TEST(Trace.Commands[1].Arguments.size() == 1ULL);
|
|
BOOST_TEST(Trace.Commands[2].Arguments.size() == 2ULL);
|
|
BOOST_TEST(Trace.Commands[3].Arguments.size() == 2ULL);
|
|
BOOST_TEST(Trace.Commands[4].Arguments.size() == 1ULL);
|
|
|
|
const std::string &ManagerAddress = Trace.Commands[0].Result;
|
|
BOOST_TEST(Trace.Commands[1].Arguments[0].getScalar() == ManagerAddress);
|
|
BOOST_TEST(Trace.Commands[2].Arguments[0].getScalar() == ManagerAddress);
|
|
BOOST_TEST(Trace.Commands[3].Arguments[0].getScalar() == ManagerAddress);
|
|
BOOST_TEST(Trace.Commands[4].Arguments[0].getScalar() == ManagerAddress);
|
|
|
|
BOOST_TEST(Trace.Commands[2].Arguments[1].getScalar() == "0");
|
|
BOOST_TEST(Trace.Commands[3].Arguments[1].getScalar() == "1");
|
|
}
|
|
|
|
BOOST_AUTO_TEST_SUITE(PipelineCTracingTestSuite,
|
|
*boost::unit_test::fixture<Fixture>())
|
|
|
|
BOOST_AUTO_TEST_CASE(PipelineCTraceTest) {
|
|
llvm::ExitOnError AbortOnError;
|
|
std::string Buffer;
|
|
|
|
{
|
|
llvm::raw_string_ostream OS(Buffer);
|
|
tracing::setTracing(&OS);
|
|
|
|
rp_manager *Manager = rp_manager_create(0, {}, "");
|
|
uint64_t StepCount = rp_manager_steps_count(Manager);
|
|
for (uint64_t I = 0; I < StepCount; I++) {
|
|
rp_manager_get_step(Manager, I);
|
|
}
|
|
|
|
rp_manager_destroy(Manager);
|
|
|
|
tracing::setTracing(nullptr);
|
|
}
|
|
|
|
tracing::Trace Trace;
|
|
{
|
|
auto MemoryBuffer = llvm::MemoryBuffer::getMemBuffer(Buffer);
|
|
auto MaybeTrace = tracing::Trace::fromBuffer(*MemoryBuffer);
|
|
BOOST_TEST(!!MaybeTrace);
|
|
|
|
Trace = *MaybeTrace;
|
|
}
|
|
|
|
verifyTrace(Trace);
|
|
|
|
Buffer.clear();
|
|
{
|
|
llvm::raw_string_ostream OS(Buffer);
|
|
tracing::setTracing(&OS);
|
|
|
|
AbortOnError(Trace.run());
|
|
|
|
tracing::setTracing(nullptr);
|
|
}
|
|
|
|
tracing::Trace Trace2;
|
|
{
|
|
auto MemoryBuffer = llvm::MemoryBuffer::getMemBuffer(Buffer);
|
|
auto MaybeTrace = tracing::Trace::fromBuffer(*MemoryBuffer);
|
|
BOOST_TEST(!!MaybeTrace);
|
|
|
|
Trace2 = *MaybeTrace;
|
|
}
|
|
|
|
verifyTrace(Trace2);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_SUITE_END()
|