[DOC] Update documentation of ObjectSpace.memsize_of
#13986
Merged
+4
−3
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
st0012
commented
Jul 23, 2025
ext/objspace/objspace.c
Outdated
| * From Ruby 2.2, memsize_of(obj) returns a memory size that includes | ||
| * the slot size occupied by the object. Prior to Ruby 3.2, this was a | ||
| * fixed size (sizeof(RVALUE)). From Ruby 3.2 with Variable Width | ||
| * Allocation, this is the actual slot size used (1×, 2×, 4×, 8×, or |
There was a problem hiding this comment.
I got this information from rb_gc_impl_objspace_init: https://github.com/Shopify/ruby/blob/9eac1c3a888088912fcc1cbb6fc677fd1ad5683c/gc/default/default.c#L9331-L9337
Let me know if it's correct?
9eac1c3 to
460ab65
Compare
eightbitraptor
approved these changes
Jul 23, 2025
|
@peterzhu2118 So does it make sense to just drop everything after |
|
No, I think there's still value in making it clear that it returns the size of the slot + externally allocated memory. |
460ab65 to
eab89a7
Compare
peterzhu2118
approved these changes
Jul 23, 2025
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.
RVALUEno longer exists and objects can now have various sizes due to VWA. So I think this API's doc should be updated.