-fixes
[oweals/gnunet.git] / src / util / time.c
index ce2f9517f7ba362d8d6641b689574ef0cdf0dfd0..3a6f380413c8e894d87546bcd8bedf2ec8d5d2b0 100644 (file)
 #include "platform.h"
 #include "gnunet_time_lib.h"
 
+#define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
+
+/**
+ * Variable used to simulate clock skew.  Used for testing, never in production.
+ */
+static long long timestamp_offset;
+
+/**
+ * Set the timestamp offset for this instance.
+ *
+ * @param offset the offset to skew the locale time by
+ */
+void
+GNUNET_TIME_set_offset (long long offset)
+{
+  timestamp_offset = offset;
+}
 
 /**
  * Get the current time (works just as "time", just that we use the
@@ -40,9 +57,9 @@ GNUNET_TIME_absolute_get ()
   struct timeval tv;
 
   GETTIMEOFDAY (&tv, NULL);
-  ret.value =
-    (uint64_t) (((uint64_t) tv.tv_sec * 1000LL) +
-                ((uint64_t) tv.tv_usec / 1000LL));
+  ret.abs_value =
+      (uint64_t) (((uint64_t) tv.tv_sec * 1000LL) +
+                  ((uint64_t) tv.tv_usec / 1000LL)) + timestamp_offset;
   return ret;
 }
 
@@ -54,6 +71,7 @@ struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_get_zero ()
 {
   static struct GNUNET_TIME_Relative zero;
+
   return zero;
 }
 
@@ -65,6 +83,7 @@ struct GNUNET_TIME_Absolute
 GNUNET_TIME_absolute_get_zero ()
 {
   static struct GNUNET_TIME_Absolute zero;
+
   return zero;
 }
 
@@ -84,7 +103,7 @@ GNUNET_TIME_relative_get_unit ()
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_get_forever ()
 {
-  static struct GNUNET_TIME_Relative forever = { (uint64_t) - 1LL };
+  static struct GNUNET_TIME_Relative forever = { UINT64_MAX };
   return forever;
 }
 
@@ -94,7 +113,7 @@ GNUNET_TIME_relative_get_forever ()
 struct GNUNET_TIME_Absolute
 GNUNET_TIME_absolute_get_forever ()
 {
-  static struct GNUNET_TIME_Absolute forever = { (uint64_t) - 1LL };
+  static struct GNUNET_TIME_Absolute forever = { UINT64_MAX };
   return forever;
 }
 
@@ -108,15 +127,17 @@ struct GNUNET_TIME_Absolute
 GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel)
 {
   struct GNUNET_TIME_Absolute ret;
-  if (rel.value == (uint64_t) - 1LL)
+
+  if (rel.rel_value == UINT64_MAX)
     return GNUNET_TIME_absolute_get_forever ();
   struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
-  if (rel.value + now.value < rel.value)
-    {
-      GNUNET_break (0);         /* overflow... */
-      return GNUNET_TIME_absolute_get_forever ();
-    }
-  ret.value = rel.value + now.value;
+
+  if (rel.rel_value + now.abs_value < rel.rel_value)
+  {
+    GNUNET_break (0);           /* overflow... */
+    return GNUNET_TIME_absolute_get_forever ();
+  }
+  ret.abs_value = rel.rel_value + now.abs_value;
   return ret;
 }
 
@@ -129,11 +150,10 @@ GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel)
  * @return timestamp that is smaller
  */
 struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_min (struct
-                          GNUNET_TIME_Relative
-                          t1, struct GNUNET_TIME_Relative t2)
+GNUNET_TIME_relative_min (struct GNUNET_TIME_Relative t1,
+                          struct GNUNET_TIME_Relative t2)
 {
-  return (t1.value < t2.value) ? t1 : t2;
+  return (t1.rel_value < t2.rel_value) ? t1 : t2;
 }
 
 
@@ -145,11 +165,10 @@ GNUNET_TIME_relative_min (struct
  * @return timestamp that is larger
  */
 struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_max (struct
-                          GNUNET_TIME_Relative
-                          t1, struct GNUNET_TIME_Relative t2)
+GNUNET_TIME_relative_max (struct GNUNET_TIME_Relative t1,
+                          struct GNUNET_TIME_Relative t2)
 {
-  return (t1.value > t2.value) ? t1 : t2;
+  return (t1.rel_value > t2.rel_value) ? t1 : t2;
 }
 
 
@@ -162,11 +181,10 @@ GNUNET_TIME_relative_max (struct
  * @return timestamp that is smaller
  */
 struct GNUNET_TIME_Absolute
-GNUNET_TIME_absolute_min (struct
-                          GNUNET_TIME_Absolute
-                          t1, struct GNUNET_TIME_Absolute t2)
+GNUNET_TIME_absolute_min (struct GNUNET_TIME_Absolute t1,
+                          struct GNUNET_TIME_Absolute t2)
 {
-  return (t1.value < t2.value) ? t1 : t2;
+  return (t1.abs_value < t2.abs_value) ? t1 : t2;
 }
 
 
@@ -175,14 +193,13 @@ GNUNET_TIME_absolute_min (struct
  *
  * @param t1 first timestamp
  * @param t2 other timestamp
- * @return timestamp that is smaller
+ * @return timestamp that is bigger
  */
 struct GNUNET_TIME_Absolute
-GNUNET_TIME_absolute_max (struct
-                          GNUNET_TIME_Absolute
-                          t1, struct GNUNET_TIME_Absolute t2)
+GNUNET_TIME_absolute_max (struct GNUNET_TIME_Absolute t1,
+                          struct GNUNET_TIME_Absolute t2)
 {
-  return (t1.value > t2.value) ? t1 : t2;
+  return (t1.abs_value > t2.abs_value) ? t1 : t2;
 }
 
 
@@ -196,19 +213,21 @@ struct GNUNET_TIME_Relative
 GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future)
 {
   struct GNUNET_TIME_Relative ret;
-  if (future.value == (uint64_t) - 1LL)
+
+  if (future.abs_value == UINT64_MAX)
     return GNUNET_TIME_relative_get_forever ();
   struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
-  if (now.value > future.value)
+
+  if (now.abs_value > future.abs_value)
     return GNUNET_TIME_relative_get_zero ();
-  ret.value = future.value - now.value;
+  ret.rel_value = future.abs_value - now.abs_value;
   return ret;
 }
 
 /**
  * Compute the time difference between the given start and end times.
  * Use this function instead of actual subtraction to ensure that
- * "FOREVER" and overflows are handeled correctly.
+ * "FOREVER" and overflows are handled correctly.
  *
  * @return 0 if start >= end; FOREVER if end==FOREVER; otherwise end - start
  */
@@ -217,31 +236,32 @@ GNUNET_TIME_absolute_get_difference (struct GNUNET_TIME_Absolute start,
                                      struct GNUNET_TIME_Absolute end)
 {
   struct GNUNET_TIME_Relative ret;
-  if (end.value == (uint64_t) - 1LL)
+
+  if (end.abs_value == UINT64_MAX)
     return GNUNET_TIME_relative_get_forever ();
-  if (end.value < start.value)
+  if (end.abs_value < start.abs_value)
     return GNUNET_TIME_relative_get_zero ();
-  ret.value = end.value - start.value;
+  ret.rel_value = end.abs_value - start.abs_value;
   return ret;
 }
 
 /**
  * Get the duration of an operation as the
- * difference of the current time and the given start time "hence".
+ * difference of the current time and the given start time "whence".
  *
- * @return aborts if hence==FOREVER, 0 if hence > now, otherwise now-hence.
+ * @return aborts if whence==FOREVER, 0 if whence > now, otherwise now-whence.
  */
 struct GNUNET_TIME_Relative
-GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute hence)
+GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence)
 {
   struct GNUNET_TIME_Absolute now;
   struct GNUNET_TIME_Relative ret;
 
   now = GNUNET_TIME_absolute_get ();
-  GNUNET_assert (hence.value != (uint64_t) - 1LL);
-  if (hence.value > now.value)
+  GNUNET_assert (whence.abs_value != UINT64_MAX);
+  if (whence.abs_value > now.abs_value)
     return GNUNET_TIME_relative_get_zero ();
-  ret.value = now.value - hence.value;
+  ret.rel_value = now.abs_value - whence.abs_value;
   return ret;
 }
 
@@ -258,18 +278,41 @@ GNUNET_TIME_absolute_add (struct GNUNET_TIME_Absolute start,
 {
   struct GNUNET_TIME_Absolute ret;
 
-  if ((start.value == (uint64_t) - 1LL) ||
-      (duration.value == (uint64_t) - 1LL))
+  if ((start.abs_value == UINT64_MAX) || (duration.rel_value == UINT64_MAX))
+    return GNUNET_TIME_absolute_get_forever ();
+  if (start.abs_value + duration.rel_value < start.abs_value)
+  {
+    GNUNET_break (0);
     return GNUNET_TIME_absolute_get_forever ();
-  if (start.value + duration.value < start.value)
-    {
-      GNUNET_break (0);
-      return GNUNET_TIME_absolute_get_forever ();
-    }
-  ret.value = start.value + duration.value;
+  }
+  ret.abs_value = start.abs_value + duration.rel_value;
+  return ret;
+}
+
+
+/**
+ * Subtract a given relative duration from the
+ * given start time.
+ *
+ * @param start some absolute time
+ * @param duration some relative time to subtract
+ * @return ZERO if start <= duration, or FOREVER if start time is FOREVER; start-duration otherwise
+ */
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start,
+                               struct GNUNET_TIME_Relative duration)
+{
+  struct GNUNET_TIME_Absolute ret;
+
+  if (start.abs_value <= duration.rel_value)
+    return GNUNET_TIME_UNIT_ZERO_ABS;
+  if (start.abs_value == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value)
+    return GNUNET_TIME_UNIT_FOREVER_ABS;
+  ret.abs_value = start.abs_value - duration.rel_value;
   return ret;
 }
 
+
 /**
  * Multiply relative time by a given factor.
  *
@@ -280,14 +323,15 @@ GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
                                unsigned int factor)
 {
   struct GNUNET_TIME_Relative ret;
+
   if (factor == 0)
     return GNUNET_TIME_relative_get_zero ();
-  ret.value = rel.value * (unsigned long long) factor;
-  if (ret.value / factor != rel.value)
-    {
-      GNUNET_break (0);
-      return GNUNET_TIME_relative_get_forever ();
-    }
+  ret.rel_value = rel.rel_value * (unsigned long long) factor;
+  if (ret.rel_value / factor != rel.rel_value)
+  {
+    GNUNET_break (0);
+    return GNUNET_TIME_relative_get_forever ();
+  }
   return ret;
 }
 
@@ -301,19 +345,20 @@ GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
-                            unsigned int factor)
+                             unsigned int factor)
 {
   struct GNUNET_TIME_Relative ret;
-  if ( (factor == 0) ||
-       (rel.value == GNUNET_TIME_UNIT_FOREVER_REL.value) )
+
+  if ((factor == 0) ||
+      (rel.rel_value == GNUNET_TIME_UNIT_FOREVER_REL.rel_value))
     return GNUNET_TIME_UNIT_FOREVER_REL;
-  ret.value = rel.value / (unsigned long long) factor;
+  ret.rel_value = rel.rel_value / (unsigned long long) factor;
   return ret;
 }
 
 
 /**
- * Calculate the estimate time of arrival/completion 
+ * Calculate the estimate time of arrival/completion
  * for an operation.
  *
  * @param start when did the operation start?
@@ -323,8 +368,8 @@ GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
  *        assuming it continues at the same speed
  */
 struct GNUNET_TIME_Relative
-GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
-                           uint64_t finished, uint64_t total)
+GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start, uint64_t finished,
+                           uint64_t total)
 {
   struct GNUNET_TIME_Relative dur;
   double exp;
@@ -336,8 +381,8 @@ GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
   if (finished == 0)
     return GNUNET_TIME_UNIT_FOREVER_REL;
   dur = GNUNET_TIME_absolute_get_duration (start);
-  exp = ((double) dur.value) * ((double) total) / ((double) finished);
-  ret.value = ((uint64_t) exp) - dur.value;
+  exp = ((double) dur.rel_value) * ((double) total) / ((double) finished);
+  ret.rel_value = ((uint64_t) exp) - dur.rel_value;
   return ret;
 }
 
@@ -345,6 +390,8 @@ GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
 /**
  * Add relative times together.
  *
+ * @param a1 first timestamp
+ * @param a2 second timestamp
  * @return FOREVER if either argument is FOREVER or on overflow; a1+a2 otherwise
  */
 struct GNUNET_TIME_Relative
@@ -353,64 +400,122 @@ GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
 {
   struct GNUNET_TIME_Relative ret;
 
-  if ((a1.value == (uint64_t) - 1LL) || (a2.value == (uint64_t) - 1LL))
+  if ((a1.rel_value == UINT64_MAX) || (a2.rel_value == UINT64_MAX))
+    return GNUNET_TIME_relative_get_forever ();
+  if (a1.rel_value + a2.rel_value < a1.rel_value)
+  {
+    GNUNET_break (0);
     return GNUNET_TIME_relative_get_forever ();
-  if (a1.value + a2.value < a1.value)
-    {
-      GNUNET_break (0);
-      return GNUNET_TIME_relative_get_forever ();
-    }
-  ret.value = a1.value + a2.value;
+  }
+  ret.rel_value = a1.rel_value + a2.rel_value;
+  return ret;
+}
+
+
+/**
+ * Subtract relative timestamp from the other.
+ *
+ * @param a1 first timestamp
+ * @param a2 second timestamp
+ * @return ZERO if a2>=a1 (including both FOREVER), FOREVER if a1 is FOREVER, a1-a2 otherwise
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
+                               struct GNUNET_TIME_Relative a2)
+{
+  struct GNUNET_TIME_Relative ret;
+
+  if (a2.rel_value >= a1.rel_value)
+    return GNUNET_TIME_relative_get_zero ();
+  if (a1.rel_value == UINT64_MAX)
+    return GNUNET_TIME_relative_get_forever ();
+  ret.rel_value = a1.rel_value - a2.rel_value;
   return ret;
 }
 
 
 /**
  * Convert relative time to network byte order.
+ *
+ * @param a time to convert
+ * @return time in network byte order
  */
 struct GNUNET_TIME_RelativeNBO
 GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a)
 {
   struct GNUNET_TIME_RelativeNBO ret;
-  ret.value__ = GNUNET_htonll (a.value);
+
+  ret.rel_value__ = GNUNET_htonll (a.rel_value);
   return ret;
 }
 
 /**
  * Convert relative time from network byte order.
+ *
+ * @param a time to convert
+ * @return time in host byte order
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a)
 {
   struct GNUNET_TIME_Relative ret;
-  ret.value = GNUNET_ntohll (a.value__);
+
+  ret.rel_value = GNUNET_ntohll (a.rel_value__);
   return ret;
 
 }
 
 /**
  * Convert absolute time to network byte order.
+ *
+ * @param a time to convert
+ * @return time in network byte order
  */
 struct GNUNET_TIME_AbsoluteNBO
 GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a)
 {
   struct GNUNET_TIME_AbsoluteNBO ret;
-  ret.value__ = GNUNET_htonll (a.value);
+
+  ret.abs_value__ = GNUNET_htonll (a.abs_value);
   return ret;
 }
 
 /**
  * Convert absolute time from network byte order.
+ *
+ * @param a time to convert
+ * @return time in host byte order
  */
 struct GNUNET_TIME_Absolute
 GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a)
 {
   struct GNUNET_TIME_Absolute ret;
-  ret.value = GNUNET_ntohll (a.value__);
+
+  ret.abs_value = GNUNET_ntohll (a.abs_value__);
   return ret;
 
 }
 
+/**
+ * Convert a relative time to a string.
+ * This is one of the very few calls in the entire API that is
+ * NOT reentrant!
+ *
+ * @param time the time to print
+ *
+ * @return string form of the time (as milliseconds)
+ */
+const char *
+GNUNET_TIME_relative_to_string (struct GNUNET_TIME_Relative time)
+{
+  static char time_string[21];
+
+  memset (time_string, 0, sizeof (time_string));
+
+  sprintf (time_string, "%llu", (unsigned long long) time.rel_value);
+  return (const char *) time_string;
+}
+
 
 
 /* end of time.c */