PTHREAD_GETCPUCLOCKID(3P)

πŸ’– PROLOG πŸ’–

Okay bestie, real talk before we even start: this manual page is part of the POSIX Programmer's Manual. And the Linux implementation of this interface may differ β€” so if you're on Linux, pls go consult the corresponding Linux manual page for the deets on Linux behavior. Or honestly? The interface might just not be implemented on Linux at all. πŸ™ˆ It's giving "check first, cry later."


✨ NAME ✨

pthread_getcpuclockid β€” access a thread CPU-time clock (ADVANCED REALTIME THREADS)


🌸 SYNOPSIS 🌸

#include <pthread.h>
#include <time.h>

int pthread_getcpuclockid(pthread_t thread_id, clockid_t *clock_id);

πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the vibe: pthread_getcpuclockid() shall return, inside clock_id, the clock ID of the CPU-time clock belonging to the thread you specified with thread_id β€” but only if that thread actually exists. That's the whole job. She's a one-trick pony and she's iconic for it. πŸ‘‘


πŸ’… RETURN VALUE πŸ’…

Success? She returns zero. Periodt. ✨

Anything else? Then an error number gets returned instead, to indicate the error. No cap.


πŸŽ€ ERRORS πŸŽ€

No errors are defined.

Heads up: the following sections are informative. (iykyk β€” informative means "for your reading pleasure," not "normative law.") πŸ’œ

πŸ“ EXAMPLES πŸ“

None. Literally none. Nothing. Empty. The girls are resting. 😭


🧚 APPLICATION USAGE 🧚

pthread_getcpuclockid() is part of the Thread CPU-Time Clocks option β€” which means it need not be provided on all implementations. So if your platform ghosts you on this one, it's not being rude, it's just allowed. πŸ’€


🌈 RATIONALE 🌈

Here's the tea: if an implementation detects use of a thread ID after the end of its lifetime, it is recommended that the function should fail and report an [ESRCH] error. So don't be out here passing expired thread IDs around like they're still valid β€” that's not main character energy, that's a bug. 🫢


⭐ FUTURE DIRECTIONS ⭐

None.


πŸ‘‘ SEE ALSO πŸ‘‘

  • clock_getcpuclockid()
  • clock_getres()
  • timer_create()

Also, from the Base Definitions volume of POSIX.1‐2017:

  • <pthread.h>
  • <time.h>

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


And that's the whole page, bestie β€” brought to you by IEEE/The Open Group, dated 2017, filed under PTHREAD_GETCPUCLOCKID(3P). Stay clocked in, stay CPU-time accurate, and go get that thread's clock ID. Slay. πŸ’…βœ¨

πŸ“¦ where this page comes from