[Profiler] Detect Single Step Instrumentation deployment

chrisnas · web-flow · commit 08c9c4cda7ea · 2024-02-19T15:03:46.000+01:00
* Detect Single Step Instrumentation
diff --git a/profiler/src/ProfilerEngine/Datadog.Profiler.Native/Configuration.cpp b/profiler/src/ProfilerEngine/Datadog.Profiler.Native/Configuration.cpp
@@ -89,6 +89,7 @@ Configuration::Configuration()
     }
 
     _isEtwEnabled = GetEnvironmentValue(EnvironmentVariables::EtwEnabled, false);
+     ExtractSsiState(_isSsiDeployed, _isSsiActivated);
 }
 
 fs::path Configuration::ExtractLogDirectory()
@@ -536,6 +537,16 @@ bool Configuration::IsEtwEnabled() const
 #endif
 }
 
+bool Configuration::IsSsiDeployed() const
+{
+    return _isSsiDeployed;
+}
+
+bool Configuration::IsSsiActivated() const
+{
+    return _isSsiActivated;
+}
+
 
 bool convert_to(shared::WSTRING const& s, bool& result)
 {
@@ -604,3 +615,30 @@ bool Configuration::IsEnvironmentValueSet(shared::WSTRING const& name, T& value)
     value = result;
     return true;
 }
+
+void Configuration::ExtractSsiState(bool& ssiDeployed, bool& ssiEnabled)
+{
+    // if the profiler has been deployed via Single Step Instrumentation,
+    // the DD_INJECTION_ENABLED env var exists.
+    // if the profiler has been activated via Single Step Instrumentation,
+    // the DD_INJECTION_ENABLED env var should contain "profiling" (it is a list of SSI installed products)
+    //
+    if (!shared::EnvironmentExist(EnvironmentVariables::SsiDeployed))
+    {
+        ssiDeployed = false;
+        ssiEnabled = false;
+        return;
+    }
+
+    ssiDeployed = true;
+
+    auto r = shared::GetEnvironmentValue(EnvironmentVariables::SsiDeployed);
+    if (r.empty())
+    {
+        ssiEnabled = false;
+        return;
+    }
+
+    auto pos = r.find(WStr("profiling"));
+    ssiEnabled = (pos != shared::WSTRING::npos);
+}
diff --git a/profiler/src/ProfilerEngine/Datadog.Profiler.Native/Configuration.h b/profiler/src/ProfilerEngine/Datadog.Profiler.Native/Configuration.h
@@ -67,6 +67,9 @@ class Configuration final : public IConfiguration
     bool IsCIVisibilityEnabled() const override;
     std::uint64_t GetCIVisibilitySpanId() const override;
     bool IsEtwEnabled() const override;
+    bool IsSsiDeployed() const override;
+    bool IsSsiActivated() const override;
+
 
 
 private:
@@ -89,6 +92,7 @@ class Configuration final : public IConfiguration
     static int32_t ExtractCpuThreadsThreshold();
     static int32_t ExtractCodeHotspotsThreadsThreshold();
     static bool GetContention();
+    static void ExtractSsiState(bool& ssiDeployed, bool& ssiEnabled);
 
 private:
     static std::string const DefaultProdSite;
@@ -151,4 +155,6 @@ class Configuration final : public IConfiguration
     bool _isCIVisibilityEnabled;
     std::uint64_t _internalCIVisibilitySpanId;
     bool _isEtwEnabled;
+    bool _isSsiDeployed;
+    bool _isSsiActivated;
 };
diff --git a/profiler/src/ProfilerEngine/Datadog.Profiler.Native/EnvironmentVariables.h b/profiler/src/ProfilerEngine/Datadog.Profiler.Native/EnvironmentVariables.h
@@ -61,6 +61,7 @@ class EnvironmentVariables final
     inline static const shared::WSTRING ThreadLifetimeEnabled       = WStr("DD_INTERNAL_THREAD_LIFETIME_ENABLED");
     inline static const shared::WSTRING SystemCallsShieldEnabled    = WStr("DD_INTERNAL_SYSTEM_CALLS_SHIELD_ENABLED");
     inline static const shared::WSTRING EtwEnabled                  = WStr("DD_INTERNAL_PROFILING_ETW_ENABLED");
+    inline static const shared::WSTRING SsiDeployed                 = WStr("DD_INJECTION_ENABLED");
 
     inline static const shared::WSTRING CIVisibilityEnabled         = WStr("DD_CIVISIBILITY_ENABLED");
     inline static const shared::WSTRING InternalCIVisibilitySpanId  = WStr("DD_INTERNAL_CIVISIBILITY_SPANID");
diff --git a/profiler/src/ProfilerEngine/Datadog.Profiler.Native/IConfiguration.h b/profiler/src/ProfilerEngine/Datadog.Profiler.Native/IConfiguration.h
@@ -65,4 +65,6 @@ class IConfiguration
     virtual bool IsCIVisibilityEnabled() const = 0;
     virtual std::uint64_t GetCIVisibilitySpanId() const = 0;
     virtual bool IsEtwEnabled() const = 0;
+    virtual bool IsSsiDeployed() const = 0;
+    virtual bool IsSsiActivated() const = 0;
 };
diff --git a/profiler/test/Datadog.Profiler.IntegrationTests/Helpers/EnvironmentVariables.cs b/profiler/test/Datadog.Profiler.IntegrationTests/Helpers/EnvironmentVariables.cs
@@ -26,5 +26,6 @@ internal class EnvironmentVariables
         public const string DebugInfoEnabled = "DD_INTERNAL_PROFILING_DEBUG_INFO_ENABLED";
         public const string GcThreadsCpuTimeEnabled = "DD_INTERNAL_GC_THREADS_CPUTIME_ENABLED";
         public const string ThreadLifetimeEnabled = "DD_INTERNAL_THREAD_LIFETIME_ENABLED";
+        public const string SsiDeployed = "DD_INJECTION_ENABLED";
     }
 }
diff --git a/profiler/test/Datadog.Profiler.Native.Tests/ConfigurationTest.cpp b/profiler/test/Datadog.Profiler.Native.Tests/ConfigurationTest.cpp
@@ -825,3 +825,63 @@ TEST(ConfigurationTest, CheckEtwIsDisabledIfEnvVarSetToFalse)
     auto expectedValue = false;
     ASSERT_THAT(configuration.IsEtwEnabled(), expectedValue);
 }
+
+TEST(ConfigurationTest, CheckSsiDeployedByDefault)
+{
+    auto configuration = Configuration{};
+    ASSERT_THAT(configuration.IsSsiDeployed(), false);
+}
+
+TEST(ConfigurationTest, CheckSsiIsDeployedIfEnvVarConstainsProfiling)
+{
+    EnvironmentHelper::EnvironmentVariable ar(EnvironmentVariables::SsiDeployed, WStr("tracer,profiling"));
+    auto configuration = Configuration{};
+    auto expectedValue = true;
+    ASSERT_THAT(configuration.IsSsiDeployed(), expectedValue);
+}
+
+TEST(ConfigurationTest, CheckSsiIsDeployedIfEnvVarDoesNotContainProfiling)
+{
+    EnvironmentHelper::EnvironmentVariable ar(EnvironmentVariables::SsiDeployed, WStr("tracer"));
+    auto configuration = Configuration{};
+    auto expectedValue = true;
+    ASSERT_THAT(configuration.IsSsiDeployed(), expectedValue);
+}
+
+TEST(ConfigurationTest, CheckSsiIsDeployedIfEnvVarIsEmpty)
+{
+    EnvironmentHelper::EnvironmentVariable ar(EnvironmentVariables::SsiDeployed, WStr(""));
+    auto configuration = Configuration{};
+    auto expectedValue = true;
+    ASSERT_THAT(configuration.IsSsiDeployed(), expectedValue);
+}
+
+TEST(ConfigurationTest, CheckSsiActivatedByDefault)
+{
+    auto configuration = Configuration{};
+    ASSERT_THAT(configuration.IsSsiActivated(), false);
+}
+
+TEST(ConfigurationTest, CheckSsiIsActivatedIfEnvVarConstainsProfiling)
+{
+    EnvironmentHelper::EnvironmentVariable ar(EnvironmentVariables::SsiDeployed, WStr("tracer,profiling"));
+    auto configuration = Configuration{};
+    auto expectedValue = true;
+    ASSERT_THAT(configuration.IsSsiActivated(), expectedValue);
+}
+
+TEST(ConfigurationTest, CheckSsiIsNotActivatedIfEnvVarDoesNotContainProfiling)
+{
+    EnvironmentHelper::EnvironmentVariable ar(EnvironmentVariables::SsiDeployed, WStr("tracer"));
+    auto configuration = Configuration{};
+    auto expectedValue = false;
+    ASSERT_THAT(configuration.IsSsiActivated(), expectedValue);
+}
+
+TEST(ConfigurationTest, CheckSsiIsNotActivatedIfEnvVarIsEmpty)
+{
+    EnvironmentHelper::EnvironmentVariable ar(EnvironmentVariables::SsiDeployed, WStr(""));
+    auto configuration = Configuration{};
+    auto expectedValue = false;
+    ASSERT_THAT(configuration.IsSsiActivated(), expectedValue);
+}
diff --git a/profiler/test/Datadog.Profiler.Native.Tests/ProfilerMockedInterface.h b/profiler/test/Datadog.Profiler.Native.Tests/ProfilerMockedInterface.h
@@ -69,6 +69,8 @@ class MockConfiguration : public IConfiguration
     MOCK_METHOD(bool, IsCIVisibilityEnabled, (), (const override));
     MOCK_METHOD(std::uint64_t, GetCIVisibilitySpanId, (), (const override));
     MOCK_METHOD(bool, IsEtwEnabled, (), (const override));
+    MOCK_METHOD(bool, IsSsiDeployed, (), (const override));
+    MOCK_METHOD(bool, IsSsiActivated, (), (const override));
 };
 
 class MockExporter : public IExporter
diff --git a/shared/src/native-src/util.cpp b/shared/src/native-src/util.cpp
@@ -121,6 +121,21 @@ namespace shared
         return false;
     }
 
+    bool EnvironmentExist(const WSTRING& name)
+    {
+#ifdef _WIN32
+        auto len = ::GetEnvironmentVariable((LPWSTR)name.data(), (LPWSTR)nullptr, 0);
+        if (len > 0)
+        {
+            return true;
+        }
+
+        return (::GetLastError() != ERROR_ENVVAR_NOT_FOUND);
+#else
+        auto cstr = std::getenv(ToString(name).c_str());
+        return (cstr != nullptr);
+#endif
+    }
 
     WSTRING GetEnvironmentValue(const WSTRING& name)
     {
diff --git a/shared/src/native-src/util.h b/shared/src/native-src/util.h
@@ -44,6 +44,9 @@ namespace shared
     // Trim removes space from the beginning and end of a string.
     std::string Trim(const std::string& str);
 
+    // Check that an environment variable exists
+    bool EnvironmentExist(const WSTRING& name);
+
     // GetEnvironmentValue returns the environment variable value for the given
     // name. Space is trimmed.
     WSTRING GetEnvironmentValue(const WSTRING& name);

Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,6 @@ internal class EnvironmentVariables`
`26`	`26`	`public const string DebugInfoEnabled = "DD_INTERNAL_PROFILING_DEBUG_INFO_ENABLED";`
`27`	`27`	`public const string GcThreadsCpuTimeEnabled = "DD_INTERNAL_GC_THREADS_CPUTIME_ENABLED";`
`28`	`28`	`public const string ThreadLifetimeEnabled = "DD_INTERNAL_THREAD_LIFETIME_ENABLED";`
	`29`	`+ public const string SsiDeployed = "DD_INJECTION_ENABLED";`
`29`	`30`	`}`
`30`	`31`	`}`