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