Migrate XML counter defs and reader from v1/v2 (#25)

* Migrate XML counter defs and reader from v1/v2 * working set * more fixes * Update CMakeLists.txt * source formatting (clang-format v11) (#83) Co-authored-by: bwelton <bwelton@users.noreply.github.com> * Update source/lib/rocprofiler/counters/CMakeLists.txt --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: bwelton <bwelton@users.noreply.github.com> Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com> [ROCm/rocprofiler-sdk commit: 59cc2a382c]
2023-09-26 11:50:57 -07:00
parent d98973ffb5
commit b66bcdd107
12 changed files with 2560 additions and 4 deletions
@@ -0,0 +1,118 @@
+/******************************************************************************
+Copyright (c) 2023 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 "metrics.hpp"
+
+#include <dlfcn.h>  // for dladdr
+#include <cstdlib>
+#include <filesystem>
+#include <optional>
+
+#include "glog/logging.h"
+#include "lib/common/xml.hpp"
+#include "rocprofiler/rocprofiler.h"
+
+namespace counters
+{
+namespace
+{
+MetricMap
+loadXml(const std::string& filename)
+{
+    MetricMap ret;
+    DLOG(INFO) << "Loading Counter Config: " << filename;
+    // todo: return unique_ptr....
+    auto xml = xml::Xml::Create(filename);
+    LOG_IF(FATAL, !xml)
+        << "Could not open XML Counter Config File (set env ROCPROFILER_METRICS_PATH)";
+
+    for(const auto& [gfx_name, nodes] : xml->GetAllNodes())
+    {
+        /**
+         * "top." is used to designate the root encapsulation of all contained XML subroots (in our
+         * case "gfxX"). This is inserted by the parser so it will always be present. .metric
+         * denotes XML tags that are contained in the subroots. This will not change unless we
+         * respec the XML (which we should...).
+         */
+        if(gfx_name.find("metric") == std::string::npos ||
+           gfx_name.find("top.") == std::string::npos)
+            continue;
+
+        auto& metricVec =
+            ret.emplace(gfx_name.substr(strlen("top."),
+                                        gfx_name.size() - strlen("top.") - strlen(".metric")),
+                        std::vector<Metric>())
+                .first->second;
+        for(const auto& node : nodes)
+        {
+            metricVec.emplace_back(node->opts["name"],
+                                   node->opts["block"],
+                                   node->opts["event"],
+                                   node->opts["descr"],
+                                   node->opts["expr"]);
+        }
+    }
+
+    DLOG(INFO) << fmt::format("{}", ret);
+    return ret;
+}
+
+std::string
+findViaInstallPath(const std::string& filename)
+{
+    Dl_info dl_info;
+    DLOG(INFO) << filename << " is being looked up via install path";
+    if(dladdr(reinterpret_cast<const void*>(rocprofiler_query_available_agents), &dl_info) != 0)
+    {
+        return std::filesystem::path{dl_info.dli_fname}.remove_filename() /
+               fmt::format("../lib/{}", filename);
+    }
+    return filename;
+}
+
+std::string
+findViaEnvironment(const std::string& filename)
+{
+    if(getenv("ROCPROFILER_METRICS_PATH"))
+    {
+        DLOG(INFO) << filename << " is being looked up via env variable ROCPROFILER_METRICS_PATH";
+        return std::filesystem::path{std::string(getenv("ROCPROFILER_METRICS_PATH"))} / filename;
+    }
+    // No environment variable, lookup via install path
+    return findViaInstallPath(filename);
+}
+
+}  // namespace
+
+MetricMap
+getDerrivedHardwareMetrics()
+{
+    return loadXml(findViaEnvironment("derived_counters.xml"));
+}
+
+MetricMap
+getBaseHardwareMetrics()
+{
+    return loadXml(findViaEnvironment("basic_counters.xml"));
+}
+
+};  // namespace counters