hebench_benchmark_category.h

Go to the documentation of this file.

 
// Copyright (C) 2021 Intel Corporation
// SPDX-License-Identifier: Apache-2.0
 
#ifndef _HEBench_Harness_Benchmark_Category_H_0596d40a3cce4b108a81595c50eb286d
#define _HEBench_Harness_Benchmark_Category_H_0596d40a3cce4b108a81595c50eb286d
 
#include <memory>
#include <ostream>
#include <string>
#include <vector>
 
#include "hebench/modules/general/include/nocopy.h"
#include "hebench/modules/logging/include/logging.h"
 
#include "include/hebench_ibenchmark.h"
 
namespace hebench {
namespace TestHarness {
 
class Engine;
 
class PartialBenchmarkCategory : public PartialBenchmark
{
public:
    DISABLE_COPY(PartialBenchmarkCategory)
    DISABLE_MOVE(PartialBenchmarkCategory)
private:
    IL_DECLARE_CLASS_NAME(PartialBenchmarkCategory)
 
public:
    typedef std::shared_ptr<PartialBenchmarkCategory> Ptr;
 
    ~PartialBenchmarkCategory() override;
 
protected:
    class RAIIHandle
    {
    public:
        DISABLE_COPY(RAIIHandle)
 
    public:
        RAIIHandle();
        RAIIHandle(RAIIHandle &&rhs) noexcept;
        RAIIHandle(const hebench::APIBridge::Handle &h) :
            handle(h) {}
        ~RAIIHandle();
        RAIIHandle &operator=(RAIIHandle &&rhs) noexcept;
        RAIIHandle &operator=(const hebench::APIBridge::Handle &rhs);
        operator bool() const noexcept { return isEmpty(this->handle); }
        void detach();
        hebench::APIBridge::ErrorCode destroy();
 
        hebench::APIBridge::Handle handle;
 
        static bool isEmpty(const hebench::APIBridge::Handle &h) noexcept;
    };
 
    PartialBenchmarkCategory(std::shared_ptr<Engine> p_engine,
                             const IBenchmarkDescriptor::DescriptionToken &description_token);
 
    virtual IDataLoader::Ptr getDataset() const = 0;
    virtual bool validateResult(IDataLoader::Ptr dataset,
                                const std::uint64_t *param_data_pack_indices,
                                const std::vector<hebench::APIBridge::NativeDataBuffer *> &outputs,
                                hebench::APIBridge::DataType data_type) const;
    virtual void logResult(std::ostream &os,
                           IDataLoader::Ptr dataset,
                           const std::uint64_t *param_data_pack_indices,
                           const std::vector<hebench::APIBridge::NativeDataBuffer *> &outputs,
                           hebench::APIBridge::DataType data_type) const;
};
 
} // namespace TestHarness
} // namespace hebench
 
#endif // defined _HEBench_Harness_Benchmark_Category_H_0596d40a3cce4b108a81595c50eb286d