include/linux/time.h

   1 #ifndef _LINUX_TIME_H
   2 #define _LINUX_TIME_H
   3
   4 #include <linux/types.h>
   5
   6 #ifdef __KERNEL__
   7 # include <linux/cache.h>
   8 # include <linux/seqlock.h>
   9 # include <linux/math64.h>
  10 #endif
  11
  12 #ifndef _STRUCT_TIMESPEC
  13 #define _STRUCT_TIMESPEC
  14 struct timespec {
  15         __kernel_time_t tv_sec;                 /* seconds */
  16         long            tv_nsec;                /* nanoseconds */
  17 };
  18 #endif
  19
  20 struct timeval {
  21         __kernel_time_t         tv_sec;         /* seconds */
  22         __kernel_suseconds_t    tv_usec;        /* microseconds */
  23 };
  24
  25 struct timezone {
  26         int     tz_minuteswest; /* minutes west of Greenwich */
  27         int     tz_dsttime;     /* type of dst correction */
  28 };
  29
  30 #ifdef __KERNEL__
  31
  32 extern struct timezone sys_tz;
  33
  34 /* Parameters used to convert the timespec values: */
  35 #define MSEC_PER_SEC    1000L
  36 #define USEC_PER_MSEC   1000L
  37 #define NSEC_PER_USEC   1000L
  38 #define NSEC_PER_MSEC   1000000L
  39 #define USEC_PER_SEC    1000000L
  40 #define NSEC_PER_SEC    1000000000L
  41 #define FSEC_PER_SEC    1000000000000000LL
  42
  43 #define TIME_T_MAX      (time_t)((1UL << ((sizeof(time_t) << 3) - 1)) - 1)
  44
  45 static inline int timespec_equal(const struct timespec *a,
  46                                  const struct timespec *b)
  47 {
  48         return (a->tv_sec == b->tv_sec) && (a->tv_nsec == b->tv_nsec);
  49 }
  50
  51 /*
  52  * lhs < rhs:  return <0
  53  * lhs == rhs: return 0
  54  * lhs > rhs:  return >0
  55  */
  56 static inline int timespec_compare(const struct timespec *lhs, const struct timespec *rhs)
  57 {
  58         if (lhs->tv_sec < rhs->tv_sec)
  59                 return -1;
  60         if (lhs->tv_sec > rhs->tv_sec)
  61                 return 1;
  62         return lhs->tv_nsec - rhs->tv_nsec;
  63 }
  64
  65 static inline int timeval_compare(const struct timeval *lhs, const struct timeval *rhs)
  66 {
  67         if (lhs->tv_sec < rhs->tv_sec)
  68                 return -1;
  69         if (lhs->tv_sec > rhs->tv_sec)
  70                 return 1;
  71         return lhs->tv_usec - rhs->tv_usec;
  72 }
  73
  74 extern unsigned long mktime(const unsigned int year, const unsigned int mon,
  75                             const unsigned int day, const unsigned int hour,
  76                             const unsigned int min, const unsigned int sec);
  77
  78 extern void set_normalized_timespec(struct timespec *ts, time_t sec, s64 nsec);
  79
  80 /*
  81  * timespec_add_safe assumes both values are positive and checks
  82  * for overflow. It will return TIME_T_MAX if the reutrn would be
  83  * smaller then either of the arguments.
  84  */
  85 extern struct timespec timespec_add_safe(const struct timespec lhs,
  86                                          const struct timespec rhs);
  87
  88
  89 static inline struct timespec timespec_add(struct timespec lhs,
  90                                                 struct timespec rhs)
  91 {
  92         struct timespec ts_delta;
  93         set_normalized_timespec(&ts_delta, lhs.tv_sec + rhs.tv_sec,
  94                                 lhs.tv_nsec + rhs.tv_nsec);
  95         return ts_delta;
  96 }
  97
  98 /*
  99  * sub = lhs - rhs, in normalized form
 100  */
 101 static inline struct timespec timespec_sub(struct timespec lhs,
 102                                                 struct timespec rhs)
 103 {
 104         struct timespec ts_delta;
 105         set_normalized_timespec(&ts_delta, lhs.tv_sec - rhs.tv_sec,
 106                                 lhs.tv_nsec - rhs.tv_nsec);
 107         return ts_delta;
 108 }
 109
 110 #define KTIME_MAX                       ((s64)~((u64)1 << 63))
 111 #if (BITS_PER_LONG == 64)
 112 # define KTIME_SEC_MAX                  (KTIME_MAX / NSEC_PER_SEC)
 113 #else
 114 # define KTIME_SEC_MAX                  LONG_MAX
 115 #endif
 116
 117 /*
 118  * Returns true if the timespec is norm, false if denorm:
 119  */
 120 static inline bool timespec_valid(const struct timespec *ts)
 121 {
 122         /* Dates before 1970 are bogus */
 123         if (ts->tv_sec < 0)
 124                 return false;
 125         /* Can't have more nanoseconds then a second */
 126         if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
 127                 return false;
 128         return true;
 129 }
 130
 131 static inline bool timespec_valid_strict(const struct timespec *ts)
 132 {
 133         if (!timespec_valid(ts))
 134                 return false;
 135         /* Disallow values that could overflow ktime_t */
 136         if ((unsigned long long)ts->tv_sec >= KTIME_SEC_MAX)
 137                 return false;
 138         return true;
 139 }
 140
 141 static inline bool timeval_valid(const struct timeval *tv)
 142 {
 143         /* Dates before 1970 are bogus */
 144         if (tv->tv_sec < 0)
 145                 return false;
 146
 147         /* Can't have more microseconds then a second */
 148         if (tv->tv_usec < 0 || tv->tv_usec >= USEC_PER_SEC)
 149                 return false;
 150
 151         return true;
 152 }
 153
 154 extern void read_persistent_clock(struct timespec *ts);
 155 extern void read_boot_clock(struct timespec *ts);
 156 extern int update_persistent_clock(struct timespec now);
 157 extern int no_sync_cmos_clock __read_mostly;
 158 void timekeeping_init(void);
 159 extern int timekeeping_suspended;
 160
 161 unsigned long get_seconds(void);
 162 struct timespec current_kernel_time(void);
 163 struct timespec __current_kernel_time(void); /* does not take xtime_lock */
 164 struct timespec get_monotonic_coarse(void);
 165 void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
 166                                 struct timespec *wtom, struct timespec *sleep);
 167 void timekeeping_inject_sleeptime(struct timespec *delta);
 168
 169 #define CURRENT_TIME            (current_kernel_time())
 170 #define CURRENT_TIME_SEC        ((struct timespec) { get_seconds(), 0 })
 171
 172 /* Some architectures do not supply their own clocksource.
 173  * This is mainly the case in architectures that get their
 174  * inter-tick times by reading the counter on their interval
 175  * timer. Since these timers wrap every tick, they're not really
 176  * useful as clocksources. Wrapping them to act like one is possible
 177  * but not very efficient. So we provide a callout these arches
 178  * can implement for use with the jiffies clocksource to provide
 179  * finer then tick granular time.
 180  */
 181 #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
 182 extern u32 arch_gettimeoffset(void);
 183 #else
 184 static inline u32 arch_gettimeoffset(void) { return 0; }
 185 #endif
 186
 187 extern void do_gettimeofday(struct timeval *tv);
 188 extern int do_settimeofday(const struct timespec *tv);
 189 extern int do_sys_settimeofday(const struct timespec *tv,
 190                                const struct timezone *tz);
 191 #define do_posix_clock_monotonic_gettime(ts) ktime_get_ts(ts)
 192 extern long do_utimes(int dfd, const char __user *filename, struct timespec *times, int flags);
 193 struct itimerval;
 194 extern int do_setitimer(int which, struct itimerval *value,
 195                         struct itimerval *ovalue);
 196 extern unsigned int alarm_setitimer(unsigned int seconds);
 197 extern int do_getitimer(int which, struct itimerval *value);
 198 extern void getnstimeofday(struct timespec *tv);
 199 extern void getrawmonotonic(struct timespec *ts);
 200 extern void getnstime_raw_and_real(struct timespec *ts_raw,
 201                 struct timespec *ts_real);
 202 extern void getboottime(struct timespec *ts);
 203 extern void monotonic_to_bootbased(struct timespec *ts);
 204 extern void get_monotonic_boottime(struct timespec *ts);
 205
 206 extern struct timespec timespec_trunc(struct timespec t, unsigned gran);
 207 extern int timekeeping_valid_for_hres(void);
 208 extern u64 timekeeping_max_deferment(void);
 209 extern void timekeeping_leap_insert(int leapsecond);
 210 extern int timekeeping_inject_offset(struct timespec *ts);
 211
 212 struct tms;
 213 extern void do_sys_times(struct tms *);
 214
 215 /*
 216  * Similar to the struct tm in userspace <time.h>, but it needs to be here so
 217  * that the kernel source is self contained.
 218  */
 219 struct tm {
 220         /*
 221          * the number of seconds after the minute, normally in the range
 222          * 0 to 59, but can be up to 60 to allow for leap seconds
 223          */
 224         int tm_sec;
 225         /* the number of minutes after the hour, in the range 0 to 59*/
 226         int tm_min;
 227         /* the number of hours past midnight, in the range 0 to 23 */
 228         int tm_hour;
 229         /* the day of the month, in the range 1 to 31 */
 230         int tm_mday;
 231         /* the number of months since January, in the range 0 to 11 */
 232         int tm_mon;
 233         /* the number of years since 1900 */
 234         long tm_year;
 235         /* the number of days since Sunday, in the range 0 to 6 */
 236         int tm_wday;
 237         /* the number of days since January 1, in the range 0 to 365 */
 238         int tm_yday;
 239 };
 240
 241 void time_to_tm(time_t totalsecs, int offset, struct tm *result);
 242
 243 /**
 244  * timespec_to_ns - Convert timespec to nanoseconds
 245  * @ts:         pointer to the timespec variable to be converted
 246  *
 247  * Returns the scalar nanosecond representation of the timespec
 248  * parameter.
 249  */
 250 static inline s64 timespec_to_ns(const struct timespec *ts)
 251 {
 252         return ((s64) ts->tv_sec * NSEC_PER_SEC) + ts->tv_nsec;
 253 }
 254
 255 /**
 256  * timeval_to_ns - Convert timeval to nanoseconds
 257  * @ts:         pointer to the timeval variable to be converted
 258  *
 259  * Returns the scalar nanosecond representation of the timeval
 260  * parameter.
 261  */
 262 static inline s64 timeval_to_ns(const struct timeval *tv)
 263 {
 264         return ((s64) tv->tv_sec * NSEC_PER_SEC) +
 265                 tv->tv_usec * NSEC_PER_USEC;
 266 }
 267
 268 /**
 269  * ns_to_timespec - Convert nanoseconds to timespec
 270  * @nsec:       the nanoseconds value to be converted
 271  *
 272  * Returns the timespec representation of the nsec parameter.
 273  */
 274 extern struct timespec ns_to_timespec(const s64 nsec);
 275
 276 /**
 277  * ns_to_timeval - Convert nanoseconds to timeval
 278  * @nsec:       the nanoseconds value to be converted
 279  *
 280  * Returns the timeval representation of the nsec parameter.
 281  */
 282 extern struct timeval ns_to_timeval(const s64 nsec);
 283
 284 /**
 285  * timespec_add_ns - Adds nanoseconds to a timespec
 286  * @a:          pointer to timespec to be incremented
 287  * @ns:         unsigned nanoseconds value to be added
 288  *
 289  * This must always be inlined because its used from the x86-64 vdso,
 290  * which cannot call other kernel functions.
 291  */
 292 static __always_inline void timespec_add_ns(struct timespec *a, u64 ns)
 293 {
 294         a->tv_sec += __iter_div_u64_rem(a->tv_nsec + ns, NSEC_PER_SEC, &ns);
 295         a->tv_nsec = ns;
 296 }
 297 #endif /* __KERNEL__ */
 298
 299 #define NFDBITS                 __NFDBITS
 300
 301 #define FD_SETSIZE              __FD_SETSIZE
 302 #define FD_SET(fd,fdsetp)       __FD_SET(fd,fdsetp)
 303 #define FD_CLR(fd,fdsetp)       __FD_CLR(fd,fdsetp)
 304 #define FD_ISSET(fd,fdsetp)     __FD_ISSET(fd,fdsetp)
 305 #define FD_ZERO(fdsetp)         __FD_ZERO(fdsetp)
 306
 307 /*
 308  * Names of the interval timers, and structure
 309  * defining a timer setting:
 310  */
 311 #define ITIMER_REAL             0
 312 #define ITIMER_VIRTUAL          1
 313 #define ITIMER_PROF             2
 314
 315 struct itimerspec {
 316         struct timespec it_interval;    /* timer period */
 317         struct timespec it_value;       /* timer expiration */
 318 };
 319
 320 struct itimerval {
 321         struct timeval it_interval;     /* timer interval */
 322         struct timeval it_value;        /* current value */
 323 };
 324
 325 /*
 326  * The IDs of the various system clocks (for POSIX.1b interval timers):
 327  */
 328 #define CLOCK_REALTIME                  0
 329 #define CLOCK_MONOTONIC                 1
 330 #define CLOCK_PROCESS_CPUTIME_ID        2
 331 #define CLOCK_THREAD_CPUTIME_ID         3
 332 #define CLOCK_MONOTONIC_RAW             4
 333 #define CLOCK_REALTIME_COARSE           5
 334 #define CLOCK_MONOTONIC_COARSE          6
 335 #define CLOCK_BOOTTIME                  7
 336 #define CLOCK_REALTIME_ALARM            8
 337 #define CLOCK_BOOTTIME_ALARM            9
 338
 339 /*
 340  * The IDs of various hardware clocks:
 341  */
 342 #define CLOCK_SGI_CYCLE                 10
 343 #define MAX_CLOCKS                      16
 344 #define CLOCKS_MASK                     (CLOCK_REALTIME | CLOCK_MONOTONIC)
 345 #define CLOCKS_MONO                     CLOCK_MONOTONIC
 346
 347 /*
 348  * The various flags for setting POSIX.1b interval timers:
 349  */
 350 #define TIMER_ABSTIME                   0x01
 351
 352 #endif