llvm-for-llvmta/include/llvm/XRay/FDRRecordProducer.h

51 lines
1.6 KiB
C++

//===- FDRRecordProducer.h - XRay FDR Mode Record Producer ----------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_INCLUDE_LLVM_XRAY_FDRRECORDPRODUCER_H_
#define LLVM_INCLUDE_LLVM_XRAY_FDRRECORDPRODUCER_H_
#include "llvm/Support/Error.h"
#include "llvm/XRay/FDRRecords.h"
#include "llvm/XRay/XRayRecord.h"
#include <memory>
namespace llvm {
namespace xray {
class RecordProducer {
public:
/// All producer implementations must yield either an Error or a non-nullptr
/// unique_ptr<Record>.
virtual Expected<std::unique_ptr<Record>> produce() = 0;
virtual ~RecordProducer() = default;
};
class FileBasedRecordProducer : public RecordProducer {
const XRayFileHeader &Header;
DataExtractor &E;
uint64_t &OffsetPtr;
uint32_t CurrentBufferBytes = 0;
// Helper function which gets the next record by speculatively reading through
// the log, finding a buffer extents record.
Expected<std::unique_ptr<Record>> findNextBufferExtent();
public:
FileBasedRecordProducer(const XRayFileHeader &FH, DataExtractor &DE,
uint64_t &OP)
: Header(FH), E(DE), OffsetPtr(OP) {}
/// This producer encapsulates the logic for loading a File-backed
/// RecordProducer hidden behind a DataExtractor.
Expected<std::unique_ptr<Record>> produce() override;
};
} // namespace xray
} // namespace llvm
#endif // LLVM_INCLUDE_LLVM_XRAY_FDRRECORDPRODUCER_H_