src/lwp/fasttime.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 /*
  11  *      fasttime.c -- Get the time of day quickly by mapping the kernel's
  12  *                    time of day variable.
  13  *
  14  *      6 January 1986
  15  *
  16  *      Modification History
  17  *      3/21/86:  Added FT_ApproxTime which returns the last time
  18  *                in seconds returned by RT_FastTime.  The intent is to give
  19  *                routines which aren't too concerned about the exact time
  20  *                fast access to the time, even on kernels without mmap.
  21  *      4/2/86:   Fixed my previous mod and fixed FT_Init so it doesn't initialize
  22  *                a second time if explicitly called after being implicitly called.
  23  *                This saves a (precious) file descriptor.
  24  */
  25
  26 #include <afsconfig.h>
  27 #include <afs/param.h>
  28
  29 RCSID
  30     ("$Header$");
  31
  32 #include <stdio.h>
  33 #include <sys/types.h>
  34 #ifdef AFS_NT40_ENV
  35 #include <sys/timeb.h>
  36 #include <winsock2.h>
  37 #else
  38 #include <sys/time.h>
  39 #include <sys/file.h>
  40 #endif
  41 #include <afs/afsutil.h>
  42
  43 int ft_debug;
  44
  45 #define TRUE    1
  46 #define FALSE   0
  47
  48 static enum InitState { notTried, tried, done } initState = notTried;
  49
  50 struct timeval FT_LastTime;     /* last time returned by RT_FastTime.  Used to implement
  51                                  * FT_ApproxTime */
  52
  53
  54 /* Call this to get the memory mapped.  It will return -1 if anything went
  55    wrong.  In that case, calls to FT_GetTimeOfDay will call gettimeofday
  56    instead.  If printErrors is true, errors in initialization will cause
  57    error messages to be printed on stderr.  If notReally is true, then
  58    things are set up so that all calls to FT_GetTimeOfDay call gettimeofday.
  59    You might want this if your program won't run too long and the nlist
  60    call is too expensive.  Yeah, it's pretty horrible.
  61 */
  62 int
  63 FT_Init(int printErrors, int notReally)
  64 {
  65     if (initState != notTried && !notReally)
  66         return (initState == done ? 0 : -1);    /* This is in case explicit initialization
  67                                                  * occurs after automatic initialization */
  68     initState = tried;
  69     if (notReally)
  70         return 0;               /* fake success, but leave initState
  71                                  * wrong. */
  72     if (printErrors)
  73         fprintf(stderr, "FT_Init: mmap  not implemented on this kernel\n");
  74     return (-1);
  75 }
  76
  77 /* Call this to get the time of day.  It will automatically initialize the
  78    first time you call it.  If you want error messages when you initialize,
  79    call FT_Init yourself.  If the initialization failed, this will just
  80    call gettimeofday.  If you ask for the timezone info, this routine will
  81    punt to gettimeofday. */
  82 int
  83 FT_GetTimeOfDay(struct timeval *tv, struct timezone *tz)
  84 {
  85     register int ret;
  86     ret = gettimeofday(tv, tz);
  87     if (!ret) {
  88         /* need to bounds check 'cause Unix can fail these checks, (esp on Suns)
  89          * and time package can generate invalid (to select syscall) values
  90          * for the time until the next interesting event if it encounters
  91          * out of range microsecond fields */
  92         if (tv->tv_usec < 0)
  93             tv->tv_usec = 0;
  94         if (tv->tv_usec > 999999)
  95             tv->tv_usec = 999999;
  96         FT_LastTime.tv_sec = tv->tv_sec;
  97         FT_LastTime.tv_usec = tv->tv_usec;
  98     }
  99     return ret;
 100 }
 101
 102
 103 /* For compatibility.  Should go away. */
 104 int
 105 TM_GetTimeOfDay(struct timeval *tv, struct timezone *tz)
 106 {
 107     return FT_GetTimeOfDay(tv, tz);
 108 }
 109
 110 int
 111 FT_AGetTimeOfDay(struct timeval *tv, struct timezone *tz)
 112 {
 113     if (FT_LastTime.tv_sec) {
 114         tv->tv_sec = FT_LastTime.tv_sec;
 115         tv->tv_usec = FT_LastTime.tv_usec;
 116         return 0;
 117     }
 118     return FT_GetTimeOfDay(tv, tz);
 119 }
 120
 121 #ifdef AFS_PTHREAD_ENV
 122 unsigned int FT_ApproxTime(void)
 123 {
 124     return time(0);
 125 }
 126 #else
 127 unsigned int
 128 FT_ApproxTime(void)
 129 {
 130     if (!FT_LastTime.tv_sec) {
 131         FT_GetTimeOfDay(&FT_LastTime, 0);
 132     }
 133     return FT_LastTime.tv_sec;
 134 }
 135 #endif