Seth Woolley's Man Viewer

gettimeofday(2) - gettimeofday, settimeofday, gettimeofday, settimeofday - get / set time - man 2 gettimeofday

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

GETTIMEOFDAY(2)            Linux Programmer's Manual           GETTIMEOFDAY(2)



NAME
       gettimeofday, settimeofday - get / set(7,n,1 builtins) time(1,2,n)

SYNOPSIS
       #include <sys/time.h>

       int gettimeofday(struct timeval *tv, struct timezone *tz);
       int settimeofday(const struct timeval *tv , const struct timezone *tz);

DESCRIPTION
       The functions gettimeofday and settimeofday can get and set(7,n,1 builtins) the time(1,2,n) as
       well  as a timezone.  The tv argument is a timeval struct, as specified
       in(1,8) <sys/time.h>:

       struct timeval {
               time_t         tv_sec;        /* seconds */
               suseconds_t    tv_usec;  /* microseconds */
       };

       and gives the number of seconds and microseconds since the  Epoch  (see
       time(1,2,n)(2)).  The tz argument is a timezone :

       struct timezone {
               int  tz_minuteswest; /* minutes W of Greenwich */
               int  tz_dsttime;     /* type of dst correction */
       };

       The  use  of  the timezone struct is obsolete; the tz_dsttime field has
       never been used under Linux - it has not been and will not be supported
       by  libc or glibc.  Each and every occurrence of this field in(1,8) the ker-
       nel source (other than the declaration) is a bug. Thus,  the  following
       is purely of historic interest.

       The  field  tz_dsttime  contains  a symbolic constant (values are given
       below) that indicates in(1,8) which part of the year Daylight Saving Time is
       in(1,8)  force.  (Note:  its value is constant throughout the year - it does
       not indicate that DST is in(1,8) force, it just selects an algorithm.)   The
       daylight saving time(1,2,n) algorithms defined are as follows :

        DST_NONE     /* not on dst */
        DST_USA      /* USA style dst */
        DST_AUST     /* Australian style dst */
        DST_WET      /* Western European dst */
        DST_MET      /* Middle European dst */
        DST_EET      /* Eastern European dst */
        DST_CAN      /* Canada */
        DST_GB       /* Great Britain and Eire */
        DST_RUM      /* Rumania */
        DST_TUR      /* Turkey */
        DST_AUSTALT  /* Australian style with shift in(1,8) 1986 */

       Of  course  it turned out that the period in(1,8) which Daylight Saving Time
       is in(1,8) force cannot be given by a simple  algorithm,  one  per  country;
       indeed, this period is determined by unpredictable political decisions.
       So this method of representing time(1,2,n) zones  has  been  abandoned.  Under
       Linux, in(1,8) a call to settimeofday the tz_dsttime field should be zero.

       Under Linux there is some peculiar `warp clock(3,n)' semantics associated to
       the settimeofday system call if(3,n) on the very first call (after  booting)
       that  has  a  non-NULL  tz  argument,  the  tv argument is NULL and the
       tz_minuteswest field is nonzero. In such a case it is assumed that  the
       CMOS  clock(3,n) is on local time(1,2,n), and that it has to be incremented by this
       amount to get UTC system time.  No doubt it is a bad idea to  use  this
       feature.

       The following macros are defined to operate on a struct timeval :
       #define       timerisset(tvp)\
               ((tvp)->tv_sec || (tvp)->tv_usec)
       #define       timercmp(tvp, uvp, cmp)\
               ((tvp)->tv_sec cmp (uvp)->tv_sec ||\
               (tvp)->tv_sec == (uvp)->tv_sec &&\
               (tvp)->tv_usec cmp (uvp)->tv_usec)
       #define       timerclear(tvp)\
               ((tvp)->tv_sec = (tvp)->tv_usec = 0)

       If  either  tv or tz is null, the corresponding structure is not set(7,n,1 builtins) or
       returned.

       Only the super user may use settimeofday.

RETURN VALUE
       gettimeofday and settimeofday return 0 for success, or -1  for  failure
       (in(1,8) which case errno is set(7,n,1 builtins) appropriately).

ERRORS
       EFAULT One of tv or tz pointed outside the accessible address space.

       EINVAL Timezone (or something else) is invalid.

       EPERM  The  calling process has insufficient privilege to call settime-
              ofday; under Linux the CAP_SYS_TIME capability is required.

NOTE
       The prototype for settimeofday and the defines for  timercmp,  timeris-
       set(7,n,1 builtins),  timerclear, timeradd, timersub are (since glibc2.2.2) only avail-
       able if(3,n) _BSD_SOURCE is defined (either explicitly,  or  implicitly,  by
       not defining _POSIX_SOURCE or compiling with the -ansi flag).

       Traditionally, the fields of struct timeval were longs.

CONFORMING TO
       SVr4,  BSD 4.3. POSIX 1003.1-2001 describes gettimeofday() but not set-
       timeofday().

SEE ALSO
       date(1), adjtimex(2), time(1,2,n)(2), ctime(3), ftime(3), capabilities(7)



Linux 2.6.6                       2004-05-27                   GETTIMEOFDAY(2)

References for this manual (incoming links)