original/man2/gettimeofday.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (c) 1992 Drew Eckhardt (drew@cs.colorado.edu), March 28, 1992
   4 .\"
   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 .\"
  25 .\" Modified by Michael Haardt (michael@moria.de)
  26 .\" Modified 1993-07-23 by Rik Faith (faith@cs.unc.edu)
  27 .\" Modified 1994-08-21 by Michael Chastain (mec@shell.portal.com):
  28 .\"   Fixed necessary '#include' lines.
  29 .\" Modified 1995-04-15 by Michael Chastain (mec@shell.portal.com):
  30 .\"   Added reference to adjtimex.
  31 .\" Removed some nonsense lines pointed out by Urs Thuermann,
  32 .\"   (urs@isnogud.escape.de), aeb, 950722.
  33 .\" Modified 1997-01-14 by Austin Donnelly (and1000@debian.org):
  34 .\"   Added return values section, and bit on EFAULT
  35 .\" Added clarification on timezone, aeb, 971210.
  36 .\" Removed "#include <unistd.h>", aeb, 010316.
  37 .\" Modified, 2004-05-27 by Michael Kerrisk <mtk.manpages@gmail.com>
  38 .\"   Added notes on capability requirement.
  39 .\"
  40 .TH GETTIMEOFDAY 2 2012-04-26 "Linux" "Linux Programmer's Manual"
  41 .SH NAME
  42 gettimeofday, settimeofday \- get / set time
  43 .SH SYNOPSIS
  44 .nf
  45 .B #include <sys/time.h>
  46
  47 .BI "int gettimeofday(struct timeval *" tv ", struct timezone *" tz );
  48
  49 .BI "int settimeofday(const struct timeval *" tv \
  50 ", const struct timezone *" tz );
  51
  52 .fi
  53 .in -4n
  54 Feature Test Macro Requirements for glibc (see
  55 .BR feature_test_macros (7)):
  56 .in
  57 .sp
  58 .BR settimeofday ():
  59 _BSD_SOURCE
  60 .SH DESCRIPTION
  61 The functions
  62 .BR gettimeofday ()
  63 and
  64 .BR settimeofday ()
  65 can get and set the time as well as a timezone.
  66 The
  67 .I tv
  68 argument is a
  69 .I struct timeval
  70 (as specified in
  71 .IR <sys/time.h> ):
  72 .sp
  73 .in +4n
  74 .nf
  75 struct timeval {
  76     time_t      tv_sec;     /* seconds */
  77     suseconds_t tv_usec;    /* microseconds */
  78 };
  79 .fi
  80 .in
  81 .sp
  82 and gives the number of seconds and microseconds since the Epoch (see
  83 .BR time (2)).
  84 The
  85 .I tz
  86 argument is a
  87 .IR "struct timezone" :
  88 .sp
  89 .in +4n
  90 .nf
  91 struct timezone {
  92     int tz_minuteswest;     /* minutes west of Greenwich */
  93     int tz_dsttime;         /* type of DST correction */
  94 };
  95 .fi
  96 .in
  97 .PP
  98 If either
  99 .I tv
 100 or
 101 .I tz
 102 is NULL, the corresponding structure is not set or returned.
 103 (However, compilation warnings will result if
 104 .I tv
 105 is NULL.)
 106 .\" The following is covered under EPERM below:
 107 .\" .PP
 108 .\" Only the superuser may use
 109 .\" .BR settimeofday ().
 110 .PP
 111 The use of the
 112 .I timezone
 113 structure is obsolete; the
 114 .I tz
 115 argument should normally be specified as NULL.
 116 (See NOTES below.)
 117
 118 Under Linux there are some peculiar "warp clock" semantics associated
 119 with the
 120 .BR settimeofday ()
 121 system call if on the very first call (after booting)
 122 that has a non-NULL
 123 .I tz
 124 argument, the
 125 .I tv
 126 argument is NULL and the
 127 .I tz_minuteswest
 128 field is nonzero.
 129 (The
 130 .I tz_dsttime
 131 field should be zero for this case.)
 132 In such a case it is assumed that the CMOS clock
 133 is on local time, and that it has to be incremented by this amount
 134 to get UTC system time.
 135 No doubt it is a bad idea to use this feature.
 136 .SH "RETURN VALUE"
 137 .BR gettimeofday ()
 138 and
 139 .BR settimeofday ()
 140 return 0 for success, or \-1 for failure (in which case
 141 .I errno
 142 is set appropriately).
 143 .SH ERRORS
 144 .TP
 145 .B EFAULT
 146 One of
 147 .I tv
 148 or
 149 .I tz
 150 pointed outside the accessible address space.
 151 .TP
 152 .B EINVAL
 153 Timezone (or something else) is invalid.
 154 .TP
 155 .B EPERM
 156 The calling process has insufficient privilege to call
 157 .BR settimeofday ();
 158 under Linux the
 159 .B CAP_SYS_TIME
 160 capability is required.
 161 .SH "CONFORMING TO"
 162 SVr4, 4.3BSD.
 163 POSIX.1-2001 describes
 164 .BR gettimeofday ()
 165 but not
 166 .BR settimeofday ().
 167 POSIX.1-2008 marks
 168 .BR gettimeofday ()
 169 as obsolete, recommending the use of
 170 .BR clock_gettime (2)
 171 instead.
 172 .SH NOTES
 173 The time returned by
 174 .BR gettimeofday (2)
 175 .I is
 176 affected by discontinuous jumps in the system time
 177 (e.g., if the system administrator manually changes the system time).
 178 If you need a monotonically increasing clock, see
 179 .BR clock_gettime (2).
 180
 181 Macros for operating on
 182 .I timeval
 183 structures are described in
 184 .BR timeradd (3).
 185
 186 Traditionally, the fields of
 187 .I struct timeval
 188 were of type
 189 .IR long .
 190
 191 The
 192 .I tz_dsttime
 193 field has never been used under Linux.
 194 .\" it has not
 195 .\" been and will not be supported by libc or glibc.
 196 .\" Each and every occurrence of this field in the kernel source
 197 .\" (other than the declaration) is a bug.
 198 Thus, the following
 199 is purely of historic interest.
 200
 201 On old systems, the field
 202 .I tz_dsttime
 203 contains a symbolic constant (values are given below)
 204 that indicates in which part of the year Daylight Saving Time
 205 is in force.
 206 (Note: this value is constant throughout the year:
 207 it does not indicate that DST is in force, it just selects an
 208 algorithm.)
 209 The daylight saving time algorithms defined are as follows:
 210 .in +4n
 211 .nf
 212
 213 \fBDST_NONE\fP     /* not on DST */
 214 .br
 215 \fBDST_USA\fP      /* USA style DST */
 216 .br
 217 \fBDST_AUST\fP     /* Australian style DST */
 218 .br
 219 \fBDST_WET\fP      /* Western European DST */
 220 .br
 221 \fBDST_MET\fP      /* Middle European DST */
 222 .br
 223 \fBDST_EET\fP      /* Eastern European DST */
 224 .br
 225 \fBDST_CAN\fP      /* Canada */
 226 .br
 227 \fBDST_GB\fP       /* Great Britain and Eire */
 228 .br
 229 \fBDST_RUM\fP      /* Romania */
 230 .br
 231 \fBDST_TUR\fP      /* Turkey */
 232 .br
 233 \fBDST_AUSTALT\fP  /* Australian style with shift in 1986 */
 234 .fi
 235 .in
 236 .PP
 237 Of course it turned out that the period in which
 238 Daylight Saving Time is in force cannot be given
 239 by a simple algorithm, one per country; indeed,
 240 this period is determined by unpredictable political
 241 decisions.
 242 So this method of representing timezones
 243 has been abandoned.
 244 .SH "SEE ALSO"
 245 .BR date (1),
 246 .BR adjtimex (2),
 247 .BR clock_gettime (2),
 248 .BR time (2),
 249 .BR ctime (3),
 250 .BR ftime (3),
 251 .BR timeradd (3),
 252 .BR capabilities (7),
 253 .BR time (7)