include/linux/time.h

   1 #ifndef _LINUX_TIME_H
   2 #define _LINUX_TIME_H
   3
   4 # include <linux/cache.h>
   5 # include <linux/seqlock.h>
   6 # include <linux/math64.h>
   7 # include <linux/time64.h>
   8
   9 extern struct timezone sys_tz;
  10
  11 #define TIME_T_MAX      (time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
  12
  13 static inline int timespec_equal(const struct timespec *a,
  14                                  const struct timespec *b)
  15 {
  16         return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
  17 }
  18
  19 /*
  20  * lhs < rhs:  return <0
  21  * lhs == rhs: return 0
  22  * lhs > rhs:  return >0
  23  */
  24 static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
  25 {
  26         if (lhs->tv_sec < rhs->tv_sec)
  27                 return -1;
  28         if (lhs->tv_sec > rhs->tv_sec)
  29                 return 1;
  30         return lhs->tv_nsec - rhs->tv_nsec;
  31 }
  32
  33 static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
  34 {
  35         if (lhs->tv_sec < rhs->tv_sec)
  36                 return -1;
  37         if (lhs->tv_sec > rhs->tv_sec)
  38                 return 1;
  39         return lhs->tv_usec - rhs->tv_usec;
  40 }
  41
  42 extern unsigned long mktime(const unsigned int year, const unsigned int mon,
  43                             const unsigned int day, const unsigned int hour,
  44                             const unsigned int min, const unsigned int sec);
  45
  46 extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
  47
  48 /*
  49  * timespec_add_safe assumes both values are positive and checks
  50  * for overflow. It will return TIME_T_MAX if the reutrn would be
  51  * smaller then either of the arguments.
  52  */
  53 extern struct timespec timespec_add_safe(const struct timespec lhs,
  54                                          const struct timespec rhs);
  55
  56
  57 static inline struct timespec timespec_add(struct timespec lhs,
  58                                                 struct timespec rhs)
  59 {
  60         struct timespec ts_delta;
  61         set_normalized_timespec(&ts_delta, lhs.tv_sec + rhs.tv_sec,
  62                                 lhs.tv_nsec + rhs.tv_nsec);
  63         return ts_delta;
  64 }
  65
  66 /*
  67  * sub = lhs - rhs, in normalized form
  68  */
  69 static inline struct timespec timespec_sub(struct timespec lhs,
  70                                                 struct timespec rhs)
  71 {
  72         struct timespec ts_delta;
  73         set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
  74                                 lhs.tv_nsec - rhs.tv_nsec);
  75         return ts_delta;
  76 }
  77
  78 /*
  79  * Returns true if the timespec is norm, false if denorm:
  80  */
  81 static inline bool timespec_valid(const struct timespec *ts)
  82 {
  83         /* Dates before 1970 are bogus */
  84         if (ts->tv_sec < 0)
  85                 return false;
  86         /* Can't have more nanoseconds then a second */
  87         if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
  88                 return false;
  89         return true;
  90 }
  91
  92 static inline bool timespec_valid_strict(const struct timespec *ts)
  93 {
  94         if (!timespec_valid(ts))
  95                 return false;
  96         /* Disallow values that could overflow ktime_t */
  97         if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
  98                 return false;
  99         return true;
 100 }
 101
 102 extern bool persistent_clock_exist;
 103
 104 static inline bool has_persistent_clock(void)
 105 {
 106         return persistent_clock_exist;
 107 }
 108
 109 extern void read_persistent_clock(struct timespec *ts);
 110 extern void read_boot_clock(struct timespec *ts);
 111 extern int persistent_clock_is_local;
 112 extern int update_persistent_clock(struct timespec now);
 113 void timekeeping_init(void);
 114 extern int timekeeping_suspended;
 115
 116 unsigned long get_seconds(void);
 117 struct timespec current_kernel_time(void);
 118 struct timespec __current_kernel_time(void); /* does not take xtime_lock */
 119 struct timespec get_monotonic_coarse(void);
 120 void timekeeping_inject_sleeptime(struct timespec *delta);
 121
 122 #define CURRENT_TIME            (current_kernel_time())
 123 #define CURRENT_TIME_SEC        ((struct timespec) { get_seconds(), 0 })
 124
 125 /* Some architectures do not supply their own clocksource.
 126  * This is mainly the case in architectures that get their
 127  * inter-tick times by reading the counter on their interval
 128  * timer. Since these timers wrap every tick, they're not really
 129  * useful as clocksources. Wrapping them to act like one is possible
 130  * but not very efficient. So we provide a callout these arches
 131  * can implement for use with the jiffies clocksource to provide
 132  * finer then tick granular time.
 133  */
 134 #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
 135 extern u32 (*arch_gettimeoffset)(void);
 136 #endif
 137
 138 extern void do_gettimeofday(struct timeval *tv);
 139 extern int do_settimeofday(const struct timespec *tv);
 140 extern int do_sys_settimeofday(const struct timespec *tv,
 141                                const struct timezone *tz);
 142 #define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
 143 extern long do_utimes(int dfd, const char __user *filename, struct timespec *times, int flags);
 144 struct itimerval;
 145 extern int do_setitimer(int which, struct itimerval *value,
 146                         struct itimerval *ovalue);
 147 extern unsigned int alarm_setitimer(unsigned int seconds);
 148 extern int do_getitimer(int which, struct itimerval *value);
 149 extern int __getnstimeofday(struct timespec *tv);
 150 extern void getnstimeofday(struct timespec *tv);
 151 extern void getrawmonotonic(struct timespec *ts);
 152 extern void getnstime_raw_and_real(struct timespec *ts_raw,
 153                 struct timespec *ts_real);
 154 extern void getboottime(struct timespec *ts);
 155 extern void monotonic_to_bootbased(struct timespec *ts);
 156 extern void get_monotonic_boottime(struct timespec *ts);
 157
 158 extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
 159 extern int timekeeping_valid_for_hres(void);
 160 extern u64 timekeeping_max_deferment(void);
 161 extern int timekeeping_inject_offset(struct timespec *ts);
 162 extern s32 timekeeping_get_tai_offset(void);
 163 extern void timekeeping_set_tai_offset(s32 tai_offset);
 164 extern void timekeeping_clocktai(struct timespec *ts);
 165
 166 struct tms;
 167 extern void do_sys_times(struct tms *);
 168
 169 /*
 170  * Similar to the struct tm in userspace <time.h>, but it needs to be here so
 171  * that the kernel source is self contained.
 172  */
 173 struct tm {
 174         /*
 175          * the number of seconds after the minute, normally in the range
 176          * 0 to 59, but can be up to 60 to allow for leap seconds
 177          */
 178         int tm_sec;
 179         /* the number of minutes after the hour, in the range 0 to 59*/
 180         int tm_min;
 181         /* the number of hours past midnight, in the range 0 to 23 */
 182         int tm_hour;
 183         /* the day of the month, in the range 1 to 31 */
 184         int tm_mday;
 185         /* the number of months since January, in the range 0 to 11 */
 186         int tm_mon;
 187         /* the number of years since 1900 */
 188         long tm_year;
 189         /* the number of days since Sunday, in the range 0 to 6 */
 190         int tm_wday;
 191         /* the number of days since January 1, in the range 0 to 365 */
 192         int tm_yday;
 193 };
 194
 195 void time_to_tm(time_t totalsecs, int offset, struct tm *result);
 196
 197 /**
 198  * timespec_to_ns - Convert timespec to nanoseconds
 199  * @ts:         pointer to the timespec variable to be converted
 200  *
 201  * Returns the scalar nanosecond representation of the timespec
 202  * parameter.
 203  */
 204 static inline s64 timespec_to_ns(const struct timespec *ts)
 205 {
 206         return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
 207 }
 208
 209 /**
 210  * timeval_to_ns - Convert timeval to nanoseconds
 211  * @ts:         pointer to the timeval variable to be converted
 212  *
 213  * Returns the scalar nanosecond representation of the timeval
 214  * parameter.
 215  */
 216 static inline s64 timeval_to_ns(const struct timeval *tv)
 217 {
 218         return ((s64) tv->tv_sec * NSEC_PER_SEC) +
 219                 tv->tv_usec * NSEC_PER_USEC;
 220 }
 221
 222 /**
 223  * ns_to_timespec - Convert nanoseconds to timespec
 224  * @nsec:       the nanoseconds value to be converted
 225  *
 226  * Returns the timespec representation of the nsec parameter.
 227  */
 228 extern struct timespec ns_to_timespec(const s64 nsec);
 229
 230 /**
 231  * ns_to_timeval - Convert nanoseconds to timeval
 232  * @nsec:       the nanoseconds value to be converted
 233  *
 234  * Returns the timeval representation of the nsec parameter.
 235  */
 236 extern struct timeval ns_to_timeval(const s64 nsec);
 237
 238 /**
 239  * timespec_add_ns - Adds nanoseconds to a timespec
 240  * @a:          pointer to timespec to be incremented
 241  * @ns:         unsigned nanoseconds value to be added
 242  *
 243  * This must always be inlined because its used from the x86-64 vdso,
 244  * which cannot call other kernel functions.
 245  */
 246 static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
 247 {
 248         a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
 249         a->tv_nsec = ns;
 250 }
 251
 252 #endif