original/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 2009-02-08 "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
  34 .BI "int pthread_getcpuclockid(pthread_t " thread ", clockid_t *" clock_id);
  35 .sp
  36 Compile and link with \fI\-pthread\fP.
  37 .fi
  38 .SH DESCRIPTION
  39 The
  40 .BR pthread_getcpuclockid ()
  41 function returns the clock ID for the CPU time clock of the thread
  42 .IR thread .
  43 .\" The clockid is constructed as follows:
  44 .\" *clockid = CLOCK_THREAD_CPUTIME_ID | (pd->tid << CLOCK_IDFIELD_SIZE)
  45 .\" where CLOCK_IDFIELD_SIZE is 3.
  46 .SH RETURN VALUE
  47 On success, this function returns 0;
  48 on error, it returns a nonzero error number.
  49 .SH ERRORS
  50 .TP
  51 .B ENOENT
  52 .\" CLOCK_THREAD_CPUTIME_ID not defined
  53 Per-thread CPU time clocks are not supported by the system.
  54 .\"
  55 .\" Looking at nptl/pthread_getcpuclockid.c an ERANGE error would
  56 .\" be possible if kernel thread IDs took more than 29 bits (which
  57 .\" they currently cannot).
  58 .TP
  59 .B ESRCH
  60 No thread with the ID
  61 .I thread
  62 could be found.
  63 .SH VERSIONS
  64 This function is available in glibc since version 2.2.
  65 .SH CONFORMING TO
  66 POSIX.1-2001.
  67 .SH NOTES
  68 When
  69 .I thread
  70 refers to the calling thread,
  71 this function returns an identifier that refers to the same clock
  72 manipulated by
  73 .BR clock_gettime (2)
  74 and
  75 .BR clock_settime (2)
  76 when given the clock ID
  77 .BR CLOCK_THREAD_CPUTIME_ID .
  78 .SH EXAMPLE
  79 The program below creates a thread and then uses
  80 .BR clock_gettime (2)
  81 to retrieve the total process CPU time,
  82 and the per-thread CPU time consumed by the two threads.
  83 The following shell session shows an example run:
  84
  85 .in +4n
  86 .nf
  87 $ \fB./a.out\fP
  88 Main thread sleeping
  89 Subthread starting infinite loop
  90 Main thread consuming some CPU time...
  91 Process total CPU time:    1.368
  92 Main thread CPU time:      0.376
  93 Subthread CPU time:        0.992
  94 .fi
  95 .in
  96 .SS Program source
  97 \&
  98 .nf
  99 /* Link with "\-lrt" */
 100
 101 #include <time.h>
 102 #include <stdio.h>
 103 #include <stdlib.h>
 104 #include <unistd.h>
 105 #include <pthread.h>
 106 #include <string.h>
 107 #include <errno.h>
 108
 109 #define handle_error(msg) \\
 110         do { perror(msg); exit(EXIT_FAILURE); } while (0)
 111
 112 #define handle_error_en(en, msg) \\
 113         do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)
 114
 115 static void *
 116 thread_start(void *arg)
 117 {
 118     printf("Subthread starting infinite loop\\n");
 119     for (;;)
 120         continue;
 121 }
 122
 123 static void
 124 pclock(char *msg, clockid_t cid)
 125 {
 126     struct timespec ts;
 127
 128     printf("%s", msg);
 129     if (clock_gettime(cid, &ts) == \-1)
 130         handle_error("clock_gettime");
 131     printf("%4ld.%03ld\\n", ts.tv_sec, ts.tv_nsec / 1000000);
 132 }
 133
 134 int
 135 main(int argc, char *argv[])
 136 {
 137     pthread_t thread;
 138     clockid_t cid;
 139     int j, s;
 140
 141     s = pthread_create(&thread, NULL, thread_start, NULL);
 142     if (s != 0)
 143         handle_error_en(s, "pthread_create");
 144
 145     printf("Main thread sleeping\\n");
 146     sleep(1);
 147
 148     printf("Main thread consuming some CPU time...\\n");
 149     for (j = 0; j < 2000000; j++)
 150         getppid();
 151
 152     pclock("Process total CPU time: ", CLOCK_PROCESS_CPUTIME_ID);
 153
 154     s = pthread_getcpuclockid(pthread_self(), &cid);
 155     if (s != 0)
 156         handle_error_en(s, "pthread_getcpuclockid");
 157     pclock("Main thread CPU time:   ", cid);
 158
 159     /* The preceding 4 lines of code could have been replaced by:
 160        pclock("Main thread CPU time:   ", CLOCK_THREAD_CPUTIME_ID); */
 161
 162     s = pthread_getcpuclockid(thread, &cid);
 163     if (s != 0)
 164         handle_error_en(s, "pthread_getcpuclockid");
 165     pclock("Subthread CPU time: 1    ", cid);
 166
 167     exit(EXIT_SUCCESS);         /* Terminates both threads */
 168 }
 169 .fi
 170 .SH SEE ALSO
 171 .BR clock_gettime (2),
 172 .BR clock_settime (2),
 173 .BR timer_create (2),
 174 .BR clock_getcpuclockid (3),
 175 .BR pthread_self (3),
 176 .BR pthreads (7),
 177 .BR time (7)
 178 .SH COLOPHON
 179 This page is part of release 3.67 of the Linux
 180 .I man-pages
 181 project.
 182 A description of the project,
 183 information about reporting bugs,
 184 and the latest version of this page,
 185 can be found at
 186 \%http://www.kernel.org/doc/man\-pages/.