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 2009-03-25 "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 .\" The following is covered under EPERM below:
 104 .\" .PP
 105 .\" Only the superuser may use
 106 .\" .BR settimeofday ().
 107 .PP
 108 The use of the
 109 .I timezone
 110 structure is obsolete; the
 111 .I tz
 112 argument should normally be specified as NULL.
 113 The
 114 .I tz_dsttime
 115 field has never been used under Linux; it has not
 116 been and will not be supported by libc or glibc.
 117 Each and every occurrence of this field in the kernel source
 118 (other than the declaration) is a bug.
 119 Thus, the following
 120 is purely of historic interest.
 121
 122 The field
 123 .I tz_dsttime
 124 contains a symbolic constant (values are given below)
 125 that indicates in which part of the year Daylight Saving Time
 126 is in force.
 127 (Note: its value is constant throughout the year:
 128 it does not indicate that DST is in force, it just selects an
 129 algorithm.)
 130 The daylight saving time algorithms defined are as follows :
 131 .in +4n
 132 .nf
 133
 134 \fBDST_NONE\fP     /* not on dst */
 135 .br
 136 \fBDST_USA\fP      /* USA style dst */
 137 .br
 138 \fBDST_AUST\fP     /* Australian style dst */
 139 .br
 140 \fBDST_WET\fP      /* Western European dst */
 141 .br
 142 \fBDST_MET\fP      /* Middle European dst */
 143 .br
 144 \fBDST_EET\fP      /* Eastern European dst */
 145 .br
 146 \fBDST_CAN\fP      /* Canada */
 147 .br
 148 \fBDST_GB\fP       /* Great Britain and Eire */
 149 .br
 150 \fBDST_RUM\fP      /* Rumania */
 151 .br
 152 \fBDST_TUR\fP      /* Turkey */
 153 .br
 154 \fBDST_AUSTALT\fP  /* Australian style with shift in 1986 */
 155 .fi
 156 .in
 157 .PP
 158 Of course it turned out that the period in which
 159 Daylight Saving Time is in force cannot be given
 160 by a simple algorithm, one per country; indeed,
 161 this period is determined by unpredictable political
 162 decisions.
 163 So this method of representing timezones
 164 has been abandoned.
 165 Under Linux, in a call to
 166 .BR settimeofday ()
 167 the
 168 .I tz_dsttime
 169 field should be zero.
 170 .PP
 171 Under Linux there are some peculiar "warp clock" semantics associated
 172 with the
 173 .BR settimeofday ()
 174 system call if on the very first call (after booting)
 175 that has a non-NULL
 176 .I tz
 177 argument, the
 178 .I tv
 179 argument is NULL and the
 180 .I tz_minuteswest
 181 field is nonzero.
 182 In such a case it is assumed that the CMOS clock
 183 is on local time, and that it has to be incremented by this amount
 184 to get UTC system time.
 185 No doubt it is a bad idea to use this feature.
 186 .PP
 187 Macros for operating on
 188 .I timeval
 189 structures are described in
 190 .BR timeradd (3).
 191 .SH "RETURN VALUE"
 192 .BR gettimeofday ()
 193 and
 194 .BR settimeofday ()
 195 return 0 for success, or \-1 for failure (in which case
 196 .I errno
 197 is set appropriately).
 198 .SH ERRORS
 199 .TP
 200 .B EFAULT
 201 One of
 202 .I tv
 203 or
 204 .I tz
 205 pointed outside the accessible address space.
 206 .TP
 207 .B EINVAL
 208 Timezone (or something else) is invalid.
 209 .TP
 210 .B EPERM
 211 The calling process has insufficient privilege to call
 212 .BR settimeofday ();
 213 under Linux the
 214 .B CAP_SYS_TIME
 215 capability is required.
 216 .SH "CONFORMING TO"
 217 SVr4, 4.3BSD.
 218 POSIX.1-2001 describes
 219 .BR gettimeofday ()
 220 but not
 221 .BR settimeofday ().
 222 POSIX.1-2008 marks
 223 .BR gettimeofday ()
 224 as obsolete, recomending the use of
 225 .BR clock_gettime (2)
 226 instead.
 227 .SH NOTES
 228 .LP
 229 Traditionally, the fields of
 230 .I struct timeval
 231 were of type
 232 .IR long .
 233 .SH "SEE ALSO"
 234 .BR date (1),
 235 .BR adjtimex (2),
 236 .BR time (2),
 237 .BR ctime (3),
 238 .BR ftime (3),
 239 .BR capabilities (7),
 240 .BR time (7)