Skip to content

Marked txm_module_object_deallocate as deprecated #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fdesbiens wants to merge 1 commit into
base: dev
Choose a base branch
from
+32 −1
Open

Marked txm_module_object_deallocate as deprecated #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions common_modules/module_lib/src/txm_module_object_deallocate.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,27 @@
#define TXM_MODULE
#include "txm_module.h"
#ifndef TXM_MODULE_OBJECT_DEALLOCATE_CALL_NOT_USED

/* DEPRECATION NOTICE
* txm_module_object_deallocate() is deprecated and must not be used in new
* code. It is retained only for backward-compatibility with existing modules.
*
* WHY: when a module calls tx_timer_delete(), tx_semaphore_delete(), or any
* other tx_*_delete() service, the Module Manager dispatch layer automatically
* releases the associated object pool memory after the kernel cleanup
* completes. No separate deallocation call is required or expected.
*
* WHAT TO DO: remove any call to txm_module_object_deallocate() from your
* module. The corresponding tx_*_delete() call already handles everything.
*
* RISK: calling txm_module_object_deallocate() on a live kernel object (one
* whose tx_*_delete() has not yet been called) frees the backing pool memory
* while the object is still referenced by the kernel, which is undefined
* behaviour (use-after-free).
*/
#pragma message("txm_module_object_deallocate() is deprecated and must not be used. " \
"Call tx_*_delete() instead; the Module Manager dispatch layer " \
"releases pool memory automatically on success.")
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
Expand Down
12 changes: 11 additions & 1 deletion common_modules/module_manager/src/txm_module_manager_object_deallocate.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,17 @@
/* */
/* DESCRIPTION */
/* */
/* This function deallocates a previously allocated object. */
/* DEPRECATED. This function is called internally by the Module */
/* Manager dispatch layer after a successful tx_*_delete() call from */
/* a module. It must not be called directly by module or application */
/* code. Calling it on a live kernel object (one whose tx_*_delete() */
/* has not yet been called) frees the backing pool memory while the */
/* object is still referenced by the kernel (use-after-free). */
/* */
/* Module authors: remove any explicit call to */
/* txm_module_object_deallocate(). Calling the appropriate */
/* tx_*_delete() service is sufficient; pool deallocation is handled */
/* automatically by the dispatch layer. */
/* */
/* INPUT */
/* */
Expand Down