lib/libc/sys/gettimeofday.2

   1 .\"     $NetBSD: gettimeofday.2,v 1.27 2010/05/18 07:14:18 jruoho Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)gettimeofday.2      8.2 (Berkeley) 5/26/95
  31 .\"
  32 .Dd May 18, 2010
  33 .Dt GETTIMEOFDAY 2
  34 .Os
  35 .Sh NAME
  36 .Nm gettimeofday ,
  37 .Nm settimeofday
  38 .Nd get/set date and time
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/time.h
  43 .Ft int
  44 .Fn gettimeofday "struct timeval * restrict tp" "void * restrict tzp"
  45 .Ft int
  46 .Fn settimeofday "const struct timeval * restrict tp" "const void * restrict tzp"
  47 .Sh DESCRIPTION
  48 .Bf -symbolic
  49 Note: time zone information is no longer provided by this interface.
  50 See
  51 .Xr localtime 3
  52 for information on how to retrieve it.
  53 .Ef
  54 .Pp
  55 The system's notion of the current UTC time is obtained with the
  56 .Fn gettimeofday
  57 call, and set with the
  58 .Fn settimeofday
  59 call.
  60 The time is expressed in seconds and microseconds
  61 since midnight (0 hour), January 1, 1970.
  62 The resolution of the system clock is hardware dependent,
  63 and the time may be updated continuously or in
  64 .Dq ticks .
  65 .Pp
  66 If
  67 .Fa tp
  68 is NULL, the time will not be returned or set.
  69 Despite being declared
  70 .Fa void * ,
  71 the objects pointed to by
  72 .Fa tzp
  73 shall be of type
  74 .Fa struct timezone .
  75 .Pp
  76 The structures pointed to by
  77 .Fa tp
  78 and
  79 .Fa tzp
  80 are defined in
  81 .In sys/time.h .
  82 The first one is described in
  83 .Xr timeval 3
  84 and the latter legacy structure is defined as:
  85 .Bd -literal -offset indent
  86 struct timezone {
  87         int     tz_minuteswest; /* of Greenwich */
  88         int     tz_dsttime;     /* type of dst correction to apply */
  89 };
  90 .Ed
  91 .Pp
  92 The
  93 .Fa timezone
  94 structure is provided only for source compatibility.
  95 It is ignored by
  96 .Fn settimeofday ,
  97 and
  98 .Fn gettimeofday
  99 will always return zeroes.
 100 .Pp
 101 If the calling user is not the super-user, then the
 102 .Fn settimeofday
 103 function in the standard C library will try to use the
 104 .Xr clockctl 4
 105 device if present, thus making possible for non privileged users to
 106 set the system time.
 107 If
 108 .Xr clockctl 4
 109 is not present or not accessible, then
 110 .Fn settimeofday
 111 reverts to the
 112 .Fn settimeofday
 113 system call, which is restricted to the super user.
 114 .\" XXX uncomment when/if this is put into place!
 115 .\" If the system is running in secure mode (see
 116 .\" .Xr init 8 ),
 117 .\" the time may only be advanced.
 118 .\" This limitation is imposed to prevent a malicious super user
 119 .\" from setting arbitrary time stamps on files.
 120 .\" The system time can still be adjusted backwards using the
 121 .\" .Xr adjtime 2
 122 .\" system call even when the system is secure.
 123 .Sh RETURN VALUES
 124 A return value 0 indicates that the call succeeded.
 125 A return value \-1 indicates an error occurred, and in this
 126 case an error code is stored into the global variable
 127 .Va errno .
 128 .Sh ERRORS
 129 The following error codes may be set in
 130 .Va errno :
 131 .Bl -tag -width Er
 132 .It Bq Er EFAULT
 133 An argument address referenced invalid memory.
 134 .It Bq Er EPERM
 135 A user other than the super user attempted to set the time, or the specified
 136 time was less than the current time, which was not permitted at the current
 137 security level.
 138 .El
 139 .Sh SEE ALSO
 140 .Xr date 1 ,
 141 .Xr adjtime 2 ,
 142 .Xr ctime 3 ,
 143 .Xr localtime 3 ,
 144 .Xr clockctl 4 ,
 145 .Xr timed 8
 146 .Sh HISTORY
 147 The
 148 .Fn gettimeofday
 149 function call appeared in
 150 .Bx 4.2 .
 151 The
 152 .Fa tzp
 153 argument was deprecated in
 154 .Bx 4.4
 155 (and many other systems).