SystemTimer 1.0

data/COPYING

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the 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 Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) 19yy  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) 19yy name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/ChangeLog

@@ -0,0 +1,4 @@
+=== 1.0.0 / 2008-02-27
+
+* Initial Release
+

data/LICENSE

@@ -0,0 +1,58 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README

@@ -0,0 +1,126 @@
+== Synopsis
+
+System Timer, a timer based on underlying SIGALRM system timers, is a
+solution to Ruby processes which hang beyond the time limit when accessing
+external resources. This is useful when timeout.rb, which relies on green
+threads, does not work consistently.
+
+== Usage
+
+  require 'systemtimer'
+
+  SystemTimer.timeout_after(5) do
+
+    # Something that should be interrupted if it takes too much time...
+    # ... even if blocked on a system call!
+
+  end
+
+== Requirements
+
+SystemTimer only works on UNIX platforms (Mac OS X, Linux, Solaris, BSD, ...).
+You can install the gem on Microsoft Windows, but you will only get 
+a convenience shell wrapping a simple call to timeout.rb under the cover.
+
+== Install
+
+    sudo gem install systemtimer
+
+
+== Authors
+
+* David Vollbracht  <http://davidvollbracht.com>
+* Philippe Hanrigou <http:/ph7spot.com>
+   
+== Copyright
+
+Copyright:: (C) 2008  David Vollbracht & Philippe Hanrigou
+
+== Description
+
+While deploying Rails application in production our team discovered
+that some web service call would not timeout way beyond their defined
+limit, progressively freezing our Mongrel cluster until we restarted
+the servers. A closer analysis revealed that the native thread in charge of
+of the web service call was never scheduled, "stucked" on the service
+call. As it turn out the timeout library bundled with Ruby 1.8 (MRI)
+relies on green-threads to perform its magic... so the magic had no chance
+to happen in this scenario.
+
+Based on an original idea by Kurtis Seebaldt <http://kseebaldt.blogspot.com>,
+David Vollbracht and Philippe Hanrigou pair programmed an alternative
+implementation based on system timers (the +SIGALRM+ POSIX signal):
+This design guarantees proper timeout behavior even when crossing-boundaries and accessing
+system/external resources. Special care has been taken to interfere as little as
+possible with other processes that might also rely on +SIGALRM+, 
+in particular MySQL.
+
+This implementation is not intended to be drop-in replacement to
+timeout.rb, just a way to wrap sensitive call to system resources.   
+
+
+== License
+
+(The Ruby License)
+
+Copyright:: (C) 2008  David Vollbracht & Philippe Hanrigou
+
+SystemTimer is copyrighted free software by David Vollbracht and Philippe Hanrigou.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+	      the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	      with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+
+

data/ext/system_timer/extconf.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'mkmf'
+create_makefile("system_timer_native")

data/ext/system_timer/system_timer_native.c

@@ -0,0 +1,217 @@
+#include "ruby.h"
+#include "rubysig.h"
+#include <signal.h>
+#include <errno.h>
+
+#define DISPLAY_ERRNO 	 		 1
+#define DO_NOT_DISPLAY_ERRNO 0
+
+VALUE rb_cSystemTimer;
+sigset_t original_mask;
+sigset_t sigalarm_mask;
+struct sigaction original_signal_handler;
+struct itimerval original_timer_interval;
+
+static void clear_pending_sigalrm_for_ruby_threads();
+static void log_debug(char*);
+static void log_error(char*, int);
+static void install_ruby_sigalrm_handler(VALUE);
+static void restore_original_ruby_sigalrm_handler(VALUE);
+static void restore_original_sigalrm_mask_when_blocked();
+static void restore_original_timer_interval();
+static void set_itimerval(struct itimerval *, int);
+
+static int debug_enabled = 0;
+
+static VALUE install_timer(VALUE self, VALUE seconds)
+{
+  struct itimerval timer_interval;
+
+	/*
+	 * Block SIG_ALRM for safe processing of SIG_ALRM configuration and save mask.
+	 */
+	if (0 != sigprocmask(SIG_BLOCK, &sigalarm_mask, &original_mask)) {
+		log_error("install_timer: Could not block SIG_ALRM", DISPLAY_ERRNO);
+		return Qnil;
+	}
+	clear_pending_sigalrm_for_ruby_threads();
+	log_debug("install_timer: Succesfully blocked SIG_ALRM at O.S. level");
+	
+  /*
+   * Save previous signal handler.
+   */
+	original_signal_handler.sa_handler = NULL;
+  if (0 != sigaction(SIGALRM, NULL, &original_signal_handler)) {
+		log_error("install_timer: Could not save existing handler for SIG_ALRM", DISPLAY_ERRNO);
+		restore_original_sigalrm_mask_when_blocked();
+		return Qnil;
+  }
+	log_debug("install_timer: Succesfully saved existing SIG_ALRM handler");
+
+	/*
+	 * Install Ruby Level SIG_ALRM handler
+	 */
+	install_ruby_sigalrm_handler(self);
+
+  /*
+   * Set new real time interval timer and save the original if any.
+   */	
+	set_itimerval(&original_timer_interval, 0);
+  set_itimerval(&timer_interval, NUM2INT(seconds));
+  if (0 != setitimer(ITIMER_REAL, &timer_interval, &original_timer_interval)) {
+		log_error("install_timer: Could not install our own timer, timeout will not work", DISPLAY_ERRNO);
+		restore_original_ruby_sigalrm_handler(self);
+		restore_original_sigalrm_mask_when_blocked();
+	  return Qnil;
+  }
+	log_debug("install_timer: Successfully installed timer");
+
+  /*
+   * Unblock SIG_ALRM
+   */
+	if (0 != sigprocmask(SIG_UNBLOCK, &sigalarm_mask, NULL)) {
+		log_error("install_timer: Could not unblock SIG_ALRM, timeout will not work", DISPLAY_ERRNO);
+		restore_original_timer_interval();
+		restore_original_ruby_sigalrm_handler(self);
+		restore_original_sigalrm_mask_when_blocked();		
+	}
+	log_debug("install_timer: Succesfully unblocked SIG_ALRM.");
+
+	return Qnil;
+}
+
+static VALUE cleanup_timer(VALUE self, VALUE seconds)
+{
+	/*
+	 * Block SIG_ALRM for safe processing of SIG_ALRM configuration.
+	 */
+	if (0 != sigprocmask(SIG_BLOCK, &sigalarm_mask, NULL)) {
+		log_error("cleanup_timer: Could not block SIG_ALRM", errno);
+	}
+	clear_pending_sigalrm_for_ruby_threads();
+	log_debug("cleanup_timer: Blocked SIG_ALRM");
+
+	/*
+	 * Install Ruby Level SIG_ALRM handler
+	 */
+	restore_original_ruby_sigalrm_handler(self);
+	
+	
+	if (original_signal_handler.sa_handler == NULL) {
+		log_error("cleanup_timer: Previous SIG_ALRM handler not initialized!", DO_NOT_DISPLAY_ERRNO);
+	} else if (0 == sigaction(SIGALRM, &original_signal_handler, NULL)) {
+		log_debug("cleanup_timer: Succesfully restored previous handler for SIG_ALRM");
+  } else {
+		log_error("cleanup_timer: Could not restore previous handler for SIG_ALRM", DISPLAY_ERRNO);
+	}
+	original_signal_handler.sa_handler = NULL;
+	
+	restore_original_timer_interval();	
+	restore_original_sigalrm_mask_when_blocked();	
+}
+
+/*
+ * Restore original timer the way it was originally set. **WARNING** Breaks original timer semantics
+ *
+ *   Not bothering to calculate how much time is left or if the timer already expired
+ *   based on when the original timer was set and how much time is passed, just resetting 
+ *   the original timer as is for the sake of simplicity.
+ *
+ */
+static void restore_original_timer_interval() {
+  if (0 != setitimer (ITIMER_REAL, &original_timer_interval, NULL)) {
+		log_error("install_timer: Could not restore original timer", DISPLAY_ERRNO);
+  }
+	log_debug("install_timer: Successfully restored timer");	
+}
+
+static void restore_original_sigalrm_mask_when_blocked() 
+{
+	if (!sigismember(&original_mask, SIGALRM)) {
+		sigprocmask(SIG_UNBLOCK, &sigalarm_mask, NULL);
+		log_debug("cleanup_timer: Unblocked SIG_ALRM");
+	} else {
+		log_debug("cleanup_timer: No Need to unblock SIG_ALRM");
+	}	
+}
+
+static void install_ruby_sigalrm_handler(VALUE self) {
+  rb_thread_critical = 1;
+	rb_funcall(self, rb_intern("install_ruby_sigalrm_handler"), 0);
+	rb_thread_critical = 0;
+}
+
+static void restore_original_ruby_sigalrm_handler(VALUE self) {
+  rb_thread_critical = 1;
+	rb_funcall(self, rb_intern("restore_original_ruby_sigalrm_handler"), 0);
+  rb_thread_critical = 0;
+}
+
+
+static VALUE debug_enabled_p(VALUE self) {
+	return debug_enabled ? Qtrue : Qfalse;
+}
+
+static VALUE enable_debug(VALUE self) {
+	debug_enabled = 1;
+	return Qnil;
+}
+
+static VALUE disable_debug(VALUE self) {
+	debug_enabled = 0;
+	return Qnil;	
+}
+
+static void log_debug(char* message) 
+{
+	if (0 != debug_enabled) {
+		printf("%s\n", message);
+	}
+	return;
+}
+
+static void log_error(char* message, int display_errno)
+{
+	fprintf(stderr, "%s: %s\n", message, display_errno ? strerror(errno) : "");
+	return;
+}
+
+/*
+ * The intent is to clear SIG_ALRM signals at the Ruby level (green threads),
+ * eventually triggering existing SIG_ALRM handler as a courtesy.
+ * 
+ * As we cannot access trap_pending_list outside of signal.c our best fallback option
+ * is to trigger all pending signals at the Ruby level (potentially triggering
+ * green thread scheduling).
+ */
+static void clear_pending_sigalrm_for_ruby_threads()
+{
+	CHECK_INTS;
+	log_debug("Succesfully triggered all pending signals at Green Thread level");
+}
+
+static void init_sigalarm_mask() 
+{
+	sigemptyset(&sigalarm_mask);
+	sigaddset(&sigalarm_mask, SIGALRM);
+	return;
+}
+
+static void set_itimerval(struct itimerval *value, int seconds) {
+	value->it_interval.tv_usec = 0;
+  value->it_interval.tv_sec = 0;
+	value->it_value.tv_usec = 0;
+  value->it_value.tv_sec = seconds; // (long int) 
+	return;
+}
+
+void Init_system_timer_native() 
+{
+	init_sigalarm_mask();
+  rb_cSystemTimer = rb_define_module("SystemTimer");
+	rb_define_singleton_method(rb_cSystemTimer, "install_timer", 	install_timer, 1);
+	rb_define_singleton_method(rb_cSystemTimer, "cleanup_timer", 	cleanup_timer, 0);
+	rb_define_singleton_method(rb_cSystemTimer, "debug_enabled?", debug_enabled_p, 0);
+	rb_define_singleton_method(rb_cSystemTimer, "enable_debug", 	enable_debug, 0);
+	rb_define_singleton_method(rb_cSystemTimer, "disable_debug",	disable_debug, 0);
+}

data/lib/system_timer.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'timeout'
+
+# Timer based on underlying SIGALRM system timers, is a
+# solution to Ruby processes which hang beyond the time limit when accessing
+# external resources. This is useful when timeout.rb, which relies on green
+# threads, does not work consistently.
+#
+# == Usage
+#
+#   require 'systemtimer'
+#
+#   SystemTimer.timeout_after(5) do
+#
+#     # Something that should be interrupted if it takes too much time...
+#     # ... even if blocked on a system call!
+#
+#   end
+#
+module SystemTimer 
+ class << self
+   
+   # Executes the method's block. If the block execution terminates before 
+   # +seconds+ seconds has passed, it returns true. If not, it terminates 
+   # the execution and raises a +Timeout::Error+.
+   def timeout_after(seconds)
+     install_timer(seconds)
+     return yield
+   ensure
+     cleanup_timer
+   end
+
+   # Backward compatibility with timeout.rb
+   alias timeout timeout_after 
+   
+   protected
+   
+   def install_ruby_sigalrm_handler                 #:nodoc:
+     timed_thread = Thread.current  # Ruby signals are always delivered to main thread by default.
+     @original_ruby_sigalrm_handler = trap('SIGALRM') do
+        log_timeout_received(timed_thread) if SystemTimer.debug_enabled?
+        timed_thread.raise Timeout::Error.new("time's up!")
+      end
+   end
+  
+   def restore_original_ruby_sigalrm_handler        #:nodoc:
+     trap('SIGALRM', original_ruby_sigalrm_handler || 'DEFAULT')
+   ensure
+     reset_original_ruby_sigalrm_handler
+   end
+   
+   def original_ruby_sigalrm_handler               #:nodoc:
+     @original_ruby_sigalrm_handler
+   end
+ 
+   def reset_original_ruby_sigalrm_handler         #:nodoc:
+     @original_ruby_sigalrm_handler = nil
+   end
+
+   def log_timeout_received(timed_thread)          #:nodoc:
+     puts <<-EOS
+       install_ruby_sigalrm_handler: Got Timeout in #{Thread.current}
+           Main thread  : #{Thread.main}
+           Timed_thread : #{timed_thread}
+           All Threads  : #{Thread.list.inspect}
+     EOS
+   end
+ end
+
+end
+
+require 'system_timer_native'

data/lib/system_timer_stub.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'timeout'
+
+module SystemTimer 
+ class << self
+
+   def timeout_after(seconds)
+     Timeout::timeout(seconds) do
+       yield
+     end
+   end
+   
+ end
+ 
+end

data/test/all_tests.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname __FILE__}/*_test.rb"].each { |test_case| require test_case }

data/test/system_timer_test.rb

@@ -0,0 +1,121 @@
+# $: << File.dirname(__FILE__) + '/../ext/xray'
+ $: << File.dirname(__FILE__) + '/../lib'
+ $: << File.dirname(__FILE__) + '/../ext/system_timer'
+ $: << File.dirname(__FILE__) + "/../../../vendor/gems/dust-0.1.4/lib"
+ $: << File.dirname(__FILE__) + "/../../../vendor/gems/mocha-0.5.3/lib"
+require 'test/unit'
+require 'system_timer'
+require 'dust'
+require 'mocha'
+require 'stringio'
+
+functional_tests do
+      
+  test "original_ruby_sigalrm_handler is nil after reset" do
+    SystemTimer.send(:install_ruby_sigalrm_handler)
+    SystemTimer.send(:reset_original_ruby_sigalrm_handler)
+    assert_nil SystemTimer.send(:original_ruby_sigalrm_handler)
+  end  
+  
+  test "original_ruby_sigalrm_handler is set to existing handler after install_ruby_sigalrm_handler" do
+    SystemTimer.expects(:trap).with('SIGALRM').returns(:an_existing_handler)
+    SystemTimer.send(:install_ruby_sigalrm_handler)
+    assert_equal :an_existing_handler, SystemTimer.send(:original_ruby_sigalrm_handler)
+  end
+  
+  test "restore_original_ruby_sigalrm_handler traps sigalrm using original_ruby_sigalrm_handler" do
+    SystemTimer.stubs(:original_ruby_sigalrm_handler).returns(:the_original_handler)
+    SystemTimer.expects(:trap).with('SIGALRM', :the_original_handler)
+    SystemTimer.send :restore_original_ruby_sigalrm_handler
+  end  
+
+  test "restore_original_ruby_sigalrm_handler resets original_ruby_sigalrm_handler" do
+    SystemTimer.stubs(:trap)
+    SystemTimer.expects(:reset_original_ruby_sigalrm_handler)
+    SystemTimer.send :restore_original_ruby_sigalrm_handler
+  end  
+
+  test "restore_original_ruby_sigalrm_handler reset SIGALRM handler to default when original_ruby_sigalrm_handler is nil" do
+    SystemTimer.stubs(:original_ruby_sigalrm_handler)
+    SystemTimer.expects(:trap).with('SIGALRM', 'DEFAULT')
+    SystemTimer.stubs(:reset_original_ruby_sigalrm_handler)
+    SystemTimer.send :restore_original_ruby_sigalrm_handler
+  end  
+  
+  test "restore_original_ruby_sigalrm_handler resets original_ruby_sigalrm_handler when trap raises" do
+    SystemTimer.stubs(:trap).returns(:the_original_handler)
+    SystemTimer.send(:install_ruby_sigalrm_handler)
+    SystemTimer.expects(:trap).raises("next time maybe...")
+    SystemTimer.expects(:reset_original_ruby_sigalrm_handler)
+
+    SystemTimer.send(:restore_original_ruby_sigalrm_handler) rescue nil
+  end  
+
+  test "timeout_after raises TimeoutError if block takes too long" do
+    assert_raises(Timeout::Error) do
+      SystemTimer.timeout_after(1) {sleep 5}
+    end
+  end
+  
+  test "timeout_after does not raises Timeout Error if block completes in time" do
+    SystemTimer.timeout_after(5) {sleep 1}
+  end
+  
+  test "timeout_after returns the value returned by the black" do
+    assert_equal :block_value, SystemTimer.timeout_after(1) {:block_value}
+  end
+
+  test "timeout_after raises TimeoutError in thread that called timeout_after" do
+    raised_thread = nil
+    other_thread = Thread.new do 
+      begin
+        SystemTimer.timeout_after(1) {sleep 5}
+        flunk "Should have timed out"
+      rescue Timeout::Error
+        raised_thread = Thread.current
+      end
+    end
+    
+    other_thread.join 
+    assert_equal other_thread, raised_thread
+  end
+  
+  test "cancelling a timer that was installed restores previous ruby handler for SIG_ALRM" do    
+    begin
+      fake_original_ruby_handler = proc {}
+      initial_ruby_handler = trap "SIGALRM", fake_original_ruby_handler
+      SystemTimer.install_timer(3)
+      SystemTimer.cleanup_timer
+      assert_equal fake_original_ruby_handler, trap("SIGALRM", "IGNORE")    
+    ensure  # avoid interfering with test infrastructure
+      trap("SIGALRM", initial_ruby_handler) if initial_ruby_handler  
+    end
+  end
+   
+  test "debug_enabled returns true after enabling debug" do
+    begin
+      SystemTimer.disable_debug
+      SystemTimer.enable_debug
+      assert_equal true, SystemTimer.debug_enabled?
+    ensure
+      SystemTimer.disable_debug
+    end
+  end 
+  
+  test "debug_enabled returns false after disable debug" do
+    begin
+      SystemTimer.enable_debug
+      SystemTimer.disable_debug
+      assert_equal false, SystemTimer.debug_enabled?
+    ensure
+      SystemTimer.disable_debug
+    end 
+  end
+  
+  test "timeout offers an API fully compatible with timeout.rb" do
+    assert_raises(Timeout::Error) do
+      SystemTimer.timeout(1) {sleep 5}
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: SystemTimer
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: []
+
+autorequire: system_timer
+bindir: bin
+cert_chain: []
+
+date: 2008-05-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: 
+- ext/system_timer/extconf.rb
+extra_rdoc_files: 
+- README
+files: 
+- COPYING
+- LICENSE
+- ChangeLog
+- ext/system_timer/system_timer_native.c
+- ext/system_timer/extconf.rb
+- lib/system_timer.rb
+- lib/system_timer_stub.rb
+- test/all_tests.rb
+- test/system_timer_test.rb
+- README
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --title
+- SystemTimer
+- --main
+- README
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Set a Timeout based on signals, which are more reliable than Timeout. Timeout is based on green threads.
+test_files: 
+- test/all_tests.rb