PHP hrtime() Function

PHP

PHP hrtime() - High Resolution Time

The hrtime() function in PHP provides access to high-resolution time measurements in nanoseconds, making it an excellent tool for performance measurement, benchmarking, and profiling your scripts with precision beyond the classic millisecond timing functions.

Introduction

In many applications, especially those involving performance optimization or benchmarking, obtaining highly precise timestamps is crucial. PHP's hrtime() function was introduced to give developers access to high-resolution time—with nanosecond accuracy—allowing more granular time measurements than the usual second or microsecond-based timers.

This tutorial will guide you through the basics of the hrtime() function, how to use it effectively, and practical examples demonstrating its benefit.

Prerequisites

  • PHP 7.3 or later (the hrtime() function was introduced in PHP 7.3)
  • Basic PHP programming knowledge
  • Command line or web server setup to run PHP scripts

Setup

No special setup is required for using hrtime() besides having a PHP environment version 7.3 or higher. You can verify your PHP version using:

php -v

If your version is adequate, you're ready to start measuring time with hrtime().

Understanding the hrtime() Function

The function signature is:

hrtime(bool $as_array = false): mixed

It returns the current high-resolution time as either an array or a single integer:

  • If $as_array is false or omitted: returns a 64-bit integer representing nanoseconds elapsed since an arbitrary point in the past.
  • If $as_array is true: returns an array with two integers [seconds, nanoseconds].

This arbitrary point in time is consistent during the PHP runtime but not related to UNIX epoch.

Examples

Example 1: Getting time as a nanosecond integer

<?php
$nanoseconds = hrtime();
echo "High resolution time: " . $nanoseconds . " nanoseconds\n";
?>

This gives a large integer value representing the nanoseconds since an arbitrary time reference.

Example 2: Getting time as an array of seconds and nanoseconds

<?php
$timeArray = hrtime(true);
echo "Seconds part: " . $timeArray[0] . "\n";
echo "Nanoseconds part: " . $timeArray[1] . "\n";
?>

Example 3: Measuring execution time of a code block

<?php
$start = hrtime(true);

// Sample code to measure
usleep(100000); // sleep 100 milliseconds

$end = hrtime(true);

// Calculate time difference in nanoseconds
$seconds = $end[0] - $start[0];
$nanoseconds = $end[1] - $start[1];

// Normalize nanoseconds to seconds if negative
if ($nanoseconds < 0) {
    $seconds--;
    $nanoseconds += 1_000_000_000;
}

$totalNanoseconds = $seconds * 1_000_000_000 + $nanoseconds;

echo "Execution time: $totalNanoseconds nanoseconds\n";
echo "Execution time: " . ($totalNanoseconds / 1_000_000_000) . " seconds\n";
?>

Here, we correctly calculate the elapsed time with nanosecond precision, even if nanoseconds wrap around during the subtraction.

Best Practices

  • Always use hrtime(true) when you want to get the time as an array to make time interval calculations easier.
  • When calculating differences, handle the case where nanosecond subtraction results in a negative value by adjusting seconds accordingly.
  • Use hrtime() for benchmarking or profiling code sections to detect even very small performance improvements or regressions.
  • Do not use hrtime() as a replacement for getting the current system clock time or timestamps for logging; it's designed for measuring intervals.

Common Mistakes to Avoid

  • Assuming the returned integer is an absolute timestamp related to UNIX epoch. It’s not—it's relative to an arbitrary point.
  • Neglecting to handle negative nanosecond differences when subtracting two time arrays.
  • Using hrtime() for general date/time needs instead of performance measurement.
  • Running hrtime() on PHP versions below 7.3 (will cause errors).
  • Ignoring that hrtime() resolution and behavior might differ across operating systems and PHP setups.

Interview Questions

Junior Level

  1. What does the hrtime() function return by default?

    It returns the current high-resolution time as an integer representing nanoseconds elapsed since an arbitrary starting point.

  2. Since which PHP version is hrtime() available?

    PHP 7.3 and later.

  3. How can you get hrtime() to return an array instead of an integer?

    By passing true as the argument: hrtime(true).

  4. What units does hrtime() measure time in?

    Nanoseconds.

  5. Is the time returned by hrtime() related to the UNIX epoch?

    No, it is relative to an arbitrary point in the past and not related to UNIX epoch.

Mid Level

  1. How would you measure the elapsed time between two points in your PHP script using hrtime()?

    Call hrtime(true) at the start and end, then calculate the difference of seconds and nanoseconds, normalizing if needed.

  2. What should you be careful about when subtracting two arrays returned by hrtime(true)?

    Be careful of negative nanosecond differences, which require adjusting the seconds part accordingly.

  3. Can hrtime() be reliably used for getting the current date and time?

    No, it should not be used for date/time but for interval measurement only.

  4. Why might you prefer hrtime() over microtime()?

    Because hrtime() provides nanosecond precision, higher than microseconds offered by microtime().

  5. What is the return type of hrtime(false)?

    A 64-bit integer representing nanoseconds elapsed.

Senior Level

  1. Explain why hrtime() returns an arbitrary time point rather than an epoch-based time.

    High-resolution timers track elapsed time for benchmarking and profiling rather than absolute time, so they measure time relative to a monotonic clock that isn’t affected by system time changes.

  2. How can using hrtime() prevent timing attacks or side-channel vulnerabilities?

    The nanosecond precision and monotonic nature allow secure measurement of execution time without being affected by system time adjustments, making timing analysis more accurate and less predictable.

  3. Discuss handling cross-platform differences when using hrtime() in a production application.

    Understand that resolution and precision may vary per OS and hardware. Test on target platforms and consider fallback mechanisms where hrtime() is unavailable or behaves differently.

  4. How would you combine multiple hrtime() measurements for complex profiling?

    Collect timestamps before and after multiple code regions, compute intervals with normalization, and aggregate or average the results to gain performance insights.

  5. Describe a scenario where using hrtime() could introduce issues or inaccurate profiling metrics.

    If the underlying clock is not truly monotonic or if the PHP environment restarts and the arbitrary starting point resets, elapsed times might be inconsistent across runs; also, overhead of calling hrtime() in very tight loops might distort measurements.

Frequently Asked Questions (FAQ)

Q1: What is the main advantage of hrtime() compared to microtime()?

A1: hrtime() provides nanosecond precision, offering higher resolution timing for accurate performance measurements, whereas microtime() provides microsecond precision.

Q2: Can I use hrtime() to get the current date or time of day?

A2: No. hrtime() returns time relative to an arbitrary point and is only suitable for measuring intervals, not for getting absolute date/time.

Q3: What happens if I call hrtime() on a PHP version lower than 7.3?

A3: The function will not exist and result in a fatal error. Ensure your PHP version is 7.3 or later to use hrtime().

Q4: How to correctly calculate elapsed time between two hrtime(true) calls?

A4: Subtract seconds and nanoseconds separately. If nanoseconds are negative, adjust by subtracting one from seconds and adding 1,000,000,000 to nanoseconds.

Q5: Is the value returned by hrtime() affected by system clock changes?

A5: No. hrtime() uses a monotonic clock, so it is immune to changes in the system clock, ensuring reliable interval timing.

Conclusion

The PHP hrtime() function is a powerful tool designed to provide developers with nanosecond precision timing for benchmarking and profiling tasks. By understanding how to use its integer and array forms and handling time difference calculations properly, you can significantly enhance your ability to measure and optimize performance in PHP scripts.

Use hrtime() when you need more accuracy than microtime() can provide but remember it is unsuitable for timestamp or date/time-related purposes. With careful use, this function can be a critical component in your PHP performance tuning toolkit.