pthread_getcpuclockid(3)

pthread_getcpuclockid3

Access a thread cpu-time clock

Usage

#include <pthread.h>

#include <time.h>

int

pthread_getcpuclockid(pthread_t thread_id, clockid_t *clock_id);

Library

POSIX Threads Library (libpthread, -lpthread)

Overview

The pthread_getcpuclockid() returns the clock ID of the CPU-time clock of the thread specified by thread_id, if the thread described by thread_id exists.

Return values

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

Errors

The pthread_getcpuclockid() function will fail if:

[ESRCH]

The value specified by thread_id does not refer to an existing thread.

Releases

30 releases since FreeBSD 10.0-RELEASE; the text changed 17 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–15.1
  18. 16.0

Standards

The pthread_getcpuclockid() function conforms to IEEE Std 1003.1-2004 (“POSIX.1”).

History

The pthread_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.