doc for: posix: use pthread_key_create() to cleanup epicsThreadOSD

mdavidsaver · May 11, 2022 · 0d5cbeb · 0d5cbeb
1 parent dd0939d
commit 0d5cbeb
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 8 deletions.
diff --git a/documentation/RELEASE_NOTES.md b/documentation/RELEASE_NOTES.md
@@ -17,6 +17,20 @@ should also be read to understand what has changed since earlier releases.
 <!-- Insert new items immediately below here ... -->
 
 
+### Fixed leak from a non-EPICS thread
+
+On some targets, if a thread not created by `epicsThreadCreate*()` directly
+or indirectly calls an `epicsThread*()` function, a specific tracking struct
+is allocated.
+
+Prior to this release, on POSIX and WIN32 targets, this
+struct would not be `free()`d, resulting in a memory leak.
+
+This release fixed the leak on POSIX targets.
+
+See the associated github [issue 241](https://github.com/epics-base/epics-base/issues/241)
+for WIN32 status.
+
 ### Fix `CHECK_RELEASE = WARN`
 
 This now works again, it was broken in 2019 (7.0.3.1) by an errant commit.

diff --git a/modules/libcom/src/osi/os/RTEMS-score/osdThread.c b/modules/libcom/src/osi/os/RTEMS-score/osdThread.c
@@ -219,8 +219,7 @@ threadWrapper (rtems_task_argument arg)
  */
 void epicsThreadExitMain (void)
 {
-    cantProceed("epicsThreadExitMain() has been deprecated for lack of usage."
-                "  Please report if you see this message.");
+    cantProceed("epicsThreadExitMain() must no longer be used.\n");
 }
 
 static rtems_status_code

diff --git a/modules/libcom/src/osi/os/WIN32/osdThread.c b/modules/libcom/src/osi/os/WIN32/osdThread.c
@@ -256,8 +256,7 @@ static void epicsParmCleanupWIN32 ( void * praw )
  */
 LIBCOM_API void epicsStdCall epicsThreadExitMain ( void )
 {
-    cantProceed("epicsThreadExitMain() has been deprecated for lack of usage."
-                "  Please report if you see this message.");
+    cantProceed("epicsThreadExitMain() must no longer be used.\n");
 }
 
 /*

diff --git a/modules/libcom/src/osi/os/posix/osdThread.c b/modules/libcom/src/osi/os/posix/osdThread.c
@@ -723,8 +723,7 @@ LIBCOM_API void epicsStdCall epicsThreadExitMain(void)
 
     epicsThreadInit();
 
-    cantProceed("epicsThreadExitMain() has been deprecated for lack of usage."
-                "  Please report if you see this message.");
+    cantProceed("epicsThreadExitMain() must no longer be used.\n");
 
     pthreadInfo = (epicsThreadOSD *)pthread_getspecific(getpthreadInfo);
     if(pthreadInfo==NULL)

diff --git a/modules/libcom/src/osi/os/vxWorks/osdThread.c b/modules/libcom/src/osi/os/vxWorks/osdThread.c
@@ -353,8 +353,7 @@ void epicsThreadResume(epicsThreadId id)
 
 void epicsThreadExitMain(void)
 {
-    cantProceed("epicsThreadExitMain() has been deprecated for lack of usage."
-                "  Please report if you see this message.");
+    cantProceed("epicsThreadExitMain() must no longer be used.\n");
 }
 
 unsigned int epicsThreadGetPriority(epicsThreadId id)