support/timespec.h

   1 /* Useful functions for tests that use struct timespec.
   2    Copyright (C) 2019-2020 Free Software Foundation, Inc.
   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
  17    <https://www.gnu.org/licenses/>.  */
  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
  27 struct timespec timespec_add (struct timespec, struct timespec)
  28   __attribute__((const));
  29 struct timespec timespec_sub (struct timespec, struct timespec)
  30   __attribute__((const));
  31
  32 static inline struct timespec
  33 make_timespec (time_t s, long int ns)
  34 {
  35   struct timespec r;
  36   r.tv_sec = s;
  37   r.tv_nsec = ns;
  38   return r;
  39 }
  40
  41 enum { TIMESPEC_HZ = 1000000000 };
  42
  43 void test_timespec_before_impl (const char *file, int line,
  44                                 const struct timespec left,
  45                                 const struct timespec right);
  46
  47 void test_timespec_equal_or_after_impl (const char *file, int line,
  48                                         const struct timespec left,
  49                                         const struct timespec right);
  50
  51 long support_timespec_ns (struct timespec time);
  52
  53 struct timespec support_timespec_normalize (struct timespec time);
  54
  55 int support_timespec_check_in_range (struct timespec expected, struct timespec observed,
  56                                   double lower_bound, double upper_bound);
  57
  58
  59 /* Check that the timespec on the left represents a time before the
  60    time on the right. */
  61 #define TEST_TIMESPEC_BEFORE(left, right)                               \
  62   test_timespec_before_impl (__FILE__, __LINE__, (left), (right))
  63
  64 #define TEST_TIMESPEC_BEFORE_NOW(left, clockid)                 \
  65   ({                                                            \
  66     struct timespec now;                                        \
  67     const int saved_errno = errno;                              \
  68     xclock_gettime ((clockid), &now);                           \
  69     TEST_TIMESPEC_BEFORE ((left), now);                         \
  70     errno = saved_errno;                                        \
  71   })
  72
  73 /* Check that the timespec on the left represents a time equal to or
  74    after the time on the right. */
  75 #define TEST_TIMESPEC_EQUAL_OR_AFTER(left, right)                       \
  76   test_timespec_equal_or_after_impl (__FILE__, __LINE__, left, right)
  77
  78 #define TEST_TIMESPEC_NOW_OR_AFTER(clockid, right)              \
  79   ({                                                            \
  80     struct timespec now;                                        \
  81     const int saved_errno = errno;                              \
  82     xclock_gettime ((clockid), &now);                           \
  83     TEST_TIMESPEC_EQUAL_OR_AFTER (now, (right));                \
  84     errno = saved_errno;                                        \
  85   })
  86
  87 #endif /* SUPPORT_TIMESPEC_H */