From 60f476cd8f3aa4cf0c9c0091e53559d7e3d30116 Mon Sep 17 00:00:00 2001
From: Lioncash <mathew1800@gmail.com>
Date: Tue, 14 Aug 2018 18:48:28 -0400
Subject: [PATCH] common/telemetry: Migrate core-independent info gathering to
common
Previously core itself was the library containing the code to gather
common information (build info, CPU info, and OS info), however all of
this isn't core-dependent and can be moved to the common code and use
the common interfaces. We can then just call those functions from the
core instead.
This will allow replacing our CPU detection with Xbyak's which has
better detection facilities than ours. It also keeps more
architecture-dependent code in common instead of core.
---
src/common/telemetry.cpp | 65 ++++++++++++++++++++++++++++++++
src/common/telemetry.h | 12 ++++++
src/core/telemetry_session.cpp | 69 ++++------------------------------
3 files changed, 84 insertions(+), 62 deletions(-)
diff --git a/src/common/telemetry.cpp b/src/common/telemetry.cpp
index bf1f548865..f53a8d193e 100644
--- a/src/common/telemetry.cpp
+++ b/src/common/telemetry.cpp
@@ -3,8 +3,15 @@
// Refer to the license.txt file included.
#include <algorithm>
+#include <cstring>
+#include "common/assert.h"
+#include "common/scm_rev.h"
#include "common/telemetry.h"
+#ifdef ARCHITECTURE_x86_64
+#include "common/x64/cpu_detect.h"
+#endif
+
namespace Telemetry {
void FieldCollection::Accept(VisitorInterface& visitor) const {
@@ -37,4 +44,62 @@ template class Field<std::string>;
template class Field<const char*>;
template class Field<std::chrono::microseconds>;
+#ifdef ARCHITECTURE_x86_64
+static const char* CpuVendorToStr(Common::CPUVendor vendor) {
+ switch (vendor) {
+ case Common::CPUVendor::INTEL:
+ return "Intel";
+ case Common::CPUVendor::AMD:
+ return "Amd";
+ case Common::CPUVendor::OTHER:
+ return "Other";
+ }
+ UNREACHABLE();
+}
+#endif
+
+void AppendBuildInfo(FieldCollection& fc) {
+ const bool is_git_dirty{std::strstr(Common::g_scm_desc, "dirty") != nullptr};
+ fc.AddField(FieldType::App, "Git_IsDirty", is_git_dirty);
+ fc.AddField(FieldType::App, "Git_Branch", Common::g_scm_branch);
+ fc.AddField(FieldType::App, "Git_Revision", Common::g_scm_rev);
+ fc.AddField(FieldType::App, "BuildDate", Common::g_build_date);
+ fc.AddField(FieldType::App, "BuildName", Common::g_build_name);
+}
+
+void AppendCPUInfo(FieldCollection& fc) {
+#ifdef ARCHITECTURE_x86_64
+ fc.AddField(FieldType::UserSystem, "CPU_Model", Common::GetCPUCaps().cpu_string);
+ fc.AddField(FieldType::UserSystem, "CPU_BrandString", Common::GetCPUCaps().brand_string);
+ fc.AddField(FieldType::UserSystem, "CPU_Vendor", CpuVendorToStr(Common::GetCPUCaps().vendor));
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_AES", Common::GetCPUCaps().aes);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_AVX", Common::GetCPUCaps().avx);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_AVX2", Common::GetCPUCaps().avx2);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_BMI1", Common::GetCPUCaps().bmi1);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_BMI2", Common::GetCPUCaps().bmi2);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_FMA", Common::GetCPUCaps().fma);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_FMA4", Common::GetCPUCaps().fma4);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_SSE", Common::GetCPUCaps().sse);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_SSE2", Common::GetCPUCaps().sse2);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_SSE3", Common::GetCPUCaps().sse3);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_SSSE3", Common::GetCPUCaps().ssse3);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_SSE41", Common::GetCPUCaps().sse4_1);
+ fc.AddField(FieldType::UserSystem, "CPU_Extension_x64_SSE42", Common::GetCPUCaps().sse4_2);
+#else
+ fc.AddField(FieldType::UserSystem, "CPU_Model", "Other");
+#endif
+}
+
+void AppendOSInfo(FieldCollection& fc) {
+#ifdef __APPLE__
+ fc.AddField(FieldType::UserSystem, "OsPlatform", "Apple");
+#elif defined(_WIN32)
+ fc.AddField(FieldType::UserSystem, "OsPlatform", "Windows");
+#elif defined(__linux__) || defined(linux) || defined(__linux)
+ fc.AddField(FieldType::UserSystem, "OsPlatform", "Linux");
+#else
+ fc.AddField(FieldType::UserSystem, "OsPlatform", "Unknown");
+#endif
+}
+
} // namespace Telemetry
diff --git a/src/common/telemetry.h b/src/common/telemetry.h
index 3bab75b59e..8d6ab986b2 100644
--- a/src/common/telemetry.h
+++ b/src/common/telemetry.h
@@ -180,4 +180,16 @@ struct NullVisitor : public VisitorInterface {
void Complete() override {}
};
+/// Appends build-specific information to the given FieldCollection,
+/// such as branch name, revision hash, etc.
+void AppendBuildInfo(FieldCollection& fc);
+
+/// Appends CPU-specific information to the given FieldCollection,
+/// such as instruction set extensions, etc.
+void AppendCPUInfo(FieldCollection& fc);
+
+/// Appends OS-specific information to the given FieldCollection,
+/// such as platform name, etc.
+void AppendOSInfo(FieldCollection& fc);
+
} // namespace Telemetry
diff --git a/src/core/telemetry_session.cpp b/src/core/telemetry_session.cpp
index 69aa7a7be1..7e4584fc2b 100644
--- a/src/core/telemetry_session.cpp
+++ b/src/core/telemetry_session.cpp
@@ -2,34 +2,16 @@
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.
-#include <cstring>
-
#include "common/assert.h"
+#include "common/common_types.h"
#include "common/file_util.h"
-#include "common/scm_rev.h"
-#ifdef ARCHITECTURE_x86_64
-#include "common/x64/cpu_detect.h"
-#endif
+
#include "core/core.h"
#include "core/settings.h"
#include "core/telemetry_session.h"
namespace Core {
-#ifdef ARCHITECTURE_x86_64
-static const char* CpuVendorToStr(Common::CPUVendor vendor) {
- switch (vendor) {
- case Common::CPUVendor::INTEL:
- return "Intel";
- case Common::CPUVendor::AMD:
- return "Amd";
- case Common::CPUVendor::OTHER:
- return "Other";
- }
- UNREACHABLE();
-}
-#endif
-
static u64 GenerateTelemetryId() {
u64 telemetry_id{};
return telemetry_id;
@@ -112,48 +94,11 @@ TelemetrySession::TelemetrySession() {
}
// Log application information
- const bool is_git_dirty{std::strstr(Common::g_scm_desc, "dirty") != nullptr};
- AddField(Telemetry::FieldType::App, "Git_IsDirty", is_git_dirty);
- AddField(Telemetry::FieldType::App, "Git_Branch", Common::g_scm_branch);
- AddField(Telemetry::FieldType::App, "Git_Revision", Common::g_scm_rev);
- AddField(Telemetry::FieldType::App, "BuildDate", Common::g_build_date);
- AddField(Telemetry::FieldType::App, "BuildName", Common::g_build_name);
-
-// Log user system information
-#ifdef ARCHITECTURE_x86_64
- AddField(Telemetry::FieldType::UserSystem, "CPU_Model", Common::GetCPUCaps().cpu_string);
- AddField(Telemetry::FieldType::UserSystem, "CPU_BrandString",
- Common::GetCPUCaps().brand_string);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Vendor",
- CpuVendorToStr(Common::GetCPUCaps().vendor));
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_AES", Common::GetCPUCaps().aes);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_AVX", Common::GetCPUCaps().avx);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_AVX2", Common::GetCPUCaps().avx2);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_BMI1", Common::GetCPUCaps().bmi1);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_BMI2", Common::GetCPUCaps().bmi2);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_FMA", Common::GetCPUCaps().fma);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_FMA4", Common::GetCPUCaps().fma4);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_SSE", Common::GetCPUCaps().sse);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_SSE2", Common::GetCPUCaps().sse2);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_SSE3", Common::GetCPUCaps().sse3);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_SSSE3",
- Common::GetCPUCaps().ssse3);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_SSE41",
- Common::GetCPUCaps().sse4_1);
- AddField(Telemetry::FieldType::UserSystem, "CPU_Extension_x64_SSE42",
- Common::GetCPUCaps().sse4_2);
-#else
- AddField(Telemetry::FieldType::UserSystem, "CPU_Model", "Other");
-#endif
-#ifdef __APPLE__
- AddField(Telemetry::FieldType::UserSystem, "OsPlatform", "Apple");
-#elif defined(_WIN32)
- AddField(Telemetry::FieldType::UserSystem, "OsPlatform", "Windows");
-#elif defined(__linux__) || defined(linux) || defined(__linux)
- AddField(Telemetry::FieldType::UserSystem, "OsPlatform", "Linux");
-#else
- AddField(Telemetry::FieldType::UserSystem, "OsPlatform", "Unknown");
-#endif
+ Telemetry::AppendBuildInfo(field_collection);
+
+ // Log user system information
+ Telemetry::AppendCPUInfo(field_collection);
+ Telemetry::AppendOSInfo(field_collection);
// Log user configuration information
AddField(Telemetry::FieldType::UserConfig, "Core_UseCpuJit", Settings::values.use_cpu_jit);
--
GitLab