Move middleware file logging to internal for the time being

Author: planetchili

IntelPresentMon/Core/source/infra/LogSetup.cpp

@@ -166,7 +166,7 @@ namespace p2c
 			}
 			// enable logfile for middleware if we're not doing the copy connection
 			if (!opt.logMiddlewareCopy && *opt.cefType == "renderer") {
-				if (auto sta = pmSetupFileLogging(logFolder.string().c_str(),
+				if (auto sta = pmSetupFileLogging_((logFolder / "pmlog-mid.txt").string().c_str(),
 					(PM_DIAGNOSTIC_LEVEL)pol.GetLogLevel(),
 					(PM_DIAGNOSTIC_LEVEL)pol.GetTraceLevel(),
 					pol.GetExceptionTrace()

IntelPresentMon/PresentMonAPI2/Internal.h

@@ -34,3 +34,11 @@ PRESENTMON_API2_EXPORT void pmFlushEntryPoint_() noexcept;
 // set middleware to log using OutputDebugString
 PRESENTMON_API2_EXPORT void pmSetupODSLogging_(PM_DIAGNOSTIC_LEVEL logLevel,
 	PM_DIAGNOSTIC_LEVEL stackTraceLevel, bool exceptionTrace);
+
+// configure the middleware to log to a file (independent of and exclusive to diagnostic system)
+// path: path to the folder to where the logfile will be written (set NULL to disable file logging)
+// logLevel: only log entries at or above this severity
+// stackTraceLevel: only add stacktraces to entries at or above this level 
+// exceptionTrace: capture additional stacktrace at point of throwing of exceptions
+PRESENTMON_API2_EXPORT PM_STATUS pmSetupFileLogging_(const char* filename, PM_DIAGNOSTIC_LEVEL logLevel,
+	PM_DIAGNOSTIC_LEVEL stackTraceLevel, bool exceptionTrace);

IntelPresentMon/PresentMonAPI2/PresentMonDiagnostics.cpp

@@ -127,15 +127,14 @@ PRESENTMON_API2_EXPORT PM_STATUS pmDiagnosticUnblockWaitingThread()
 	return PM_STATUS_FAILURE;
 }
 
-PRESENTMON_API2_EXPORT PM_STATUS pmSetupFileLogging(const char* path, PM_DIAGNOSTIC_LEVEL logLevel,
+PRESENTMON_API2_EXPORT PM_STATUS pmSetupFileLogging_(const char* filename, PM_DIAGNOSTIC_LEVEL logLevel,
 	PM_DIAGNOSTIC_LEVEL stackTraceLevel, bool exceptionTrace)
 {
-	const auto fsPath = std::filesystem::path(path);
-	if (!std::filesystem::is_directory(fsPath)) {
+	auto filePath = std::filesystem::path(filename);
+	if (!std::filesystem::is_directory(filePath.parent_path())) {
 		return PM_STATUS_NONEXISTENT_FILE_PATH;
 	}
-	auto file = fsPath / std::format("pmlog-mid-{}.txt", GetCurrentProcessId());
-	log::SetupFileChannel(std::move(file), GetLogLevel_(logLevel),
+	log::SetupFileChannel(std::move(filePath), GetLogLevel_(logLevel),
 		GetLogLevel_(stackTraceLevel), exceptionTrace);
 	return PM_STATUS_SUCCESS;
 }

IntelPresentMon/PresentMonAPI2/PresentMonDiagnostics.h

@@ -119,15 +119,6 @@ extern "C" {
 	// wake it up so that it can exit gracefully
 	PRESENTMON_API2_EXPORT PM_STATUS pmDiagnosticUnblockWaitingThread();
 
-	// configure the middleware to log to a file (independent of diagnostic system)
-	// path: path to the folder to where the logfile will be written (set NULL to disable file logging)
-	// logLevel: only log entries at or above this severity
-	// stackTraceLevel: only add stacktraces to entries at or above this level 
-	// exceptionTrace: capture additional stacktrace at point of throwing of exceptions
-	PRESENTMON_API2_EXPORT PM_STATUS pmSetupFileLogging(const char* path, PM_DIAGNOSTIC_LEVEL logLevel,
-		PM_DIAGNOSTIC_LEVEL stackTraceLevel, bool exceptionTrace);
-
-
 #ifdef __cplusplus
 } // extern "C"
 #endif

IntelPresentMon/PresentMonAPI2Loader/Implementation.cpp

@@ -51,14 +51,14 @@ PM_STATUS(*pFunc_pmDiagnosticEnqueueMessage_)(const PM_DIAGNOSTIC_MESSAGE*) = nu
 PM_STATUS(*pFunc_pmDiagnosticFreeMessage_)(PM_DIAGNOSTIC_MESSAGE*) = nullptr;
 PM_DIAGNOSTIC_WAKE_REASON(*pFunc_pmDiagnosticWaitForMessage_)(uint32_t) = nullptr;
 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
 _CrtMemState(*pFunc_pmCreateHeapCheckpoint__)() = nullptr;
 LoggingSingletons(*pFunc_pmLinkLogging__)(std::shared_ptr<pmon::util::log::IChannel>,
 	std::function<pmon::util::log::IdentificationTable&()>) = nullptr;
 void(*pFunc_pmFlushEntryPoint__)() = nullptr;
 void(*pFunc_pmSetupODSLogging__)(PM_DIAGNOSTIC_LEVEL, PM_DIAGNOSTIC_LEVEL, bool) = nullptr;
+PM_STATUS(*pFunc_pmSetupFileLogging__)(const char*, PM_DIAGNOSTIC_LEVEL,
+	PM_DIAGNOSTIC_LEVEL, bool) = nullptr;
 
 
 // internal loader state globals
@@ -169,12 +169,12 @@ PRESENTMON_API2_EXPORT PM_STATUS LoadLibrary_()
 			RESOLVE(pmDiagnosticFreeMessage);
 			RESOLVE(pmDiagnosticWaitForMessage);
 			RESOLVE(pmDiagnosticUnblockWaitingThread);
-			RESOLVE(pmSetupFileLogging);
 			// internal
 			RESOLVE_CPP(pmCreateHeapCheckpoint_);
 			RESOLVE_CPP(pmLinkLogging_);
 			RESOLVE_CPP(pmFlushEntryPoint_);
 			RESOLVE_CPP(pmSetupODSLogging_);
+			RESOLVE_CPP(pmSetupFileLogging_);
 			// if we make it here then we have succeeded
 			middlewareLoadResult_ = PM_STATUS_SUCCESS;
 		}
@@ -376,11 +376,12 @@ PRESENTMON_API2_EXPORT PM_STATUS pmDiagnosticUnblockWaitingThread()
 	LoadEndpointsIfEmpty_();
 	return pFunc_pmDiagnosticUnblockWaitingThread_();
 }
-PRESENTMON_API2_EXPORT PM_STATUS pmSetupFileLogging(const char* path, PM_DIAGNOSTIC_LEVEL logLevel,
+
+PRESENTMON_API2_EXPORT PM_STATUS pmSetupFileLogging_(const char* file, PM_DIAGNOSTIC_LEVEL logLevel,
 	PM_DIAGNOSTIC_LEVEL stackTraceLevel, bool exceptionTrace)
 {
 	LoadEndpointsIfEmpty_();
-	return pFunc_pmSetupFileLogging_(path, logLevel, stackTraceLevel, exceptionTrace);
+	return pFunc_pmSetupFileLogging__(file, logLevel, stackTraceLevel, exceptionTrace);
 }