HEBench
hebench_eltwisemult_o.cpp
Go to the documentation of this file.
1 
2 // Copyright (C) 2021 Intel Corporation
3 // SPDX-License-Identifier: Apache-2.0
4 
5 #include <bitset>
6 #include <cassert>
7 #include <cstring>
8 #include <iomanip>
9 #include <iostream>
10 #include <sstream>
11 #include <stdexcept>
12 #include <utility>
13 
14 #include "hebench/modules/timer/include/timer.h"
15 
16 #include "hebench/api_bridge/api.h"
17 #include "hebench/modules/general/include/hebench_math_utils.h"
18 #include "include/hebench_engine.h"
19 
20 #include "../include/hebench_eltwisemult_o.h"
21 
22 namespace hebench {
23 namespace TestHarness {
24 namespace EltwiseMult {
25 namespace Offline {
26 
27 //----------------------------
28 // class BenchmarkDescription
29 //----------------------------
30 
31 bool BenchmarkDescriptor::m_b_registered = // register the benchmark with the factory
32  hebench::TestHarness::BenchmarkFactory::registerSupportedBenchmark(std::make_shared<BenchmarkDescriptor>());
33 
35  const std::vector<hebench::APIBridge::WorkloadParam> &w_params) const
36 {
37  assert(m_b_registered);
38 
39  // return true if benchmark is supported
40 
41  bool retval =
44 
45  return retval;
46 }
47 
49  const Engine &engine,
50  const BenchmarkDescription::Backend &backend_desc,
51  const BenchmarkDescription::Configuration &config) const
52 {
53  // finish describing workload
54  assert(OpParameterCount == 2);
55  assert(DefaultBatchSize == 5);
56 
57  BenchmarkDescriptorCategory::completeWorkloadDescription(output, engine, backend_desc, config);
58 
59  assert(OpParameterCount == output.operation_params_count);
60 
61  std::stringstream ss;
62  std::uint64_t *batch_sizes = output.concrete_descriptor.cat_params.offline.data_count;
63  std::uint64_t vector_size = fetchVectorSize(config.w_params);
64 
65  std::uint64_t sample_size_fallback =
66  config.fallback_default_sample_size > 0 ?
69  std::uint64_t result_batch_size =
72  config.default_sample_sizes,
73  backend_desc.descriptor,
74  sample_size_fallback,
76  // complete header with workload specifics
77  ss << ", , C = V0 * V1" << std::endl
78  << ", , , Elements, Batch size" << std::endl;
79  for (std::size_t i = 0; i < OpParameterCount; ++i)
80  {
81  ss << ", , V" << i << ", " << vector_size << ", " << batch_sizes[i] << std::endl;
82  } // end for
83  ss << ", , C, " << vector_size << ", " << result_batch_size << std::endl;
84 
85  output.workload_header = ss.str();
86 }
87 
89  const DescriptionToken &description_token)
90 {
91  assert(m_b_registered);
92  Benchmark *retval = nullptr;
93 
94  try
95  {
96  retval = new Benchmark(p_engine, description_token);
97  }
98  catch (...)
99  {
100  if (retval)
101  delete retval;
102  throw;
103  }
104 
105  return retval;
106 }
107 
109 {
110  assert(m_b_registered);
111  if (p_bench)
112  delete p_bench;
113 }
114 
115 //-----------------
116 // class Benchmark
117 //-----------------
118 
119 Benchmark::Benchmark(std::shared_ptr<Engine> p_engine,
120  const IBenchmarkDescriptor::DescriptionToken &description_token) :
121  BenchmarkOffline(p_engine, description_token)
122 {
123 }
124 
126 {
127  hebench::Common::EventTimer timer;
128  hebench::Common::TimingReportEvent::Ptr p_timing_event;
129  std::uint64_t batch_sizes[BenchmarkDescriptor::OpParameterCount];
130  std::stringstream ss;
131 
132  std::uint64_t vector_size = BenchmarkDescriptor::fetchVectorSize(this->getBenchmarkConfiguration().w_params);
133 
134  std::uint64_t sample_size_fallback =
140  this->getBenchmarkConfiguration().default_sample_sizes,
141  this->getBackendDescription().descriptor,
142  sample_size_fallback,
144 
145  std::cout << IOS_MSG_INFO << hebench::Logging::GlobalLogger::log("Generating workload...") << std::endl;
146 
147  std::cout << IOS_MSG_INFO << hebench::Logging::GlobalLogger::log("Loading workload data...") << std::endl;
148 
149  std::cout << IOS_MSG_INFO << hebench::Logging::GlobalLogger::log("Preparing workload.") << std::endl;
150 
151  timer.start();
152  if (this->getBenchmarkConfiguration().dataset_filename.empty())
153  {
154  // generates random vectors for input and generates (computes) ground truth
155  std::cout << IOS_MSG_INFO << hebench::Logging::GlobalLogger::log("Generating data...") << std::endl;
156  m_data = DataLoader::create(vector_size,
157  batch_sizes[0], batch_sizes[1],
158  this->getBackendDescription().descriptor.data_type);
159  } // end if
160  else
161  {
162  std::stringstream ss;
163  ss << "Loading data from external dataset: " << std::endl
164  << "\"" << this->getBenchmarkConfiguration().dataset_filename << "\"";
165  std::cout << IOS_MSG_INFO << hebench::Logging::GlobalLogger::log(ss.str()) << std::endl;
166  // load vectors for input and ground truth from file
167  m_data = DataLoader::create(vector_size,
168  batch_sizes[0], batch_sizes[1],
169  this->getBackendDescription().descriptor.data_type,
170  this->getBenchmarkConfiguration().dataset_filename);
171  } // end else
172  p_timing_event = timer.stop<std::milli>();
173 
174  ss = std::stringstream();
175  ss << "Total data loaded: " << m_data->getTotalDataLoaded() << " bytes";
176  std::cout << IOS_MSG_DONE << hebench::Logging::GlobalLogger::log(ss.str()) << std::endl;
177  ss = std::stringstream();
178  ss << "Elapsed wall time: " << p_timing_event->elapsedWallTime<std::milli>() << " ms";
179  std::cout << IOS_MSG_INFO << hebench::Logging::GlobalLogger::log(ss.str()) << std::endl;
180  ss = std::stringstream();
181  ss << "Elapsed CPU time: " << p_timing_event->elapsedCPUTime<std::milli>() << " ms";
182  std::cout << IOS_MSG_INFO << hebench::Logging::GlobalLogger::log(ss.str()) << std::endl;
183 }
184 
186  const std::uint64_t *param_data_pack_indices,
187  const std::vector<hebench::APIBridge::NativeDataBuffer *> &outputs,
188  hebench::APIBridge::DataType data_type) const
189 {
190  assert(dataset->getParameterCount() == BenchmarkDescriptorCategory::OpParameterCount
191  && dataset->getResultCount() == BenchmarkDescriptorCategory::OpResultCount);
192 
193  return BenchmarkOffline::validateResult(dataset, param_data_pack_indices, outputs, data_type);
194 }
195 
196 } // namespace Offline
197 } // namespace EltwiseMult
198 } // namespace TestHarness
199 } // namespace hebench
const hebench::APIBridge::BenchmarkDescriptor & descriptor
Benchmark backend descriptor, as retrieved by backend, corresponding to the registration handle h_des...
std::uint64_t fallback_default_sample_size
Default sample size to be used if a specific size is not specified in the default_sample_sizes collec...
std::vector< std::uint64_t > default_sample_sizes
Default sample size for each operation parameter.
std::vector< hebench::APIBridge::WorkloadParam > w_params
Set of arguments for workload parameters.
std::string dataset_filename
File containing data for the benchmark. If empty string, benchmarks that can auto generate the datase...
static bool registerSupportedBenchmark(std::shared_ptr< IBenchmarkDescriptor > p_desc_obj)
Registers a benchmark description object that represents one of the supported workloads.
Base class for workload benchmarks in the offline category.
bool matchBenchmarkDescriptor(const hebench::APIBridge::BenchmarkDescriptor &bench_desc, const std::vector< hebench::APIBridge::WorkloadParam > &w_params) const override
Determines if the represented benchmark can perform the workload described by a specified HEBench ben...
static std::uint64_t fetchVectorSize(const std::vector< hebench::APIBridge::WorkloadParam > &w_params)
void completeWorkloadDescription(WorkloadDescriptionOutput &output, const Engine &engine, const BenchmarkDescription::Backend &backend_desc, const BenchmarkDescription::Configuration &config) const override
Completes the description for the matched benchmark.
static DataLoader::Ptr create(std::uint64_t vector_size, std::uint64_t batch_size_a, std::uint64_t batch_size_b, hebench::APIBridge::DataType data_type)
hebench::TestHarness::PartialBenchmark * createBenchmark(std::shared_ptr< Engine > p_engine, const DescriptionToken &description_token) override
Creates the represented IBenchmark object that can perform the workload specified by the HEBench benc...
void destroyBenchmark(hebench::TestHarness::PartialBenchmark *p_bench) override
Destroys an object returned by createBenchmark().
bool matchBenchmarkDescriptor(const hebench::APIBridge::BenchmarkDescriptor &bench_desc, const std::vector< hebench::APIBridge::WorkloadParam > &w_params) const override
Determines if the represented benchmark can perform the workload described by a specified HEBench ben...
void completeWorkloadDescription(WorkloadDescriptionOutput &output, const Engine &engine, const BenchmarkDescription::Backend &backend_desc, const BenchmarkDescription::Configuration &config) const override
Completes the description for the matched benchmark.
void init() override
Initializes the partial benchmark members.
bool validateResult(IDataLoader::Ptr dataset, const std::uint64_t *param_data_pack_indices, const std::vector< hebench::APIBridge::NativeDataBuffer * > &p_outputs, hebench::APIBridge::DataType data_type) const override
Validates the result of an operation against the ground truth.
Token returned by a successful call to IBenchmarkDescriptor::matchBenchmarkDescriptor().
std::shared_ptr< IDataLoader > Ptr
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
Validates the result of an operation against the ground truth.
std::string workload_header
Workload specific information to be added to the report header.
static std::uint64_t computeSampleSizes(std::uint64_t *sample_sizes, std::size_t param_count, const std::vector< std::uint64_t > &config_sample_sizes, const hebench::APIBridge::BenchmarkDescriptor &bench_desc, std::uint64_t default_sample_size_fallback, bool force_config)
Extracts the batch sizes for a workload from a specified HEBench API benchmark descriptor.
static bool getForceConfigValues()
Specifies whether frontend will override backend descriptors using configuration data or not.
std::size_t operation_params_count
Number of parameters for the represented workload operation.
hebench::APIBridge::BenchmarkDescriptor concrete_descriptor
Benchmark descriptor completed with concrete values assigned to configurable fields.
Bundles values that need to be filled by a workload during completeWorkloadDescription().
const BenchmarkDescription::Backend & getBackendDescription() const
Allows read-only access to this benchmark backend description.
const BenchmarkDescription::Configuration & getBenchmarkConfiguration() const
Allows read-only access to this benchmark configuration.
#define IOS_MSG_DONE
#define IOS_MSG_INFO
DataType
Defines data types for a workload.
Definition: types.h:379
CategoryParams cat_params
Parameters for the category.
Definition: types.h:532
Category category
Category for the benchmark.
Definition: types.h:531
Defines a benchmark test.
Definition: types.h:527