[ruby-core:111697] [Ruby master Feature#18949] Deprecate and remove replicate and dummy encodings

Issue #18949 has been updated by Eregon (Benoit Daloze).



Target version set to 3.3



This is all done now, only https://github.com/ruby/ruby/pull/7079 left and =
I'll merge that when it passes CI.



Overall:

* We deprecated and removed `Encoding#replicate`

* We removed `get_actual_encoding()`

* We limited to 256 encodings and kept `rb_define_dummy_encoding()` with th=
at constraint.

* There is a single flat array to lookup encodings, `rb_enc_from_index()` i=
s fast now.



Since the limit is 256 and not 128 though it means `ENCODING_GET` is not ju=
st `RB_ENCODING_GET_INLINED` but still has the check and slow fallback.



Thank you for the discussion, @ko1 for implementing the fixed-size table an=
d let's close this.

Of course for all builtin encodings the cost is just the extra check.

Maybe the limit could be changed later to 128 if this optimization is wante=
d.



----------------------------------------

Feature #18949: Deprecate and remove replicate and dummy encodings

https://bugs.ruby-lang.org/issues/18949#change-101095



* Author: Eregon (Benoit Daloze)

* Status: Open

* Priority: Normal

* Assignee: Eregon (Benoit Daloze)

* Target version: 3.3

----------------------------------------

Ruby has a lot of accidental complexity.

Sometimes it becomes clear some features bring a lot of complexity and yet =
provide little value or are used very rarely.

Also most Ruby users do not even know about these features.

Replicate and dummy encodings seem to clearly fall into this category, almo=
st nobody uses them but they add a significant complexity and also add a si=
gnificant performance overhead.

Notably, the existence of those means the number of encodings in a Ruby run=
time is actually variable and not fixed.

That means extra synchronization, hashtable lookups, indirections, function=
 calls, etc.



## Replicate Encodings



Replicate encodings are created using `Encoding#replicate(name)`.

It almost sounds like an alias but in fact it is more than that and creates=
 a new Encoding object, which can be used by a String:

```ruby

e =3D Encoding::US_ASCII.replicate('MY-US-ASCII')

s =3D "abc".force_encoding(e)

p s.encoding # =3D> e

p s.encoding.name # =3D> 'MY-US-ASCII'

```



This seems completely useless.

There is an obvious first step here which is to change `Encoding#replicate`=
 to return the receiver, and just install an alias for it.

That avoids creating more encoding instances needlessly.



I think we should also deprecate and remove this method though, it is never=
 a good idea to have a global mutable map like this.

If someone want extra aliases for encodings, they can easily to do so by ha=
ving their own Hash: `{ alias =3D> encoding }.fetch(name) { Encoding.find(n=
ame) }`.



## Dummy Encodings



Dummy encodings are not real encodings. They are artificial encodings desig=
ned to look like encodings, but don't function as encodings in Ruby.

>From the docs:

```

enc.dummy? -> true or false

------------------------------------------------------------------------

Returns true for dummy encodings. A dummy encoding is an encoding for

which character handling is not properly implemented. It is used for

stateful encodings.

```



I wonder why we have those half-implemented encodings in core, it sounds to=
 me like unfinished work which should not have been merged.



The "codepoints" of dummy encodings are just "bytes" and so they behave the=
 same as `Encoding::BINARY`, with the exception of the UTF-16 and UTF-32 du=
mmy encodings.



### UTF-16 and UTF-32 dummy encodings



These two are special dummy encodings.

What they do is they scan the first 2 or 4 bytes of the String, and if thos=
e bytes are a byte-order mark (BOM),

the true "actual" encoding is resolved to UTF-16BE/UTF-16LE or UTF-32BE/UTF=
-32LE.

Otherwise, `Encoding::BINARY` is returned.

This logic is done by `get_actual_encoding()`.



What is weird is this check is not done on String creation, no, it is done =
*every time* the encoding of that String is accessed (and the result is not=
 stored on the String).

That is a needless overhead and really unreliable semantics.

Do we really want a String which automagically changes between UTF-16LE and=
 UTF-16BE based on mutating its bytes? I think nobody wants that:

```ruby

s =3D "\xFF\xFEa\x00b\x00c\x00d\x00".force_encoding("UTF-16")

p s # =3D> "\uFEFFabcd"

s.setbyte 0, 254

s.setbyte 1, 255

p s # =3D> "\uFEFF\u6100\u6200\u6300\u6400"

```



I think the path is clear, we should deprecate and then remove Encoding::UT=
F_16 and Encoding::UTF_32 (dummy encodings).

And then we no longer need `get_actual_encoding()` and the overhead it adds=
 to every String method.



We could also keep those constants and make them refer the native-endian UT=
F-16/32.

But that could cause confusing errors as we would change the meaning of the=
m.

We could add `Encoding::UTF_16NE` / `Encoding::UTF_16_NATIVE_ENDIAN` if tha=
t is useful.



Another possibility would be to resolve these encodings on String creation,=
 like:

```

"\xFF\xFE".force_encoding("UTF-16").encoding # =3D> UTF-16LE

String.new("\xFF\xFE", encoding: Encoding::UTF_16).encoding # =3D> UTF-16LE

"ab".force_encoding("UTF-16").encoding # exception, not a BOM

String.new("ab", encoding: Encoding::UTF_16).encoding # exception, not a BOM

```

I think it is unnecessary to keep such complexity though.

A class method on String or Encoding like e.g. `Encoding.find_from_bom(stri=
ng)` is so much clearer and efficient (no need to special case those encodi=
ngs in String.new, #force_encoding, etc).



FWIW JRuby seems to use `getActualEncoding()` only in 2 places (scanForCode=
Range, inspect), which is an indication those dummy UTF encodings are barel=
y used if ever. Similarly, TruffleRuby only has 4 usages of `GetActualEncod=
ingNode`.



### Existing dummy encodings



```

> Encoding.list.select(&:dummy?)=20

[#<Encoding:UTF-16 (dummy)>,  #<Encoding:UTF-32 (dummy)>,

 #<Encoding:IBM037 (dummy)>, #<Encoding:UTF-7 (dummy)>,

 #<Encoding:ISO-2022-JP (dummy)>, #<Encoding:ISO-2022-JP-2 (dummy)>, #<Enco=
ding:ISO-2022-JP-KDDI (dummy)>,

 #<Encoding:CP50220 (dummy)>, #<Encoding:CP50221 (dummy)>]

```



So besides UTF-16/UTF-32 dummy, it's only 7 encodings.

Does anyone use one of these 7 dummy encodings?



What is interesting to note, is that these encodings are exactly the ones t=
hat are also not ASCII-compatible, with the exception of UTF-16BE/UTF-16LE/=
UTF-32BE/UTF-32LE (non-dummy).

As a note, UTF-{16,32}{BE,LE} are ASCII-compatible in codepoints but not in=
 bytes, and Ruby uses the bytes definition of ASCII-compatible.

There is potential to simplify encoding compatibility rules and encoding co=
mpatibility checks based on that.

So what this means is if we removed dummy encodings, all encodings except U=
TF-{16,32}{BE,LE} would be ASCII-compatible, which would lead to significan=
t simplifications for many string operations which currently need to handle=
 dummy encodings specially.

Unicode encodings like UTF-{16,32}{BE,LE} already have special behavior for=
 some Ruby methods, so those are already handled specially in some places (=
they are the only encodings with minLength > 1).



```

> Encoding.list.reject(&:ascii_compatible?)

[#<Encoding:UTF-16BE>, #<Encoding:UTF-16LE>,

 #<Encoding:UTF-32BE>, #<Encoding:UTF-32LE>,

 #<Encoding:UTF-16 (dummy)>, #<Encoding:UTF-32 (dummy)>,

 #<Encoding:IBM037 (dummy)>, #<Encoding:UTF-7 (dummy)>,

 #<Encoding:ISO-2022-JP (dummy)>, #<Encoding:ISO-2022-JP-2 (dummy)>, #<Enco=
ding:ISO-2022-JP-KDDI (dummy)>,

 #<Encoding:CP50220 (dummy)>, #<Encoding:CP50221 (dummy)>]

```



What can we do with such a dummy non-ASCII-compatible encoding?

Almost nothing useful:

```ruby

s =3D "abc".encode("IBM037")

=3D> "\x81\x82\x83"

> s.bytes

=3D> [129, 130, 131]

> s.codepoints

=3D> [129, 130, 131]

> s =3D=3D "abc"

=3D> false

> "=E9t=E9".encode("IBM037")

=3D> "\x51\xA3\x51"

```



So about the only thing that works with them is `String#encode`.



I think we could preserve that functionality, if actually used (does anyone=
 use one of these 7 dummy encodings?), through:

```ruby

> "=E9t=E9".encode("IBM037")

=3D> "\x51\xA3\x51" (.encoding =3D=3D BINARY)

> "\x51\xA3\x51".encode("UTF-8", "IBM037") # encode from IBM037 to UTF-8

=3D> "=E9t=E9" (.encoding =3D=3D UTF-8)

```



That way there is no need for those to be Encoding instances, we would only=
 need the conversion tables.



It is even better if we can remove them, so the notion of "dummy encodings"=
 can disappear completely and nobody needs to understand or implement them.



### rb_define_dummy_encoding(name)



The C-API has `rb_define_dummy_encoding(const char *name)`.

This creates a new Encoding instance with `dummy?=3Dtrue`, and it is also n=
on-ASCII-compatible.

There seems to be no purpose to this besides storing the metadata of an enc=
oding which does not exist in Ruby.

This seems a really expensive/complex way to handle that from the VM point =
of view (because it dynamically creates an Encoding and add it to lists/map=
s/etc).

A simple replacement would be to mark the String as BINARY and save the enc=
oding name as an instance variable of that String.

Since anyway Ruby can't understand anything about that String, it's just ra=
w bytes to Ruby's eyes.



## Summary



I suggest we deprecate replicate and dummy encodings in Ruby 3.2.

And then we remove them in the next version.



This will significantly simplify string-related methods, and the behavior e=
xposed to Ruby users.



It will also significantly speedup encoding lookup in CRuby (and other Ruby=
 implementations).

With a fixed number of encodings we can ensure all encoding indices fit in =
7 bits, and `ENCODING_GET` can be simply `RB_ENCODING_GET_INLINED`.

`get_actual_encoding()` will be gone and its overhead as well.

`rb_enc_from_index()` would be just `return global_enc_table->list[index].e=
nc;`, instead of the expensive behavior currently with `GLOBAL_ENC_TABLE_EV=
AL` which takes a lock and more when there are multiple Ractors.

Many checks in these methods would be removed as well.

Yet another improvement would be to load all encodings eagerly, that is sma=
ll and fast in my experience, what is slow and big is the conversion tables=
, that'd simplify `must_encindex()` further.

These changes would affect most String methods, which use

```

STR_ENC_GET->get_encoding which does:

  get_actual_encoding->rb_enc_from_index and possibly ->enc_from_index

  ENCODING_GET->RB_ENCODING_GET_INLINED and possibly ->rb_enc_get_index->en=
c_get_index_str->rb_attr_get

```

Some of these details are mentioned in https://github.com/ruby/ruby/pull/60=
95#discussion_r915149708.

The overhead is so large that it is worth handling some hardcoded encoding =
indices directly in String methods.

This feels wrong, getting the encoding from a String should be simple, stra=
ightforward and fast.



Further optimizations will be unlocked as the encoding list becomes fixed a=
nd immutable.

For example, the name-to-Encoding map is then immutable and could use perfe=
ct hashing.

Inline caching those lookups also becomes easier as the the map cannot chan=
ge.

Also that map would no longer need synchronization, etc.



## To Decide



Each item is independent. I think 1 & 2 are very important, 3 less but woul=
d be nice.



1. Deprecate and then remove `Encoding#replicate` and `rb_define_dummy_enco=
ding()`. With that there is a fixed number of encodings, a lot of simplific=
ations and many optimizations become available. They are used respectively =
in only 1 gem and 5 gems, see https://bugs.ruby-lang.org/issues/18949#note-4

2. Deprecate and then remove the dummy UTF-16 and UTF-32 encodings. This re=
moves the need for `get_actual_encoding()` which is expensive. This functio=
nality seems rarely used in practice, and it only works when such strings h=
ave a BOM, which is very rare.

3. Deprecate and then remove other dummy encodings, so there are no more du=
mmy "half-implemented" encodings and all encodings are ASCII-compatible in =
terms of codepoints.







--=20

https://bugs.ruby-lang.org/

 ______________________________________________
 ruby-core mailing list -- [e-mail]
 To unsubscribe send an email to [e-mail]
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-c=
ore.ml.ruby-lang.org/