timeout-interrupt 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'ffi-libc'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda"
+  gem "yard"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    ffi (1.1.0)
+    ffi-libc (0.0.5)
+      ffi (>= 0.6.0, <= 1.1.0)
+    git (1.2.5)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.6.1)
+    rake (10.0.3)
+    rdoc (4.0.0)
+      json (~> 1.4)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    yard (0.8.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  ffi-libc
+  jeweler
+  rdoc
+  shoulda
+  simplecov
+  yard

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,17 @@
+timeout-interrupt
+=================
+
+Works like ruby's timeout, but interrupts every call, also syscalls, which blocks the hole ruby-process.
+
+It uses POSIX's alarm and traps ALRM-signals.
+
+Known limitations bacause of alarm and ALRM are, that you can not use alarm or trap ALRM.
+
+Do not forget, syscall can have allocated memory.
+If you interrupt a call, which can not free his allocations, you will have a memory leak.
+So, use it only, if your process did not live any longer or if you call something, which never allocate mem
+
+Copyleft
+=========
+
+Copyright (c) 2013 Denis Knauf. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "timeout-interrupt"
+  gem.homepage = "http://github.com/DenisKnauf/ruby-timeout-interrupt"
+  gem.license = "AGPLv3"
+  gem.summary = %Q{"Interrupts systemcalls too."}
+  gem.description = %Q{Timeout-lib, which interrupts everything, also systemcalls. It uses libc-alarm.}
+  gem.email = "Denis.Knauf@gmail.com"
+  gem.authors = ["Denis Knauf"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'simplecov'
+#Rcov::RcovTask.new do |test|
+  #test.libs << 'test'
+  #test.pattern = 'test/**/test_*.rb'
+  #test.verbose = true
+  #test.rcov_opts << '--exclude "gems/*"'
+#end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/timeout_interrupt.rb

@@ -0,0 +1,49 @@
+require 'ffi/libc'
+require 'timeout'
+
+module FFI
+	module LibC
+		attach_function :alarm, [:uint], :uint  unless FFI::LibC.respond_to? :alarm
+	end
+end
+
+module TimeoutInterrupt
+	def self.timeouts
+		@timeouts ||= {}
+	end
+
+	def self.alarm_trap sig
+		key, (at, bt) = TimeoutInterrupt.timeouts.min_by {|key,(at,bt)| at }
+		return  if Time.now < at
+		raise Timeout::Error, 'execution expired', bt
+	end
+
+	def self.setup_timeout
+		if TimeoutInterrupt.timeouts.empty?
+			Signal.trap( 'ALRM') {}
+			FFI::LibC.alarm 0
+		else
+			key, (at, bt) = TimeoutInterrupt.timeouts.min_by {|key,(at,bt)| at }
+			secs = (at - Time.now).to_i+1
+			TimeoutInterrupt.alarm_trap  if 1 > secs
+			Signal.trap 'ALRM', &TimeoutInterrupt.method( :alarm_trap)
+			FFI::LibC.alarm secs
+		end
+	end
+
+	def self.timeout seconds
+		seconds = seconds.to_i
+		raise Timeout::Error, "Timeout must be longer than '0' seconds."  unless 0 < seconds
+		return lambda {|&e| self.timeout seconds, &e }  unless block_given?
+		at = Time.now + seconds
+		key, bt = Random.rand( 2**64-1), Kernel.caller
+		begin
+			TimeoutInterrupt.timeouts[key] = [at, bt]
+			TimeoutInterrupt.setup_timeout
+			yield
+		ensure
+			TimeoutInterrupt.timeouts.delete key
+			TimeoutInterrupt.setup_timeout
+		end
+	end
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+require 'timeout'
+require 'benchmark'
+require 'ffi/libc'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'timeout_interrupt'
+
+class Test::Unit::TestCase
+end

data/test/test_ruby-timeout-interrupt.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+class TestRubyTimeoutInterrupt < Test::Unit::TestCase
+	def blocking
+		t = FFI::LibC.fopen '/dev/ptmx', 'r'
+		b = FFI::LibC.malloc 1025
+		s = FFI::LibC.fread b, 1, 1024, t
+	ensure
+		FFI::LibC.fclose t  if t
+		FFI::LibC.free b    if b
+	end
+
+	def assert_no_defined_timeout_yet
+		assert TimeoutInterrupt.timeouts.empty?, "For testing, no timeout should be defined, yet!"
+	end
+
+	should "not interrupt a long blocking call with the old Timeout" do
+		time = Benchmark.realtime do
+			begin
+				TimeoutInterrupt.timeout(5) do
+					Timeout.timeout(1) do
+						blocking
+						assert false, "Should be unreachable!"
+					end
+				end
+			rescue Timeout::Error
+				:ok
+			end
+		end
+		assert 3 < time, "Did timeout!"
+	end
+
+	should "interrupt a long blocking call with the new TimeoutInterrupt" do
+		time = Benchmark.realtime do
+			begin
+				TimeoutInterrupt.timeout(1) do
+					blocking
+					assert false, "Should be unreachable!"
+				end
+			rescue Timeout::Error
+				:ok
+			end
+		end
+		assert 3 > time, "Did not interrupt."
+	end
+
+	should "interrupt scoped timeout, but not outer timeout" do
+		assert_no_defined_timeout_yet
+		begin
+			TimeoutInterrupt.timeout(10) do
+				TimeoutInterrupt.timeout(1) do
+					Kernel.sleep 2
+				end
+				assert false, "Should be unreachable!"
+			end
+		rescue Timeout::Error
+			:ok
+		end
+		assert TimeoutInterrupt.timeouts.empty?, "There are timeouts defined, yet!"
+	end
+
+	should "clear timeouts, if not timed out, too." do
+		assert_no_defined_timeout_yet
+		TimeoutInterrupt.timeout(10) {}
+		assert TimeoutInterrupt.timeouts.empty?, "There are timeouts defined, yet!"
+	end
+
+	should "return a Proc if now block given, but do not create a timeout." do
+		assert_no_defined_timeout_yet
+		assert TimeoutInterrupt.timeout(10).kind_of?( Proc), "Did not return a Proc."
+	end
+
+	should "run a returned Proc with given timeout." do
+		assert_no_defined_timeout_yet
+		to = TimeoutInterrupt.timeout(10)
+		called = false
+		to.call { called = true }
+		assert called, "Did not called."
+	end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: timeout-interrupt
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Denis Knauf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-libc
+  requirement: &72349180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *72349180
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &72348250 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72348250
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &72367400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72367400
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &72364150 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72364150
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &72360610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72360610
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &72357200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72357200
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &72355990 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72355990
+description: Timeout-lib, which interrupts everything, also systemcalls. It uses libc-alarm.
+email: Denis.Knauf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/timeout_interrupt.rb
+- test/helper.rb
+- test/test_ruby-timeout-interrupt.rb
+homepage: http://github.com/DenisKnauf/ruby-timeout-interrupt
+licenses:
+- AGPLv3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -502487251
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: ! '"Interrupts systemcalls too."'
+test_files: []