rdc_field_t replaces uint32_t; centralize field data

Make the RDC use the new rdc_field_t enum instead of uint32_t.
This will help prevent invalid field types from being passed in.

Also, centralize where data related to fields is kept. This will
reduce the number of places where changes are required each
time a new field is added.

Finally, cleaned up several cpplint issues.

Change-Id: I48e4512e18c164411d8b09ae3d4bed99fba359ec
This commit is contained in:
Chris Freehill
2020-07-24 19:40:48 -05:00
parent e6d910f67a
commit 5950ebadc4
43 changed files with 459 additions and 388 deletions
+39
View File
@@ -0,0 +1,39 @@
/*
Copyright (c) 2020 - present 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
copies 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
IMPLIED, 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 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
FLD_DESC_ENT(RDC_FI_INVALID, "Unknown/Invalid field", "INVALID")
FLD_DESC_ENT(RDC_FI_GPU_COUNT, "GPU count in the system", "GPU_COUNT")
FLD_DESC_ENT(RDC_FI_DEV_NAME, "Name of the device", "DEV_NAME")
FLD_DESC_ENT(RDC_FI_GPU_CLOCK, "Current GPU clock frequencies.", "GPU_CLOCK")
FLD_DESC_ENT(RDC_FI_MEM_CLOCK, "Current Memory clock frequencies.", "MEM_CLOCK")
FLD_DESC_ENT(RDC_FI_MEMORY_TEMP, "Memory temperature in millidegrees Celsius.", "MEMORY_TEMP")
FLD_DESC_ENT(RDC_FI_GPU_TEMP, "GPU temperature in millidegrees Celsius.", "GPU_TEMP")
FLD_DESC_ENT(RDC_FI_POWER_USAGE, "Power usage in microwatts.", "POWER_USAGE")
FLD_DESC_ENT(RDC_FI_PCIE_TX, "PCIe Tx utilization in bytes/second.", "PCIE_TX")
FLD_DESC_ENT(RDC_FI_PCIE_RX, "PCIe Rx utilization in bytes/second.", "PCIE_RX")
FLD_DESC_ENT(RDC_FI_GPU_UTIL, "GPU busy percentage.", "GPU_UTIL")
FLD_DESC_ENT(RDC_FI_GPU_MEMORY_USAGE,
"Memory usage of the GPU instance in bytes.", "GPU_MEMORY_USAGE")
FLD_DESC_ENT(RDC_FI_GPU_MEMORY_TOTAL, "Total memory of the GPU instance", "GPU_MEMORY_TOTAL")
FLD_DESC_ENT(RDC_FI_ECC_CORRECT_TOTAL, "Accumulated correctable ECC errors.", "ECC_CORRECT")
FLD_DESC_ENT(RDC_FI_ECC_UNCORRECT_TOTAL,
"Accumulated uncorrectable ECC errors.", "ECC_UNCORRECT")
+72
View File
@@ -0,0 +1,72 @@
/*
Copyright (c) 2020 - present 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
copies 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
IMPLIED, 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 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#include <assert.h>
#include <algorithm>
#include "common/rdc_fields_supported.h"
#include "rdc/rdc.h"
namespace amd {
namespace rdc {
#define FLD_DESC_ENT(ID, DESC, LABEL) \
{static_cast<uint32_t>(ID), {#ID, (DESC), (LABEL)}},
static const fld_id2name_map_t field_id_to_descript = {
#include "common/rdc_field_data.data"
};
#undef FLD_DESC_ENT
#define FLD_DESC_ENT(ID, DESC, LABEL) {#ID, (ID)},
static fld_name2id_map_t field_name_to_id = {
#include "common/rdc_field_data.data" // NOLINT
};
#undef FLD_DESC_ENT
amd::rdc::fld_id2name_map_t &
get_field_id_description_from_id(void) {
return field_id_to_descript;
}
bool get_field_id_from_name(const std::string name, rdc_field_t *value) {
assert(value != nullptr);
auto id = field_name_to_id.find(name);
if (id == field_name_to_id.end()) {
return false;
}
*value = static_cast<rdc_field_t>(id->second);
return true;
}
bool is_field_valid(rdc_field_t field_id) {
if (field_id == RDC_FI_INVALID) {
return false;
}
return field_id_to_descript.find(static_cast<uint32_t>(field_id)) !=
field_id_to_descript.end();
}
} // namespace rdc
} // namespace amd
+50
View File
@@ -0,0 +1,50 @@
/*
Copyright (c) 2020 - present 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
copies 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
IMPLIED, 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 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#ifndef COMMON_RDC_FIELDS_SUPPORTED_H_
#define COMMON_RDC_FIELDS_SUPPORTED_H_
#include <string>
#include <unordered_map>
#include "rdc/rdc.h"
namespace amd {
namespace rdc {
typedef struct {
std::string enum_name;
std::string description;
std::string label;
} field_id_descript;
typedef const std::unordered_map<uint32_t, const field_id_descript>
fld_id2name_map_t;
typedef std::unordered_map<std::string, uint32_t> fld_name2id_map_t;
bool get_field_id_from_name(const std::string name, rdc_field_t *value);
fld_id2name_map_t & get_field_id_description_from_id(void); // NOLINT
bool is_field_valid(rdc_field_t field_id);
} // namespace rdc
} // namespace amd
#endif // COMMON_RDC_FIELDS_SUPPORTED_H_