Merge pull request #324 from GameTechDev/feature/svc-launch

markgalvan-intel · web-flow · commit 9ff04eb33eda · 2024-07-16T10:35:48.000-07:00
Service as Child
diff --git a/IntelPresentMon/AppCef/source/winmain.cpp b/IntelPresentMon/AppCef/source/winmain.cpp
@@ -9,9 +9,15 @@
 #include <Core/source/cli/CliOptions.h>
 #include <CommonUtilities/log/IdentificationTable.h>
 #include <CommonUtilities/generated/build_id.h>
+#include <CommonUtilities/win/Utilities.h>
 #include <PresentMonAPIWrapper/DiagnosticHandler.h>
 #include <dwmapi.h>
 
+#pragma warning(push)
+#pragma warning(disable : 4297)
+#include <boost/process.hpp>
+#pragma warning(pop)
+
 #pragma comment(lib, "Dwmapi.lib")
 
 using namespace p2c;
@@ -225,8 +231,27 @@ int APIENTRY WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLi
     // configure the logging system (partially based on command line options)
     ConfigureLogging();
 
-    using namespace client;
     try {
+        // service-as-child handling
+        std::optional<boost::process::child> childSvc;
+        if (!opt.cefType && opt.svcAsChild) {
+            using namespace std::literals;
+            namespace bp = boost::process;
+
+            childSvc.emplace("PresentMonService.exe"s,
+                "--control-pipe"s, *opt.controlPipe,
+                "--nsm-prefix"s, "pm-frame-nsm"s,
+                "--intro-nsm"s, *opt.shmName,
+                "--etw-session-name"s, *opt.etwSessionName);
+
+            if (!pmon::util::win::WaitForNamedPipe(*opt.controlPipe, 1500)) {
+                pmlog_error(L"timeout waiting for child service control pipe to go online");
+                return -1;
+            }
+        }
+
+        using namespace client;
+        // cef process constellation fork control
         CefMainArgs main_args{ hInstance };
         CefRefPtr<ccef::NanoCefProcessHandler> app = new ccef::NanoCefProcessHandler{};
 
diff --git a/IntelPresentMon/CommonUtilities/Exception.cpp b/IntelPresentMon/CommonUtilities/Exception.cpp
@@ -2,6 +2,7 @@
 #include "../CommonUtilities/win/Utilities.h"
 #include <sstream>
 #include "log/GlobalPolicy.h"
+#include "log/StackTrace.h"
 #include <format>
 
 
diff --git a/IntelPresentMon/CommonUtilities/Exception.h b/IntelPresentMon/CommonUtilities/Exception.h
@@ -1,10 +1,15 @@
 #pragma once
 #include "str/String.h"
-#include "log/StackTrace.h"
 #include <exception>
+#include <memory>
 
 namespace pmon::util
 {
+	namespace log
+	{
+		class StackTrace;
+	}
+
 	class Exception : public std::exception
 	{
 	public:
@@ -50,6 +55,7 @@ namespace pmon::util
 
 	void InstallSehTranslator() noexcept;
 
+#define PM_DEFINE_EX_FROM(base, name) class name : public base { public: using base::base; }
 #define PM_DEFINE_EX(name) class name : public ::pmon::util::Exception { public: using Exception::Exception; }
 
 // prevent any exceptions from leaking from this statement
diff --git a/IntelPresentMon/CommonUtilities/cli/CliFramework.h b/IntelPresentMon/CommonUtilities/cli/CliFramework.h
@@ -247,22 +247,19 @@ namespace pmon::util::cli
 		}
 	};
 
-	class MutualInclusion : RuleBase_
+	class Dependency : RuleBase_
 	{
 	public:
 		template<class...T>
-		MutualInclusion(T&...elements)
+		Dependency(T&...elements)
 		{
-			Include(elements...);
+			Depend_(elements...);
 		}
 	private:
 		template<class T, class...Rest>
-		void Include(T& pivot, const Rest&...rest) const
+		void Depend_(T& pivot, const Rest&...rest) const
 		{
-			if constexpr (sizeof...(rest) > 0) {
-				GetOption_(pivot)->needs(GetOption_(rest)...);
-				Include(rest...);
-			}
+			GetOption_(pivot)->needs(GetOption_(rest)...);
 		}
 	};
 
diff --git a/IntelPresentMon/CommonUtilities/win/Utilities.cpp b/IntelPresentMon/CommonUtilities/win/Utilities.cpp
@@ -1,6 +1,8 @@
 #pragma once 
 #include "Utilities.h"
 #include "../log/Log.h"
+#include <chrono>
+#include <thread>
 
 namespace pmon::util::win
 {
@@ -106,4 +108,17 @@ namespace pmon::util::win
 		return L"unknown_seh_code";
 #undef FOR_EACH_STA
 	}
+
+	bool WaitForNamedPipe(const std::string& fullname, int timeoutMs)
+	{
+		using namespace std::literals; using clock = std::chrono::high_resolution_clock;
+		const auto start = clock::now();
+		while (!::WaitNamedPipeA(fullname.c_str(), 10)) {
+			if (clock::now() - start >= timeoutMs * 1ms) {
+				return false;
+			}
+			std::this_thread::sleep_for(10ms);
+		}
+		return true;
+	}
 }
diff --git a/IntelPresentMon/CommonUtilities/win/Utilities.h b/IntelPresentMon/CommonUtilities/win/Utilities.h
@@ -4,6 +4,10 @@
 
 namespace pmon::util::win
 {
+	// convert WinAPI HRESULT code to human-readable string
 	std::wstring GetErrorDescription(HRESULT hr) noexcept;
+	// convert Structured Exception Handling error code to human-readable string
 	std::wstring GetSEHSymbol(DWORD sehCode) noexcept;
+	// returns true of the named pipe is available for connection
+	bool WaitForNamedPipe(const std::string& fullname, int timeoutMs);
 }
diff --git a/IntelPresentMon/ControlLib/Adl2Wrapper.h b/IntelPresentMon/ControlLib/Adl2Wrapper.h
@@ -68,30 +68,27 @@
      lpOdFanControl)
 
 namespace pwr::amd {
-
-class Adl2Wrapper {
- public:
-  Adl2Wrapper();
-  Adl2Wrapper(const Adl2Wrapper& t) = delete;
-  Adl2Wrapper& operator=(const Adl2Wrapper& t) = delete;
-  ~Adl2Wrapper();
-
-  static bool Ok(int sta) noexcept { return sta == ADL_OK; }
-  // endpoint wrapper functions
+	class Adl2Wrapper {
+	public:
+		Adl2Wrapper();
+		Adl2Wrapper(const Adl2Wrapper& t) = delete;
+		Adl2Wrapper& operator=(const Adl2Wrapper& t) = delete;
+		~Adl2Wrapper();
+		static bool Ok(int sta) noexcept { return sta == ADL_OK; }
+		// endpoint wrapper functions
 #define X_(name, ...) int name(NVW_ARGS(__VA_ARGS__)) const noexcept;
-  AMD_ADL2_ENDPOINT_LIST
+		AMD_ADL2_ENDPOINT_LIST
 #undef X_
- private:
-
-  DllModule dll{{"atiadlxx.dll", "atiadlxy.dll"}};
+	private:
+        // data
+		DllModule dll{ {"atiadlxx.dll", "atiadlxy.dll"} };
+		ADL_CONTEXT_HANDLE adl_context_ = nullptr;
+        // endpoint pointers
 #define X_(name, ...) \
   int (*p##name)(ADL_CONTEXT_HANDLE context, NVW_ARGS(__VA_ARGS__)) = nullptr;
-  AMD_ADL2_ENDPOINT_LIST
+		AMD_ADL2_ENDPOINT_LIST
 #undef X_
-  // Private endpoint pointer to shutdown ADL2
-  int (*ADL2_Main_Control_Destroy_ptr_)(ADL_CONTEXT_HANDLE) = nullptr;
-  ADL_CONTEXT_HANDLE adl_context_ = nullptr;
-  // Test function
-};
-
+		// Private endpoint pointer to shutdown ADL2
+		int (*ADL2_Main_Control_Destroy_ptr_)(ADL_CONTEXT_HANDLE) = nullptr;
+	};
 }  // namespace pwr::amd
diff --git a/IntelPresentMon/ControlLib/ControlLib.vcxproj b/IntelPresentMon/ControlLib/ControlLib.vcxproj
@@ -202,6 +202,7 @@
     <ClInclude Include="CpuTelemetryInfo.h" />
     <ClInclude Include="DllModule.h" />
     <ClInclude Include="CpuTelemetry.h" />
+    <ClInclude Include="Exceptions.h" />
     <ClInclude Include="IntelPowerTelemetryAdapter.h" />
     <ClInclude Include="Logging.h" />
     <ClInclude Include="MacroHelpers.h" />
diff --git a/IntelPresentMon/ControlLib/ControlLib.vcxproj.filters b/IntelPresentMon/ControlLib/ControlLib.vcxproj.filters
@@ -75,6 +75,7 @@
     <ClInclude Include="PowerTelemetryProviderFactory.h" />
     <ClInclude Include="PresentMonPowerTelemetry.h" />
     <ClInclude Include="TelemetryHistory.h" />
+    <ClInclude Include="Exceptions.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="NvapiWrapper.cpp">
diff --git a/IntelPresentMon/ControlLib/DllModule.h b/IntelPresentMon/ControlLib/DllModule.h
@@ -7,6 +7,9 @@
 #include <vector>
 #include <stdexcept>
 #include <format>
+#include <cassert>
+#include "Exceptions.h"
+
 
 class DllModule
 {
@@ -15,20 +18,17 @@ class DllModule
     DllModule& operator=(const DllModule& t) = delete;
 	DllModule(const std::vector<std::string>& dllFiles)
 	{
-		if (dllFiles.empty())
-		{
-			throw std::runtime_error{ "No dll files specified for dll module" };
-		}
+		assert(!dllFiles.empty());
+
 		// try list of dll candidates in order
-		for (const auto& file : dllFiles)
-		{
-			if (hModule = LoadLibraryExA(file.c_str(), NULL, LOAD_LIBRARY_SEARCH_SYSTEM32))
-			{
+		for (const auto& file : dllFiles) {
+			if (hModule = LoadLibraryExA(file.c_str(), NULL, LOAD_LIBRARY_SEARCH_SYSTEM32)) {
 				return;
 			}
 		}
 		// if all failed to load, throw exception
-		throw std::runtime_error{ std::format("Failed to load library, last DLL tried: {}", dllFiles.back().c_str()) };
+		auto msg = std::format("Unable to locate telemetry library, last DLL tried: {}", dllFiles.back().c_str());
+		throw Except<TelemetrySubsystemAbsent>(std::move(msg));
 	}
 	~DllModule()
 	{
diff --git a/IntelPresentMon/ControlLib/Exceptions.h b/IntelPresentMon/ControlLib/Exceptions.h
@@ -0,0 +1,8 @@
+#pragma once
+#include "../CommonUtilities/Exception.h"
+
+PM_DEFINE_EX(TelementryException);
+
+PM_DEFINE_EX_FROM(TelementryException, TelemetrySubsystemAbsent);
+
+using ::pmon::util::Except;
diff --git a/IntelPresentMon/ControlLib/IntelPowerTelemetryProvider.cpp b/IntelPresentMon/ControlLib/IntelPowerTelemetryProvider.cpp
@@ -3,6 +3,7 @@
 #include "IntelPowerTelemetryProvider.h"
 #include "IntelPowerTelemetryAdapter.h"
 #include "Logging.h"
+#include "Exceptions.h"
 
 namespace pwr::intel
 {
@@ -20,7 +21,7 @@ namespace pwr::intel
         // initialize the igcl api
         if (const auto result = ctlInit(&ctl_init_args, &apiHandle); result != CTL_RESULT_SUCCESS) {
             IGCL_ERR(result);
-            throw std::runtime_error{"failed igcl api init"};
+            throw Except<TelemetrySubsystemAbsent>("Unable to initialize Intel Graphics Control Library");
         }
 
         // enumerate devices available via igcl (get a list of device handles)
diff --git a/IntelPresentMon/ControlLib/NvmlWrapper.h b/IntelPresentMon/ControlLib/NvmlWrapper.h
@@ -45,6 +45,7 @@ namespace pwr::nv
 #undef X_
 
 	private:
+		// data
 		DllModule dll{ { "nvml.dll" } };
 		// endpoint pointers
 #define X_(name, ...) nvmlReturn_t (*p##name)(NVW_ARGS(__VA_ARGS__)) = nullptr;
diff --git a/IntelPresentMon/Core/source/cli/CliOptions.h b/IntelPresentMon/Core/source/cli/CliOptions.h
@@ -18,15 +18,18 @@ namespace p2c::cli
 
 	private: Group gd_{ this, "Debugging", "Aids in debugging this tool" }; public:
 		Option<std::string> url{ this, "--p2c-url", "", "URL to load instead of app files" };
-		Option<std::string> controlPipe{ this, "--p2c-control-pipe", "", "Named pipe to connect to the service with" };
-		Option<std::string> shmName{ this, "--p2c-shm-name", "", "Shared memory to connect to the service with" };
+		Option<std::string> controlPipe{ this, "--p2c-control-pipe", R"(\\.\pipe\pm-ctrl)", "Named pipe to connect to the service with" };
+		Option<std::string> shmName{ this, "--p2c-shm-name", "pm-intro-shm", "Shared memory to connect to the service with" };
+		Option<std::string> etwSessionName{ this, "--p2c-etw-session-name", "pm-child-etw-session", "ETW session name when lauching service as child" };
+		Flag svcAsChild{ this, "--p2c-svc-as-child", "Launch service as child console app" };
 		Flag noNetFail{ this, "--p2c-no-net-fail", "Disable error modal for bad url accesses" };
 		Flag debugWaitRender{ this, "--p2c-debug-wait-render", "Force all render child processes to wait for debugger connection" };
 		Flag debugWaitClient{ this, "--p2c-debug-wait-client", "Force main client process to wait for debugger connection" };
 		Flag filesWorking{ this, "--p2c-files-working", "Use the working directory for file storage" };
 		Flag traceExceptions{ this, "--p2c-trace-exceptions", "Add stack trace to all thrown exceptions (including SEH exceptions)" };
 		Flag enableDiagnostic{ this, "--p2c-enable-diagnostic", "Enable debug diagnostic layer forwarding (duplicates exiisting log entries)" };
 
+
 	private: Group gl_{ this, "Logging", "Customize logging for this tool"}; public:
 		Option<log::Level> logLevel{ this, "--p2c-log-level", log::Level::Error, "Severity to log at", logLevelTf_ };
 		Option<log::Level> logTraceLevel{ this, "--p2c-log-trace-level", log::Level::Error, "Severity to print stacktrace at", logLevelTf_ };
@@ -43,6 +46,7 @@ namespace p2c::cli
 
 	private:
 		MutualExclusion excl_{ logDenyList, logAllowList };
+		Dependency incl_{ etwSessionName, svcAsChild };
 		NoForward noForward_{ cefType, logPipeName };
 		AllowExtras ext_{ this };
 	};
diff --git a/IntelPresentMon/Core/source/kernel/Kernel.cpp b/IntelPresentMon/Core/source/kernel/Kernel.cpp
@@ -159,8 +159,17 @@ namespace p2c::kern
             // connect to wbem
             win::com::WbemConnection wbemConn;
 
+            // connection names control from cli override / svc-as-child
+            auto controlPipe = opt.controlPipe.AsOptional();
+            auto shmName = opt.shmName.AsOptional();
+            // force optionals filled with default values if not specified when launching service as child
+            if (opt.svcAsChild) {
+                controlPipe = *opt.controlPipe;
+                shmName = *opt.shmName;
+            }
+
             // create the PresentMon object
-            try { pm.emplace(opt.controlPipe.AsOptional(), opt.shmName.AsOptional()); }
+            try { pm.emplace(controlPipe, shmName); }
             catch (...) {
                 pHandler->OnPresentmonInitFailed();
                 pmlog_error(L"Failed to init presentmon api").no_trace();
diff --git a/IntelPresentMon/PresentMonService/PowerTelemetryContainer.cpp b/IntelPresentMon/PresentMonService/PowerTelemetryContainer.cpp

Original file line number	Diff line number	Diff line change
`@@ -247,22 +247,19 @@ namespace pmon::util::cli`
`247`	`247`	`}`
`248`	`248`	`};`
`249`	`249`
`250`		`- class MutualInclusion : RuleBase_`
	`250`	`+ class Dependency : RuleBase_`
`251`	`251`	`{`
`252`	`252`	`public:`
`253`	`253`	`template<class...T>`
`254`		`- MutualInclusion(T&...elements)`
	`254`	`+ Dependency(T&...elements)`
`255`	`255`	`{`
`256`		`- Include(elements...);`
	`256`	`+ Depend_(elements...);`
`257`	`257`	`}`
`258`	`258`	`private:`
`259`	`259`	`template<class T, class...Rest>`
`260`		`- void Include(T& pivot, const Rest&...rest) const`
	`260`	`+ void Depend_(T& pivot, const Rest&...rest) const`
`261`	`261`	`{`
`262`		`- if constexpr (sizeof...(rest) > 0) {`
`263`		`- GetOption_(pivot)->needs(GetOption_(rest)...);`
`264`		`- Include(rest...);`
`265`		`- }`
	`262`	`+ GetOption_(pivot)->needs(GetOption_(rest)...);`
`266`	`263`	`}`
`267`	`264`	`};`
`268`	`265`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,10 @@`
`4`	`4`
`5`	`5`	`namespace pmon::util::win`
`6`	`6`	`{`
	`7`	`+ // convert WinAPI HRESULT code to human-readable string`
`7`	`8`	`std::wstring GetErrorDescription(HRESULT hr) noexcept;`
	`9`	`+ // convert Structured Exception Handling error code to human-readable string`
`8`	`10`	`std::wstring GetSEHSymbol(DWORD sehCode) noexcept;`
	`11`	`+ // returns true of the named pipe is available for connection`
	`12`	`+ bool WaitForNamedPipe(const std::string& fullname, int timeoutMs);`
`9`	`13`	`}`