Release 4.7 include/linux/ktime.h

/*
 *  include/linux/ktime.h
 *
 *  ktime_t - nanosecond-resolution time format.
 *
 *   Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
 *   Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
 *
 *  data type definitions, declarations, prototypes and macros.
 *
 *  Started by: Thomas Gleixner and Ingo Molnar
 *
 *  Credits:
 *
 *      Roman Zippel provided the ideas and primary code snippets of
 *      the ktime_t union and further simplifications of the original
 *      code.
 *
 *  For licencing details see kernel-base/COPYING
 */
#ifndef _LINUX_KTIME_H

#define _LINUX_KTIME_H

#include <linux/time.h>
#include <linux/jiffies.h>

/*
 * ktime_t:
 *
 * A single 64-bit variable is used to store the hrtimers
 * internal representation of time values in scalar nanoseconds. The
 * design plays out best on 64-bit CPUs, where most conversions are
 * NOPs and most arithmetic ktime_t operations are plain arithmetic
 * operations.
 *
 */

union ktime {
	
s64	tv64;
};


typedef union ktime ktime_t;		
/* Kill this */

/**
 * ktime_set - Set a ktime_t variable from a seconds/nanoseconds value
 * @secs:       seconds to set
 * @nsecs:      nanoseconds to set
 *
 * Return: The ktime_t representation of the value.
 */


static inline ktime_t ktime_set(const s64 secs, const unsigned long nsecs)
{
	if (unlikely(secs >= KTIME_SEC_MAX))
		return (ktime_t){ .tv64 = KTIME_MAX };

	return (ktime_t) { .tv64 = secs * NSEC_PER_SEC + (s64)nsecs };
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
thomas gleixner
thomas gleixner
53
98.15%
2
66.67%
john stultz
john stultz
1
1.85%
1
33.33%
Total
54
100.00%
3
100.00%

/* Subtract two ktime_t variables. rem = lhs -rhs: */

#define ktime_sub(lhs, rhs) \
		({ (ktime_t){ .tv64 = (lhs).tv64 - (rhs).tv64 }; })

/* Add two ktime_t variables. res = lhs + rhs: */

#define ktime_add(lhs, rhs) \
		({ (ktime_t){ .tv64 = (lhs).tv64 + (rhs).tv64 }; })

/*
 * Add a ktime_t variable and a scalar nanosecond value.
 * res = kt + nsval:
 */

#define ktime_add_ns(kt, nsval) \
		({ (ktime_t){ .tv64 = (kt).tv64 + (nsval) }; })

/*
 * Subtract a scalar nanosecod from a ktime_t variable
 * res = kt - nsval:
 */

#define ktime_sub_ns(kt, nsval) \
		({ (ktime_t){ .tv64 = (kt).tv64 - (nsval) }; })

/* convert a timespec to ktime_t format: */


static inline ktime_t timespec_to_ktime(struct timespec ts)
{
	return ktime_set(ts.tv_sec, ts.tv_nsec);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
roman zippel
roman zippel
19
82.61%
1
50.00%
thomas gleixner
thomas gleixner
4
17.39%
1
50.00%
Total
23
100.00%
2
100.00%

/* convert a timespec64 to ktime_t format: */


static inline ktime_t timespec64_to_ktime(struct timespec64 ts)
{
	return ktime_set(ts.tv_sec, ts.tv_nsec);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
john stultz
john stultz
23
100.00%
1
100.00%
Total
23
100.00%
1
100.00%

/* convert a timeval to ktime_t format: */


static inline ktime_t timeval_to_ktime(struct timeval tv)
{
	return ktime_set(tv.tv_sec, tv.tv_usec * NSEC_PER_USEC);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
roman zippel
roman zippel
21
84.00%
1
50.00%
thomas gleixner
thomas gleixner
4
16.00%
1
50.00%
Total
25
100.00%
2
100.00%

/* Map the ktime_t to timespec conversion to ns_to_timespec function */

#define ktime_to_timespec(kt)		ns_to_timespec((kt).tv64)

/* Map the ktime_t to timespec conversion to ns_to_timespec function */

#define ktime_to_timespec64(kt)		ns_to_timespec64((kt).tv64)

/* Map the ktime_t to timeval conversion to ns_to_timeval function */

#define ktime_to_timeval(kt)		ns_to_timeval((kt).tv64)

/* Convert ktime_t to nanoseconds - NOP in the scalar storage format: */

#define ktime_to_ns(kt)			((kt).tv64)


/**
 * ktime_equal - Compares two ktime_t variables to see if they are equal
 * @cmp1:       comparable1
 * @cmp2:       comparable2
 *
 * Compare two ktime_t variables.
 *
 * Return: 1 if equal.
 */


static inline int ktime_equal(const ktime_t cmp1, const ktime_t cmp2)
{
	return cmp1.tv64 == cmp2.tv64;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
ilpo jarvinen
ilpo jarvinen
24
100.00%
1
100.00%
Total
24
100.00%
1
100.00%

/**
 * ktime_compare - Compares two ktime_t variables for less, greater or equal
 * @cmp1:       comparable1
 * @cmp2:       comparable2
 *
 * Return: ...
 *   cmp1  < cmp2: return <0
 *   cmp1 == cmp2: return 0
 *   cmp1  > cmp2: return >0
 */


static inline int ktime_compare(const ktime_t cmp1, const ktime_t cmp2)
{
	if (cmp1.tv64 < cmp2.tv64)
		return -1;
	if (cmp1.tv64 > cmp2.tv64)
		return 1;
	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
daniel borkmann
daniel borkmann
45
100.00%
1
100.00%
Total
45
100.00%
1
100.00%

/**
 * ktime_after - Compare if a ktime_t value is bigger than another one.
 * @cmp1:       comparable1
 * @cmp2:       comparable2
 *
 * Return: true if cmp1 happened after cmp2.
 */


static inline bool ktime_after(const ktime_t cmp1, const ktime_t cmp2)
{
	return ktime_compare(cmp1, cmp2) > 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
daniel borkmann
daniel borkmann
25
100.00%
1
100.00%
Total
25
100.00%
1
100.00%

/**
 * ktime_before - Compare if a ktime_t value is smaller than another one.
 * @cmp1:       comparable1
 * @cmp2:       comparable2
 *
 * Return: true if cmp1 happened before cmp2.
 */


static inline bool ktime_before(const ktime_t cmp1, const ktime_t cmp2)
{
	return ktime_compare(cmp1, cmp2) < 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
daniel borkmann
daniel borkmann
25
100.00%
1
100.00%
Total
25
100.00%
1
100.00%

#if BITS_PER_LONG < 64
extern s64 __ktime_divns(const ktime_t kt, s64 div);


static inline s64 ktime_divns(const ktime_t kt, s64 div)
{
	/*
         * Negative divisors could cause an inf loop,
         * so bug out here.
         */
	BUG_ON(div < 0);
	if (__builtin_constant_p(div) && !(div >> 32)) {
		s64 ns = kt.tv64;
		u64 tmp = ns < 0 ? -ns : ns;

		do_div(tmp, div);
		return ns < 0 ? -tmp : tmp;
	} else {
		return __ktime_divns(kt, div);
	}
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
nicolas pitre
nicolas pitre
55
64.71%
1
50.00%
john stultz
john stultz
30
35.29%
1
50.00%
Total
85
100.00%
2
100.00%

#else /* BITS_PER_LONG < 64 */


static inline s64 ktime_divns(const ktime_t kt, s64 div)
{
	/*
         * 32-bit implementation cannot handle negative divisors,
         * so catch them on 64bit as well.
         */
	WARN_ON(div < 0);
	return kt.tv64 / div;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
john stultz
john stultz
23
79.31%
1
50.00%
thomas gleixner
thomas gleixner
6
20.69%
1
50.00%
Total
29
100.00%
2
100.00%

#endif



static inline s64 ktime_to_us(const ktime_t kt)
{
	return ktime_divns(kt, NSEC_PER_USEC);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
hideaki yoshifuji
hideaki yoshifuji
15
78.95%
1
50.00%
thomas gleixner
thomas gleixner
4
21.05%
1
50.00%
Total
19
100.00%
2
100.00%



static inline s64 ktime_to_ms(const ktime_t kt)
{
	return ktime_divns(kt, NSEC_PER_MSEC);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
chuck lever
chuck lever
15
78.95%
1
50.00%
thomas gleixner
thomas gleixner
4
21.05%
1
50.00%
Total
19
100.00%
2
100.00%



static inline s64 ktime_us_delta(const ktime_t later, const ktime_t earlier)
{
       return ktime_to_us(ktime_sub(later, earlier));
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
gerrit renker
gerrit renker
24
92.31%
1
50.00%
arnaldo carvalho de melo
arnaldo carvalho de melo
2
7.69%
1
50.00%
Total
26
100.00%
2
100.00%



static inline s64 ktime_ms_delta(const ktime_t later, const ktime_t earlier)
{
	return ktime_to_ms(ktime_sub(later, earlier));
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
chunyan zhang
chunyan zhang
26
100.00%
1
100.00%
Total
26
100.00%
1
100.00%



static inline ktime_t ktime_add_us(const ktime_t kt, const u64 usec)
{
	return ktime_add_ns(kt, usec * NSEC_PER_USEC);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
arnaldo carvalho de melo
arnaldo carvalho de melo
24
96.00%
2
66.67%
liu ying
liu ying
1
4.00%
1
33.33%
Total
25
100.00%
3
100.00%



static inline ktime_t ktime_add_ms(const ktime_t kt, const u64 msec)
{
	return ktime_add_ns(kt, msec * NSEC_PER_MSEC);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
daniel borkmann
daniel borkmann
25
100.00%
1
100.00%
Total
25
100.00%
1
100.00%



static inline ktime_t ktime_sub_us(const ktime_t kt, const u64 usec)
{
	return ktime_sub_ns(kt, usec * NSEC_PER_USEC);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
arnaldo carvalho de melo
arnaldo carvalho de melo
22
88.00%
1
33.33%
gerrit renker
gerrit renker
2
8.00%
1
33.33%
liu ying
liu ying
1
4.00%
1
33.33%
Total
25
100.00%
3
100.00%

extern ktime_t ktime_add_safe(const ktime_t lhs, const ktime_t rhs);

/**
 * ktime_to_timespec_cond - convert a ktime_t variable to timespec
 *                          format only if the variable contains data
 * @kt:         the ktime_t variable to convert
 * @ts:         the timespec variable to store the result in
 *
 * Return: %true if there was a successful conversion, %false if kt was 0.
 */


static inline __must_check bool ktime_to_timespec_cond(const ktime_t kt,
						       struct timespec *ts)
{
	if (kt.tv64) {
		*ts = ktime_to_timespec(kt);
		return true;
	} else {
		return false;
	}
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
daniel borkmann
daniel borkmann
35
83.33%
2
66.67%
john stultz
john stultz
7
16.67%
1
33.33%
Total
42
100.00%
3
100.00%

/**
 * ktime_to_timespec64_cond - convert a ktime_t variable to timespec64
 *                          format only if the variable contains data
 * @kt:         the ktime_t variable to convert
 * @ts:         the timespec variable to store the result in
 *
 * Return: %true if there was a successful conversion, %false if kt was 0.
 */


static inline __must_check bool ktime_to_timespec64_cond(const ktime_t kt,
						       struct timespec64 *ts)
{
	if (kt.tv64) {
		*ts = ktime_to_timespec64(kt);
		return true;
	} else {
		return false;
	}
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
john stultz
john stultz
35
83.33%
1
50.00%
daniel borkmann
daniel borkmann
7
16.67%
1
50.00%
Total
42
100.00%
2
100.00%

/*
 * The resolution of the clocks. The resolution value is returned in
 * the clock_getres() system call to give application programmers an
 * idea of the (in)accuracy of timers. Timer values are rounded up to
 * this resolution values.
 */

#define LOW_RES_NSEC		TICK_NSEC

#define KTIME_LOW_RES		(ktime_t){ .tv64 = LOW_RES_NSEC }



static inline ktime_t ns_to_ktime(u64 ns)
{
	static const ktime_t ktime_zero = { .tv64 = 0 };

	return ktime_add_ns(ktime_zero, ns);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
ingo molnar
ingo molnar
30
100.00%
1
100.00%
Total
30
100.00%
1
100.00%



static inline ktime_t ms_to_ktime(u64 ms)
{
	static const ktime_t ktime_zero = { .tv64 = 0 };

	return ktime_add_ms(ktime_zero, ms);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
daniel borkmann
daniel borkmann
30
100.00%
1
100.00%
Total
30
100.00%
1
100.00%

# include <linux/timekeeping.h>

#endif
Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
thomas gleixner
thomas gleixner
197
23.73%
8
25.81%
daniel borkmann
daniel borkmann
194
23.37%
5
16.13%
john stultz
john stultz
131
15.78%
4
12.90%
arnaldo carvalho de melo
arnaldo carvalho de melo
59
7.11%
2
6.45%
nicolas pitre
nicolas pitre
56
6.75%
1
3.23%
roman zippel
roman zippel
40
4.82%
1
3.23%
ingo molnar
ingo molnar
30
3.61%
1
3.23%
chunyan zhang
chunyan zhang
26
3.13%
1
3.23%
gerrit renker
gerrit renker
26
3.13%
1
3.23%
ilpo jarvinen
ilpo jarvinen
24
2.89%
1
3.23%
hideaki yoshifuji
hideaki yoshifuji
15
1.81%
1
3.23%
chuck lever
chuck lever
15
1.81%
1
3.23%
andrew morton
andrew morton
6
0.72%
1
3.23%
tony breeds
tony breeds
5
0.60%
1
3.23%
yacine belkadi
yacine belkadi
4
0.48%
1
3.23%
liu ying
liu ying
2
0.24%
1
3.23%
Total
830
100.00%
31
100.00%
  
Directory: include/linux

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.