include/linux/time64.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_TIME64_H
   3 #define _LINUX_TIME64_H
   4
   5 #include <uapi/linux/time.h>
   6 #include <linux/math64.h>
   7
   8 typedef __s64 time64_t;
   9 typedef __u64 timeu64_t;
  10
  11 /*
  12  * This wants to go into uapi/linux/time.h once we agreed about the
  13  * userspace interfaces.
  14  */
  15 #if __BITS_PER_LONG == 64
  16 # define timespec64 timespec
  17 #define itimerspec64 itimerspec
  18 #else
  19 struct timespec64 {
  20         time64_t        tv_sec;                 /* seconds */
  21         long            tv_nsec;                /* nanoseconds */
  22 };
  23
  24 struct itimerspec64 {
  25         struct timespec64 it_interval;
  26         struct timespec64 it_value;
  27 };
  28
  29 #endif
  30
  31 /* Parameters used to convert the timespec values: */
  32 #define MSEC_PER_SEC    1000L
  33 #define USEC_PER_MSEC   1000L
  34 #define NSEC_PER_USEC   1000L
  35 #define NSEC_PER_MSEC   1000000L
  36 #define USEC_PER_SEC    1000000L
  37 #define NSEC_PER_SEC    1000000000L
  38 #define FSEC_PER_SEC    1000000000000000LL
  39
  40 /* Located here for timespec[64]_valid_strict */
  41 #define TIME64_MAX                      ((s64)~((u64)1 << 63))
  42 #define KTIME_MAX                       ((s64)~((u64)1 << 63))
  43 #define KTIME_SEC_MAX                   (KTIME_MAX / NSEC_PER_SEC)
  44
  45 #if __BITS_PER_LONG == 64
  46
  47 static inline struct timespec timespec64_to_timespec(const struct timespec64 ts64)
  48 {
  49         return ts64;
  50 }
  51
  52 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
  53 {
  54         return ts;
  55 }
  56
  57 static inline struct itimerspec itimerspec64_to_itimerspec(struct itimerspec64 *its64)
  58 {
  59         return *its64;
  60 }
  61
  62 static inline struct itimerspec64 itimerspec_to_itimerspec64(struct itimerspec *its)
  63 {
  64         return *its;
  65 }
  66
  67 # define timespec64_equal               timespec_equal
  68 # define timespec64_compare             timespec_compare
  69 # define set_normalized_timespec64      set_normalized_timespec
  70 # define timespec64_add                 timespec_add
  71 # define timespec64_sub                 timespec_sub
  72 # define timespec64_valid               timespec_valid
  73 # define timespec64_valid_strict        timespec_valid_strict
  74 # define timespec64_to_ns               timespec_to_ns
  75 # define ns_to_timespec64               ns_to_timespec
  76 # define timespec64_add_ns              timespec_add_ns
  77
  78 #else
  79
  80 static inline struct timespec timespec64_to_timespec(const struct timespec64 ts64)
  81 {
  82         struct timespec ret;
  83
  84         ret.tv_sec = (time_t)ts64.tv_sec;
  85         ret.tv_nsec = ts64.tv_nsec;
  86         return ret;
  87 }
  88
  89 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
  90 {
  91         struct timespec64 ret;
  92
  93         ret.tv_sec = ts.tv_sec;
  94         ret.tv_nsec = ts.tv_nsec;
  95         return ret;
  96 }
  97
  98 static inline struct itimerspec itimerspec64_to_itimerspec(struct itimerspec64 *its64)
  99 {
 100         struct itimerspec ret;
 101
 102         ret.it_interval = timespec64_to_timespec(its64->it_interval);
 103         ret.it_value = timespec64_to_timespec(its64->it_value);
 104         return ret;
 105 }
 106
 107 static inline struct itimerspec64 itimerspec_to_itimerspec64(struct itimerspec *its)
 108 {
 109         struct itimerspec64 ret;
 110
 111         ret.it_interval = timespec_to_timespec64(its->it_interval);
 112         ret.it_value = timespec_to_timespec64(its->it_value);
 113         return ret;
 114 }
 115
 116 static inline int timespec64_equal(const struct timespec64 *a,
 117                                    const struct timespec64 *b)
 118 {
 119         return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
 120 }
 121
 122 /*
 123  * lhs < rhs:  return <0
 124  * lhs == rhs: return 0
 125  * lhs > rhs:  return >0
 126  */
 127 static inline int timespec64_compare(const struct timespec64 *lhs, const struct timespec64 *rhs)
 128 {
 129         if (lhs->tv_sec < rhs->tv_sec)
 130                 return -1;
 131         if (lhs->tv_sec > rhs->tv_sec)
 132                 return 1;
 133         return lhs->tv_nsec - rhs->tv_nsec;
 134 }
 135
 136 extern void set_normalized_timespec64(struct timespec64 *ts, time64_t sec, s64 nsec);
 137
 138 static inline struct timespec64 timespec64_add(struct timespec64 lhs,
 139                                                 struct timespec64 rhs)
 140 {
 141         struct timespec64 ts_delta;
 142         set_normalized_timespec64(&ts_delta, lhs.tv_sec + rhs.tv_sec,
 143                                 lhs.tv_nsec + rhs.tv_nsec);
 144         return ts_delta;
 145 }
 146
 147 /*
 148  * sub = lhs - rhs, in normalized form
 149  */
 150 static inline struct timespec64 timespec64_sub(struct timespec64 lhs,
 151                                                 struct timespec64 rhs)
 152 {
 153         struct timespec64 ts_delta;
 154         set_normalized_timespec64(&ts_delta, lhs.tv_sec - rhs.tv_sec,
 155                                 lhs.tv_nsec - rhs.tv_nsec);
 156         return ts_delta;
 157 }
 158
 159 /*
 160  * Returns true if the timespec64 is norm, false if denorm:
 161  */
 162 static inline bool timespec64_valid(const struct timespec64 *ts)
 163 {
 164         /* Dates before 1970 are bogus */
 165         if (ts->tv_sec < 0)
 166                 return false;
 167         /* Can't have more nanoseconds then a second */
 168         if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
 169                 return false;
 170         return true;
 171 }
 172
 173 static inline bool timespec64_valid_strict(const struct timespec64 *ts)
 174 {
 175         if (!timespec64_valid(ts))
 176                 return false;
 177         /* Disallow values that could overflow ktime_t */
 178         if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
 179                 return false;
 180         return true;
 181 }
 182
 183 /**
 184  * timespec64_to_ns - Convert timespec64 to nanoseconds
 185  * @ts:         pointer to the timespec64 variable to be converted
 186  *
 187  * Returns the scalar nanosecond representation of the timespec64
 188  * parameter.
 189  */
 190 static inline s64 timespec64_to_ns(const struct timespec64 *ts)
 191 {
 192         /* Prevent multiplication overflow */
 193         if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
 194                 return KTIME_MAX;
 195
 196         return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
 197 }
 198
 199 /**
 200  * ns_to_timespec64 - Convert nanoseconds to timespec64
 201  * @nsec:       the nanoseconds value to be converted
 202  *
 203  * Returns the timespec64 representation of the nsec parameter.
 204  */
 205 extern struct timespec64 ns_to_timespec64(const s64 nsec);
 206
 207 /**
 208  * timespec64_add_ns - Adds nanoseconds to a timespec64
 209  * @a:          pointer to timespec64 to be incremented
 210  * @ns:         unsigned nanoseconds value to be added
 211  *
 212  * This must always be inlined because its used from the x86-64 vdso,
 213  * which cannot call other kernel functions.
 214  */
 215 static __always_inline void timespec64_add_ns(struct timespec64 *a, u64 ns)
 216 {
 217         a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
 218         a->tv_nsec = ns;
 219 }
 220
 221 #endif
 222
 223 /*
 224  * timespec64_add_safe assumes both values are positive and checks for
 225  * overflow. It will return TIME64_MAX in case of overflow.
 226  */
 227 extern struct timespec64 timespec64_add_safe(const struct timespec64 lhs,
 228                                          const struct timespec64 rhs);
 229
 230 #endif /* _LINUX_TIME64_H */