vondruch / rpms / ruby

Forked from rpms/ruby 6 years ago
Clone

c2026da Disable Fiddle test cases making use of FFI closure.

Authored and Committed by jackorp 2 years ago
1 file changed. 8 lines added. 1 lines removed.
    Disable Fiddle test cases making use of FFI closure.
    
    Fiddle::Closure object is making use of FFI closure
    from libffi. When such object is created (instantiated) in Ruby,
    and then the process forks on an SELinux-enabled system, the memory
    will become corrupted. That is usually not a problem until the
    The garbage collector sweeps the object and tries to free it, in which case the
    Ruby process will fail with signal SIGABRT.
    
    Tests in test/fiddle/test_closure.rb, test/fiddle/test_func.rb,
    and test/fiddle/test_function.rb use the `Fiddle::Closure` class
    directly and fiddle/test_import.rb use the class indirectly through
    `bind_function` method, therefore they are disabled to prevent
    introducing the problematic object into the Ruby GC during test suite
    execution instead of relying on that fork and subsequent
    garbage collection will not happen.
    
    If an FFI closure object is allocated in Ruby
    and the `fork` function is used afterward, the memory
    pointing to the closure gets corrupted, and if Ruby GC
    tries to collect the object in that state, a SIGABRT
    error occurs.
    
    The minimal Ruby reproducer for the issue is the following:
    ~~~
    $ cat fiddle_fork.rb
    require 'fiddle/closure'
    require 'fiddle/struct'
    
    Fiddle::Closure.new(Fiddle::TYPE_VOID, [])
    
    fork { }
    
    GC.start
    ~~~
    
    We allocate an unused Closure object,
    so it is free for the GC to pick up. Before we call `GC.start`
    we fork the process as that corrupts the memory.
    
    Running this with ruby-3.1.2-167.fc37.x86_64 on SELinux enabled system:
    ~~~
    $ ruby fiddle_fork.rb
    Aborted (core dumped)
    ~~~
    
    Such issues may appear at random (depending on the use of forking and GC)
    in larger applications that use Fiddle::Closure but can be spotted by the
    following functions appearing in the coredump backtrace:
    ~~~
    0x00007f6284d3e5b3 in dlfree (mem=<optimized out>) at ../src/dlmalloc.c:4350
    0x00007f6284d6d0b1 in dealloc () from /usr/lib64/ruby/fiddle.so
    0x00007f6295e432ec in finalize_list () from /lib64/libruby.so.3.1
    0x00007f6295e43420 in finalize_deferred.lto_priv () from /lib64/libruby.so.3.1
    0x00007f6295e4ff1c in gc_start_internal.lto_priv () from /lib64/libruby.so.3.1
    ~~~
    
    Possible solutions to prevent Ruby from crashing:
    * Do not use Fiddle::Closure.
    * Use the Fiddle::Closure object only in isolated subprocess that
      will not fork further.
    * Enable static trampolines in libffi as noted in bugzilla comment:
      <https://bugzilla.redhat.com/show_bug.cgi?id=2040380#c9>
    
    See related discussion on
    <https://bugzilla.redhat.com/show_bug.cgi?id=2040380>
    
    Ruby upstream ticket:
    <https://bugs.ruby-lang.org/issues/18914>
    
    Ruby Fiddle ticket:
    <https://github.com/ruby/fiddle/issues/102>
    
        
file modified
+8 -1