[thirdparty/glibc.git] / support / timespec.h

/* Useful functions for tests that use struct timespec.
   Copyright (C) 2019-2022 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, see
   <https://www.gnu.org/licenses/>.  */

#ifndef SUPPORT_TIMESPEC_H
#define SUPPORT_TIMESPEC_H

#include <stdio.h>
#include <time.h>
#include <support/check.h>
#include <support/xtime.h>

static inline struct timespec
make_timespec (time_t s, long int ns)
{
  struct timespec r;
  r.tv_sec = s;
  r.tv_nsec = ns;
  return r;
}

enum { TIMESPEC_HZ = 1000000000 };

#ifndef __USE_TIME_BITS64
struct timespec timespec_add (struct timespec, struct timespec)
  __attribute__((const));
struct timespec timespec_sub (struct timespec, struct timespec)
  __attribute__((const));

void test_timespec_before_impl (const char *file, int line,
                                struct timespec left,
                                struct timespec right);

void test_timespec_equal_or_after_impl (const char *file, int line,
                                        struct timespec left,
                                        struct timespec right);

time_t support_timespec_ns (struct timespec time);

struct timespec support_timespec_normalize (struct timespec time);

int support_timespec_check_in_range (struct timespec expected,
				     struct timespec observed,
				     double lower_bound, double upper_bound);

#else
struct timespec __REDIRECT (timespec_add, (struct timespec, struct timespec),
			    timespec_add_time64);
struct timespec __REDIRECT (timespec_sub, (struct timespec, struct timespec),
			    timespec_sub_time64);
void __REDIRECT (test_timespec_before_impl, (const char *file, int line,
					     struct timespec left,
					     struct timespec right),
		 test_timespec_before_impl_time64);
void __REDIRECT (test_timespec_equal_or_after_impl, (const char *f, int line,
						     struct timespec left,
						     struct timespec right),
		 test_timespec_equal_or_after_impl_time64);

time_t __REDIRECT (support_timespec_ns, (struct timespec time),
		   support_timespec_ns_time64);

struct timespec __REDIRECT (support_timespec_normalize, (struct timespec time),
			    support_timespec_normalize_time64);

int __REDIRECT (support_timespec_check_in_range, (struct timespec expected,
						  struct timespec observed,
						  double lower_bound,
						  double upper_bound),
		support_timespec_check_in_range_time64);
#endif

/* Check that the timespec on the left represents a time before the
   time on the right. */
#define TEST_TIMESPEC_BEFORE(left, right)                               \
  test_timespec_before_impl (__FILE__, __LINE__, (left), (right))

#define TEST_TIMESPEC_BEFORE_NOW(left, clockid)                 \
  ({                                                            \
    struct timespec now;                                        \
    const int saved_errno = errno;                              \
    xclock_gettime ((clockid), &now);                           \
    TEST_TIMESPEC_BEFORE ((left), now);                         \
    errno = saved_errno;                                        \
  })

/* Check that the timespec on the left represents a time equal to or
   after the time on the right. */
#define TEST_TIMESPEC_EQUAL_OR_AFTER(left, right)                       \
  test_timespec_equal_or_after_impl (__FILE__, __LINE__, left, right)

#define TEST_TIMESPEC_NOW_OR_AFTER(clockid, right)              \
  ({                                                            \
    struct timespec now;                                        \
    const int saved_errno = errno;                              \
    xclock_gettime ((clockid), &now);                           \
    TEST_TIMESPEC_EQUAL_OR_AFTER (now, (right));                \
    errno = saved_errno;                                        \
  })

#endif /* SUPPORT_TIMESPEC_H */
Commit	Line	Data
51983996	1	/* Useful functions for tests that use struct timespec.
581c785b	2	Copyright (C) 2019-2022 Free Software Foundation, Inc.
51983996 MC	3	This file is part of the GNU C Library.
	4
	5	The GNU C Library is free software; you can redistribute it and/or
	6	modify it under the terms of the GNU Lesser General Public
	7	License as published by the Free Software Foundation; either
	8	version 2.1 of the License, or (at your option) any later version.
	9
	10	The GNU C Library is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	13	Lesser General Public License for more details.
	14
	15	You should have received a copy of the GNU Lesser General Public
	16	License along with the GNU C Library; if not, see
5a82c748	17	<https://www.gnu.org/licenses/>. */
51983996 MC	18
	19	#ifndef SUPPORT_TIMESPEC_H
	20	#define SUPPORT_TIMESPEC_H
	21
	22	#include <stdio.h>
	23	#include <time.h>
	24	#include <support/check.h>
	25	#include <support/xtime.h>
	26
51983996 MC	27	static inline struct timespec
	28	make_timespec (time_t s, long int ns)
	29	{
	30	struct timespec r;
	31	r.tv_sec = s;
	32	r.tv_nsec = ns;
	33	return r;
	34	}
	35
	36	enum { TIMESPEC_HZ = 1000000000 };
	37
e9bc2b3b AZ	38	#ifndef __USE_TIME_BITS64
	39	struct timespec timespec_add (struct timespec, struct timespec)
	40	__attribute__((const));
	41	struct timespec timespec_sub (struct timespec, struct timespec)
	42	__attribute__((const));
	43
51983996	44	void test_timespec_before_impl (const char *file, int line,
e9bc2b3b AZ	45	struct timespec left,
e9bc2b3b AZ	46	struct timespec right);
51983996 MC	47
51983996 MC	48	void test_timespec_equal_or_after_impl (const char *file, int line,
e9bc2b3b AZ	49	struct timespec left,
e9bc2b3b AZ	50	struct timespec right);
51983996	51
f896fc0f	52	time_t support_timespec_ns (struct timespec time);
04deeaa9 LM	53
	54	struct timespec support_timespec_normalize (struct timespec time);
	55
e9bc2b3b AZ	56	int support_timespec_check_in_range (struct timespec expected,
	57	struct timespec observed,
	58	double lower_bound, double upper_bound);
	59
	60	#else
	61	struct timespec __REDIRECT (timespec_add, (struct timespec, struct timespec),
	62	timespec_add_time64);
	63	struct timespec __REDIRECT (timespec_sub, (struct timespec, struct timespec),
	64	timespec_sub_time64);
	65	void __REDIRECT (test_timespec_before_impl, (const char *file, int line,
	66	struct timespec left,
	67	struct timespec right),
	68	test_timespec_before_impl_time64);
	69	void __REDIRECT (test_timespec_equal_or_after_impl, (const char *f, int line,
	70	struct timespec left,
	71	struct timespec right),
	72	test_timespec_equal_or_after_impl_time64);
	73
	74	time_t __REDIRECT (support_timespec_ns, (struct timespec time),
	75	support_timespec_ns_time64);
	76
	77	struct timespec __REDIRECT (support_timespec_normalize, (struct timespec time),
	78	support_timespec_normalize_time64);
	79
	80	int __REDIRECT (support_timespec_check_in_range, (struct timespec expected,
	81	struct timespec observed,
	82	double lower_bound,
	83	double upper_bound),
	84	support_timespec_check_in_range_time64);
	85	#endif
04deeaa9	86
51983996 MC	87	/* Check that the timespec on the left represents a time before the
	88	time on the right. */
	89	#define TEST_TIMESPEC_BEFORE(left, right) \
	90	test_timespec_before_impl (__FILE__, __LINE__, (left), (right))
	91
	92	#define TEST_TIMESPEC_BEFORE_NOW(left, clockid) \
	93	({ \
	94	struct timespec now; \
	95	const int saved_errno = errno; \
	96	xclock_gettime ((clockid), &now); \
	97	TEST_TIMESPEC_BEFORE ((left), now); \
	98	errno = saved_errno; \
	99	})
	100
ff6bec7d MC	101	/* Check that the timespec on the left represents a time equal to or
ff6bec7d MC	102	after the time on the right. */
51983996 MC	103	#define TEST_TIMESPEC_EQUAL_OR_AFTER(left, right) \
	104	test_timespec_equal_or_after_impl (__FILE__, __LINE__, left, right)
	105
	106	#define TEST_TIMESPEC_NOW_OR_AFTER(clockid, right) \
	107	({ \
	108	struct timespec now; \
	109	const int saved_errno = errno; \
	110	xclock_gettime ((clockid), &now); \
	111	TEST_TIMESPEC_EQUAL_OR_AFTER (now, (right)); \
	112	errno = saved_errno; \
	113	})
	114
	115	#endif /* SUPPORT_TIMESPEC_H */