clock_getcpuclockid(3)

clock_getcpuclockid3

Access a process cpu-time clock

Usage

#include <time.h>

int

clock_getcpuclockid(pid_t pid, clockid_t *clock_id);

Library

Standard C Library (libc, -lc)

Overview

The clock_getcpuclockid() returns the clock ID of the CPU-time clock of the process specified by pid. If the process described by pid exists and the calling process has permission, the clock ID of this clock will be returned in clock_id.

If pid is zero, the clock_getcpuclockid() function returns the clock ID of the CPU-time clock of the process making the call, in clock_id.

Return values

Upon successful completion, clock_getcpuclockid() returns zero; otherwise, an error number is returned to indicate the error.

Errors

The clock_getcpuclockid() function will fail if:

[EPERM]

The requesting process does not have permission to access the CPU-time clock for the process.

[ESRCH]

No process can be found corresponding to the process specified by pid.

Releases

30 releases since FreeBSD 10.0-RELEASE; the text changed 16 times.

  1. 10.0
  2. 10.1
  3. 10.2
  4. 10.3
  5. 10.4
  6. 11.0
  7. 11.1
  8. 11.2
  9. 11.3
  10. 11.4
  11. 12.0
  12. 12.1
  13. 12.2
  14. 12.3
  15. 12.4
  16. 13.0–13.2
  17. 13.3–16.0

Standards

The clock_getcpuclockid() function conforms to IEEE Std 1003.1-2001 (“POSIX.1”).

History

The clock_getcpuclockid() function first appeared in FreeBSD 10.0.

Authors

David Xu ⟨[email protected]⟩

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.