man3/pthread_getcpuclockid.3

   1 .\" Copyright (c) 2009 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_GETCPUCLOCKID 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_getcpuclockid \- retrieve ID of a thread's CPU time clock
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <pthread.h>
  32 .B #include <time.h>
  33 .PP
  34 .BI "int pthread_getcpuclockid(pthread_t " thread ", clockid_t *" clockid );
  35 .PP
  36 Compile and link with \fI\-pthread\fP.
  37 .fi
  38 .SH DESCRIPTION
  39 The
  40 .BR pthread_getcpuclockid ()
  41 function obtains the ID of the CPU-time clock of the thread whose ID is
  42 given in
  43 .IR thread ,
  44 and returns it in the location pointed to by
  45 .IR clockid .
  46 .\" The clockid is constructed as follows:
  47 .\" *clockid = CLOCK_THREAD_CPUTIME_ID | (pd->tid << CLOCK_IDFIELD_SIZE)
  48 .\" where CLOCK_IDFIELD_SIZE is 3.
  49 .SH RETURN VALUE
  50 On success, this function returns 0;
  51 on error, it returns a nonzero error number.
  52 .SH ERRORS
  53 .TP
  54 .B ENOENT
  55 .\" CLOCK_THREAD_CPUTIME_ID not defined
  56 Per-thread CPU time clocks are not supported by the system.
  57 .\"
  58 .\" Looking at nptl/pthread_getcpuclockid.c an ERANGE error would
  59 .\" be possible if kernel thread IDs took more than 29 bits (which
  60 .\" they currently cannot).
  61 .TP
  62 .B ESRCH
  63 No thread with the ID
  64 .I thread
  65 could be found.
  66 .SH VERSIONS
  67 This function is available in glibc since version 2.2.
  68 .SH ATTRIBUTES
  69 For an explanation of the terms used in this section, see
  70 .BR attributes (7).
  71 .ad l
  72 .nh
  73 .TS
  74 allbox;
  75 lbx lb lb
  76 l l l.
  77 Interface       Attribute       Value
  78 T{
  79 .BR pthread_getcpuclockid ()
  80 T}      Thread safety   MT-Safe
  81 .TE
  82 .hy
  83 .ad
  84 .sp 1
  85 .SH CONFORMING TO
  86 POSIX.1-2001, POSIX.1-2008.
  87 .SH NOTES
  88 When
  89 .I thread
  90 refers to the calling thread,
  91 this function returns an identifier that refers to the same clock
  92 manipulated by
  93 .BR clock_gettime (2)
  94 and
  95 .BR clock_settime (2)
  96 when given the clock ID
  97 .BR CLOCK_THREAD_CPUTIME_ID .
  98 .SH EXAMPLES
  99 The program below creates a thread and then uses
 100 .BR clock_gettime (2)
 101 to retrieve the total process CPU time,
 102 and the per-thread CPU time consumed by the two threads.
 103 The following shell session shows an example run:
 104 .PP
 105 .in +4n
 106 .EX
 107 $ \fB./a.out\fP
 108 Main thread sleeping
 109 Subthread starting infinite loop
 110 Main thread consuming some CPU time...
 111 Process total CPU time:    1.368
 112 Main thread CPU time:      0.376
 113 Subthread CPU time:        0.992
 114 .EE
 115 .in
 116 .SS Program source
 117 \&
 118 .EX
 119 /* Link with "\-lrt" */
 120
 121 #include <time.h>
 122 #include <stdio.h>
 123 #include <stdint.h>
 124 #include <stdlib.h>
 125 #include <unistd.h>
 126 #include <pthread.h>
 127 #include <string.h>
 128 #include <errno.h>
 129
 130 #define handle_error(msg) \e
 131         do { perror(msg); exit(EXIT_FAILURE); } while (0)
 132
 133 #define handle_error_en(en, msg) \e
 134         do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
 135
 136 static void *
 137 thread_start(void *arg)
 138 {
 139     printf("Subthread starting infinite loop\en");
 140     for (;;)
 141         continue;
 142 }
 143
 144 static void
 145 pclock(char *msg, clockid_t cid)
 146 {
 147     struct timespec ts;
 148
 149     printf("%s", msg);
 150     if (clock_gettime(cid, &ts) == \-1)
 151         handle_error("clock_gettime");
 152     printf("%4jd.%03ld\en", (intmax_t) ts.tv_sec, ts.tv_nsec / 1000000);
 153 }
 154
 155 int
 156 main(int argc, char *argv[])
 157 {
 158     pthread_t thread;
 159     clockid_t cid;
 160     int s;
 161
 162     s = pthread_create(&thread, NULL, thread_start, NULL);
 163     if (s != 0)
 164         handle_error_en(s, "pthread_create");
 165
 166     printf("Main thread sleeping\en");
 167     sleep(1);
 168
 169     printf("Main thread consuming some CPU time...\en");
 170     for (int j = 0; j < 2000000; j++)
 171         getppid();
 172
 173     pclock("Process total CPU time: ", CLOCK_PROCESS_CPUTIME_ID);
 174
 175     s = pthread_getcpuclockid(pthread_self(), &cid);
 176     if (s != 0)
 177         handle_error_en(s, "pthread_getcpuclockid");
 178     pclock("Main thread CPU time:   ", cid);
 179
 180     /* The preceding 4 lines of code could have been replaced by:
 181        pclock("Main thread CPU time:   ", CLOCK_THREAD_CPUTIME_ID); */
 182
 183     s = pthread_getcpuclockid(thread, &cid);
 184     if (s != 0)
 185         handle_error_en(s, "pthread_getcpuclockid");
 186     pclock("Subthread CPU time: 1    ", cid);
 187
 188     exit(EXIT_SUCCESS);         /* Terminates both threads */
 189 }
 190 .EE
 191 .SH SEE ALSO
 192 .BR clock_gettime (2),
 193 .BR clock_settime (2),
 194 .BR timer_create (2),
 195 .BR clock_getcpuclockid (3),
 196 .BR pthread_self (3),
 197 .BR pthreads (7),
 198 .BR time (7)