Upgrade to Time-HiRes-1.87
[perl.git] / ext / Time / HiRes / t / HiRes.t
1 #!./perl -w
2
3 BEGIN {
4     if ($ENV{PERL_CORE}) {
5         chdir 't' if -d 't';
6         @INC = '../lib';
7         require Config; import Config;
8         if (" $Config{'extensions'} " !~ m[ Time/HiRes ]) {
9             print "1..0 # Skip -- Perl configured without Time::HiRes module\n";
10             exit 0;
11         }
12     }
13 }
14
15 BEGIN { $| = 1; print "1..33\n"; }
16
17 END { print "not ok 1\n" unless $loaded }
18
19 use Time::HiRes qw(tv_interval);
20
21 $loaded = 1;
22
23 print "ok 1\n";
24
25 use strict;
26
27 my $have_gettimeofday    = &Time::HiRes::d_gettimeofday;
28 my $have_usleep          = &Time::HiRes::d_usleep;
29 my $have_nanosleep       = &Time::HiRes::d_nanosleep;
30 my $have_ualarm          = &Time::HiRes::d_ualarm;
31 my $have_clock_gettime   = &Time::HiRes::d_clock_gettime;
32 my $have_clock_getres    = &Time::HiRes::d_clock_getres;
33 my $have_clock_nanosleep = &Time::HiRes::d_clock_nanosleep;
34 my $have_clock           = &Time::HiRes::d_clock;
35
36 sub has_symbol {
37     my $symbol = shift;
38     eval "use Time::HiRes qw($symbol)";
39     return 0 unless $@ eq '';
40     eval "my \$a = $symbol";
41     return $@ eq '';
42 }
43
44 printf "# have_gettimeofday    = %d\n", $have_gettimeofday;
45 printf "# have_usleep          = %d\n", $have_usleep;
46 printf "# have_nanosleep       = %d\n", $have_nanosleep;
47 printf "# have_ualarm          = %d\n", $have_ualarm;
48 printf "# have_clock_gettime   = %d\n", $have_clock_gettime;
49 printf "# have_clock_getres    = %d\n", $have_clock_getres;
50 printf "# have_clock_nanosleep = %d\n", $have_clock_nanosleep;
51 printf "# have_clock           = %d\n", $have_clock;
52
53 import Time::HiRes 'gettimeofday'       if $have_gettimeofday;
54 import Time::HiRes 'usleep'             if $have_usleep;
55 import Time::HiRes 'nanosleep'          if $have_nanosleep;
56 import Time::HiRes 'ualarm'             if $have_ualarm;
57 import Time::HiRes 'clock_gettime'      if $have_clock_gettime;
58 import Time::HiRes 'clock_getres'       if $have_clock_getres;
59 import Time::HiRes 'clock_nanosleep'    if $have_clock_nanosleep;
60 import Time::HiRes 'clock'              if $have_clock;
61
62 use Config;
63
64 use Time::HiRes qw(gettimeofday);
65
66 my $have_alarm = $Config{d_alarm};
67 my $have_fork  = $Config{d_fork};
68 my $waitfor = 60; # 10-20 seconds is normal (load affects this).
69 my $timer_pid;
70 my $TheEnd;
71
72 if ($have_fork) {
73     print "# I am the main process $$, starting the timer process...\n";
74     $timer_pid = fork();
75     if (defined $timer_pid) {
76         if ($timer_pid == 0) { # We are the kid, set up the timer.
77             my $ppid = getppid();
78             print "# I am the timer process $$, sleeping for $waitfor seconds...\n";
79             sleep($waitfor);
80             warn "\n$0: overall time allowed for tests (${waitfor}s) exceeded!\n";
81             print "# Terminating main process $ppid...\n";
82             kill('TERM', $ppid);
83             print "# This is the timer process $$, over and out.\n";
84             exit(0);
85         } else {
86             print "# The timer process $timer_pid launched, continuing testing...\n";
87             $TheEnd = time() + $waitfor;
88         }
89     } else {
90         warn "$0: fork failed: $!\n";
91     }
92 } else {
93     print "# No timer process (need fork)\n";
94 }
95
96 my $xdefine = ''; 
97
98 if (open(XDEFINE, "xdefine")) {
99     chomp($xdefine = <XDEFINE>);
100     close(XDEFINE);
101 }
102
103 # Ideally, we'd like to test that the timers are rather precise.
104 # However, if the system is busy, there are no guarantees on how
105 # quickly we will return.  This limit used to be 10%, but that
106 # was occasionally triggered falsely.  
107 # Try 20%.  
108 # Another possibility might be to print "ok" if the test completes fine
109 # with (say) 10% slosh, "skip - system may have been busy?" if the test
110 # completes fine with (say) 30% slosh, and fail otherwise.  If you do that,
111 # consider changing over to test.pl at the same time.
112 # --A.D., Nov 27, 2001
113 my $limit = 0.20; # 20% is acceptable slosh for testing timers
114
115 sub skip {
116     map { print "ok $_ # skipped\n" } @_;
117 }
118
119 sub ok {
120     my ($n, $result, @info) = @_;
121     if ($result) {
122         print "ok $n\n";
123     }
124     else {
125         print "not ok $n\n";
126         print "# @info\n" if @info;
127     }
128 }
129
130 unless ($have_gettimeofday) {
131     skip 2..6;
132 }
133 else {
134     my @one = gettimeofday();
135     ok 2, @one == 2, 'gettimeofday returned ', 0+@one, ' args';
136     ok 3, $one[0] > 850_000_000, "@one too small";
137
138     sleep 1;
139
140     my @two = gettimeofday();
141     ok 4, ($two[0] > $one[0] || ($two[0] == $one[0] && $two[1] > $one[1])),
142             "@two is not greater than @one";
143
144     my $f = Time::HiRes::time();
145     ok 5, $f > 850_000_000, "$f too small";
146     ok 6, $f - $two[0] < 2, "$f - $two[0] >= 2";
147 }
148
149 unless ($have_usleep) {
150     skip 7..8;
151 }
152 else {
153     use Time::HiRes qw(usleep);
154     my $one = time;
155     usleep(10_000);
156     my $two = time;
157     usleep(10_000);
158     my $three = time;
159     ok 7, $one == $two || $two == $three, "slept too long, $one $two $three";
160
161     unless ($have_gettimeofday) {
162         skip 8;
163     }
164     else {
165         my $f = Time::HiRes::time();
166         usleep(500_000);
167         my $f2 = Time::HiRes::time();
168         my $d = $f2 - $f;
169         ok 8, $d > 0.4 && $d < 0.9, "slept $d secs $f to $f2";
170     }
171 }
172
173 # Two-arg tv_interval() is always available.
174 {
175     my $f = tv_interval [5, 100_000], [10, 500_000];
176     ok 9, abs($f - 5.4) < 0.001, $f;
177 }
178
179 unless ($have_gettimeofday) {
180     skip 10;
181 }
182 else {
183     my $r = [gettimeofday()];
184     my $f = tv_interval $r;
185     ok 10, $f < 2, $f;
186 }
187
188 unless ($have_usleep && $have_gettimeofday) {
189     skip 11;
190 }
191 else {
192     my $r = [ gettimeofday() ];
193     Time::HiRes::sleep( 0.5 );
194     my $f = tv_interval $r;
195     ok 11, $f > 0.4 && $f < 0.9, "slept $f instead of 0.5 secs.";
196 }
197
198 unless ($have_ualarm && $have_alarm) {
199     skip 12..13;
200 }
201 else {
202     my $tick = 0;
203     local $SIG{ ALRM } = sub { $tick++ };
204
205     my $one = time; $tick = 0; ualarm(10_000); while ($tick == 0) { }
206     my $two = time; $tick = 0; ualarm(10_000); while ($tick == 0) { }
207     my $three = time;
208     ok 12, $one == $two || $two == $three, "slept too long, $one $two $three";
209     print "# tick = $tick, one = $one, two = $two, three = $three\n";
210
211     $tick = 0; ualarm(10_000, 10_000); while ($tick < 3) { }
212     ok 13, 1;
213     ualarm(0);
214     print "# tick = $tick, one = $one, two = $two, three = $three\n";
215 }
216
217 # Did we even get close?
218
219 unless ($have_gettimeofday) {
220     skip 14;
221 } else {
222  my ($s, $n, $i) = (0);
223  for $i (1 .. 100) {
224      $s += Time::HiRes::time() - time();
225      $n++;
226  }
227  # $s should be, at worst, equal to $n
228  # (time() may be rounding down, up, or closest)
229  ok 14, abs($s) / $n <= 1.0, "Time::HiRes::time() not close to time()";
230  print "# s = $s, n = $n, s/n = ", $s/$n, "\n";
231 }
232
233 my $has_ualarm = $Config{d_ualarm};
234
235 $has_ualarm ||= $xdefine =~ /-DHAS_UALARM/;
236
237 unless (   defined &Time::HiRes::gettimeofday
238         && defined &Time::HiRes::ualarm
239         && defined &Time::HiRes::usleep
240         && $has_ualarm) {
241     for (15..17) {
242         print "ok $_ # Skip: no gettimeofday or no ualarm or no usleep\n";
243     }
244 } else {
245     use Time::HiRes qw(time alarm sleep);
246
247     my ($f, $r, $i, $not, $ok);
248
249     $f = time; 
250     print "# time...$f\n";
251     print "ok 15\n";
252
253     $r = [Time::HiRes::gettimeofday()];
254     sleep (0.5);
255     print "# sleep...", Time::HiRes::tv_interval($r), "\nok 16\n";
256
257     $r = [Time::HiRes::gettimeofday()];
258     $i = 5;
259     $SIG{ALRM} = "tick";
260     while ($i > 0)
261     {
262         alarm(0.3);
263         select (undef, undef, undef, 3);
264         my $ival = Time::HiRes::tv_interval ($r);
265         print "# Select returned! $i $ival\n";
266         print "# ", abs($ival/3 - 1), "\n";
267         # Whether select() gets restarted after signals is
268         # implementation dependent.  If it is restarted, we
269         # will get about 3.3 seconds: 3 from the select, 0.3
270         # from the alarm.  If this happens, let's just skip
271         # this particular test.  --jhi
272         if (abs($ival/3.3 - 1) < $limit) {
273             $ok = "Skip: your select() may get restarted by your SIGALRM (or just retry test)";
274             undef $not;
275             last;
276         }
277         my $exp = 0.3 * (5 - $i);
278         # This test is more sensitive, so impose a softer limit.
279         if (abs($ival/$exp - 1) > 3*$limit) {
280             my $ratio = abs($ival/$exp);
281             $not = "while: $exp sleep took $ival ratio $ratio";
282             last;
283         }
284         $ok = $i;
285     }
286
287     sub tick
288     {
289         $i--;
290         my $ival = Time::HiRes::tv_interval ($r);
291         print "# Tick! $i $ival\n";
292         my $exp = 0.3 * (5 - $i);
293         # This test is more sensitive, so impose a softer limit.
294         if (abs($ival/$exp - 1) > 3*$limit) {
295             my $ratio = abs($ival/$exp);
296             $not = "tick: $exp sleep took $ival ratio $ratio";
297             $i = 0;
298         }
299     }
300
301     alarm(0); # can't cancel usig %SIG
302
303     print $not ? "not ok 17 # $not\n" : "ok 17 # $ok\n";
304 }
305
306 unless (   defined &Time::HiRes::setitimer
307         && defined &Time::HiRes::getitimer
308         && has_symbol('ITIMER_VIRTUAL')
309         && $Config{sig_name} =~ m/\bVTALRM\b/) {
310     for (18..19) {
311         print "ok $_ # Skip: no virtual interval timers\n";
312     }
313 } else {
314     use Time::HiRes qw(setitimer getitimer ITIMER_VIRTUAL);
315
316     my $i = 3;
317     my $r = [Time::HiRes::gettimeofday()];
318
319     $SIG{VTALRM} = sub {
320         $i ? $i-- : setitimer(&ITIMER_VIRTUAL, 0);
321         print "# Tick! $i ", Time::HiRes::tv_interval($r), "\n";
322     };  
323
324     print "# setitimer: ", join(" ", setitimer(ITIMER_VIRTUAL, 0.5, 0.4)), "\n";
325
326     # Assume interval timer granularity of $limit * 0.5 seconds.  Too bold?
327     my $virt = getitimer(&ITIMER_VIRTUAL);
328     print "not " unless defined $virt && abs($virt / 0.5) - 1 < $limit;
329     print "ok 18\n";
330
331     print "# getitimer: ", join(" ", getitimer(ITIMER_VIRTUAL)), "\n";
332
333     while (getitimer(&ITIMER_VIRTUAL)) {
334         my $j;
335         for (1..1000) { $j++ } # Can't be unbreakable, must test getitimer().
336     }
337
338     print "# getitimer: ", join(" ", getitimer(ITIMER_VIRTUAL)), "\n";
339
340     $virt = getitimer(&ITIMER_VIRTUAL);
341     print "not " unless defined $virt && $virt == 0;
342     print "ok 19\n";
343
344     $SIG{VTALRM} = 'DEFAULT';
345 }
346
347 if ($have_gettimeofday &&
348     $have_usleep) {
349     use Time::HiRes qw(usleep);
350
351     my ($t0, $td);
352
353     my $sleep = 1.5; # seconds
354     my $msg;
355
356     $t0 = gettimeofday();
357     $a = abs(sleep($sleep)        / $sleep         - 1.0);
358     $td = gettimeofday() - $t0;
359     my $ratio = 1.0 + $a;
360
361     $msg = "$td went by while sleeping $sleep, ratio $ratio.\n";
362
363     if ($td < $sleep * (1 + $limit)) {
364         print $a < $limit ? "ok 20 # $msg" : "not ok 20 # $msg";
365     } else {
366         print "ok 20 # Skip: $msg";
367     }
368
369     $t0 = gettimeofday();
370     $a = abs(usleep($sleep * 1E6) / ($sleep * 1E6) - 1.0);
371     $td = gettimeofday() - $t0;
372     $ratio = 1.0 + $a;
373
374     $msg = "$td went by while sleeping $sleep, ratio $ratio.\n";
375
376     if ($td < $sleep * (1 + $limit)) {
377         print $a < $limit ? "ok 21 # $msg" : "not ok 21 # $msg";
378     } else {
379         print "ok 21 # Skip: $msg";
380     }
381
382 } else {
383     for (20..21) {
384         print "ok $_ # Skip: no gettimeofday\n";
385     }
386 }
387
388 unless ($have_nanosleep) {
389     skip 22..23;
390 }
391 else {
392     my $one = CORE::time;
393     nanosleep(10_000_000);
394     my $two = CORE::time;
395     nanosleep(10_000_000);
396     my $three = CORE::time;
397     ok 22, $one == $two || $two == $three, "slept too long, $one $two $three";
398
399     unless ($have_gettimeofday) {
400         skip 23;
401     }
402     else {
403         my $f = Time::HiRes::time();
404         nanosleep(500_000_000);
405         my $f2 = Time::HiRes::time();
406         my $d = $f2 - $f;
407         ok 23, $d > 0.4 && $d < 0.9, "slept $d secs $f to $f2";
408     }
409 }
410
411 eval { sleep(-1) };
412 print $@ =~ /::sleep\(-1\): negative time not invented yet/ ?
413     "ok 24\n" : "not ok 24\n";
414
415 eval { usleep(-2) };
416 print $@ =~ /::usleep\(-2\): negative time not invented yet/ ?
417     "ok 25\n" : "not ok 25\n";
418
419 if ($have_ualarm) {
420     eval { alarm(-3) };
421     print $@ =~ /::alarm\(-3, 0\): negative time not invented yet/ ?
422         "ok 26\n" : "not ok 26\n";
423
424     eval { ualarm(-4) };
425     print $@ =~ /::ualarm\(-4, 0\): negative time not invented yet/ ?
426     "ok 27\n" : "not ok 27\n";
427 } else {
428     skip 26;
429     skip 27;
430 }
431
432 if ($have_nanosleep) {
433     eval { nanosleep(-5) };
434     print $@ =~ /::nanosleep\(-5\): negative time not invented yet/ ?
435         "ok 28\n" : "not ok 28\n";
436 } else {
437     skip 28;
438 }
439
440 if ($have_ualarm && $] >= 5.008001) {
441     # http://groups.google.com/group/perl.perl5.porters/browse_thread/thread/adaffaaf939b042e/20dafc298df737f0%2320dafc298df737f0?sa=X&oi=groupsr&start=0&num=3
442     # Perl changes [18765] and [18770], perl bug [perl #20920]
443
444     # First we will find the loop size N (a for() loop 0..N-1)
445     # that will take more than T seconds.
446
447     my $T = 0.01;
448     use Time::HiRes qw(time);
449     my $N = 1024;
450     my $i;
451     N: {
452         do {
453             my $t0 = time();
454             for ($i = 0; $i < $N; $i++) { }
455             my $t1 = time();
456             my $dt = $t1 - $t0;
457             print "# N = $N, t1 = $t1, t0 = $t0, dt = $dt\n";
458             last N if $dt > $T;
459             $N *= 2;
460         } while (1);
461     }
462
463     # The time-burner which takes at least T seconds.
464     my $F = sub {
465         my $c = @_ ? shift : 1;
466         my $n = $c * $N;
467         my $i;
468         for ($i = 0; $i < $n; $i++) { }
469     };
470
471     # Then we will setup a periodic timer (the two-argument alarm() of
472     # Time::HiRes, behind the curtains the libc ualarm()) which has
473     # a signal handler that takes so much time (on the first initial
474     # invocation) that the first periodic invocation (second invocation)
475     # will happen before the first invocation has finished.  In Perl 5.8.0
476     # the "safe signals" concept was implemented, with unfortunately at least
477     # one bug that caused a core dump on reentering the handler. This bug
478     # was fixed by the time of Perl 5.8.1.
479
480     # Do not try mixing sleep() and alarm() for testing this.
481
482     my $a = 0; # Number of alarms we receive.
483     my $A = 2; # Number of alarms we will handle before disarming.
484                # (We may well get $A + 1 alarms.)
485
486     $SIG{ALRM} = sub {
487         $a++;
488         print "# Alarm $a - ", time(), "\n";
489         alarm(0) if $a >= $A; # Disarm the alarm.
490         $F->(2); # Try burning CPU at least for 2T seconds.
491     }; 
492
493     use Time::HiRes qw(alarm); 
494     alarm($T, $T);  # Arm the alarm.
495
496     $F->(10); # Try burning CPU at least for 10T seconds.
497
498     print "ok 29\n"; # Not core dumping by now is considered to be the success.
499 } else {
500     skip 29;
501 }
502
503 if ($have_clock_gettime &&
504     # All implementations of clock_gettime() 
505     # are SUPPOSED TO support CLOCK_REALTIME.
506     has_symbol('CLOCK_REALTIME')) {
507     my $ok = 0;
508  TRY: {
509         for my $try (1..3) {
510             print "# CLOCK_REALTIME: try = $try\n";
511             my $t0 = clock_gettime(&CLOCK_REALTIME);
512             use Time::HiRes qw(sleep);
513             my $T = 1.5;
514             sleep($T);
515             my $t1 = clock_gettime(&CLOCK_REALTIME);
516             if ($t0 > 0 && $t1 > $t0) {
517                 print "# t1 = $t1, t0 = $t0\n";
518                 my $dt = $t1 - $t0;
519                 my $rt = abs(1 - $dt / $T);
520                 print "# dt = $dt, rt = $rt\n";
521                 if ($rt <= 2 * $limit) {
522                     $ok = 1;
523                     last TRY;
524                 }
525             } else {
526                 print "# Error: t0 = $t0, t1 = $t1\n";
527             }
528             my $r = rand() + rand();
529             printf "# Sleeping for %.6f seconds...\n", $r;
530             sleep($r);
531         }
532     }
533     if ($ok) {
534         print "ok 30\n";
535     } else {
536         print "not ok 30\n";
537     }
538 } else {
539     print "# No clock_gettime\n";
540     skip 30;
541 }
542
543 if ($have_clock_getres) {
544     my $tr = clock_getres();
545     if ($tr > 0) {
546         print "ok 31 # tr = $tr\n";
547     } else {
548         print "not ok 31 # tr = $tr\n";
549     }
550 } else {
551     print "# No clock_getres\n";
552     skip 31;
553 }
554
555 if ($have_clock_nanosleep &&
556     has_symbol('CLOCK_REALTIME')) {
557     my $s = 1.5;
558     my $t = clock_nanosleep(&CLOCK_REALTIME, $s);
559     my $r = abs(1 - $t / $s);
560     if ($r < 2 * $limit) {
561         print "ok 32\n";
562     } else {
563         print "not ok 32 # $t = $t, r = $r\n";
564     }
565 } else {
566     print "# No clock_nanosleep\n";
567     skip 32;
568 }
569
570 if ($have_clock) {
571     my @clock = clock();
572     print "# clock = @clock\n";
573     for my $i (1..3) {
574         for (my $j = 0; $j < 1e6; $j++) { }
575         push @clock, clock();
576         print "# clock = @clock\n";
577     }
578     if ($clock[0] >= 0 &&
579         $clock[1] > $clock[0] &&
580         $clock[2] > $clock[1] &&
581         $clock[3] > $clock[2]) {
582         print "ok 33\n";
583     } else {
584         print "not ok 33\n";
585     }
586 } else {
587     print "# No clock\n";
588     skip 33;
589 }
590
591 END {
592     if ($timer_pid) { # Only in the main process.
593         my $left = $TheEnd - time();
594         printf "# I am the main process $$, terminating the timer process $timer_pid\n# before it terminates me in %d seconds (testing took %d seconds).\n", $left, $waitfor - $left;
595         my $kill = kill('TERM', $timer_pid); # We are done, the timer can go.
596         printf "# kill TERM $timer_pid = %d\n", $kill;
597         unlink("ktrace.out"); # Used in BSD system call tracing.
598         print "# All done.\n";
599     }
600 }
601