CLOCK(3P)

๐ŸŒธ CLOCK(3P) โ€” bestie edition ๐ŸŒธ

okay so this one's from the POSIX Programmer's Manual, section 3P, and it's literally called CLOCK. it's giving "how much CPU did my lil program eat" energy and honestly? obsessed. ๐Ÿ’…

โœจ PROLOG โœจ

so like, real talk before we even start โ€” this manual page is part of the POSIX Programmer's Manual. the Linux implementation of this interface may differ (so consult the corresponding Linux manual page for details on Linux behavior), or the interface may not even be implemented on Linux at all. ๐Ÿ™ˆ no cap, check first.


๐Ÿ’– NAME ๐Ÿ’–

clock โ€” report CPU time used ๐Ÿ•โœจ

๐ŸŽ€ SYNOPSIS ๐ŸŽ€

#include <time.h>

clock_t clock(void);

๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

okay so first things first, bestie: the functionality described on this reference page is aligned with the ISO C standard. any conflict between the requirements described here and the ISO C standard is unintentional โ€” like, nobody's trying to start drama. this volume of POSIX.1โ€2017 defers to the ISO C standard. periodt. ๐Ÿ‘‘

now the actual tea: the clock() function shall return the implementation's best approximation to the processor time used by the process since the beginning of an implementation-defined era related only to the process invocation. that's the whole vibe. ๐ŸŒˆ

๐Ÿ’œ RETURN VALUE ๐Ÿ’œ

so to determine the time in seconds, the value returned by clock() should be divided by the value of the macro CLOCKS_PER_SEC. and CLOCKS_PER_SEC is defined to be one million in <time.h>. (one million!! she's fancy like that ๐Ÿ’…)

and if the processor time used is not available or its value cannot be represented, the function shall return the value (clock_t)-1. ๐Ÿ˜ญ

โญ ERRORS โญ

No errors are defined.

(and the following sections are informative, jsyk ๐Ÿ‘€)

๐ŸŒธ EXAMPLES ๐ŸŒธ

None.

...yeah. nothing. it's giving minimalism. ๐Ÿซถ

๐ŸŒบ APPLICATION USAGE ๐ŸŒบ

okay bestie this part actually matters, listen up:

in programming environments where clock_t is a 32-bit integer type and CLOCKS_PER_SEC is one million, clock() will start failing in less than 36 minutes of processor time for signed clock_t, or 72 minutes for unsigned clock_t. ๐Ÿ’€ that's it. that's the whole window. applications intended to be portable to such environments should use times() instead (or clock_gettime() with CLOCK_PROCESS_CPUTIME_ID, if supported).

so basically: if you're on a 32-bit clock_t situation, your clock hits the ceiling in under an hour and just gives up. not her fault, but like, plan accordingly. ๐Ÿ™ˆ

and in order to measure the time spent in a program, clock() should be called at the start of the program and its return value subtracted from the value returned by subsequent calls. (start value, end value, subtract, slay. โž–โœจ) the value returned by clock() is defined for compatibility across systems that have clocks with different resolutions. and the resolution on any particular system need not be to microsecond accuracy. so don't come for her about precision, she's doing her best. ๐ŸŽ€

๐Ÿ’ซ RATIONALE ๐Ÿ’ซ

None.

๐Ÿ”ฎ FUTURE DIRECTIONS ๐Ÿ”ฎ

None.

๐Ÿ‘‘ SEE ALSO ๐Ÿ‘‘

asctime(), clock_getres(), ctime(), difftime(), gmtime(), localtime(), mktime(), strftime(), strptime(), time(), times(), utime()

the Base Definitions volume of POSIX.1โ€2017, <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. (so if there's beef, the original wins, no debate ๐Ÿซก) 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, 2017 โ€” mwah, thanks for the lore, sending you the biggest forehead kiss ๐Ÿ’–๐ŸŽ€โœจ

๐Ÿ“ฆ where this page comes from