src/include/gnunet_time_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2013 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @author Christian Grothoff
  21  *
  22  * @file
  23  * Functions related to time
  24  *
  25  * @defgroup time  Time library
  26  * Time and time calculations.
  27  * @{
  28  */
  29
  30 #ifndef GNUNET_TIME_LIB_H
  31 #define GNUNET_TIME_LIB_H
  32
  33 #ifdef __cplusplus
  34 extern "C"
  35 {
  36 #if 0                           /* keep Emacsens' auto-indent happy */
  37 }
  38 #endif
  39 #endif
  40
  41 #include "gnunet_common.h"
  42
  43 /**
  44  * Time for absolute times used by GNUnet, in microseconds.
  45  */
  46 struct GNUNET_TIME_Absolute
  47 {
  48   /**
  49    * The actual value.
  50    */
  51   uint64_t abs_value_us;
  52 };
  53
  54 /**
  55  * Time for relative time used by GNUnet, in microseconds.
  56  * Always positive, so we can only refer to future time.
  57  */
  58 struct GNUNET_TIME_Relative
  59 {
  60   /**
  61    * The actual value.
  62    */
  63   uint64_t rel_value_us;
  64 };
  65
  66 GNUNET_NETWORK_STRUCT_BEGIN
  67
  68 /**
  69  * Time for relative time used by GNUnet, in microseconds and in network byte order.
  70  */
  71 struct GNUNET_TIME_RelativeNBO
  72 {
  73   /**
  74    * The actual value (in network byte order).
  75    */
  76   uint64_t rel_value_us__ GNUNET_PACKED;
  77 };
  78
  79
  80 /**
  81  * Time for absolute time used by GNUnet, in microseconds and in network byte order.
  82  */
  83 struct GNUNET_TIME_AbsoluteNBO
  84 {
  85   /**
  86    * The actual value (in network byte order).
  87    */
  88   uint64_t abs_value_us__ GNUNET_PACKED;
  89 };
  90 GNUNET_NETWORK_STRUCT_END
  91
  92 /**
  93  * Relative time zero.
  94  */
  95 #define GNUNET_TIME_UNIT_ZERO     GNUNET_TIME_relative_get_zero_()
  96
  97 /**
  98  * Absolute time zero.
  99  */
 100 #define GNUNET_TIME_UNIT_ZERO_ABS GNUNET_TIME_absolute_get_zero_()
 101
 102 /**
 103  * One microsecond, our basic time unit.
 104  */
 105 #define GNUNET_TIME_UNIT_MICROSECONDS GNUNET_TIME_relative_get_unit_()
 106
 107 /**
 108  * One millisecond.
 109  */
 110 #define GNUNET_TIME_UNIT_MILLISECONDS GNUNET_TIME_relative_get_millisecond_()
 111
 112 /**
 113  * One second.
 114  */
 115 #define GNUNET_TIME_UNIT_SECONDS GNUNET_TIME_relative_get_second_()
 116
 117 /**
 118  * One minute.
 119  */
 120 #define GNUNET_TIME_UNIT_MINUTES GNUNET_TIME_relative_get_minute_()
 121
 122 /**
 123  * One hour.
 124  */
 125 #define GNUNET_TIME_UNIT_HOURS   GNUNET_TIME_relative_get_hour_()
 126
 127 /**
 128  * One day.
 129  */
 130 #define GNUNET_TIME_UNIT_DAYS    GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_HOURS,   24)
 131
 132 /**
 133  * One week.
 134  */
 135 #define GNUNET_TIME_UNIT_WEEKS   GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS,     7)
 136
 137 /**
 138  * One month (30 days).
 139  */
 140 #define GNUNET_TIME_UNIT_MONTHS  GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS,    30)
 141
 142 /**
 143  * One year (365 days).
 144  */
 145 #define GNUNET_TIME_UNIT_YEARS   GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_DAYS,   365)
 146
 147 /**
 148  * Constant used to specify "forever".  This constant
 149  * will be treated specially in all time operations.
 150  */
 151 #define GNUNET_TIME_UNIT_FOREVER_REL GNUNET_TIME_relative_get_forever_ ()
 152
 153 /**
 154  * Constant used to specify "forever".  This constant
 155  * will be treated specially in all time operations.
 156  */
 157 #define GNUNET_TIME_UNIT_FOREVER_ABS GNUNET_TIME_absolute_get_forever_ ()
 158
 159
 160
 161 /**
 162  * Threshold after which exponential backoff should not increase (15 m).
 163  */
 164 #define GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
 165
 166
 167 /**
 168  * Perform our standard exponential back-off calculation, starting at 1 ms
 169  * and then going by a factor of 2 up unto a maximum of 15 m.
 170  *
 171  * @param r current backoff time, initially zero
 172  */
 173 #define GNUNET_TIME_STD_BACKOFF(r) GNUNET_TIME_relative_min (GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD, \
 174    GNUNET_TIME_relative_multiply (GNUNET_TIME_relative_max (GNUNET_TIME_UNIT_MILLISECONDS, (r)), 2));
 175
 176
 177 /**
 178  * Randomized exponential back-off, starting at 1 ms
 179  * and going up by a factor of 2+r, where 0 <= r <= 0.5, up
 180  * to a maximum of the given threshold.
 181  *
 182  * @param rt current backoff time, initially zero
 183  * @param threshold maximum value for backoff
 184  * @return the next backoff time
 185  */
 186 struct GNUNET_TIME_Relative
 187 GNUNET_TIME_randomized_backoff(struct GNUNET_TIME_Relative rt, struct GNUNET_TIME_Relative threshold);
 188
 189
 190 /**
 191  * Return relative time of 0ms.
 192  */
 193 struct GNUNET_TIME_Relative
 194 GNUNET_TIME_relative_get_zero_ (void);
 195
 196
 197 /**
 198  * Return absolute time of 0ms.
 199  */
 200 struct GNUNET_TIME_Absolute
 201 GNUNET_TIME_absolute_get_zero_ (void);
 202
 203
 204 /**
 205  * Return relative time of 1 microsecond.
 206  */
 207 struct GNUNET_TIME_Relative
 208 GNUNET_TIME_relative_get_unit_ (void);
 209
 210
 211 /**
 212  * Return relative time of 1ms.
 213  */
 214 struct GNUNET_TIME_Relative
 215 GNUNET_TIME_relative_get_millisecond_ (void);
 216
 217
 218 /**
 219  * Return relative time of 1s.
 220  */
 221 struct GNUNET_TIME_Relative
 222 GNUNET_TIME_relative_get_second_ (void);
 223
 224
 225 /**
 226  * Return relative time of 1 minute.
 227  */
 228 struct GNUNET_TIME_Relative
 229 GNUNET_TIME_relative_get_minute_ (void);
 230
 231
 232 /**
 233  * Return relative time of 1 hour.
 234  */
 235 struct GNUNET_TIME_Relative
 236 GNUNET_TIME_relative_get_hour_ (void);
 237
 238
 239 /**
 240  * Return "forever".
 241  */
 242 struct GNUNET_TIME_Relative
 243 GNUNET_TIME_relative_get_forever_ (void);
 244
 245
 246 /**
 247  * Return "forever".
 248  */
 249 struct GNUNET_TIME_Absolute
 250 GNUNET_TIME_absolute_get_forever_ (void);
 251
 252
 253 /**
 254  * Get the current time.
 255  *
 256  * @return the current time
 257  */
 258 struct GNUNET_TIME_Absolute
 259 GNUNET_TIME_absolute_get (void);
 260
 261
 262 /**
 263  * Convert relative time to an absolute time in the
 264  * future.
 265  *
 266  * @param rel relative time to convert
 267  * @return timestamp that is "rel" in the future, or FOREVER if rel==FOREVER (or if we would overflow)
 268  */
 269 struct GNUNET_TIME_Absolute
 270 GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel);
 271
 272
 273 /**
 274  * Round a time value so that it is suitable for transmission
 275  * via JSON encodings.
 276  *
 277  * @param at time to round
 278  * @return #GNUNET_OK if time was already rounded, #GNUNET_NO if
 279  *         it was just now rounded
 280  */
 281 int
 282 GNUNET_TIME_round_abs (struct GNUNET_TIME_Absolute *at);
 283
 284
 285 /**
 286  * Round a time value so that it is suitable for transmission
 287  * via JSON encodings.
 288  *
 289  * @param rt time to round
 290  * @return #GNUNET_OK if time was already rounded, #GNUNET_NO if
 291  *         it was just now rounded
 292  */
 293 int
 294 GNUNET_TIME_round_rel (struct GNUNET_TIME_Relative *rt);
 295
 296
 297 /**
 298  * Return the minimum of two relative time values.
 299  *
 300  * @param t1 first timestamp
 301  * @param t2 other timestamp
 302  * @return timestamp that is smaller
 303  */
 304 struct GNUNET_TIME_Relative
 305 GNUNET_TIME_relative_min (struct GNUNET_TIME_Relative t1,
 306                           struct GNUNET_TIME_Relative t2);
 307
 308
 309
 310 /**
 311  * Return the maximum of two relative time values.
 312  *
 313  * @param t1 first timestamp
 314  * @param t2 other timestamp
 315  * @return timestamp that is larger
 316  */
 317 struct GNUNET_TIME_Relative
 318 GNUNET_TIME_relative_max (struct GNUNET_TIME_Relative t1,
 319                           struct GNUNET_TIME_Relative t2);
 320
 321
 322 /**
 323  * Return the minimum of two absolute time values.
 324  *
 325  * @param t1 first timestamp
 326  * @param t2 other timestamp
 327  * @return timestamp that is smaller
 328  */
 329 struct GNUNET_TIME_Absolute
 330 GNUNET_TIME_absolute_min (struct GNUNET_TIME_Absolute t1,
 331                           struct GNUNET_TIME_Absolute t2);
 332
 333
 334 /**
 335  * Return the maximum of two absolute time values.
 336  *
 337  * @param t1 first timestamp
 338  * @param t2 other timestamp
 339  * @return timestamp that is smaller
 340  */
 341 struct GNUNET_TIME_Absolute
 342 GNUNET_TIME_absolute_max (struct GNUNET_TIME_Absolute t1,
 343                           struct GNUNET_TIME_Absolute t2);
 344
 345
 346 /**
 347  * Given a timestamp in the future, how much time
 348  * remains until then?
 349  *
 350  * @param future some absolute time, typically in the future
 351  * @return future - now, or 0 if now >= future, or FOREVER if future==FOREVER.
 352  */
 353 struct GNUNET_TIME_Relative
 354 GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future);
 355
 356
 357 /**
 358  * Calculate the estimate time of arrival/completion
 359  * for an operation.
 360  *
 361  * @param start when did the operation start?
 362  * @param finished how much has been done?
 363  * @param total how much must be done overall (same unit as for "finished")
 364  * @return remaining duration for the operation,
 365  *        assuming it continues at the same speed
 366  */
 367 struct GNUNET_TIME_Relative
 368 GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start,
 369                            uint64_t finished,
 370                            uint64_t total);
 371
 372
 373 /**
 374  * Compute the time difference between the given start and end times.
 375  * Use this function instead of actual subtraction to ensure that
 376  * "FOREVER" and overflows are handeled correctly.
 377  *
 378  * @param start some absolute time
 379  * @param end some absolute time (typically larger or equal to start)
 380  * @return 0 if start >= end; FOREVER if end==FOREVER; otherwise end - start
 381  */
 382 struct GNUNET_TIME_Relative
 383 GNUNET_TIME_absolute_get_difference (struct GNUNET_TIME_Absolute start,
 384                                      struct GNUNET_TIME_Absolute end);
 385
 386
 387 /**
 388  * Get the duration of an operation as the
 389  * difference of the current time and the given start time "hence".
 390  *
 391  * @param whence some absolute time, typically in the past
 392  * @return 0 if hence > now, otherwise now-hence.
 393  */
 394 struct GNUNET_TIME_Relative
 395 GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence);
 396
 397
 398 /**
 399  * Add a given relative duration to the
 400  * given start time.
 401  *
 402  * @param start some absolute time
 403  * @param duration some relative time to add
 404  * @return FOREVER if either argument is FOREVER or on overflow; start+duration otherwise
 405  */
 406 struct GNUNET_TIME_Absolute
 407 GNUNET_TIME_absolute_add (struct GNUNET_TIME_Absolute start,
 408                           struct GNUNET_TIME_Relative duration);
 409
 410
 411 /**
 412  * Subtract a given relative duration from the
 413  * given start time.
 414  *
 415  * @param start some absolute time
 416  * @param duration some relative time to subtract
 417  * @return ZERO if start <= duration, or FOREVER if start time is FOREVER; start-duration otherwise
 418  */
 419 struct GNUNET_TIME_Absolute
 420 GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start,
 421                                struct GNUNET_TIME_Relative duration);
 422
 423
 424 /**
 425  * Multiply relative time by a given factor.
 426  *
 427  * @param rel some duration
 428  * @param factor integer to multiply with
 429  * @return FOREVER if rel=FOREVER or on overflow; otherwise rel*factor
 430  */
 431 struct GNUNET_TIME_Relative
 432 GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
 433                                unsigned long long factor);
 434
 435
 436 /**
 437  * Saturating multiply relative time by a given factor.
 438  *
 439  * @param rel some duration
 440  * @param factor integer to multiply with
 441  * @return FOREVER if rel=FOREVER or on overflow; otherwise rel*factor
 442  */
 443 struct GNUNET_TIME_Relative
 444 GNUNET_TIME_relative_saturating_multiply (struct GNUNET_TIME_Relative rel,
 445                                           unsigned long long factor);
 446
 447
 448 /**
 449  * Divide relative time by a given factor.
 450  *
 451  * @param rel some duration
 452  * @param factor integer to divide by
 453  * @return FOREVER if rel=FOREVER or factor==0; otherwise rel/factor
 454  */
 455 struct GNUNET_TIME_Relative
 456 GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
 457                              unsigned long long factor);
 458
 459
 460 /**
 461  * Add relative times together.
 462  *
 463  * @param a1 some relative time
 464  * @param a2 some other relative time
 465  * @return FOREVER if either argument is FOREVER or on overflow; a1+a2 otherwise
 466  */
 467 struct GNUNET_TIME_Relative
 468 GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
 469                           struct GNUNET_TIME_Relative a2);
 470
 471
 472 /**
 473  * Subtract relative timestamp from the other.
 474  *
 475  * @param a1 first timestamp
 476  * @param a2 second timestamp
 477  * @return ZERO if a2>=a1 (including both FOREVER), FOREVER if a1 is FOREVER, a1-a2 otherwise
 478  */
 479 struct GNUNET_TIME_Relative
 480 GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
 481                                struct GNUNET_TIME_Relative a2);
 482
 483
 484 /**
 485  * Convert relative time to network byte order.
 486  *
 487  * @param a time to convert
 488  * @return converted time value
 489  */
 490 struct GNUNET_TIME_RelativeNBO
 491 GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a);
 492
 493
 494 /**
 495  * Convert relative time from network byte order.
 496  *
 497  * @param a time to convert
 498  * @return converted time value
 499  */
 500 struct GNUNET_TIME_Relative
 501 GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a);
 502
 503
 504 /**
 505  * Convert absolute time to network byte order.
 506  *
 507  * @param a time to convert
 508  * @return converted time value
 509  */
 510 struct GNUNET_TIME_AbsoluteNBO
 511 GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a);
 512
 513
 514 /**
 515  * Convert absolute time from network byte order.
 516  *
 517  * @param a time to convert
 518  * @return converted time value
 519  */
 520 struct GNUNET_TIME_Absolute
 521 GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a);
 522
 523
 524 /**
 525  * Set the timestamp offset for this instance.
 526  *
 527  * @param offset the offset to skew the locale time by
 528  */
 529 void
 530 GNUNET_TIME_set_offset (long long offset);
 531
 532
 533 /**
 534  * Get the timestamp offset for this instance.
 535  *
 536  * @return the offset we currently skew the locale time by
 537  */
 538 long long
 539 GNUNET_TIME_get_offset (void);
 540
 541
 542 /**
 543  * Return the current year (i.e. '2011').
 544  */
 545 unsigned int
 546 GNUNET_TIME_get_current_year (void);
 547
 548
 549 /**
 550  * Convert a year to an expiration time of January 1st of that year.
 551  *
 552  * @param year a year (after 1970, please ;-)).
 553  * @return absolute time for January 1st of that year.
 554  */
 555 struct GNUNET_TIME_Absolute
 556 GNUNET_TIME_year_to_time (unsigned int year);
 557
 558
 559 /**
 560  * Convert an expiration time to the respective year (rounds)
 561  *
 562  * @param at absolute time
 563  * @return year a year (after 1970), 0 on error
 564  */
 565 unsigned int
 566 GNUNET_TIME_time_to_year (struct GNUNET_TIME_Absolute at);
 567
 568
 569 /**
 570  * A configuration object.
 571  */
 572 struct GNUNET_CONFIGURATION_Handle;
 573
 574
 575 /**
 576  * Obtain the current time and make sure it is monotonically
 577  * increasing.  Guards against systems without an RTC or
 578  * clocks running backwards and other nasty surprises. Does
 579  * not guarantee that the returned time is near the current
 580  * time returned by #GNUNET_TIME_absolute_get().  Two
 581  * subsequent calls (within a short time period) may return the
 582  * same value. Persists the last returned time on disk to
 583  * ensure that time never goes backwards. As a result, the
 584  * resulting value can be used to check if a message is the
 585  * "most recent" value and replays of older messages (from
 586  * the same origin) would be discarded.
 587  *
 588  * @param cfg configuration, used to determine where to
 589  *   store the time; user can also insist RTC is working
 590  *   nicely and disable the feature
 591  * @return monotonically increasing time
 592  */
 593 struct GNUNET_TIME_Absolute
 594 GNUNET_TIME_absolute_get_monotonic (const struct GNUNET_CONFIGURATION_Handle *cfg);
 595
 596
 597 #if 0                           /* keep Emacsens' auto-indent happy */
 598 {
 599 #endif
 600 #ifdef __cplusplus
 601 }
 602 #endif
 603
 604 /* ifndef GNUNET_TIME_LIB_H */
 605 #endif
 606
 607 /** @} */ /* end of group time */
 608
 609 /* end of gnunet_time_lib.h */