[ruby-core:90606] [Ruby trunk Feature#15393] Add compilation flags to freeze Array and Hash literals

[223-322-223-322@mail.ru]

Issue #15393 has been updated by sergey-posokhov (Sergey Posokhov).

File frequency-1.rb added
File frequency-2.rb added

> I would like to add VM compilation options to freeze array and hash literals.  For example:

My two samples:

~~~ ruby
#!/usr/local/bin/ruby -w

def frequency(text)
  def prepare_string(text)
    text.gsub!(",", "")                            
        .split(" ")                              #
  end                                            # <-- freeze the result and return it
                                                 #
  def sort_frequency_report(fq)	
    fq.to_h
      .sort_by{|k, v| v }
      .reverse
      .to_h                                      #
  end                                            # <-- freeze the result and return it
                                                 #
  word_list = prepare_string(text)
  
  fq = Hash.new()
  
  for word in word_list
    if fq.has_key?(word)
      fq[word] += 1
    else
      fq[word] = 1
    end  
  end
                                                 #  
  sort_frequency_report(fq)                      # <-- freeze the result and return it
end                                              #

p frequency("text text text text
             text txet text text
             text text text")
~~~

And:

~~~ ruby
#!/usr/local/bin/ruby -w

def frequency(text)
  def prepare_string(text)
    text.gsub!(",", "")                            
        .split(" ")
  end

  def sort_frequency_report(fq)	
    #                                            #
    # fq = Hash.new()                            # Why?!.. is it correct?..
    #                                            #

    fq.to_h
      .sort_by{|k, v| v }
      .reverse
      .to_h
  end

  word_list = prepare_string(text)
  
  fq = Hash.new()
  
  for word in word_list
    if fq.has_key?(word)
      fq[word] += 1
    else
      fq[word] = 1
    end  
  end

  sort_frequency_report(fq)
end

p frequency("text text text text
             text txet text text
             text text text")
~~~


----------------------------------------
Feature #15393: Add compilation flags to freeze Array and Hash literals
https://bugs.ruby-lang.org/issues/15393#change-75765

* Author: tenderlovemaking (Aaron Patterson)
* Status: Open
* Priority: Normal
* Assignee: 
* Target version: 
----------------------------------------
Hi,

I would like to add VM compilation options to freeze array and hash literals.  For example:

~~~ ruby
frozen = RubyVM::InstructionSequence.compile(<<-eocode, __FILE__, nil, 0, frozen_string_literal: true, frozen_hash_and_array_literal: true)
  { 'a' => ['b', { 'c' => 'd' }] }
eocode
puts frozen.disasm
~~~

Output is:

~~~
$ ./ruby thing.rb
== disasm: #<ISeq:<compiled>@thing.rb:0 (0,0)-(0,34)> (catch: FALSE)
0000 putobject                    {"a"=>["b", {"c"=>"d"}]}
0002 leave
~~~

Anything nested in the hash that can't be "frozen" will cause it to not be frozen.

For example:

~~~ ruby
not_frozen = RubyVM::InstructionSequence.compile(<<-eocode, __FILE__, nil, 0, frozen_string_literal: true, frozen_hash_and_array_literal: true)
  { 'a' => some_method }
eocode
puts not_frozen.disasm
~~~

Output:

~~~
$ ./ruby thing.rb
== disasm: #<ISeq:<compiled>@thing.rb:0 (0,0)-(0,24)> (catch: FALSE)
0000 putobject                    "a"
0002 putself
0003 opt_send_without_block       <callinfo!mid:some_method, argc:0, FCALL|VCALL|ARGS_SIMPLE>, <callcache>
0006 newhash                      2
0008 leave
~~~

Eventually I would like to freeze array and hash literals in source code itself, but I think this is a good first step.

The reason I want this feature is I think we can reduce some object allocations, and once Guilds are implemented, easily create immutable data.

I've attached a patch that implements the above.

(Also I think maybe "frozen_literals" would be a better name, but I don't want to imply that numbers or booleans are frozen too)

Thanks!

---Files--------------------------------
frequency-1.rb (1.06 KB)
frequency-2.rb (775 Bytes)


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