1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
|
/* ************************************************************************
* Copyright (C) 2020-2024 Advanced Micro Devices, Inc. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell cop-
* ies of the Software, and to permit persons to whom the Software is furnished
* to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IM-
* PLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNE-
* CTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* ************************************************************************ */
#pragma once
#include "rocblas_arguments.hpp"
namespace ArgumentLogging
{
const double NA_value = -1.0; // invalid for time, GFlop, GB
}
void ArgumentModel_set_log_function_name(bool f);
bool ArgumentModel_get_log_function_name();
void ArgumentModel_set_log_datatype(bool d);
bool ArgumentModel_get_log_datatype();
void ArgumentModel_log_frequencies(rocblas_internal_ostream& name_line,
rocblas_internal_ostream& val_line);
// ArgumentModel template has a variadic list of argument enums
template <rocblas_argument... Args>
class ArgumentModel
{
// Whether model has a particular parameter
static constexpr bool has(rocblas_argument param)
{
for(auto x : {Args...})
if(x == param)
return true;
return false;
// TODO: Replace with C++17 fold expression, a C++17 extension
// return ((Args == param) || ...);
}
public:
void log_perf(rocblas_internal_ostream& name_line,
rocblas_internal_ostream& val_line,
const Arguments& arg,
double gpu_us,
double gflops,
double gbytes,
double cpu_us,
double norm1,
double norm2,
double norm3,
double norm4)
{
// requires enablement for frequency logging
ArgumentModel_log_frequencies(name_line, val_line);
constexpr bool has_batch_count = has(e_batch_count);
rocblas_int batch_count = has_batch_count ? arg.batch_count : 1;
rocblas_int hot_calls = arg.iters < 1 ? 1 : arg.iters;
// gpu time is total cumulative over hot calls, cpu is not
if(hot_calls > 1)
gpu_us /= hot_calls;
// per/us to per/sec *10^6
const double c_per_usec_to_per_sec = 1e6;
// Print total number of cold iterations
name_line << ",cold_iters";
val_line << ", " << arg.cold_iters;
// Print total number of hot iterations
name_line << ",hot_iters";
val_line << ", " << arg.iters;
// append performance fields
if(gflops != ArgumentLogging::NA_value)
{
double rocblas_gflops = gflops * batch_count / gpu_us * c_per_usec_to_per_sec;
name_line << ",rocblas-Gflops";
val_line << ", " << rocblas_gflops;
}
if(gbytes != ArgumentLogging::NA_value)
{
double rocblas_GBps = gbytes * batch_count / gpu_us * c_per_usec_to_per_sec;
// GB/s not usually reported for non-memory bound functions
name_line << ",rocblas-GB/s";
val_line << ", " << rocblas_GBps;
}
name_line << ",us";
val_line << ", " << gpu_us;
if(arg.unit_check || arg.norm_check)
{
if(cpu_us != ArgumentLogging::NA_value)
{
if(gflops != ArgumentLogging::NA_value)
{
double cblas_gflops = gflops * batch_count / cpu_us * c_per_usec_to_per_sec;
name_line << ",CPU-Gflops";
val_line << "," << cblas_gflops;
}
name_line << ",CPU-us";
val_line << "," << cpu_us;
}
if(arg.norm_check)
{
if(norm1 != ArgumentLogging::NA_value)
{
name_line << ",norm_error_1";
val_line << "," << norm1;
}
if(norm2 != ArgumentLogging::NA_value)
{
name_line << ",norm_error_2";
val_line << "," << norm2;
}
if(norm3 != ArgumentLogging::NA_value)
{
name_line << ",norm_error_3";
val_line << "," << norm3;
}
if(norm4 != ArgumentLogging::NA_value)
{
name_line << ",norm_error_4";
val_line << "," << norm4;
}
}
}
}
template <typename T>
void log_args(rocblas_internal_ostream& str,
const Arguments& arg,
double gpu_us,
double gflops,
double gpu_bytes = ArgumentLogging::NA_value,
double cpu_us = ArgumentLogging::NA_value,
double norm1 = ArgumentLogging::NA_value,
double norm2 = ArgumentLogging::NA_value,
double norm3 = ArgumentLogging::NA_value,
double norm4 = ArgumentLogging::NA_value)
{
if(arg.iters < 1)
return; // warmup test only
rocblas_internal_ostream name_list;
rocblas_internal_ostream value_list;
value_list.set_csv(true);
if(ArgumentModel_get_log_function_name())
{
auto delim = ",";
name_list << "function" << delim;
value_list << arg.function << delim;
}
if(ArgumentModel_get_log_datatype())
{
auto delim = ",";
name_list << "a_type" << delim;
value_list << rocblas_datatype2string(arg.a_type) << delim;
name_list << "b_type" << delim;
value_list << rocblas_datatype2string(arg.b_type) << delim;
name_list << "c_type" << delim;
value_list << rocblas_datatype2string(arg.c_type) << delim;
name_list << "d_type" << delim;
value_list << rocblas_datatype2string(arg.d_type) << delim;
name_list << "compute_type" << delim;
value_list << rocblas_datatype2string(arg.compute_type) << delim;
}
// Output (name, value) pairs to name_list and value_list
auto print = [&, delim = ""](const char* name, auto&& value) mutable {
name_list << delim << name;
value_list << delim << value;
delim = ",";
};
// Args is a parameter pack of type: rocblas_argument...
// The rocblas_argument enum values in Args correspond to the function arguments that
// will be printed by rocblas_test or rocblas_bench. For example, the function:
//
// rocblas_ddot(rocblas_handle handle,
// rocblas_int n,
// const double* x,
// rocblas_int incx,
// const double* y,
// rocblas_int incy,
// double* result);
// will have <Args> = <e_N, e_incx, e_incy>
//
// print is a lambda defined above this comment block
//
// arg is an instance of the Arguments struct
//
// apply is a templated lambda for C++17 and a templated functor for C++14
//
// For rocblas_ddot, the following template specialization of apply will be called:
// apply<e_N>(print, arg, T{}), apply<e_incx>(print, arg, T{}), apply<e_incy>(print, arg, T{})
//
// apply in turn calls print with a string corresponding to the enum, for example "N" and the value of N
//
#if __cplusplus >= 201703L
// C++17
(ArgumentsHelper::apply<Args>(print, arg, T{}), ...);
#else
// C++14. TODO: Remove when C++17 is used
(void)(int[]){(ArgumentsHelper::apply<Args>{}()(print, arg, T{}), 0)...};
#endif
if(arg.timing)
log_perf(name_list,
value_list,
arg,
gpu_us,
gflops,
gpu_bytes,
cpu_us,
norm1,
norm2,
norm3,
norm4);
str << name_list << "\n" << value_list << std::endl;
}
};
|