Remove unsafe try_module_get(THIS_MODULE) #328
Merged
+9
−46
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
linD026
reviewed
Aug 5, 2025
lkmpg.tex
Outdated
| It is important to keep the counter accurate; if you ever lose track of the correct usage count, you will never be able to unload the module; it is now reboot time. | ||
| This is bound to happen to you sooner or later during a module's development. | ||
| Note: The use of \cpp|try_module_get(THIS_MODULE)| and \cpp|module_put(THIS_MODULE)| within a module's own code is considered unsafe and should be avoided. | ||
| The kernel automatically manages the reference count when file operations are in progress, so manual reference counting is unnecessary and can lead to race conditions. |
There was a problem hiding this comment.
It would be better to have some external references to this, such as:
This commit removes all instances of try_module_get(THIS_MODULE) and corresponding module_put(THIS_MODULE) calls from example modules. This pattern is considered unsafe because: - The kernel automatically manages module reference counting during file operations - Manual reference counting within a module's own code can lead to race conditions - It is redundant and unnecessary for proper module operation It also updates documentation to: - Remove references to try_module_get/module_put functions - Add note explaining why these functions should be avoided - Keep only module_refcount() as a safe display function Close #52
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit removes all instances of try_module_get(THIS_MODULE) and corresponding module_put(THIS_MODULE) calls from example modules. This pattern is considered unsafe because:
It also updates documentation to:
Close #52
Summary by Bito
This pull request enhances kernel module safety by removing unsafe functions try_module_get(THIS_MODULE) and module_put(THIS_MODULE), which can cause race conditions. It promotes the use of the safe module_refcount() function and updates the documentation accordingly.