Changeset 272 for trunk/src/3rdparty/os2/xsystray/xsystray_api.c

Timestamp:

Oct 31, 2009, 2:00:20 AM (16 years ago)

Author:

Dmitry A. Kuminov

Message:

3rdparty: os2/xsystray: Use shared memory pool instead of TLS for structures sent to the system tray server by the client-side API. The memory pool is big enough to hold ~64 simultaneous requests to the server (e.g. 64 parallel threads). This also fixes a potential bug when not all threads could re-give their per-thread memory blocks to the server process after it is stopped and restarted.

File:

• trunk/src/3rdparty/os2/xsystray/xsystray_api.c (modified) (13 diffs)

trunk/src/3rdparty/os2/xsystray/xsystray_api.c

@@ -17 +17 @@
 #define INCL_DOSPROCESS
 #define INCL_WINWINDOWMGR
+
 #define INCL_WINATOM
 #define INCL_WINPOINTERS
@@ -26 +27 @@
 #include <string.h>
 #include <sys/builtin.h>        // atomics
-#include <InnotekLIBC/thread.h> // TLS
 
 static HWND G_hwndSysTray = NULLHANDLE;
-static int G_itlsSysTrayCtlData = -1;
-
-static HWND FindSysTrayWindow()
+            // window handle of the system tray server
+
+static PVOID G_pvMemoryPool = NULL;
+             // memory pool for SYSTRAYCTLDATA structs used by WM_XST_CONTROL
+             // messages. Note that once allocated, this memory is never freed:
+             // it is intentional since the memory is assumed to be always in
+             // need and that the system will free it when the application
+             // terminates
+
+#define MEMORYPOOL_SIZE 65536
+        // taking SYSTRAYCTLDATA size into account, this is enough for at least
+        // 64 threads sending WM_XST_CONTROL simultaneously, which sounds sane
+
+// @todo to be on the safe side with casting in __atomic_cmpxchg32() we need
+// compile-time assertions like this:
+// AssertCompile(sizeof(uint32_t) == sizeof(HWND));
+// AssertCompile(sizeof(uint32_t) == sizeof(PVOID));
+
+static HWND FindSysTrayServerWindow()
 {
     char buf[sizeof(WNDCLASS_WIDGET_XSYSTRAY_SERVER) + 1];
@@ -62 +78 @@
         {
             bTriedFind = TRUE;
-            HWND hwnd = FindSysTrayWindow();
+            HWND hwnd = FindSysTrayWindow();
             __atomic_cmpxchg32((uint32_t *)&G_hwndSysTray, hwnd, NULLHANDLE);
             if (G_hwndSysTray == NULLHANDLE)
@@ -72 +88 @@
             arc = ERROR_INVALID_HANDLE;
             if (WinQueryWindowProcess(G_hwndSysTray, &pid, &tid))
-                arc = DosGiveSharedMem(__libc_TLSGet(G_itlsSysTrayCtlData),
+                arc = DosGiveSharedMem(,
                                        pid, PAG_READ | PAG_WRITE);
             if (arc != NO_ERROR)
@@ -100 +116 @@
 }
 
-// This function returns a per-thread SYSTRAYCTLDATA pointer. We communicate
-// to the server thread using WinSendMsg() which allows us to reuse a single
-// memory block for all calls (WinSendMsg() doesn't return until the server is
-// done with processing the message).
-static PSYSTRAYCTLDATA GetSysTrayCtlDataPtr()
+// This function allocates a SYSTRAYCTLDATA struct in the pool of shared memory.
+// If there is no free space in the pool, it returns NULL. The allocated memory
+// must be freed by FreeSysTrayCtlDataPtr() when not needed.
+static PSYSTRAYCTLDATA AllocSysTrayCtlDataPtr()
 {
     APIRET arc;
-
-    // allocate a thread local storage entry if not done so
-    if (G_itlsSysTrayCtlData == -1)
-    {
-        // @todo does XWorkplace have its own TLS? Or is it built with GCC? Not?
-        // Use DosAllocThreadLocalMemory() directly then (though it's not nice
-        // due to the too limited amount of memory space in that area)
-        int itls = __libc_TLSAlloc();
-        if (!__atomic_cmpxchg32(&G_itlsSysTrayCtlData, itls, -1))
+    PVOID pvPool;
+    PSYSTRAYCTLDATA pData;
+
+    if (!G_pvMemoryPool)
+    {
+        // Note: we don't PAG_COMMIT, DosSubAllocMem will do so when needed
+        arc = DosAllocSharedMem((PVOID)&pvPool, NULL, MEMORYPOOL_SIZE,
+                                PAG_READ | PAG_WRITE | OBJ_GIVEABLE);
+        if (arc == NO_ERROR)
+            arc = DosSubSetMem(pvPool,
+                               DOSSUB_INIT | DOSSUB_SPARSE_OBJ,
+                               MEMORYPOOL_SIZE);
+        if (!__atomic_cmpxchg32((uint32_t *)&G_pvMemoryPool,
+                                (uint32_t)pvPool, (uint32_t)NULL))
         {
             // another thread has already got an entry, discard our try
-            if (itls != -1)
-                __libc_TLSFree(itls);
+            if ()
+                );
         }
-
-        if (G_itlsSysTrayCtlData == -1)
-            return NULL;
-    }
-
-    // allocate a SYSTRAYCTLDATA struct for this thread if not done so
-    PSYSTRAYCTLDATA pData = __libc_TLSGet(G_itlsSysTrayCtlData);
-    if (!pData)
-    {
-        arc = DosAllocSharedMem((PVOID)&pData, NULL, sizeof(SYSTRAYCTLDATA),
-                                PAG_COMMIT | PAG_READ | PAG_WRITE | OBJ_GIVEABLE);
-        if (arc != NO_ERROR)
-            return NULL;
-
-        __libc_TLSSet(G_itlsSysTrayCtlData, pData);
-
-        // note that we don't ever free the allocated block since our API doesn't
-        // have a concept of initialization/termination and therefore it's fine
-        // if the memory stays allocated until application termination
-    }
+        else
+        {
+            // we could fail to allocate while being the first... give up
+            if (arc != NO_ERROR)
+                return NULL;
+        }
+    }
+
+    arc = DosSubAllocMem(G_pvMemoryPool, (PVOID)&pData, sizeof(SYSTRAYCTLDATA));
+    if (arc != NO_ERROR)
+        return NULL;
 
     return pData;
+
+
+
+
+
 }
 
@@ -166 +182 @@
 {
     BOOL brc;
-    PSYSTRAYCTLDATA pData = GetSysTrayCtlDataPtr();
+    PSYSTRAYCTLDATA pData = SysTrayCtlDataPtr();
     if (!pData)
         return FALSE;
@@ -184 +200 @@
     }
 
+
+
     return brc;
 }
@@ -224 +242 @@
     BOOL brc;
     PPIB ppib;
-    PSYSTRAYCTLDATA pData = GetSysTrayCtlDataPtr();
+    PSYSTRAYCTLDATA pData = SysTrayCtlDataPtr();
     if (!pData)
         return FALSE;
@@ -230 +248 @@
     // give all processes temporary access to hIcon
     brc = WinSetPointerOwner(hIcon, 0, FALSE);
-    if (!brc)
-        return FALSE;
-
-    pData->ulCommand = SYSTRAYCMD_ADDICON;
-    pData->hwndSender = hwnd;
-    pData->u.icon.ulId = ulId;
-    pData->u.icon.hIcon = hIcon;
-    pData->u.icon.ulMsgId = ulMsgId;
-
-    brc = SendSysTrayCtlMsg(pData);
-
-    // revoke temporary access to hIcon
-    DosGetInfoBlocks(NULL, &ppib);
-    WinSetPointerOwner(hIcon, ppib->pib_ulpid, TRUE);
+    if (brc)
+    {
+        pData->ulCommand = SYSTRAYCMD_ADDICON;
+        pData->hwndSender = hwnd;
+        pData->u.icon.ulId = ulId;
+        pData->u.icon.hIcon = hIcon;
+        pData->u.icon.ulMsgId = ulMsgId;
+
+        brc = SendSysTrayCtlMsg(pData);
+
+        // revoke temporary access to hIcon
+        DosGetInfoBlocks(NULL, &ppib);
+        WinSetPointerOwner(hIcon, ppib->pib_ulpid, TRUE);
+    }
+
+    FreeSysTrayCtlDataPtr(pData);
 
     return brc;
@@ -260 +280 @@
                           ULONG ulId)   // in: icon ID to remove
 {
-    PSYSTRAYCTLDATA pData = GetSysTrayCtlDataPtr();
+    BOOL brc;
+    PSYSTRAYCTLDATA pData = AllocSysTrayCtlDataPtr();
     if (!pData)
         return FALSE;
@@ -268 +289 @@
     pData->u.icon.ulId = ulId;
 
-    return SendSysTrayCtlMsg(pData);
+    brc = SendSysTrayCtlMsg(pData);
+
+    FreeSysTrayCtlDataPtr(pData);
+
+    return brc;
 }
 
@@ -292 +317 @@
                               PSZ pszText)  // in: tooltip text
 {
-    PSYSTRAYCTLDATA pData = GetSysTrayCtlDataPtr();
+    BOOL brc;
+    PSYSTRAYCTLDATA pData = AllocSysTrayCtlDataPtr();
     if (!pData)
         return FALSE;
@@ -310 +336 @@
     }
 
-    return SendSysTrayCtlMsg(pData);
+    brc = SendSysTrayCtlMsg(pData);
+
+    FreeSysTrayCtlDataPtr(pData);
+
+    return brc;
 }