Add documentation on dllmain restrictions (#389)

Signed-off-by: Neil R. Spruit <[email protected]>

Author: nrspruit

source/layers/tracing/windows/tracing_init.cpp

@@ -9,6 +9,12 @@
 #include <windows.h>
 
 namespace tracing_layer {
+/*
+ * DllMain is called by the OS when the DLL is loaded or unloaded.
+ * When modifying the code here, be aware of the restrictions on what can be done
+ * inside DllMain. See https://learn.microsoft.com/en-us/windows/win32/dlls/dynamic-link-library-best-practices
+ * for more information.
+ */
 extern "C" BOOL APIENTRY DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) {
     if (fdwReason == DLL_PROCESS_DETACH) {
       delete pGlobalAPITracerContextImp;

source/lib/windows/lib_init.cpp

@@ -14,6 +14,12 @@
 namespace ze_lib
 {
 #ifndef L0_STATIC_LOADER_BUILD
+    /*
+    * DllMain is called by the OS when the DLL is loaded or unloaded.
+    * When modifying the code here, be aware of the restrictions on what can be done
+    * inside DllMain. See https://learn.microsoft.com/en-us/windows/win32/dlls/dynamic-link-library-best-practices
+    * for more information.
+    */
     extern "C" BOOL APIENTRY DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) {
         if (fdwReason == DLL_PROCESS_DETACH) {
             delete context;

source/loader/windows/loader_init.cpp

@@ -11,6 +11,12 @@
 namespace loader
 {
 #ifdef L0_STATIC_LOADER_BUILD
+    /*
+    * DllMain is called by the OS when the DLL is loaded or unloaded.
+    * When modifying the code here, be aware of the restrictions on what can be done
+    * inside DllMain. See https://learn.microsoft.com/en-us/windows/win32/dlls/dynamic-link-library-best-practices
+    * for more information.
+    */
     extern "C" BOOL APIENTRY DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) {
         if (fdwReason == DLL_PROCESS_DETACH) {
             delete context;