improve open session c-api endpoint

added service action to query introspection shm name
reworked open session with custom names to on require control pipe name
moved custom open to the public api

Author: planetchili

IntelPresentMon/Core/source/cli/CliOptions.h

@@ -21,9 +21,9 @@ 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", 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" };
+		Option<std::string> shmName{ this, "--p2c-shm-name", "pm-intro-shm", "Shared memory to use when launching service as child" };
 		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" };

IntelPresentMon/Core/source/kernel/Kernel.cpp

@@ -160,15 +160,13 @@ namespace p2c::kern
 
             // 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(controlPipe, shmName); }
+            try { pm.emplace(controlPipe); }
             catch (...) {
                 pHandler->OnPresentmonInitFailed();
                 pmlog_error("Failed to init presentmon api").no_trace();

IntelPresentMon/Core/source/pmon/PresentMon.cpp

@@ -30,19 +30,18 @@ namespace p2c::pmon
 		BlobContainer blobs_;
 	};
 
-	PresentMon::PresentMon(std::optional<std::string> namedPipeName, std::optional<std::string> sharedMemoryName, double window_in, double offset_in, uint32_t telemetrySamplePeriodMs_in)
+	PresentMon::PresentMon(std::optional<std::string> namedPipeName, double window_in, double offset_in, uint32_t telemetrySamplePeriodMs_in)
 	{
 		const auto RemoveDoubleQuotes = [](std::string s) {
 			if (s.front() == '"' && s.back() == '"' && s.size() >= 2) {
 				s = s.substr(1, s.size() - 2);
 			}
 			return s;
 		};
-		if (namedPipeName && sharedMemoryName) {
+		if (namedPipeName) {
 			auto pipeName = RemoveDoubleQuotes(*namedPipeName);
-			auto shmName = RemoveDoubleQuotes(*sharedMemoryName);
-			pmlog_info(std::format("Connecting to service with custom pipe [{}] and nsm [{}]", pipeName, shmName));
-			pSession = std::make_unique<pmapi::Session>(std::move(pipeName), std::move(shmName));
+			pmlog_info(std::format("Connecting to service with custom pipe [{}]", pipeName));
+			pSession = std::make_unique<pmapi::Session>(std::move(pipeName));
 		}
 		else {
 			pmlog_info("Connecting to service with default pipe name");

IntelPresentMon/Core/source/pmon/PresentMon.h

@@ -25,7 +25,7 @@ namespace p2c::pmon
 	{
 	public:
 		// functions
-		PresentMon(std::optional<std::string> namedPipeName, std::optional<std::string> sharedMemoryName, double window = 1000., double offset = 1000., uint32_t telemetrySampleRateMs = 16);
+		PresentMon(std::optional<std::string> namedPipeName, double window = 1000., double offset = 1000., uint32_t telemetrySampleRateMs = 16);
 		~PresentMon();
 		void StartTracking(uint32_t pid_);
 		void StopTracking();

IntelPresentMon/PresentMonAPI2/Internal.h

@@ -8,13 +8,6 @@
 #include <memory>
 #include <functional>
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-	PRESENTMON_API2_EXPORT PM_STATUS pmOpenSession_(PM_SESSION_HANDLE* pHandle, const char* pipeNameOverride, const char* introNsmOverride);
-#ifdef __cplusplus
-}
-#endif
 
 // testing support functions
 PRESENTMON_API2_EXPORT _CrtMemState pmCreateHeapCheckpoint_();

IntelPresentMon/PresentMonAPI2/PresentMonAPI.cpp

@@ -60,35 +60,6 @@ PRESENTMON_API2_EXPORT _CrtMemState pmCreateHeapCheckpoint_()
 	return s;
 }
 
-PRESENTMON_API2_EXPORT PM_STATUS pmOpenSession_(PM_SESSION_HANDLE* pHandle, const char* pipeNameOverride, const char* introNsmOverride)
-{
-	try {
-		if (!pHandle) {
-			pmlog_error("null session handle outptr").diag();
-			return PM_STATUS_BAD_ARGUMENT;
-		}
-		std::shared_ptr<Middleware> pMiddleware;
-		std::optional<std::string> pipeName;
-		std::optional<std::string> introNsm;
-		if (pipeNameOverride) {
-			pipeName = std::string(pipeNameOverride);
-		}
-		if (introNsmOverride) {
-			introNsm = std::string(introNsmOverride);
-		}
- 		pMiddleware = std::make_shared<ConcreteMiddleware>(std::move(pipeName), std::move(introNsm));
-		*pHandle = pMiddleware.get();
-		handleMap_[*pHandle] = std::move(pMiddleware);
-		pmlog_info("Middleware successfully opened session with service");
-		return PM_STATUS_SUCCESS;
-	}
-	catch (...) {
-		const auto code = util::GeneratePmStatus();
-		pmlog_error(util::ReportException()).code(code);
-		return code;
-	}
-}
-
 PRESENTMON_API2_EXPORT LoggingSingletons pmLinkLogging_(
 	std::shared_ptr<pmon::util::log::IChannel> pChannel,
 	std::function<pmon::util::log::IdentificationTable&()> getIdTable)
@@ -146,10 +117,31 @@ PRESENTMON_API2_EXPORT void pmSetupODSLogging_(PM_DIAGNOSTIC_LEVEL logLevel,
 		(pmon::util::log::Level)stackTraceLevel, exceptionTrace);
 }
 
+PRESENTMON_API2_EXPORT PM_STATUS pmOpenSessionWithPipe(PM_SESSION_HANDLE* pHandle, const char* pipe)
+{
+	try {
+		if (!pHandle) {
+			pmlog_error("null session handle outptr").diag();
+			return PM_STATUS_BAD_ARGUMENT;
+		}
+		std::shared_ptr<Middleware> pMiddleware;
+		pMiddleware = std::make_shared<ConcreteMiddleware>(pipe ? std::optional<std::string>{ pipe } : std::nullopt);
+		*pHandle = pMiddleware.get();
+		handleMap_[*pHandle] = std::move(pMiddleware);
+		pmlog_info("Middleware successfully opened session with service");
+		return PM_STATUS_SUCCESS;
+	}
+	catch (...) {
+		const auto code = util::GeneratePmStatus();
+		pmlog_error(util::ReportException()).code(code);
+		return code;
+	}
+}
+
 // public endpoints
 PRESENTMON_API2_EXPORT PM_STATUS pmOpenSession(PM_SESSION_HANDLE* pHandle)
 {
-	return pmOpenSession_(pHandle, nullptr, nullptr);
+	return pmOpenSessionWithPipe(pHandle, nullptr);
 }
 
 PRESENTMON_API2_EXPORT PM_STATUS pmCloseSession(PM_SESSION_HANDLE handle)

IntelPresentMon/PresentMonAPI2/PresentMonAPI.h

@@ -367,6 +367,7 @@ extern "C" {
 	typedef struct PM_SESSION* PM_SESSION_HANDLE;
 
 	PRESENTMON_API2_EXPORT PM_STATUS pmOpenSession(PM_SESSION_HANDLE* pHandle);
+	PRESENTMON_API2_EXPORT PM_STATUS pmOpenSessionWithPipe(PM_SESSION_HANDLE* pHandle, const char* controlPipeName);
 	PRESENTMON_API2_EXPORT PM_STATUS pmCloseSession(PM_SESSION_HANDLE handle);
 	PRESENTMON_API2_EXPORT PM_STATUS pmStartTrackingProcess(PM_SESSION_HANDLE handle, uint32_t process_id);
 	PRESENTMON_API2_EXPORT PM_STATUS pmStopTrackingProcess(PM_SESSION_HANDLE handle, uint32_t process_id);

IntelPresentMon/PresentMonAPI2Loader/Implementation.cpp

@@ -24,6 +24,7 @@ class LoaderError_ : public pmon::ipc::PmStatusError
 
 // pointers to runtime-resolved core API functions
 PM_STATUS(*pFunc_pmOpenSession_)(PM_SESSION_HANDLE*) = nullptr;
+PM_STATUS(*pFunc_pmOpenSessionWithPipe_)(PM_SESSION_HANDLE* pHandle, const char*) = nullptr;
 PM_STATUS(*pFunc_pmCloseSession_)(PM_SESSION_HANDLE) = nullptr;
 PM_STATUS(*pFunc_pmStartTrackingProcess_)(PM_SESSION_HANDLE, uint32_t) = nullptr;
 PM_STATUS(*pFunc_pmStopTrackingProcess_)(PM_SESSION_HANDLE, uint32_t) = nullptr;
@@ -53,7 +54,6 @@ PM_STATUS(*pFunc_pmDiagnosticUnblockWaitingThread_)() = nullptr;
 PM_STATUS(*pFunc_pmSetupFileLogging_)(const char*, PM_DIAGNOSTIC_LEVEL,
 	PM_DIAGNOSTIC_LEVEL, bool) = nullptr;
 // pointers to runtime-resolved internal functions
-PM_STATUS(*pFunc_pmOpenSession__)(PM_SESSION_HANDLE* pHandle, const char*, const char*) = nullptr;
 _CrtMemState(*pFunc_pmCreateHeapCheckpoint__)() = nullptr;
 LoggingSingletons(*pFunc_pmLinkLogging__)(std::shared_ptr<pmon::util::log::IChannel>,
 	std::function<pmon::util::log::IdentificationTable&()>) = nullptr;
@@ -143,6 +143,7 @@ PRESENTMON_API2_EXPORT PM_STATUS LoadLibrary_()
 			}
 			// core
 			RESOLVE(pmOpenSession);
+			RESOLVE(pmOpenSessionWithPipe);
 			RESOLVE(pmCloseSession);
 			RESOLVE(pmStartTrackingProcess);
 			RESOLVE(pmStopTrackingProcess);
@@ -170,8 +171,7 @@ PRESENTMON_API2_EXPORT PM_STATUS LoadLibrary_()
 			RESOLVE(pmDiagnosticUnblockWaitingThread);
 			RESOLVE(pmSetupFileLogging);
 			// internal
-			RESOLVE(pmOpenSession_); // !!
-			RESOLVE_CPP(pmCreateHeapCheckpoint_); // ??
+			RESOLVE_CPP(pmCreateHeapCheckpoint_);
 			RESOLVE_CPP(pmLinkLogging_);
 			RESOLVE_CPP(pmFlushEntryPoint_);
 			RESOLVE_CPP(pmSetupODSLogging_);
@@ -201,6 +201,11 @@ PRESENTMON_API2_EXPORT PM_STATUS pmOpenSession(PM_SESSION_HANDLE* pHandle)
 	LoadEndpointsIfEmpty_();
 	return pFunc_pmOpenSession_(pHandle);
 }
+PRESENTMON_API2_EXPORT PM_STATUS pmOpenSessionWithPipe(PM_SESSION_HANDLE* pHandle, const char* pipeNameOverride)
+{
+	LoadEndpointsIfEmpty_();
+	return pFunc_pmOpenSessionWithPipe_(pHandle, pipeNameOverride);
+}
 PRESENTMON_API2_EXPORT PM_STATUS pmCloseSession(PM_SESSION_HANDLE handle)
 {
 	LoadEndpointsIfEmpty_();
@@ -276,12 +281,6 @@ PRESENTMON_API2_EXPORT PM_STATUS pmGetApiVersion(PM_VERSION* pVersion)
 	LoadEndpointsIfEmpty_();
 	return pFunc_pmGetApiVersion_(pVersion);
 }
-// expose
-PRESENTMON_API2_EXPORT PM_STATUS pmOpenSession_(PM_SESSION_HANDLE* pHandle, const char* pipeNameOverride, const char* introNsmOverride)
-{
-	LoadEndpointsIfEmpty_();
-	return pFunc_pmOpenSession__(pHandle, pipeNameOverride, introNsmOverride);
-}
 // deprecate?
 PRESENTMON_API2_EXPORT _CrtMemState pmCreateHeapCheckpoint_()
 {