src/vppinfra/time_range.h

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef included_time_range_h
  17 #define included_time_range_h
  18
  19 #include <vppinfra/format.h>
  20 #include <vppinfra/time.h>
  21
  22 typedef enum
  23 {
  24   CLIB_TIMEBASE_DAYLIGHT_NONE = 0,
  25   CLIB_TIMEBASE_DAYLIGHT_USA,
  26 } clib_timebase_daylight_time_t;
  27
  28 typedef struct
  29 {
  30   /* provides f64 seconds since clib_time_init was called */
  31   clib_time_t clib_time;
  32   /*
  33    * time in f64 seconds since Thursday 1 Jan 1970 00:00:00 UTC
  34    * when clib_time_init was called
  35    */
  36   f64 time_zero;
  37   f64 timezone_offset;
  38   f64 summer_offset;
  39   clib_timebase_daylight_time_t daylight_time_type;
  40   f64 cached_year_start;
  41   f64 cached_year_end;
  42   f64 cached_summer_start;
  43   f64 cached_summer_end;
  44 } clib_timebase_t;
  45
  46 typedef struct
  47 {
  48   u32 year, month, day, hour, minute, second, nanosecond;
  49   /* 0 => Thursday */
  50   u32 day_name_index;
  51   f64 fractional_seconds;
  52 } clib_timebase_component_t;
  53
  54 typedef struct
  55 {
  56   f64 start, end;
  57 } clib_timebase_range_t;
  58
  59 void clib_timebase_init (clib_timebase_t * tb, i32 timezone_offset_in_hours,
  60                          clib_timebase_daylight_time_t daylight_type);
  61
  62 void clib_timebase_time_to_components (f64 now,
  63                                        clib_timebase_component_t * cp);
  64
  65 f64 clib_timebase_components_to_time (clib_timebase_component_t * cp);
  66
  67 f64 clib_timebase_find_sunday_midnight (f64 start_time);
  68 f64 clib_timebase_offset_from_sunday (u8 * day);
  69 f64 clib_timebase_summer_offset (clib_timebase_t * tb, f64 now);
  70
  71 unformat_function_t unformat_clib_timebase_range_hms;
  72 unformat_function_t unformat_clib_timebase_range_vector;
  73
  74 format_function_t format_clib_timebase_time;
  75
  76 static inline f64 clib_timebase_summer_offset_fastpath
  77   (clib_timebase_t * tb, f64 now)
  78 {
  79   if (PREDICT_TRUE
  80       (now >= tb->cached_year_start && now <= tb->cached_year_end))
  81     {
  82       if (now >= tb->cached_summer_start && now <= tb->cached_summer_end)
  83         return tb->summer_offset;
  84       else
  85         return 0.0;
  86     }
  87   else
  88     return clib_timebase_summer_offset (tb, now);
  89 }
  90
  91 static inline f64
  92 clib_timebase_now (clib_timebase_t * tb)
  93 {
  94   f64 now;
  95
  96   now = tb->time_zero + clib_time_now (&tb->clib_time);
  97   now += tb->timezone_offset;
  98   now += clib_timebase_summer_offset_fastpath (tb, now);
  99
 100   return now;
 101 }
 102
 103 static inline int
 104 clib_timebase_is_leap_year (u32 year)
 105 {
 106   int rv;
 107
 108   if (PREDICT_TRUE ((year % 4) != 0))
 109     return 0;
 110
 111   rv = 0;
 112
 113   if ((year % 4) == 0)
 114     rv = 1;
 115   if ((year % 100) == 0)
 116     rv = 0;
 117   if ((year % 400) == 0)
 118     rv = 1;
 119   return rv;
 120 }
 121
 122 #endif /* included_time_range_h */
 123
 124
 125 /*
 126  * fd.io coding-style-patch-verification: ON
 127  *
 128  * Local Variables:
 129  * eval: (c-set-style "gnu")
 130  * End:
 131  */