stopgap_13632 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24c31b0438ffbdc89e3e80b5bb7f49d1de13e361
+  data.tar.gz: c08119667058a4f92dae3b5510b0ef03afdcc47f
+SHA512:
+  metadata.gz: 91ace3348ffa796061f0cdb22edd895837f678c0bccf51605d91e27e0ffb55adbf4a659427ec33369abd23e7552a72337447cf4349a4108262f788f40b29d256
+  data.tar.gz: 88f906e4342376151cfa8706bda38fc48c626c97ff2a33c6bb71048830ea4f0dee91d542b0cfe12ae2a9f0b6e331a29376fecba67484e6d3fb0c6255b2c664a6

data/.gitignore

@@ -0,0 +1,6 @@
+*.so
+.idea/
+*.gem
+.ruby-version
+tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+before_script: bundle exec rake compile
+script: bundle exec rake test
+branches:
+  only: [master]
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nikolay Vashchenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+## Description
+Ruby gem temporary stopgap workaround for MRI Ruby versions 2.2.7, 2.3.4, 2.4.1 for the bug https://bugs.ruby-lang.org/issues/13632 until proper fix gets backported.
+
+## Installation
+```ruby
+gem install stopgap_13632
+require 'stopgap_13632'
+```
+
+## Usage
+And when an "IOError: stream closed" happens in a thread, accessing a busy IO:
+```
+rescue IOError
+  Thread.current.purge_interrupt_queue
+end
+```
+It will unblock the thread and allow it to proceed.
+
+## Contributing
+```bash
+rake compile
+rake test
+```
+
+## CI
+[![Build Status](https://secure.travis-ci.org/NickolasVashchenko/stopgap_13632.svg)](http://travis-ci.org/NickolasVashchenko/stopgap_13632)
+[![Build Status](https://ci.appveyor.com/api/projects/status/cqgu4tce6of44c9x?svg=true)](https://ci.appveyor.com/api/projects/status/cqgu4tce6of44c9x?svg=true)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/extensiontask'
+require 'rake/testtask'
+
+spec = Gem::Specification.load('stopgap_13632.gemspec')
+Rake::ExtensionTask.new('stopgap_13632', spec)
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/test_*.rb'
+end

data/appveyor.yml

@@ -0,0 +1,22 @@
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - SET PATH=C:\MinGW\bin;%PATH%
+  - SET RAKEOPT=-rdevkit
+  - ruby --version
+  - gem --version
+  - bundle install
+  - bundle exec rake compile
+
+build: off
+
+test_script:
+  - bundle exec rake test
+
+environment:
+  matrix:
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
+
+branches:
+  only:
+    - master

data/ext/stopgap_13632/extconf.rb

@@ -0,0 +1,13 @@
+require 'mkmf'
+
+extension_name = 'stopgap_13632'
+
+dir_config(extension_name)
+
+BROKEN_VERSIONS = %w(2.2.7 2.3.4 2.4.1)
+if (BROKEN_VERSIONS.include? RUBY_VERSION)
+  $defs << '-DBROKEN_RUBY'
+  $defs << "-DVERSION_#{RUBY_VERSION.gsub('.', '_')}"
+end
+
+create_makefile(extension_name )

data/ext/stopgap_13632/stopgap_13632.c

@@ -0,0 +1,91 @@
+#ifdef BROKEN_RUBY
+#include "ruby.h"
+#include "ruby/config.h"
+
+struct common_field {
+	const size_t len;
+	const char *name;
+  int raw;
+	VALUE value;
+};
+
+enum enum4 {
+    status1,
+    status2,
+    status3,
+    status4
+};
+
+#if defined(_WIN32)
+#include <windows.h>
+typedef HANDLE rb_nativethread_id_t;
+#else
+#include <pthread.h>
+typedef pthread_t rb_nativethread_id_t;
+#endif
+
+typedef struct half_thread {
+    void *vmlt_node1;
+    void *vmlt_node2;
+    void *self;
+    void *vm;
+    void *stack;
+    size_t stack_size;
+    void *cfp;
+    int safe_level;
+    int raised_flag;
+    void *last_status;
+    int state;
+    int waiting_fd;
+    void *passed_block;
+    void *passed_bmethod_me;
+    void *passed_ci_or_calling;
+    void *top_self;
+    void *top_wrapper;
+    #ifndef VERSION_2_4_1
+        void *base_block;
+    #endif
+    void *root_lep;
+    void *root_svar;
+    rb_nativethread_id_t thread_id;
+#ifdef NON_SCALAR_THREAD_ID
+    char thread_id_string[sizeof(rb_nativethread_id_t) * 2 + 3];
+#endif
+    enum enum4 status;
+    int to_kill;
+    int priority;
+#if defined(_WIN32)
+    void *interrupt_event;
+#elif defined(HAVE_PTHREAD_H)
+    void *ubf_list1_or_signal_thread_list;
+#ifndef VERSION_2_2_7
+    void *ubf_list2;
+#endif
+    pthread_cond_t cond;
+#ifdef HAVE_CLOCKID_T
+    clockid_t clockid;
+#endif
+#endif
+    void *blocking_region_buffer;
+    void *thgroup;
+    void *value;
+    void *errinfo;
+    VALUE pending_interrupt_queue;
+    void *pending_interrupt_mask_stack;
+    int pending_interrupt_queue_checked;
+} rb_half_thread_t;
+
+VALUE
+rb_thread_purge_queue(VALUE thread)
+{
+    rb_half_thread_t *th = (rb_half_thread_t*)DATA_PTR(thread);
+    th->pending_interrupt_queue_checked = 1;
+    rb_ary_clear(th->pending_interrupt_queue);
+    return Qnil;
+}
+
+void Init_stopgap_13632()
+{
+  rb_define_method(rb_cThread, "purge_interrupt_queue", rb_thread_purge_queue, 0);
+}
+#endif

data/stopgap_13632.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = 'stopgap_13632'
+  s.version = '1.0.0.beta'
+  s.authors = ['Nikolay Vashchenko']
+  s.description = 'Temporary stopgap workaround for MRI Ruby versions 2.2.7, 2.3.4, 2.4.1 for the bug https://bugs.ruby-lang.org/issues/13632 until it gets backported'
+  s.summary = 'Temporary solution for https://bugs.ruby-lang.org/issues/13632'
+  s.email = 'sir.nickolas@gmail.com'
+  s.extensions = ['ext/stopgap_13632/extconf.rb']
+  s.files = `git ls-files`.split($/)
+  s.homepage = 'https://github.com/NickolasVashchenko/stopgap_13632'
+  s.license = 'MIT'
+  s.platform = 'ruby' # Installable only for MRI
+  s.required_ruby_version = '> 2.2.6', '< 2.4.2'
+  s.add_development_dependency 'rake-compiler', '~> 1.0'
+  s.add_development_dependency 'minitest', '~> 5.8'
+end

data/test/test_stopgap_13632.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require_relative '../lib/stopgap_13632'
+
+Thread.abort_on_exception = true
+
+class Stopgap13632Test < Minitest::Test
+
+  def test_concurrent_io_access
+    pipes = []
+    threads = []
+    100.times do
+      r, w = IO.pipe
+      pipes << [r, w]
+      threads << Thread.new do
+        while r.gets
+        end rescue IOError
+        if Thread.current.pending_interrupt?
+          assert Thread.current.respond_to? (:purge_interrupt_queue), "The bug detected for version #{RUBY_VERSION}"
+          Thread.current.purge_interrupt_queue
+          assert !Thread.current.pending_interrupt?, 'Workaround failed'
+        end
+      end
+    end
+    pipes.each do |r, w|
+      w.puts 'test'
+      w.close
+      r.close
+    end
+    threads.each do |th|
+      th.join
+    end
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: stopgap_13632
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Nikolay Vashchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: Temporary stopgap workaround for MRI Ruby versions 2.2.7, 2.3.4, 2.4.1
+  for the bug https://bugs.ruby-lang.org/issues/13632 until it gets backported
+email: sir.nickolas@gmail.com
+executables: []
+extensions:
+- ext/stopgap_13632/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- appveyor.yml
+- ext/stopgap_13632/extconf.rb
+- ext/stopgap_13632/stopgap_13632.c
+- lib/.keep
+- stopgap_13632.gemspec
+- test/test_stopgap_13632.rb
+homepage: https://github.com/NickolasVashchenko/stopgap_13632
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 2.2.6
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 2.4.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Temporary solution for https://bugs.ruby-lang.org/issues/13632
+test_files: []