hebench_engine.h

Go to the documentation of this file.

 
// Copyright (C) 2021 Intel Corporation
// SPDX-License-Identifier: Apache-2.0
 
#ifndef _HEBench_Harness_Engine_H_0596d40a3cce4b108a81595c50eb286d
#define _HEBench_Harness_Engine_H_0596d40a3cce4b108a81595c50eb286d
 
#include <memory>
#include <string>
#include <vector>
 
#include "hebench/api_bridge/types.h"
#include "hebench/modules/general/include/nocopy.h"
#include "hebench/modules/logging/include/logging.h"
 
#include "hebench_benchmark_description.h"
#include "hebench_benchmark_factory.h"
 
namespace hebench {
namespace TestHarness {
 
class Engine : public std::enable_shared_from_this<Engine>
{
public:
    DISABLE_COPY(Engine)
    DISABLE_MOVE(Engine)
private:
    IL_DECLARE_CLASS_NAME(Engine)
 
public:
    typedef std::shared_ptr<Engine> Ptr;
 
    static void completeBenchmarkDescriptor(hebench::TestHarness::BenchmarkDescription::Backend &backend_description,
                                            const hebench::APIBridge::BenchmarkDescriptor &completed_descriptor);
 
    std::string getErrorDescription(hebench::APIBridge::ErrorCode err_code) const;
    void validateRetCode(hebench::APIBridge::ErrorCode err_code, bool last_error = true) const;
    static Engine::Ptr create(const std::vector<std::int8_t> &data);
 
    virtual ~Engine();
 
    std::string getSchemeName(hebench::APIBridge::Scheme s) const;
    std::string getSecurityName(hebench::APIBridge::Scheme s,
                                hebench::APIBridge::Security sec) const;
    std::string getExtraDescription(hebench::APIBridge::Handle h_bench_desc,
                                    const std::vector<hebench::APIBridge::WorkloadParam> &w_params) const;
 
    std::size_t countBenchmarks() const { return m_h_bench_desc.size(); }
 
    IBenchmark::Ptr createBenchmark(IBenchmarkDescriptor::DescriptionToken::Ptr p_token,
                                    hebench::Utilities::TimingReportEx &out_report);
    IBenchmarkDescriptor::DescriptionToken::Ptr describeBenchmark(std::size_t index,
                                                                  const BenchmarkDescription::Configuration &config) const;
 
    std::vector<std::vector<hebench::APIBridge::WorkloadParam>> getDefaultWorkloadParams(std::size_t index) const;
 
    std::string getLastErrorDescription() const;
 
    const hebench::APIBridge::Handle &handle() const { return m_handle; }
 
private:
    hebench::APIBridge::Handle m_handle;
    // handles to backend registered benchmark descriptors in order of subscription
    std::vector<hebench::APIBridge::Handle> m_h_bench_desc;
    std::weak_ptr<IBenchmark> m_last_benchmark; // keeps track of whether a benchmark is already created
 
    Engine();
    void init(const std::vector<std::int8_t> &data);
};
 
} // namespace TestHarness
} // namespace hebench
 
#endif // defined _HEBench_Harness_Engine_H_0596d40a3cce4b108a81595c50eb286d