| Ticket UUID: | 547989 | ||
| Title: | Undocumented public API: threads | ||
| Type: | Bug | Created on: | 2002-04-24 09:57:59 |
| Submitter: | dkf | Assigned to: | vasiljevic |
| Subsystem: | 49. Threading | Severity: | Minor |
| Priority: | 4 | Last modified: | 2014-08-29 16:04:13 |
| Status: | Open | Closed by: | nobody |
| Resolution: | None | Closed on: | |
| Version: | obsolete: 8.4a5 | ||
| Description: | ||||
The following publically-named API functions are undocumented. Tcl_GetAllocMutex (mac/tclMacThrd.c) Tcl_GetAllocMutex (unix/tclUnixThrd.c) Tcl_GetAllocMutex (win/tclWinThrd.c) | ||||
| User Comments: | ||||
andreas_kupries added on 2002-05-15 02:15:05:
Logged In: YES user_id=75003 It is also exported through the public stub table. Its description however indicates that it is more an internal function required for the initialization of the memory allocation subsystem (MAS) of the core. IMHO making it public makes sense only if we allow the replacement of the MAS by an external system. Something I consider unlikely. Hm, ports to PDA's ? ... No, not even for such. They most likely will use a different allocator, yes, but that is part of the porting work. The change is not externally visible. So, my recommendation for now is to not to document this function and to make it internal in the next major release of the core. I will assign this now to Jeff to get his opinion too. vasiljevic added on 2007-06-30 22:59:55:
Logged In: YES user_id=95086 Originator: NO I have very little experience with stub exported calls. It is definitely so that above are to be used only internally and should therefore be named as TclpGetAllocMutex or such. They should not be exported. So what to do? Wait for 9.0 and scrap them out of the public API? dkf added on 2007-07-01 01:04:05:
Logged In: YES user_id=79902 Originator: YES I agree (given comments here) that it probably should be called TclpGetAllocMutex, and should have MODULE_SCOPE, but who knows who is calling it? :-( So, I suggest doing the rename and then creating a wrapper function (called Tcl_GetAllocMutex) that calls the real function. (Maybe while printing a message stderr that an unsupported/deprecated API has been called?) There should also be a comment in tcl.decls beside the function declaration that indicates that the function is deprecated and likely to be removed in 9.0. With that done, open a separate FRQ ticket to remind us to revisit this (i.e. remove the function) for 9.0, which is when we allow that sort of ABI change. With *that* done, close this ticket. Does this make things clear? vasiljevic added on 2007-07-01 02:30:03:
Logged In: YES user_id=95086 Originator: NO All is clear. dkf added on 2007-12-13 18:49:26:
Logged In: YES user_id=79902 Originator: YES Looking in the 'changes' file, I see this: 8/9/99 (internal api change) Removed the TclpMutexLock and TclpMutexUnlock APIs and added a new exported api, Tcl_GetAllocMutex. These APIs are all for the mutex used in the simple memory allocators. By making this change we are able to substitute different implementations of the thread-related APIs without having to recompile the Tcl core. (welch) dkf added on 2008-03-20 17:00:06:
Logged In: YES user_id=79902 Originator: YES It seems to me that the right thing to do is to switch this to a call in the internal stubs table; anything poking this deep needs to beware the dragons anyway. Hence it is better not documented (other than perhaps in comments in tclInt.decls and the rest of the sources). Dropping prio; no way should this block the 8.5.2 release! dkf added on 2013-09-10 18:50:06:
See branch bug-547989 for proposed code. dgp added on 2014-08-29 16:04:13:
heh. This one got away. | ||||
