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  * Return relative time of 0ms.
 178  */
 179 struct GNUNET_TIME_Relative
 180 GNUNET_TIME_relative_get_zero_ (void);
 181
 182
 183 /**
 184  * Return absolute time of 0ms.
 185  */
 186 struct GNUNET_TIME_Absolute
 187 GNUNET_TIME_absolute_get_zero_ (void);
 188
 189
 190 /**
 191  * Return relative time of 1 microsecond.
 192  */
 193 struct GNUNET_TIME_Relative
 194 GNUNET_TIME_relative_get_unit_ (void);
 195
 196
 197 /**
 198  * Return relative time of 1ms.
 199  */
 200 struct GNUNET_TIME_Relative
 201 GNUNET_TIME_relative_get_millisecond_ (void);
 202
 203
 204 /**
 205  * Return relative time of 1s.
 206  */
 207 struct GNUNET_TIME_Relative
 208 GNUNET_TIME_relative_get_second_ (void);
 209
 210
 211 /**
 212  * Return relative time of 1 minute.
 213  */
 214 struct GNUNET_TIME_Relative
 215 GNUNET_TIME_relative_get_minute_ (void);
 216
 217
 218 /**
 219  * Return relative time of 1 hour.
 220  */
 221 struct GNUNET_TIME_Relative
 222 GNUNET_TIME_relative_get_hour_ (void);
 223
 224
 225 /**
 226  * Return "forever".
 227  */
 228 struct GNUNET_TIME_Relative
 229 GNUNET_TIME_relative_get_forever_ (void);
 230
 231
 232 /**
 233  * Return "forever".
 234  */
 235 struct GNUNET_TIME_Absolute
 236 GNUNET_TIME_absolute_get_forever_ (void);
 237
 238
 239 /**
 240  * Get the current time.
 241  *
 242  * @return the current time
 243  */
 244 struct GNUNET_TIME_Absolute
 245 GNUNET_TIME_absolute_get (void);
 246
 247
 248 /**
 249  * Convert relative time to an absolute time in the
 250  * future.
 251  *
 252  * @param rel relative time to convert
 253  * @return timestamp that is "rel" in the future, or FOREVER if rel==FOREVER (or if we would overflow)
 254  */
 255 struct GNUNET_TIME_Absolute
 256 GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel);
 257
 258
 259 /**
 260  * Round a time value so that it is suitable for transmission
 261  * via JSON encodings.
 262  *
 263  * @param at time to round
 264  * @return #GNUNET_OK if time was already rounded, #GNUNET_NO if
 265  *         it was just now rounded
 266  */
 267 int
 268 GNUNET_TIME_round_abs (struct GNUNET_TIME_Absolute *at);
 269
 270
 271 /**
 272  * Round a time value so that it is suitable for transmission
 273  * via JSON encodings.
 274  *
 275  * @param rt time to round
 276  * @return #GNUNET_OK if time was already rounded, #GNUNET_NO if
 277  *         it was just now rounded
 278  */
 279 int
 280 GNUNET_TIME_round_rel (struct GNUNET_TIME_Relative *rt);
 281
 282
 283 /**
 284  * Return the minimum of two relative time values.
 285  *
 286  * @param t1 first timestamp
 287  * @param t2 other timestamp
 288  * @return timestamp that is smaller
 289  */
 290 struct GNUNET_TIME_Relative
 291 GNUNET_TIME_relative_min (struct GNUNET_TIME_Relative t1,
 292                           struct GNUNET_TIME_Relative t2);
 293
 294
 295
 296 /**
 297  * Return the maximum of two relative time values.
 298  *
 299  * @param t1 first timestamp
 300  * @param t2 other timestamp
 301  * @return timestamp that is larger
 302  */
 303 struct GNUNET_TIME_Relative
 304 GNUNET_TIME_relative_max (struct GNUNET_TIME_Relative t1,
 305                           struct GNUNET_TIME_Relative t2);
 306
 307
 308 /**
 309  * Return the minimum of two absolute time values.
 310  *
 311  * @param t1 first timestamp
 312  * @param t2 other timestamp
 313  * @return timestamp that is smaller
 314  */
 315 struct GNUNET_TIME_Absolute
 316 GNUNET_TIME_absolute_min (struct GNUNET_TIME_Absolute t1,
 317                           struct GNUNET_TIME_Absolute t2);
 318
 319
 320 /**
 321  * Return the maximum of two absolute time values.
 322  *
 323  * @param t1 first timestamp
 324  * @param t2 other timestamp
 325  * @return timestamp that is smaller
 326  */
 327 struct GNUNET_TIME_Absolute
 328 GNUNET_TIME_absolute_max (struct GNUNET_TIME_Absolute t1,
 329                           struct GNUNET_TIME_Absolute t2);
 330
 331
 332 /**
 333  * Given a timestamp in the future, how much time
 334  * remains until then?
 335  *
 336  * @param future some absolute time, typically in the future
 337  * @return future - now, or 0 if now >= future, or FOREVER if future==FOREVER.
 338  */
 339 struct GNUNET_TIME_Relative
 340 GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future);
 341
 342
 343 /**
 344  * Calculate the estimate time of arrival/completion
 345  * for an operation.
 346  *
 347  * @param start when did the operation start?
 348  * @param finished how much has been done?
 349  * @param total how much must be done overall (same unit as for "finished")
 350  * @return remaining duration for the operation,
 351  *        assuming it continues at the same speed
 352  */
 353 struct GNUNET_TIME_Relative
 354 GNUNET_TIME_calculate_eta (struct GNUNET_TIME_Absolute start, uint64_t finished,
 355                            uint64_t total);
 356
 357
 358 /**
 359  * Compute the time difference between the given start and end times.
 360  * Use this function instead of actual subtraction to ensure that
 361  * "FOREVER" and overflows are handeled correctly.
 362  *
 363  * @param start some absolute time
 364  * @param end some absolute time (typically larger or equal to start)
 365  * @return 0 if start >= end; FOREVER if end==FOREVER; otherwise end - start
 366  */
 367 struct GNUNET_TIME_Relative
 368 GNUNET_TIME_absolute_get_difference (struct GNUNET_TIME_Absolute start,
 369                                      struct GNUNET_TIME_Absolute end);
 370
 371
 372 /**
 373  * Get the duration of an operation as the
 374  * difference of the current time and the given start time "hence".
 375  *
 376  * @param whence some absolute time, typically in the past
 377  * @return 0 if hence > now, otherwise now-hence.
 378  */
 379 struct GNUNET_TIME_Relative
 380 GNUNET_TIME_absolute_get_duration (struct GNUNET_TIME_Absolute whence);
 381
 382
 383 /**
 384  * Add a given relative duration to the
 385  * given start time.
 386  *
 387  * @param start some absolute time
 388  * @param duration some relative time to add
 389  * @return FOREVER if either argument is FOREVER or on overflow; start+duration otherwise
 390  */
 391 struct GNUNET_TIME_Absolute
 392 GNUNET_TIME_absolute_add (struct GNUNET_TIME_Absolute start,
 393                           struct GNUNET_TIME_Relative duration);
 394
 395
 396 /**
 397  * Subtract a given relative duration from the
 398  * given start time.
 399  *
 400  * @param start some absolute time
 401  * @param duration some relative time to subtract
 402  * @return ZERO if start <= duration, or FOREVER if start time is FOREVER; start-duration otherwise
 403  */
 404 struct GNUNET_TIME_Absolute
 405 GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start,
 406                                struct GNUNET_TIME_Relative duration);
 407
 408
 409 /**
 410  * Multiply relative time by a given factor.
 411  *
 412  * @param rel some duration
 413  * @param factor integer to multiply with
 414  * @return FOREVER if rel=FOREVER or on overflow; otherwise rel*factor
 415  */
 416 struct GNUNET_TIME_Relative
 417 GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
 418                                unsigned long long factor);
 419
 420
 421 /**
 422  * Saturating multiply relative time by a given factor.
 423  *
 424  * @param rel some duration
 425  * @param factor integer to multiply with
 426  * @return FOREVER if rel=FOREVER or on overflow; otherwise rel*factor
 427  */
 428 struct GNUNET_TIME_Relative
 429 GNUNET_TIME_relative_saturating_multiply (struct GNUNET_TIME_Relative rel,
 430                                           unsigned long long factor);
 431
 432
 433 /**
 434  * Divide relative time by a given factor.
 435  *
 436  * @param rel some duration
 437  * @param factor integer to divide by
 438  * @return FOREVER if rel=FOREVER or factor==0; otherwise rel/factor
 439  */
 440 struct GNUNET_TIME_Relative
 441 GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
 442                              unsigned long long factor);
 443
 444
 445 /**
 446  * Add relative times together.
 447  *
 448  * @param a1 some relative time
 449  * @param a2 some other relative time
 450  * @return FOREVER if either argument is FOREVER or on overflow; a1+a2 otherwise
 451  */
 452 struct GNUNET_TIME_Relative
 453 GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
 454                           struct GNUNET_TIME_Relative a2);
 455
 456
 457 /**
 458  * Subtract relative timestamp from the other.
 459  *
 460  * @param a1 first timestamp
 461  * @param a2 second timestamp
 462  * @return ZERO if a2>=a1 (including both FOREVER), FOREVER if a1 is FOREVER, a1-a2 otherwise
 463  */
 464 struct GNUNET_TIME_Relative
 465 GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
 466                                struct GNUNET_TIME_Relative a2);
 467
 468
 469 /**
 470  * Convert relative time to network byte order.
 471  *
 472  * @param a time to convert
 473  * @return converted time value
 474  */
 475 struct GNUNET_TIME_RelativeNBO
 476 GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a);
 477
 478
 479 /**
 480  * Convert relative time from network byte order.
 481  *
 482  * @param a time to convert
 483  * @return converted time value
 484  */
 485 struct GNUNET_TIME_Relative
 486 GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a);
 487
 488
 489 /**
 490  * Convert absolute time to network byte order.
 491  *
 492  * @param a time to convert
 493  * @return converted time value
 494  */
 495 struct GNUNET_TIME_AbsoluteNBO
 496 GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a);
 497
 498
 499 /**
 500  * Convert absolute time from network byte order.
 501  *
 502  * @param a time to convert
 503  * @return converted time value
 504  */
 505 struct GNUNET_TIME_Absolute
 506 GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a);
 507
 508
 509 /**
 510  * Set the timestamp offset for this instance.
 511  *
 512  * @param offset the offset to skew the locale time by
 513  */
 514 void
 515 GNUNET_TIME_set_offset (long long offset);
 516
 517
 518 /**
 519  * Get the timestamp offset for this instance.
 520  *
 521  * @return the offset we currently skew the locale time by
 522  */
 523 long long
 524 GNUNET_TIME_get_offset (void);
 525
 526
 527 /**
 528  * Return the current year (i.e. '2011').
 529  */
 530 unsigned int
 531 GNUNET_TIME_get_current_year (void);
 532
 533
 534 /**
 535  * Convert a year to an expiration time of January 1st of that year.
 536  *
 537  * @param year a year (after 1970, please ;-)).
 538  * @return absolute time for January 1st of that year.
 539  */
 540 struct GNUNET_TIME_Absolute
 541 GNUNET_TIME_year_to_time (unsigned int year);
 542
 543
 544 /**
 545  * Convert an expiration time to the respective year (rounds)
 546  *
 547  * @param at absolute time
 548  * @return year a year (after 1970), 0 on error
 549  */
 550 unsigned int
 551 GNUNET_TIME_time_to_year (struct GNUNET_TIME_Absolute at);
 552
 553
 554 #if 0                           /* keep Emacsens' auto-indent happy */
 555 {
 556 #endif
 557 #ifdef __cplusplus
 558 }
 559 #endif
 560
 561 /* ifndef GNUNET_TIME_LIB_H */
 562 #endif
 563
 564 /** @} */ /* end of group time */
 565
 566 /* end of gnunet_time_lib.h */