mirrors/ruby
0
0 Fork 0
mirror of https://github.com/ruby/ruby.git synced 2026-10-28 16:36:20 +08:00
Code Activity

Rework the RUBY_TYPED_FROZEN_SHAREABLE to be more precise and accurate

Browse Source 
* See https://github.com/ruby/ruby/pull/18492#discussion_r4207898351
This commit is contained in:
Benoit Daloze committed 2026-10-09 21:26:54 +02:00
1 parent 5ee67ca362
commit ef83236c79
1 file changed
+6 -4
Notes: git 2026-10-09 19:27:32 +00:00 
Merged: https://github.com/ruby/ruby/pull/19281
Download Patch File Download Diff File Expand all files Collapse all files
doc/efficient_extensions.md
+6 -4
View File
@@ -476,12 +476,14 @@ Why:
Sharp edge: if struct allocation inside `Make_Struct` fails, you can end up with a Ruby object whose data pointer is `NULL`. Still usually better than the leak. Reach for `Wrap_Struct` only when you already have a pre-existing struct pointer you can't recreate.
### Tip: 🟧 _Set `RUBY_TYPED_FROZEN_SHAREABLE` if you want frozen TypedData to cross Ractors_
### Tip: 🟧 _Set `RUBY_TYPED_FROZEN_SHAREABLE` if you want immutable TypedData to cross Ractors_
Impact: _Allows frozen instances to be shared across Ractors without copying_
Impact: _Allows immutable instances to be shared across Ractors without copying_
Why:
1. Without the flag, `Ractor.make_shareable(obj)` raises for your type.
2. With the flag (plus freezing + `Ractor.make_shareable`), the object can be read from any Ractor.
2. With the flag (+ freezing + `Ractor.make_shareable`), the object can be read from any Ractor.
Do make sure that your object and C code are able to correctly run across many Ractors with no thread safety issues.
This requires the instance and its fields to be immutable, see
https://github.com/ruby/ruby/blob/master/doc/extension.rdoc#appendix-f-ractor-support for details.
`Ractor.make_shareable(obj)` will then make the TypedData instance and every Ruby object it refers to shareable (immutable).