Returns now GNUNET_SYSERR
[oweals/gnunet.git] / src / util / time.c
index 90351138adff090a8d879a9d244a94edc72e6401..e1440f26056eb2fb171dc653127b0821dbece210 100644 (file)
@@ -40,7 +40,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));
   return ret;
 }
 
@@ -82,7 +84,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;
 }
 
@@ -92,7 +94,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;
 }
 
@@ -106,15 +108,15 @@ 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)
+  if (rel.rel_value + now.abs_value < rel.rel_value)
     {
       GNUNET_break (0);         /* overflow... */
       return GNUNET_TIME_absolute_get_forever ();
     }
-  ret.value = rel.value + now.value;
+  ret.abs_value = rel.rel_value + now.abs_value;
   return ret;
 }
 
@@ -126,13 +128,28 @@ GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel)
  * @param t2 other timestamp
  * @return timestamp that is smaller
  */
-struct GNUNET_TIME_Relative GNUNET_TIME_relative_min (struct
-                                                     GNUNET_TIME_Relative
-                                                     t1,
-                                                     struct
-                                                     GNUNET_TIME_Relative t2)
+struct GNUNET_TIME_Relative
+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;
+}
+
+
+/**
+ * Return the maximum of two relative time values.
+ *
+ * @param t1 first timestamp
+ * @param t2 other timestamp
+ * @return timestamp that is larger
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_max (struct
+                          GNUNET_TIME_Relative
+                          t1, struct GNUNET_TIME_Relative t2)
+{
+  return (t1.rel_value > t2.rel_value) ? t1 : t2;
 }
 
 
@@ -144,15 +161,31 @@ struct GNUNET_TIME_Relative GNUNET_TIME_relative_min (struct
  * @param t2 other timestamp
  * @return timestamp that is smaller
  */
-struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_min (struct
-                                                     GNUNET_TIME_Absolute
-                                                     t1,
-                                                     struct
-                                                     GNUNET_TIME_Absolute t2)
+struct GNUNET_TIME_Absolute
+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;
 }
 
+
+/**
+ * Return the maximum of two relative time values.
+ *
+ * @param t1 first timestamp
+ * @param t2 other timestamp
+ * @return timestamp that is smaller
+ */
+struct GNUNET_TIME_Absolute
+GNUNET_TIME_absolute_max (struct
+                          GNUNET_TIME_Absolute
+                          t1, struct GNUNET_TIME_Absolute t2)
+{
+  return (t1.abs_value > t2.abs_value) ? t1 : t2;
+}
+
+
 /**
  * Given a timestamp in the future, how much time
  * remains until then?
@@ -163,12 +196,12 @@ 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;
 }
 
@@ -184,11 +217,11 @@ 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;
 }
 
@@ -205,10 +238,10 @@ GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute hence)
   struct GNUNET_TIME_Relative ret;
 
   now = GNUNET_TIME_absolute_get ();
-  GNUNET_assert (hence.value != (uint64_t) - 1LL);
-  if (hence.value > now.value)
+  GNUNET_assert (hence.abs_value != UINT64_MAX);
+  if (hence.abs_value > now.abs_value)
     return GNUNET_TIME_relative_get_zero ();
-  ret.value = now.value - hence.value;
+  ret.rel_value = now.abs_value - hence.abs_value;
   return ret;
 }
 
@@ -225,18 +258,45 @@ 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.value + duration.value < start.value)
+  if (start.abs_value + duration.rel_value < start.abs_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.
  *
@@ -249,12 +309,32 @@ GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
   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)
+  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;
+}
+
+
+/**
+ * Divide relative time by a given factor.
+ *
+ * @param rel some duration
+ * @param factor integer to divide by
+ * @return FOREVER if rel=FOREVER or factor==0; otherwise rel/factor
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
+                            unsigned int factor)
+{
+  struct GNUNET_TIME_Relative ret;
+  if ( (factor == 0) ||
+       (rel.rel_value == GNUNET_TIME_UNIT_FOREVER_REL.rel_value) )
+    return GNUNET_TIME_UNIT_FOREVER_REL;
+  ret.rel_value = rel.rel_value / (unsigned long long) factor;
   return ret;
 }
 
@@ -269,9 +349,9 @@ GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
  * @return remaining duration for the operation,
  *        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)
+struct GNUNET_TIME_Relative
+GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
+                           uint64_t finished, uint64_t total)
 {
   struct GNUNET_TIME_Relative dur;
   double exp;
@@ -283,8 +363,8 @@ struct GNUNET_TIME_Relative GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolu
   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;
 }
 
@@ -292,6 +372,8 @@ struct GNUNET_TIME_Relative GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolu
 /**
  * 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
@@ -300,60 +382,94 @@ 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.value + a2.value < a1.value)
+  if (a1.rel_value + a2.rel_value < a1.rel_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;
 
 }