From 986256ffb92ab7c8fc7cf9f2c424919a439a824f Mon Sep 17 00:00:00 2001 From: kaizhangNV <149626564+kaizhangNV@users.noreply.github.com> Date: Tue, 23 Jul 2024 10:45:26 -0500 Subject: Feature/capture (#4625) * Add decoder * Add a replay executable to consume the decoded content Add file-processor.cpp/h where we implement the logic to process the captured file block by block. Each block is: function header + parameter buffer + function tailer + function output[optional]. After reading one block, the block of data is sent to decoder module to dispatch the corresponding API. Add slang-decoder.cpp/h where we implement the logic to dispatch the slang API according to the input block data. - Rename api_callId.h to capture-format.h - Renmae capture_utility.cpp to capture-utility.cpp - Renmae capture_utility.h to capture-utility.h - Change the #include file name accordingly. * Reorganize source files structure Move all the capture logic code into `capture` directory. - the capture code will be build with slang dll. Move all the replay logic code into `relay` directoy. - the replay code is not part of slang dll, it will be built as a stand alone binary and link against slang dll. Change the #include file names accordingly. Add tools/slang-replay/main.cpp for the slang-replay stand alone binary place holder. Will implement it later. Update premake5.lua accordingly. * Update cmake files Update cmake files to change the build process for capture and relay system. - capture component should be build with slang dll, so we should not include replay component. - replay component should be a separate executable tool, which should not include capture component. - In order to easy use our current cmake infrastructure, move the shared files to a `util` folder - change the header include path * Redesgin the interfaces of consumers Fix some issues in capture Finish implementing all slang-decoder functions * Fix the AppleClang build issue * Address few comments - Fix the weird indent issues. - Correct the function name for CreateGlobalSession() - Rename file-processor to captureFile-processor to be more specific. - Use Slang::List instead of std::vector * record/replay: name refactor change Refactor the naming. Change the name "encoder/capture" to "record". --- .../replay/recordFile-processor.cpp | 132 +++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 source/slang-record-replay/replay/recordFile-processor.cpp (limited to 'source/slang-record-replay/replay/recordFile-processor.cpp') diff --git a/source/slang-record-replay/replay/recordFile-processor.cpp b/source/slang-record-replay/replay/recordFile-processor.cpp new file mode 100644 index 000000000..bf9cec435 --- /dev/null +++ b/source/slang-record-replay/replay/recordFile-processor.cpp @@ -0,0 +1,132 @@ +#include "recordFile-processor.h" +#include "../util/record-utility.h" +#include "parameter-decoder.h" + +namespace SlangRecord +{ + RecordFileProcessor::RecordFileProcessor(const std::string& filename) + { + Slang::String path(filename.c_str()); + Slang::FileMode fileMode = Slang::FileMode::Open; + Slang::FileAccess fileAccess = Slang::FileAccess::Read; + Slang::FileShare fileShare = Slang::FileShare::None; + + // Open the record file with read-only access + SlangResult res = m_inputStream.init(path, fileMode, fileAccess, fileShare); + + if (res != SLANG_OK) + { + SlangRecord::slangRecordLog(SlangRecord::LogLevel::Error, "Failed to open file %s\n", filename.c_str()); + std::abort(); + } + } + + bool RecordFileProcessor::processNextBlock() + { + FunctionHeader header {}; + if (!processHeader(header)) + { + return false; + } + + ApiClassId classId = static_cast(getClassId(header.callId)); + + // capacity comparison will be performed in the reserve call, so we can safely call reserve + m_parameterBuffer.reserve(header.dataSizeInBytes); + + size_t readBytes = 0; + SlangResult res = SLANG_OK; + + if (header.dataSizeInBytes) + { + res = m_inputStream.read(m_parameterBuffer.getBuffer(), header.dataSizeInBytes, readBytes); + } + + if (res != SLANG_OK || readBytes != header.dataSizeInBytes) + { + return false; + } + + FunctionTailer tailer {}; + if (!processTailer(tailer)) + { + return false; + } + + if (tailer.dataSizeInBytes) + { + m_outputBuffer.reserve(tailer.dataSizeInBytes); + res = m_inputStream.read(m_outputBuffer.getBuffer(), tailer.dataSizeInBytes, readBytes); + + if (res != SLANG_OK || readBytes != tailer.dataSizeInBytes) + { + return false; + } + } + + bool ret = false; + SlangDecoder::ParameterBlock paramBlock {}; + paramBlock.parameterBuffer = m_parameterBuffer.getBuffer(); + paramBlock.parameterBufferSize = header.dataSizeInBytes; + paramBlock.outputBuffer = m_outputBuffer.getBuffer(); + paramBlock.outputBufferSize = tailer.dataSizeInBytes; + + if (classId == GlobalFunction) + { + ret = m_decoder.processFunctionCall(header, paramBlock); + } + else + { + ret = m_decoder.processMethodCall(header, paramBlock); + } + + m_parameterBuffer.clear(); + return ret; + } + + bool RecordFileProcessor::processHeader(FunctionHeader& header) + { + size_t readBytes = 0; + SlangResult res = m_inputStream.read(&header, sizeof(FunctionHeader), readBytes); + + if (res != SLANG_OK || readBytes != sizeof(FunctionHeader)) + { + return false; + } + + if (header.magic != MAGIC_HEADER || header.callId == ApiCallId::InvalidCallId) + { + return false; + } + + return true; + } + + bool RecordFileProcessor::processTailer(FunctionTailer& tailer) + { + size_t readBytes = 0; + SlangResult res = m_inputStream.read(&tailer, sizeof(FunctionTailer), readBytes); + + if (res != SLANG_OK || readBytes != sizeof(FunctionTailer)) + { + return false; + } + + if (tailer.magic != MAGIC_TAILER) + { + return false; + } + + return true; + } + + bool RecordFileProcessor::processMethod(FunctionHeader const& header, const uint8_t* parameterBuffer, int64_t bufferSize) + { + return false; + } + + bool RecordFileProcessor::processFunction(FunctionHeader const& header, const uint8_t* parameterBuffer, int64_t bufferSize) + { + return false; + } +}; // namespace SlangRecord -- cgit v1.2.3