SystemTimer 1.0

Sign up to get free protection for your applications and to get access to all the features.
data/COPYING ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) 19yy <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) 19yy name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
@@ -0,0 +1,4 @@
1
+ === 1.0.0 / 2008-02-27
2
+
3
+ * Initial Release
4
+
data/LICENSE ADDED
@@ -0,0 +1,58 @@
1
+ Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
2
+ You can redistribute it and/or modify it under either the terms of the GPL
3
+ (see COPYING.txt file), or the conditions below:
4
+
5
+ 1. You may make and give away verbatim copies of the source form of the
6
+ software without restriction, provided that you duplicate all of the
7
+ original copyright notices and associated disclaimers.
8
+
9
+ 2. You may modify your copy of the software in any way, provided that
10
+ you do at least ONE of the following:
11
+
12
+ a) place your modifications in the Public Domain or otherwise
13
+ make them Freely Available, such as by posting said
14
+ modifications to Usenet or an equivalent medium, or by allowing
15
+ the author to include your modifications in the software.
16
+
17
+ b) use the modified software only within your corporation or
18
+ organization.
19
+
20
+ c) rename any non-standard executables so the names do not conflict
21
+ with standard executables, which must also be provided.
22
+
23
+ d) make other distribution arrangements with the author.
24
+
25
+ 3. You may distribute the software in object code or executable
26
+ form, provided that you do at least ONE of the following:
27
+
28
+ a) distribute the executables and library files of the software,
29
+ together with instructions (in the manual page or equivalent)
30
+ on where to get the original distribution.
31
+
32
+ b) accompany the distribution with the machine-readable source of
33
+ the software.
34
+
35
+ c) give non-standard executables non-standard names, with
36
+ instructions on where to get the original software distribution.
37
+
38
+ d) make other distribution arrangements with the author.
39
+
40
+ 4. You may modify and include the part of the software into any other
41
+ software (possibly commercial). But some files in the distribution
42
+ are not written by the author, so that they are not under this terms.
43
+
44
+ They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
45
+ files under the ./missing directory. See each file for the copying
46
+ condition.
47
+
48
+ 5. The scripts and library files supplied as input to or produced as
49
+ output from the software do not automatically fall under the
50
+ copyright of the software, but belong to whomever generated them,
51
+ and may be sold commercially, and may be aggregated with this
52
+ software.
53
+
54
+ 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
55
+ IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
56
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
57
+ PURPOSE.
58
+
data/README ADDED
@@ -0,0 +1,126 @@
1
+ == Synopsis
2
+
3
+ System Timer, a timer based on underlying SIGALRM system timers, is a
4
+ solution to Ruby processes which hang beyond the time limit when accessing
5
+ external resources. This is useful when timeout.rb, which relies on green
6
+ threads, does not work consistently.
7
+
8
+ == Usage
9
+
10
+ require 'systemtimer'
11
+
12
+ SystemTimer.timeout_after(5) do
13
+
14
+ # Something that should be interrupted if it takes too much time...
15
+ # ... even if blocked on a system call!
16
+
17
+ end
18
+
19
+ == Requirements
20
+
21
+ SystemTimer only works on UNIX platforms (Mac OS X, Linux, Solaris, BSD, ...).
22
+ You can install the gem on Microsoft Windows, but you will only get
23
+ a convenience shell wrapping a simple call to timeout.rb under the cover.
24
+
25
+ == Install
26
+
27
+ sudo gem install systemtimer
28
+
29
+
30
+ == Authors
31
+
32
+ * David Vollbracht <http://davidvollbracht.com>
33
+ * Philippe Hanrigou <http:/ph7spot.com>
34
+
35
+ == Copyright
36
+
37
+ Copyright:: (C) 2008 David Vollbracht & Philippe Hanrigou
38
+
39
+ == Description
40
+
41
+ While deploying Rails application in production our team discovered
42
+ that some web service call would not timeout way beyond their defined
43
+ limit, progressively freezing our Mongrel cluster until we restarted
44
+ the servers. A closer analysis revealed that the native thread in charge of
45
+ of the web service call was never scheduled, "stucked" on the service
46
+ call. As it turn out the timeout library bundled with Ruby 1.8 (MRI)
47
+ relies on green-threads to perform its magic... so the magic had no chance
48
+ to happen in this scenario.
49
+
50
+ Based on an original idea by Kurtis Seebaldt <http://kseebaldt.blogspot.com>,
51
+ David Vollbracht and Philippe Hanrigou pair programmed an alternative
52
+ implementation based on system timers (the +SIGALRM+ POSIX signal):
53
+ This design guarantees proper timeout behavior even when crossing-boundaries and accessing
54
+ system/external resources. Special care has been taken to interfere as little as
55
+ possible with other processes that might also rely on +SIGALRM+,
56
+ in particular MySQL.
57
+
58
+ This implementation is not intended to be drop-in replacement to
59
+ timeout.rb, just a way to wrap sensitive call to system resources.
60
+
61
+
62
+ == License
63
+
64
+ (The Ruby License)
65
+
66
+ Copyright:: (C) 2008 David Vollbracht & Philippe Hanrigou
67
+
68
+ SystemTimer is copyrighted free software by David Vollbracht and Philippe Hanrigou.
69
+ You can redistribute it and/or modify it under either the terms of the GPL
70
+ (see COPYING file), or the conditions below:
71
+
72
+ 1. You may make and give away verbatim copies of the source form of the
73
+ software without restriction, provided that you duplicate all of the
74
+ original copyright notices and associated disclaimers.
75
+
76
+ 2. You may modify your copy of the software in any way, provided that
77
+ you do at least ONE of the following:
78
+
79
+ a) place your modifications in the Public Domain or otherwise
80
+ make them Freely Available, such as by posting said
81
+ modifications to Usenet or an equivalent medium, or by allowing
82
+ the author to include your modifications in the software.
83
+
84
+ b) use the modified software only within your corporation or
85
+ organization.
86
+
87
+ c) rename any non-standard executables so the names do not conflict
88
+ with standard executables, which must also be provided.
89
+
90
+ d) make other distribution arrangements with the author.
91
+
92
+ 3. You may distribute the software in object code or executable
93
+ form, provided that you do at least ONE of the following:
94
+
95
+ a) distribute the executables and library files of the software,
96
+ together with instructions (in the manual page or equivalent)
97
+ on where to get the original distribution.
98
+
99
+ b) accompany the distribution with the machine-readable source of
100
+ the software.
101
+
102
+ c) give non-standard executables non-standard names, with
103
+ instructions on where to get the original software distribution.
104
+
105
+ d) make other distribution arrangements with the author.
106
+
107
+ 4. You may modify and include the part of the software into any other
108
+ software (possibly commercial). But some files in the distribution
109
+ are not written by the author, so that they are not under this terms.
110
+
111
+ They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
112
+ files under the ./missing directory. See each file for the copying
113
+ condition.
114
+
115
+ 5. The scripts and library files supplied as input to or produced as
116
+ output from the software do not automatically fall under the
117
+ copyright of the software, but belong to whomever generated them,
118
+ and may be sold commercially, and may be aggregated with this
119
+ software.
120
+
121
+ 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
122
+ IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
123
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
124
+ PURPOSE.
125
+
126
+
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ require 'mkmf'
3
+ create_makefile("system_timer_native")
@@ -0,0 +1,217 @@
1
+ #include "ruby.h"
2
+ #include "rubysig.h"
3
+ #include <signal.h>
4
+ #include <errno.h>
5
+
6
+ #define DISPLAY_ERRNO 1
7
+ #define DO_NOT_DISPLAY_ERRNO 0
8
+
9
+ VALUE rb_cSystemTimer;
10
+ sigset_t original_mask;
11
+ sigset_t sigalarm_mask;
12
+ struct sigaction original_signal_handler;
13
+ struct itimerval original_timer_interval;
14
+
15
+ static void clear_pending_sigalrm_for_ruby_threads();
16
+ static void log_debug(char*);
17
+ static void log_error(char*, int);
18
+ static void install_ruby_sigalrm_handler(VALUE);
19
+ static void restore_original_ruby_sigalrm_handler(VALUE);
20
+ static void restore_original_sigalrm_mask_when_blocked();
21
+ static void restore_original_timer_interval();
22
+ static void set_itimerval(struct itimerval *, int);
23
+
24
+ static int debug_enabled = 0;
25
+
26
+ static VALUE install_timer(VALUE self, VALUE seconds)
27
+ {
28
+ struct itimerval timer_interval;
29
+
30
+ /*
31
+ * Block SIG_ALRM for safe processing of SIG_ALRM configuration and save mask.
32
+ */
33
+ if (0 != sigprocmask(SIG_BLOCK, &sigalarm_mask, &original_mask)) {
34
+ log_error("install_timer: Could not block SIG_ALRM", DISPLAY_ERRNO);
35
+ return Qnil;
36
+ }
37
+ clear_pending_sigalrm_for_ruby_threads();
38
+ log_debug("install_timer: Succesfully blocked SIG_ALRM at O.S. level");
39
+
40
+ /*
41
+ * Save previous signal handler.
42
+ */
43
+ original_signal_handler.sa_handler = NULL;
44
+ if (0 != sigaction(SIGALRM, NULL, &original_signal_handler)) {
45
+ log_error("install_timer: Could not save existing handler for SIG_ALRM", DISPLAY_ERRNO);
46
+ restore_original_sigalrm_mask_when_blocked();
47
+ return Qnil;
48
+ }
49
+ log_debug("install_timer: Succesfully saved existing SIG_ALRM handler");
50
+
51
+ /*
52
+ * Install Ruby Level SIG_ALRM handler
53
+ */
54
+ install_ruby_sigalrm_handler(self);
55
+
56
+ /*
57
+ * Set new real time interval timer and save the original if any.
58
+ */
59
+ set_itimerval(&original_timer_interval, 0);
60
+ set_itimerval(&timer_interval, NUM2INT(seconds));
61
+ if (0 != setitimer(ITIMER_REAL, &timer_interval, &original_timer_interval)) {
62
+ log_error("install_timer: Could not install our own timer, timeout will not work", DISPLAY_ERRNO);
63
+ restore_original_ruby_sigalrm_handler(self);
64
+ restore_original_sigalrm_mask_when_blocked();
65
+ return Qnil;
66
+ }
67
+ log_debug("install_timer: Successfully installed timer");
68
+
69
+ /*
70
+ * Unblock SIG_ALRM
71
+ */
72
+ if (0 != sigprocmask(SIG_UNBLOCK, &sigalarm_mask, NULL)) {
73
+ log_error("install_timer: Could not unblock SIG_ALRM, timeout will not work", DISPLAY_ERRNO);
74
+ restore_original_timer_interval();
75
+ restore_original_ruby_sigalrm_handler(self);
76
+ restore_original_sigalrm_mask_when_blocked();
77
+ }
78
+ log_debug("install_timer: Succesfully unblocked SIG_ALRM.");
79
+
80
+ return Qnil;
81
+ }
82
+
83
+ static VALUE cleanup_timer(VALUE self, VALUE seconds)
84
+ {
85
+ /*
86
+ * Block SIG_ALRM for safe processing of SIG_ALRM configuration.
87
+ */
88
+ if (0 != sigprocmask(SIG_BLOCK, &sigalarm_mask, NULL)) {
89
+ log_error("cleanup_timer: Could not block SIG_ALRM", errno);
90
+ }
91
+ clear_pending_sigalrm_for_ruby_threads();
92
+ log_debug("cleanup_timer: Blocked SIG_ALRM");
93
+
94
+ /*
95
+ * Install Ruby Level SIG_ALRM handler
96
+ */
97
+ restore_original_ruby_sigalrm_handler(self);
98
+
99
+
100
+ if (original_signal_handler.sa_handler == NULL) {
101
+ log_error("cleanup_timer: Previous SIG_ALRM handler not initialized!", DO_NOT_DISPLAY_ERRNO);
102
+ } else if (0 == sigaction(SIGALRM, &original_signal_handler, NULL)) {
103
+ log_debug("cleanup_timer: Succesfully restored previous handler for SIG_ALRM");
104
+ } else {
105
+ log_error("cleanup_timer: Could not restore previous handler for SIG_ALRM", DISPLAY_ERRNO);
106
+ }
107
+ original_signal_handler.sa_handler = NULL;
108
+
109
+ restore_original_timer_interval();
110
+ restore_original_sigalrm_mask_when_blocked();
111
+ }
112
+
113
+ /*
114
+ * Restore original timer the way it was originally set. **WARNING** Breaks original timer semantics
115
+ *
116
+ * Not bothering to calculate how much time is left or if the timer already expired
117
+ * based on when the original timer was set and how much time is passed, just resetting
118
+ * the original timer as is for the sake of simplicity.
119
+ *
120
+ */
121
+ static void restore_original_timer_interval() {
122
+ if (0 != setitimer (ITIMER_REAL, &original_timer_interval, NULL)) {
123
+ log_error("install_timer: Could not restore original timer", DISPLAY_ERRNO);
124
+ }
125
+ log_debug("install_timer: Successfully restored timer");
126
+ }
127
+
128
+ static void restore_original_sigalrm_mask_when_blocked()
129
+ {
130
+ if (!sigismember(&original_mask, SIGALRM)) {
131
+ sigprocmask(SIG_UNBLOCK, &sigalarm_mask, NULL);
132
+ log_debug("cleanup_timer: Unblocked SIG_ALRM");
133
+ } else {
134
+ log_debug("cleanup_timer: No Need to unblock SIG_ALRM");
135
+ }
136
+ }
137
+
138
+ static void install_ruby_sigalrm_handler(VALUE self) {
139
+ rb_thread_critical = 1;
140
+ rb_funcall(self, rb_intern("install_ruby_sigalrm_handler"), 0);
141
+ rb_thread_critical = 0;
142
+ }
143
+
144
+ static void restore_original_ruby_sigalrm_handler(VALUE self) {
145
+ rb_thread_critical = 1;
146
+ rb_funcall(self, rb_intern("restore_original_ruby_sigalrm_handler"), 0);
147
+ rb_thread_critical = 0;
148
+ }
149
+
150
+
151
+ static VALUE debug_enabled_p(VALUE self) {
152
+ return debug_enabled ? Qtrue : Qfalse;
153
+ }
154
+
155
+ static VALUE enable_debug(VALUE self) {
156
+ debug_enabled = 1;
157
+ return Qnil;
158
+ }
159
+
160
+ static VALUE disable_debug(VALUE self) {
161
+ debug_enabled = 0;
162
+ return Qnil;
163
+ }
164
+
165
+ static void log_debug(char* message)
166
+ {
167
+ if (0 != debug_enabled) {
168
+ printf("%s\n", message);
169
+ }
170
+ return;
171
+ }
172
+
173
+ static void log_error(char* message, int display_errno)
174
+ {
175
+ fprintf(stderr, "%s: %s\n", message, display_errno ? strerror(errno) : "");
176
+ return;
177
+ }
178
+
179
+ /*
180
+ * The intent is to clear SIG_ALRM signals at the Ruby level (green threads),
181
+ * eventually triggering existing SIG_ALRM handler as a courtesy.
182
+ *
183
+ * As we cannot access trap_pending_list outside of signal.c our best fallback option
184
+ * is to trigger all pending signals at the Ruby level (potentially triggering
185
+ * green thread scheduling).
186
+ */
187
+ static void clear_pending_sigalrm_for_ruby_threads()
188
+ {
189
+ CHECK_INTS;
190
+ log_debug("Succesfully triggered all pending signals at Green Thread level");
191
+ }
192
+
193
+ static void init_sigalarm_mask()
194
+ {
195
+ sigemptyset(&sigalarm_mask);
196
+ sigaddset(&sigalarm_mask, SIGALRM);
197
+ return;
198
+ }
199
+
200
+ static void set_itimerval(struct itimerval *value, int seconds) {
201
+ value->it_interval.tv_usec = 0;
202
+ value->it_interval.tv_sec = 0;
203
+ value->it_value.tv_usec = 0;
204
+ value->it_value.tv_sec = seconds; // (long int)
205
+ return;
206
+ }
207
+
208
+ void Init_system_timer_native()
209
+ {
210
+ init_sigalarm_mask();
211
+ rb_cSystemTimer = rb_define_module("SystemTimer");
212
+ rb_define_singleton_method(rb_cSystemTimer, "install_timer", install_timer, 1);
213
+ rb_define_singleton_method(rb_cSystemTimer, "cleanup_timer", cleanup_timer, 0);
214
+ rb_define_singleton_method(rb_cSystemTimer, "debug_enabled?", debug_enabled_p, 0);
215
+ rb_define_singleton_method(rb_cSystemTimer, "enable_debug", enable_debug, 0);
216
+ rb_define_singleton_method(rb_cSystemTimer, "disable_debug", disable_debug, 0);
217
+ }
@@ -0,0 +1,72 @@
1
+ require 'rubygems'
2
+ require 'timeout'
3
+
4
+ # Timer based on underlying SIGALRM system timers, is a
5
+ # solution to Ruby processes which hang beyond the time limit when accessing
6
+ # external resources. This is useful when timeout.rb, which relies on green
7
+ # threads, does not work consistently.
8
+ #
9
+ # == Usage
10
+ #
11
+ # require 'systemtimer'
12
+ #
13
+ # SystemTimer.timeout_after(5) do
14
+ #
15
+ # # Something that should be interrupted if it takes too much time...
16
+ # # ... even if blocked on a system call!
17
+ #
18
+ # end
19
+ #
20
+ module SystemTimer
21
+ class << self
22
+
23
+ # Executes the method's block. If the block execution terminates before
24
+ # +seconds+ seconds has passed, it returns true. If not, it terminates
25
+ # the execution and raises a +Timeout::Error+.
26
+ def timeout_after(seconds)
27
+ install_timer(seconds)
28
+ return yield
29
+ ensure
30
+ cleanup_timer
31
+ end
32
+
33
+ # Backward compatibility with timeout.rb
34
+ alias timeout timeout_after
35
+
36
+ protected
37
+
38
+ def install_ruby_sigalrm_handler #:nodoc:
39
+ timed_thread = Thread.current # Ruby signals are always delivered to main thread by default.
40
+ @original_ruby_sigalrm_handler = trap('SIGALRM') do
41
+ log_timeout_received(timed_thread) if SystemTimer.debug_enabled?
42
+ timed_thread.raise Timeout::Error.new("time's up!")
43
+ end
44
+ end
45
+
46
+ def restore_original_ruby_sigalrm_handler #:nodoc:
47
+ trap('SIGALRM', original_ruby_sigalrm_handler || 'DEFAULT')
48
+ ensure
49
+ reset_original_ruby_sigalrm_handler
50
+ end
51
+
52
+ def original_ruby_sigalrm_handler #:nodoc:
53
+ @original_ruby_sigalrm_handler
54
+ end
55
+
56
+ def reset_original_ruby_sigalrm_handler #:nodoc:
57
+ @original_ruby_sigalrm_handler = nil
58
+ end
59
+
60
+ def log_timeout_received(timed_thread) #:nodoc:
61
+ puts <<-EOS
62
+ install_ruby_sigalrm_handler: Got Timeout in #{Thread.current}
63
+ Main thread : #{Thread.main}
64
+ Timed_thread : #{timed_thread}
65
+ All Threads : #{Thread.list.inspect}
66
+ EOS
67
+ end
68
+ end
69
+
70
+ end
71
+
72
+ require 'system_timer_native'
@@ -0,0 +1,15 @@
1
+ require 'rubygems'
2
+ require 'timeout'
3
+
4
+ module SystemTimer
5
+ class << self
6
+
7
+ def timeout_after(seconds)
8
+ Timeout::timeout(seconds) do
9
+ yield
10
+ end
11
+ end
12
+
13
+ end
14
+
15
+ end
@@ -0,0 +1 @@
1
+ Dir["#{File.dirname __FILE__}/*_test.rb"].each { |test_case| require test_case }
@@ -0,0 +1,121 @@
1
+ # $: << File.dirname(__FILE__) + '/../ext/xray'
2
+ $: << File.dirname(__FILE__) + '/../lib'
3
+ $: << File.dirname(__FILE__) + '/../ext/system_timer'
4
+ $: << File.dirname(__FILE__) + "/../../../vendor/gems/dust-0.1.4/lib"
5
+ $: << File.dirname(__FILE__) + "/../../../vendor/gems/mocha-0.5.3/lib"
6
+ require 'test/unit'
7
+ require 'system_timer'
8
+ require 'dust'
9
+ require 'mocha'
10
+ require 'stringio'
11
+
12
+ functional_tests do
13
+
14
+ test "original_ruby_sigalrm_handler is nil after reset" do
15
+ SystemTimer.send(:install_ruby_sigalrm_handler)
16
+ SystemTimer.send(:reset_original_ruby_sigalrm_handler)
17
+ assert_nil SystemTimer.send(:original_ruby_sigalrm_handler)
18
+ end
19
+
20
+ test "original_ruby_sigalrm_handler is set to existing handler after install_ruby_sigalrm_handler" do
21
+ SystemTimer.expects(:trap).with('SIGALRM').returns(:an_existing_handler)
22
+ SystemTimer.send(:install_ruby_sigalrm_handler)
23
+ assert_equal :an_existing_handler, SystemTimer.send(:original_ruby_sigalrm_handler)
24
+ end
25
+
26
+ test "restore_original_ruby_sigalrm_handler traps sigalrm using original_ruby_sigalrm_handler" do
27
+ SystemTimer.stubs(:original_ruby_sigalrm_handler).returns(:the_original_handler)
28
+ SystemTimer.expects(:trap).with('SIGALRM', :the_original_handler)
29
+ SystemTimer.send :restore_original_ruby_sigalrm_handler
30
+ end
31
+
32
+ test "restore_original_ruby_sigalrm_handler resets original_ruby_sigalrm_handler" do
33
+ SystemTimer.stubs(:trap)
34
+ SystemTimer.expects(:reset_original_ruby_sigalrm_handler)
35
+ SystemTimer.send :restore_original_ruby_sigalrm_handler
36
+ end
37
+
38
+ test "restore_original_ruby_sigalrm_handler reset SIGALRM handler to default when original_ruby_sigalrm_handler is nil" do
39
+ SystemTimer.stubs(:original_ruby_sigalrm_handler)
40
+ SystemTimer.expects(:trap).with('SIGALRM', 'DEFAULT')
41
+ SystemTimer.stubs(:reset_original_ruby_sigalrm_handler)
42
+ SystemTimer.send :restore_original_ruby_sigalrm_handler
43
+ end
44
+
45
+ test "restore_original_ruby_sigalrm_handler resets original_ruby_sigalrm_handler when trap raises" do
46
+ SystemTimer.stubs(:trap).returns(:the_original_handler)
47
+ SystemTimer.send(:install_ruby_sigalrm_handler)
48
+ SystemTimer.expects(:trap).raises("next time maybe...")
49
+ SystemTimer.expects(:reset_original_ruby_sigalrm_handler)
50
+
51
+ SystemTimer.send(:restore_original_ruby_sigalrm_handler) rescue nil
52
+ end
53
+
54
+ test "timeout_after raises TimeoutError if block takes too long" do
55
+ assert_raises(Timeout::Error) do
56
+ SystemTimer.timeout_after(1) {sleep 5}
57
+ end
58
+ end
59
+
60
+ test "timeout_after does not raises Timeout Error if block completes in time" do
61
+ SystemTimer.timeout_after(5) {sleep 1}
62
+ end
63
+
64
+ test "timeout_after returns the value returned by the black" do
65
+ assert_equal :block_value, SystemTimer.timeout_after(1) {:block_value}
66
+ end
67
+
68
+ test "timeout_after raises TimeoutError in thread that called timeout_after" do
69
+ raised_thread = nil
70
+ other_thread = Thread.new do
71
+ begin
72
+ SystemTimer.timeout_after(1) {sleep 5}
73
+ flunk "Should have timed out"
74
+ rescue Timeout::Error
75
+ raised_thread = Thread.current
76
+ end
77
+ end
78
+
79
+ other_thread.join
80
+ assert_equal other_thread, raised_thread
81
+ end
82
+
83
+ test "cancelling a timer that was installed restores previous ruby handler for SIG_ALRM" do
84
+ begin
85
+ fake_original_ruby_handler = proc {}
86
+ initial_ruby_handler = trap "SIGALRM", fake_original_ruby_handler
87
+ SystemTimer.install_timer(3)
88
+ SystemTimer.cleanup_timer
89
+ assert_equal fake_original_ruby_handler, trap("SIGALRM", "IGNORE")
90
+ ensure # avoid interfering with test infrastructure
91
+ trap("SIGALRM", initial_ruby_handler) if initial_ruby_handler
92
+ end
93
+ end
94
+
95
+ test "debug_enabled returns true after enabling debug" do
96
+ begin
97
+ SystemTimer.disable_debug
98
+ SystemTimer.enable_debug
99
+ assert_equal true, SystemTimer.debug_enabled?
100
+ ensure
101
+ SystemTimer.disable_debug
102
+ end
103
+ end
104
+
105
+ test "debug_enabled returns false after disable debug" do
106
+ begin
107
+ SystemTimer.enable_debug
108
+ SystemTimer.disable_debug
109
+ assert_equal false, SystemTimer.debug_enabled?
110
+ ensure
111
+ SystemTimer.disable_debug
112
+ end
113
+ end
114
+
115
+ test "timeout offers an API fully compatible with timeout.rb" do
116
+ assert_raises(Timeout::Error) do
117
+ SystemTimer.timeout(1) {sleep 5}
118
+ end
119
+ end
120
+
121
+ end
metadata ADDED
@@ -0,0 +1,66 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: SystemTimer
3
+ version: !ruby/object:Gem::Version
4
+ version: "1.0"
5
+ platform: ruby
6
+ authors: []
7
+
8
+ autorequire: system_timer
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2008-05-28 00:00:00 -07:00
13
+ default_executable:
14
+ dependencies: []
15
+
16
+ description:
17
+ email:
18
+ executables: []
19
+
20
+ extensions:
21
+ - ext/system_timer/extconf.rb
22
+ extra_rdoc_files:
23
+ - README
24
+ files:
25
+ - COPYING
26
+ - LICENSE
27
+ - ChangeLog
28
+ - ext/system_timer/system_timer_native.c
29
+ - ext/system_timer/extconf.rb
30
+ - lib/system_timer.rb
31
+ - lib/system_timer_stub.rb
32
+ - test/all_tests.rb
33
+ - test/system_timer_test.rb
34
+ - README
35
+ has_rdoc: true
36
+ homepage:
37
+ post_install_message:
38
+ rdoc_options:
39
+ - --title
40
+ - SystemTimer
41
+ - --main
42
+ - README
43
+ - --line-numbers
44
+ require_paths:
45
+ - lib
46
+ required_ruby_version: !ruby/object:Gem::Requirement
47
+ requirements:
48
+ - - ">="
49
+ - !ruby/object:Gem::Version
50
+ version: "0"
51
+ version:
52
+ required_rubygems_version: !ruby/object:Gem::Requirement
53
+ requirements:
54
+ - - ">="
55
+ - !ruby/object:Gem::Version
56
+ version: "0"
57
+ version:
58
+ requirements: []
59
+
60
+ rubyforge_project:
61
+ rubygems_version: 1.0.1
62
+ signing_key:
63
+ specification_version: 2
64
+ summary: Set a Timeout based on signals, which are more reliable than Timeout. Timeout is based on green threads.
65
+ test_files:
66
+ - test/all_tests.rb