-code deduplication in rsa sign/verify code
[oweals/gnunet.git] / src / util / time.c
index e48377fa3031fc74fbd3a5db30cc9b15d27db9c4..afb0c00c1afc80463bcad8bea5ad394abbbe9df7 100644 (file)
@@ -28,6 +28,9 @@
 
 #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;
 
 /**
@@ -55,8 +58,8 @@ GNUNET_TIME_absolute_get ()
 
   GETTIMEOFDAY (&tv, NULL);
   ret.abs_value =
-    (uint64_t) (((uint64_t) tv.tv_sec * 1000LL) +
-               ((uint64_t) tv.tv_usec / 1000LL)) + timestamp_offset;
+      (uint64_t) (((uint64_t) tv.tv_sec * 1000LL) +
+                  ((uint64_t) tv.tv_usec / 1000LL)) + timestamp_offset;
   return ret;
 }
 
@@ -65,7 +68,7 @@ GNUNET_TIME_absolute_get ()
  * Return relative time of 0ms.
  */
 struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_get_zero ()
+GNUNET_TIME_relative_get_zero_ ()
 {
   static struct GNUNET_TIME_Relative zero;
 
@@ -77,28 +80,63 @@ GNUNET_TIME_relative_get_zero ()
  * Return absolute time of 0ms.
  */
 struct GNUNET_TIME_Absolute
-GNUNET_TIME_absolute_get_zero ()
+GNUNET_TIME_absolute_get_zero_ ()
 {
   static struct GNUNET_TIME_Absolute zero;
 
   return zero;
 }
 
+
 /**
  * Return relative time of 1ms.
  */
 struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_get_unit ()
+GNUNET_TIME_relative_get_unit_ ()
 {
   static struct GNUNET_TIME_Relative one = { 1 };
   return one;
 }
 
+
+/**
+ * Return relative time of 1s.
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_second_ ()
+{
+  static struct GNUNET_TIME_Relative one = { 1000 };
+  return one;
+}
+
+
+/**
+ * Return relative time of 1 minute.
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_minute_ ()
+{
+  static struct GNUNET_TIME_Relative one = { 60 * 1000 };
+  return one;
+}
+
+
+/**
+ * Return relative time of 1 hour.
+ */
+struct GNUNET_TIME_Relative
+GNUNET_TIME_relative_get_hour_ ()
+{
+  static struct GNUNET_TIME_Relative one = { 60 * 60 * 1000 };
+  return one;
+}
+
+
 /**
  * Return "forever".
  */
 struct GNUNET_TIME_Relative
-GNUNET_TIME_relative_get_forever ()
+GNUNET_TIME_relative_get_forever_ ()
 {
   static struct GNUNET_TIME_Relative forever = { UINT64_MAX };
   return forever;
@@ -108,7 +146,7 @@ GNUNET_TIME_relative_get_forever ()
  * Return "forever".
  */
 struct GNUNET_TIME_Absolute
-GNUNET_TIME_absolute_get_forever ()
+GNUNET_TIME_absolute_get_forever_ ()
 {
   static struct GNUNET_TIME_Absolute forever = { UINT64_MAX };
   return forever;
@@ -126,14 +164,14 @@ GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel)
   struct GNUNET_TIME_Absolute ret;
 
   if (rel.rel_value == UINT64_MAX)
-    return GNUNET_TIME_absolute_get_forever ();
+    return GNUNET_TIME_UNIT_FOREVER_ABS;
   struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
 
   if (rel.rel_value + now.abs_value < rel.rel_value)
-    {
-      GNUNET_break (0);                /* overflow... */
-      return GNUNET_TIME_absolute_get_forever ();
-    }
+  {
+    GNUNET_break (0);           /* overflow... */
+    return GNUNET_TIME_UNIT_FOREVER_ABS;
+  }
   ret.abs_value = rel.rel_value + now.abs_value;
   return ret;
 }
@@ -148,7 +186,7 @@ GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel)
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_min (struct GNUNET_TIME_Relative t1,
-                         struct GNUNET_TIME_Relative t2)
+                          struct GNUNET_TIME_Relative t2)
 {
   return (t1.rel_value < t2.rel_value) ? t1 : t2;
 }
@@ -163,7 +201,7 @@ GNUNET_TIME_relative_min (struct GNUNET_TIME_Relative t1,
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_max (struct GNUNET_TIME_Relative t1,
-                         struct GNUNET_TIME_Relative t2)
+                          struct GNUNET_TIME_Relative t2)
 {
   return (t1.rel_value > t2.rel_value) ? t1 : t2;
 }
@@ -179,7 +217,7 @@ GNUNET_TIME_relative_max (struct GNUNET_TIME_Relative t1,
  */
 struct GNUNET_TIME_Absolute
 GNUNET_TIME_absolute_min (struct GNUNET_TIME_Absolute t1,
-                         struct GNUNET_TIME_Absolute t2)
+                          struct GNUNET_TIME_Absolute t2)
 {
   return (t1.abs_value < t2.abs_value) ? t1 : t2;
 }
@@ -190,11 +228,11 @@ GNUNET_TIME_absolute_min (struct GNUNET_TIME_Absolute t1,
  *
  * @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)
+                          struct GNUNET_TIME_Absolute t2)
 {
   return (t1.abs_value > t2.abs_value) ? t1 : t2;
 }
@@ -212,11 +250,11 @@ GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future)
   struct GNUNET_TIME_Relative ret;
 
   if (future.abs_value == UINT64_MAX)
-    return GNUNET_TIME_relative_get_forever ();
+    return GNUNET_TIME_UNIT_FOREVER_REL;
   struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
 
   if (now.abs_value > future.abs_value)
-    return GNUNET_TIME_relative_get_zero ();
+    return GNUNET_TIME_UNIT_ZERO;
   ret.rel_value = future.abs_value - now.abs_value;
   return ret;
 }
@@ -230,14 +268,14 @@ GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future)
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_absolute_get_difference (struct GNUNET_TIME_Absolute start,
-                                    struct GNUNET_TIME_Absolute end)
+                                     struct GNUNET_TIME_Absolute end)
 {
   struct GNUNET_TIME_Relative ret;
 
   if (end.abs_value == UINT64_MAX)
-    return GNUNET_TIME_relative_get_forever ();
+    return GNUNET_TIME_UNIT_FOREVER_REL;
   if (end.abs_value < start.abs_value)
-    return GNUNET_TIME_relative_get_zero ();
+    return GNUNET_TIME_UNIT_ZERO;
   ret.rel_value = end.abs_value - start.abs_value;
   return ret;
 }
@@ -257,7 +295,7 @@ GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence)
   now = GNUNET_TIME_absolute_get ();
   GNUNET_assert (whence.abs_value != UINT64_MAX);
   if (whence.abs_value > now.abs_value)
-    return GNUNET_TIME_relative_get_zero ();
+    return GNUNET_TIME_UNIT_ZERO;
   ret.rel_value = now.abs_value - whence.abs_value;
   return ret;
 }
@@ -271,17 +309,17 @@ GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence)
  */
 struct GNUNET_TIME_Absolute
 GNUNET_TIME_absolute_add (struct GNUNET_TIME_Absolute start,
-                         struct GNUNET_TIME_Relative duration)
+                          struct GNUNET_TIME_Relative duration)
 {
   struct GNUNET_TIME_Absolute ret;
 
   if ((start.abs_value == UINT64_MAX) || (duration.rel_value == UINT64_MAX))
-    return GNUNET_TIME_absolute_get_forever ();
+    return GNUNET_TIME_UNIT_FOREVER_ABS;
   if (start.abs_value + duration.rel_value < start.abs_value)
-    {
-      GNUNET_break (0);
-      return GNUNET_TIME_absolute_get_forever ();
-    }
+  {
+    GNUNET_break (0);
+    return GNUNET_TIME_UNIT_FOREVER_ABS;
+  }
   ret.abs_value = start.abs_value + duration.rel_value;
   return ret;
 }
@@ -297,7 +335,7 @@ GNUNET_TIME_absolute_add (struct GNUNET_TIME_Absolute start,
  */
 struct GNUNET_TIME_Absolute
 GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start,
-                              struct GNUNET_TIME_Relative duration)
+                               struct GNUNET_TIME_Relative duration)
 {
   struct GNUNET_TIME_Absolute ret;
 
@@ -317,18 +355,18 @@ GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start,
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
-                              unsigned int factor)
+                               unsigned int factor)
 {
   struct GNUNET_TIME_Relative ret;
 
   if (factor == 0)
-    return GNUNET_TIME_relative_get_zero ();
+    return GNUNET_TIME_UNIT_ZERO;
   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 ();
-    }
+  {
+    GNUNET_break (0);
+    return GNUNET_TIME_UNIT_FOREVER_REL;
+  }
   return ret;
 }
 
@@ -342,7 +380,7 @@ 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;
 
@@ -365,8 +403,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;
@@ -393,17 +431,17 @@ GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
-                         struct GNUNET_TIME_Relative a2)
+                          struct GNUNET_TIME_Relative a2)
 {
   struct GNUNET_TIME_Relative ret;
 
   if ((a1.rel_value == UINT64_MAX) || (a2.rel_value == UINT64_MAX))
-    return GNUNET_TIME_relative_get_forever ();
+    return GNUNET_TIME_UNIT_FOREVER_REL;
   if (a1.rel_value + a2.rel_value < a1.rel_value)
-    {
-      GNUNET_break (0);
-      return GNUNET_TIME_relative_get_forever ();
-    }
+  {
+    GNUNET_break (0);
+    return GNUNET_TIME_UNIT_FOREVER_REL;
+  }
   ret.rel_value = a1.rel_value + a2.rel_value;
   return ret;
 }
@@ -418,14 +456,14 @@ GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
  */
 struct GNUNET_TIME_Relative
 GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
-                              struct GNUNET_TIME_Relative a2)
+                               struct GNUNET_TIME_Relative a2)
 {
   struct GNUNET_TIME_Relative ret;
 
   if (a2.rel_value >= a1.rel_value)
-    return GNUNET_TIME_relative_get_zero ();
+    return GNUNET_TIME_UNIT_ZERO;
   if (a1.rel_value == UINT64_MAX)
-    return GNUNET_TIME_relative_get_forever ();
+    return GNUNET_TIME_UNIT_FOREVER_REL;
   ret.rel_value = a1.rel_value - a2.rel_value;
   return ret;
 }
@@ -446,6 +484,7 @@ GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a)
   return ret;
 }
 
+
 /**
  * Convert relative time from network byte order.
  *
@@ -462,6 +501,7 @@ GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a)
 
 }
 
+
 /**
  * Convert absolute time to network byte order.
  *
@@ -477,6 +517,7 @@ GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a)
   return ret;
 }
 
+
 /**
  * Convert absolute time from network byte order.
  *
@@ -493,26 +534,5 @@ GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a)
 
 }
 
-/**
- * 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 */