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
  30 #include <stdio.h>
  31 #include <sys/types.h>
  32 #ifdef AFS_NT40_ENV
  33 #include <sys/timeb.h>
  34 #include <winsock2.h>
  35 #else
  36 #include <sys/time.h>
  37 #include <sys/file.h>
  38 #endif
  39 #include <afs/afsutil.h>
  40
  41 int ft_debug;
  42
  43 #define TRUE    1
  44 #define FALSE   0
  45
  46 static enum InitState { notTried, tried, done } initState = notTried;
  47
  48 struct timeval FT_LastTime;     /* last time returned by RT_FastTime.  Used to implement
  49                                  * FT_ApproxTime */
  50
  51
  52 /* Call this to get the memory mapped.  It will return -1 if anything went
  53    wrong.  In that case, calls to FT_GetTimeOfDay will call gettimeofday
  54    instead.  If printErrors is true, errors in initialization will cause
  55    error messages to be printed on stderr.  If notReally is true, then
  56    things are set up so that all calls to FT_GetTimeOfDay call gettimeofday.
  57    You might want this if your program won't run too long and the nlist
  58    call is too expensive.  Yeah, it's pretty horrible.
  59 */
  60 int
  61 FT_Init(int printErrors, int notReally)
  62 {
  63     if (initState != notTried && !notReally)
  64         return (initState == done ? 0 : -1);    /* This is in case explicit initialization
  65                                                  * occurs after automatic initialization */
  66     initState = tried;
  67     if (notReally)
  68         return 0;               /* fake success, but leave initState
  69                                  * wrong. */
  70     if (printErrors)
  71         fprintf(stderr, "FT_Init: mmap  not implemented on this kernel\n");
  72     return (-1);
  73 }
  74
  75 /* Call this to get the time of day.  It will automatically initialize the
  76    first time you call it.  If you want error messages when you initialize,
  77    call FT_Init yourself.  If the initialization failed, this will just
  78    call gettimeofday.  If you ask for the timezone info, this routine will
  79    punt to gettimeofday. */
  80 int
  81 FT_GetTimeOfDay(struct timeval *tv, struct timezone *tz)
  82 {
  83     int ret;
  84     ret = gettimeofday(tv, tz);
  85     if (!ret) {
  86         /* need to bounds check 'cause Unix can fail these checks, (esp on Suns)
  87          * and time package can generate invalid (to select syscall) values
  88          * for the time until the next interesting event if it encounters
  89          * out of range microsecond fields */
  90         if (tv->tv_usec < 0)
  91             tv->tv_usec = 0;
  92         if (tv->tv_usec > 999999)
  93             tv->tv_usec = 999999;
  94         FT_LastTime.tv_sec = tv->tv_sec;
  95         FT_LastTime.tv_usec = tv->tv_usec;
  96     }
  97     return ret;
  98 }
  99
 100
 101 /* For compatibility.  Should go away. */
 102 int
 103 TM_GetTimeOfDay(struct timeval *tv, struct timezone *tz)
 104 {
 105     return FT_GetTimeOfDay(tv, tz);
 106 }
 107
 108 int
 109 FT_AGetTimeOfDay(struct timeval *tv, struct timezone *tz)
 110 {
 111     if (FT_LastTime.tv_sec) {
 112         tv->tv_sec = FT_LastTime.tv_sec;
 113         tv->tv_usec = FT_LastTime.tv_usec;
 114         return 0;
 115     }
 116     return FT_GetTimeOfDay(tv, tz);
 117 }
 118
 119 #ifdef AFS_PTHREAD_ENV
 120 unsigned int FT_ApproxTime(void)
 121 {
 122     return time(0);
 123 }
 124 #else
 125 unsigned int
 126 FT_ApproxTime(void)
 127 {
 128     if (!FT_LastTime.tv_sec) {
 129         FT_GetTimeOfDay(&FT_LastTime, 0);
 130     }
 131     return FT_LastTime.tv_sec;
 132 }
 133 #endif