Time::HiRes - High resolution alarm, sleep, gettimeofday, interval timers

  use Time::HiRes qw( usleep ualarm gettimeofday tv_interval nanosleep );

  usleep ($microseconds);
  nanosleep ($nanoseconds);

  ualarm ($microseconds);
  ualarm ($microseconds, $interval_microseconds);

  $t0 = [gettimeofday];
  ($seconds, $microseconds) = gettimeofday;

  $elapsed = tv_interval ( $t0, [$seconds, $microseconds]);
  $elapsed = tv_interval ( $t0, [gettimeofday]);
  $elapsed = tv_interval ( $t0 );

  use Time::HiRes qw ( time alarm sleep );

  $now_fractions = time;
  sleep ($floating_seconds);
  alarm ($floating_seconds);
  alarm ($floating_seconds, $floating_interval);

  use Time::HiRes qw( setitimer getitimer
                      ITIMER_REAL ITIMER_VIRTUAL ITIMER_PROF ITIMER_REALPROF );

  setitimer ($which, $floating_seconds, $floating_interval );
  getitimer ($which);

The CWTime::HiRes module implements a Perl interface to the CWusleep, CWnanosleep, CWualarm, CWgettimeofday, and CWsetitimer/CWgetitimer system calls, in other words, high resolution time and timers. See the EXAMPLES section below and the test scripts for usage; see your system documentation for the description of the underlying CWnanosleep or CWusleep, CWualarm, CWgettimeofday, and CWsetitimer/CWgetitimer calls.

If your system lacks CWgettimeofday() or an emulation of it you don't get CWgettimeofday() or the one-argument form of CWtv_interval(). If your system lacks all of CWnanosleep(), CWusleep(), and CWselect(), you don't get CWTime::HiRes::usleep(), CWTime::HiRes::nanosleep(), or CWTime::HiRes::sleep(). If your system lacks both CWualarm() and CWsetitimer() you don't get CWTime::HiRes::ualarm() or CWTime::HiRes::alarm().

If you try to import an unimplemented function in the CWuse statement it will fail at compile time.

If your subsecond sleeping is implemented with CWnanosleep() instead of CWusleep(), you can mix subsecond sleeping with signals since CWnanosleep() does not use signals. This, however, is not portable, and you should first check for the truth value of CW&Time::HiRes::d_nanosleep to see whether you have nanosleep, and then carefully read your CWnanosleep() C API documentation for any peculiarities.

Unless using CWnanosleep for mixing sleeping with signals, give some thought to whether Perl is the tool you should be using for work requiring nanosecond accuracies.

The following functions can be imported from this module. No functions are exported by default.

gettimeofday ()

In array context returns a two-element array with the seconds and microseconds since the epoch. In scalar context returns floating seconds like CWTime::HiRes::time() (see below). Sleeps for the number of microseconds (millionths of a second) specified. Returns the number of microseconds actually slept. Can sleep for more than one second, unlike the CWusleep system call. See also CWTime::HiRes::usleep() and CWTime::HiRes::sleep(). Do not expect usleep() to be exact down to one microsecond. Sleeps for the number of nanoseconds (1e9ths of a second) specified. Returns the number of nanoseconds actually slept (accurate only to microseconds, the nearest thousand of them). Can sleep for more than one second. See also CWTime::HiRes::sleep() and CWTime::HiRes::usleep(). Do not expect nanosleep() to be exact down to one nanosecond. Getting even accuracy of one thousand nanoseconds is good. Issues a CWualarm call; the CW$interval_useconds is optional and will be zero if unspecified, resulting in CWalarm-like behaviour. Note that the interaction between alarms and sleeps are unspecified.

tv_interval

tv_interval ( CW$ref_to_gettimeofday [, CW$ref_to_later_gettimeofday] ) Returns the floating seconds between the two times, which should have been returned by CWgettimeofday(). If the second argument is omitted, then the current time is used.

time ()

Returns a floating seconds since the epoch. This function can be imported, resulting in a nice drop-in replacement for the CWtime provided with core Perl; see the EXAMPLES below. NOTE 1: This higher resolution timer can return values either less or more than the core CWtime(), depending on whether your platform rounds the higher resolution timer values up, down, or to the nearest second to get the core CWtime(), but naturally the difference should be never more than half a second. NOTE 2: Since Sunday, September 9th, 2001 at 01:46:40 AM GMT, when the CWtime() seconds since epoch rolled over to 1_000_000_000, the default floating point format of Perl and the seconds since epoch have conspired to produce an apparent bug: if you print the value of CWTime::HiRes::time() you seem to be getting only five decimals, not six as promised (microseconds). Not to worry, the microseconds are there (assuming your platform supports such granularity in the first place). What is going on is that the default floating point format of Perl only outputs 15 digits. In this case that means ten digits before the decimal separator and five after. To see the microseconds you can use either CWprintf/CWsprintf with CW"%.6f", or the CWgettimeofday() function in list context, which will give you the seconds and microseconds as two separate values. Sleeps for the specified amount of seconds. Returns the number of seconds actually slept (a floating point value). This function can be imported, resulting in a nice drop-in replacement for the CWsleep provided with perl, see the EXAMPLES below. Note that the interaction between alarms and sleeps are unspecified. The CWSIGALRM signal is sent after the specified number of seconds. Implemented using CWualarm(). The CW$interval_floating_seconds argument is optional and will be zero if unspecified, resulting in CWalarm()-like behaviour. This function can be imported, resulting in a nice drop-in replacement for the CWalarm provided with perl, see the EXAMPLES below. NOTE 1: With some combinations of operating systems and Perl releases CWSIGALRM restarts CWselect(), instead of interrupting it. This means that an CWalarm() followed by a CWselect() may together take the sum of the times specified for the the CWalarm() and the CWselect(), not just the time of the CWalarm(). Note that the interaction between alarms and sleeps are unspecified. Start up an interval timer: after a certain time, a signal arrives, and more signals may keep arriving at certain intervals. To disable an itimer, use CW$floating_seconds of zero. If the CW$interval_floating_seconds is set to zero (or unspecified), the timer is disabled after the next delivered signal. Use of interval timers may interfere with CWalarm(), CWsleep(), and CWusleep(). In standard-speak the interaction is unspecified, which means that anything may happen: it may work, it may not. In scalar context, the remaining time in the timer is returned. In list context, both the remaining time and the interval are returned. There are usually three or four interval timers available: the CW$which can be CWITIMER_REAL, CWITIMER_VIRTUAL, CWITIMER_PROF, or CWITIMER_REALPROF. Note that which ones are available depends: true UNIX platforms usually have the first three, but (for example) Win32 and Cygwin have only CWITIMER_REAL, and only Solaris seems to have CWITIMER_REALPROF (which is used to profile multithreaded programs). CWITIMER_REAL results in CWalarm()-like behavior. Time is counted in real time; that is, wallclock time. CWSIGALRM is delivered when the timer expires. CWITIMER_VIRTUAL counts time in (process) virtual time; that is, only when the process is running. In multiprocessor/user/CPU systems this may be more or less than real or wallclock time. (This time is also known as the user time.) CWSIGVTALRM is delivered when the timer expires. CWITIMER_PROF counts time when either the process virtual time or when the operating system is running on behalf of the process (such as I/O). (This time is also known as the system time.) (The sum of user time and system time is known as the CPU time.) CWSIGPROF is delivered when the timer expires. CWSIGPROF can interrupt system calls. The semantics of interval timers for multithreaded programs are system-specific, and some systems may support additional interval timers. See your CWsetitimer() documentation. Return the remaining time in the interval timer specified by CW$which. In scalar context, the remaining time is returned. In list context, both the remaining time and the interval are returned. The interval is always what you put in using CWsetitimer().

  use Time::HiRes qw(usleep ualarm gettimeofday tv_interval);

  $microseconds = 750_000;
  usleep $microseconds;

  # signal alarm in 2.5s & every .1s thereafter
  ualarm 2_500_000, 100_000;

  # get seconds and microseconds since the epoch
  ($s, $usec) = gettimeofday;

  # measure elapsed time 
  # (could also do by subtracting 2 gettimeofday return values)
  $t0 = [gettimeofday];
  # do bunch of stuff here
  $t1 = [gettimeofday];
  # do more stuff here
  $t0_t1 = tv_interval $t0, $t1;

  $elapsed = tv_interval ($t0, [gettimeofday]);
  $elapsed = tv_interval ($t0); # equivalent code

  #
  # replacements for time, alarm and sleep that know about
  # floating seconds
  #
  use Time::HiRes;
  $now_fractions = Time::HiRes::time;
  Time::HiRes::sleep (2.5);
  Time::HiRes::alarm (10.6666666);

  use Time::HiRes qw ( time alarm sleep );
  $now_fractions = time;
  sleep (2.5);
  alarm (10.6666666);

  # Arm an interval timer to go off first at 10 seconds and
  # after that every 2.5 seconds, in process virtual time

  use Time::HiRes qw ( setitimer ITIMER_VIRTUAL time );

  $SIG{VTALRM} = sub { print time, "\n" };
  setitimer(ITIMER_VIRTUAL, 10, 2.5);

In addition to the perl API described above, a C API is available for extension writers. The following C functions are available in the modglobal hash:

  name             C prototype
  ---------------  ----------------------
  Time::NVtime     double (*)()
  Time::U2time     void (*)(UV ret[2])

Both functions return equivalent information (like CWgettimeofday) but with different representations. The names CWNVtime and CWU2time were selected mainly because they are operating system independent. (CWgettimeofday is Unix-centric, though some platforms like VMS have emulations for it.)

Here is an example of using CWNVtime from C:

  double (*myNVtime)();
  SV **svp = hv_fetch(PL_modglobal, "Time::NVtime", 12, 0);
  if (!svp)         croak("Time::HiRes is required");
  if (!SvIOK(*svp)) croak("Time::NVtime isn't a function pointer");
  myNVtime = INT2PTR(double(*)(), SvIV(*svp));
  printf("The current time is: %f\n", (*myNVtime)());

You tried to use a negative time argument.

Something went horribly wrong the number of microseconds that cannot become negative just became negative. Maybe your compiler is broken?

Notice that the core CWtime() maybe rounding rather than truncating. What this means is that the core CWtime() may be reporting the time as one second later than CWgettimeofday() and CWTime::HiRes::time().

Adjusting the system clock (either manually or by services like ntp) may cause problems, especially for long running programs that assume a monotonously increasing time (note that all platforms do not adjust time as gracefully as UNIX ntp does). For example in Win32 (and derived platforms like Cygwin and MinGW) the Time::HiRes::time() may temporarily drift off from the system clock (and the original time()) by up to 0.5 seconds. Time::HiRes will notice this eventually and recalibrate.

D. Wegscheid <wegscd@whirlpool.com> R. Schertler <roderick@argon.org> J. Hietaniemi <jhi@iki.fi> G. Aas <gisle@aas.no>

Copyright (c) 1996-2002 Douglas E. Wegscheid. All rights reserved.

Copyright (c) 2002,2003,2004 Jarkko Hietaniemi. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.