gnunet_time_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2001-2022 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_TIME_LIB_H
#define GNUNET_TIME_LIB_H
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_common.h"
 
struct GNUNET_TIME_Absolute
{
  uint64_t abs_value_us;
};
 
struct GNUNET_TIME_Timestamp
{
  struct GNUNET_TIME_Absolute abs_time;
};
 
struct GNUNET_TIME_Relative
{
  uint64_t rel_value_us;
};
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct GNUNET_TIME_RelativeNBO
{
  uint64_t rel_value_us__ GNUNET_PACKED;
};
 
 
struct GNUNET_TIME_AbsoluteNBO
{
  uint64_t abs_value_us__ GNUNET_PACKED;
};
 
struct GNUNET_TIME_TimestampNBO
{
  struct GNUNET_TIME_AbsoluteNBO abs_time_nbo;
};
 
GNUNET_NETWORK_STRUCT_END
 
#define GNUNET_TIME_UNIT_ZERO ((struct GNUNET_TIME_Relative){0})
 
#define GNUNET_TIME_UNIT_ZERO_ABS ((struct GNUNET_TIME_Absolute){0})
 
#define GNUNET_TIME_UNIT_ZERO_TS ((struct GNUNET_TIME_Timestamp){{0}})
 
#define GNUNET_TIME_UNIT_MICROSECONDS GNUNET_TIME_relative_get_unit_ ()
 
#define GNUNET_TIME_UNIT_MILLISECONDS GNUNET_TIME_relative_get_millisecond_ ()
 
#define GNUNET_TIME_UNIT_SECONDS GNUNET_TIME_relative_get_second_ ()
 
#define GNUNET_TIME_UNIT_MINUTES GNUNET_TIME_relative_get_minute_ ()
 
#define GNUNET_TIME_UNIT_HOURS   GNUNET_TIME_relative_get_hour_ ()
 
#define GNUNET_TIME_UNIT_DAYS    GNUNET_TIME_relative_multiply ( \
          GNUNET_TIME_UNIT_HOURS, 24)
 
#define GNUNET_TIME_UNIT_WEEKS   GNUNET_TIME_relative_multiply ( \
          GNUNET_TIME_UNIT_DAYS, 7)
 
#define GNUNET_TIME_UNIT_MONTHS  GNUNET_TIME_relative_multiply ( \
          GNUNET_TIME_UNIT_DAYS, 30)
 
#define GNUNET_TIME_UNIT_YEARS   GNUNET_TIME_relative_multiply ( \
          GNUNET_TIME_UNIT_DAYS, 365)
 
#define GNUNET_TIME_UNIT_FOREVER_REL \
        ((struct GNUNET_TIME_Relative){UINT64_MAX})
 
#define GNUNET_TIME_UNIT_FOREVER_ABS \
        ((struct GNUNET_TIME_Absolute){UINT64_MAX})
#define GNUNET_TIME_UNIT_NEVER_ABS \
        ((struct GNUNET_TIME_Absolute){UINT64_MAX})
 
#define GNUNET_TIME_UNIT_FOREVER_TS \
        ((struct GNUNET_TIME_Timestamp){{UINT64_MAX}})
 
 
#define GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD \
        GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
 
 
#define GNUNET_TIME_STD_BACKOFF(r) GNUNET_TIME_relative_min ( \
          GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD, \
          GNUNET_TIME_relative_multiply ( \
            GNUNET_TIME_relative_max (GNUNET_TIME_UNIT_MILLISECONDS, (r)), 2))
 
 
enum GNUNET_TIME_RounderInterval
{
  GNUNET_TIME_RI_NONE = 0,
 
  GNUNET_TIME_RI_SECOND,
 
  GNUNET_TIME_RI_MINUTE,
 
  GNUNET_TIME_RI_HOUR,
 
  GNUNET_TIME_RI_DAY,
 
  GNUNET_TIME_RI_WEEK,
 
  GNUNET_TIME_RI_MONTH,
 
  GNUNET_TIME_RI_QUARTER,
 
  GNUNET_TIME_RI_YEAR
};
 
 
enum GNUNET_TIME_RounderInterval
GNUNET_TIME_relative_to_round_interval (struct GNUNET_TIME_Relative rel);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TIME_string_to_round_interval (const char *ri_str,
                                      enum GNUNET_TIME_RounderInterval *ri);
 
 
const char *
GNUNET_TIME_round_interval2s (enum GNUNET_TIME_RounderInterval ri);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_round_up (struct GNUNET_TIME_Absolute at,
                      enum GNUNET_TIME_RounderInterval ri);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_round_up_utc (struct GNUNET_TIME_Absolute at,
                          enum GNUNET_TIME_RounderInterval ri);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_round_down (struct GNUNET_TIME_Absolute at,
                        enum GNUNET_TIME_RounderInterval ri);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_round_down_utc (struct GNUNET_TIME_Absolute at,
                            enum GNUNET_TIME_RounderInterval ri);
 
 
const char *
GNUNET_TIME_timestamp2s (struct GNUNET_TIME_Timestamp ts);
 
 
const char *
GNUNET_TIME_absolute2s (struct GNUNET_TIME_Absolute ts);
 
 
const char *
GNUNET_TIME_relative2s (struct GNUNET_TIME_Relative delta,
                        bool do_round);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_randomized_backoff (struct GNUNET_TIME_Relative rt,
                                struct GNUNET_TIME_Relative threshold);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_randomize (struct GNUNET_TIME_Relative r);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_get_zero_ (void);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_get_zero_ (void);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_get_unit_ (void);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_get_millisecond_ (void);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_get_second_ (void);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_get_minute_ (void);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_get_hour_ (void);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_get_forever_ (void);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_get_forever_ (void);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_get (void);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_relative_to_absolute (struct GNUNET_TIME_Relative rel);
 
 
struct GNUNET_TIME_Timestamp
GNUNET_TIME_relative_to_timestamp (struct GNUNET_TIME_Relative rel);
 
 
struct GNUNET_TIME_Timestamp
GNUNET_TIME_absolute_to_timestamp (struct GNUNET_TIME_Absolute at);
 
 
struct GNUNET_TIME_Timestamp
GNUNET_TIME_timestamp_get (void);
 
 
#define GNUNET_TIME_absolute_cmp(t1,op,t2) \
        ((void) (1 op 2), (t1).abs_value_us op (t2).abs_value_us)
 
 
#define GNUNET_TIME_timestamp_cmp(t1,op,t2) \
        GNUNET_TIME_absolute_cmp ((t1).abs_time,op,(t2).abs_time)
 
 
#define GNUNET_TIME_relative_cmp(t1,op,t2) \
        ((void) (1 op 2), (t1).rel_value_us op (t2).rel_value_us)
 
 
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_max (struct GNUNET_TIME_Relative t1,
                          struct GNUNET_TIME_Relative t2);
 
 
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_max (struct GNUNET_TIME_Absolute t1,
                          struct GNUNET_TIME_Absolute t2);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_round_down (struct GNUNET_TIME_Absolute at,
                                 struct GNUNET_TIME_Relative rt);
 
 
struct GNUNET_TIME_Timestamp
GNUNET_TIME_timestamp_max (struct GNUNET_TIME_Timestamp t1,
                           struct GNUNET_TIME_Timestamp t2);
 
 
struct GNUNET_TIME_Timestamp
GNUNET_TIME_timestamp_min (struct GNUNET_TIME_Timestamp t1,
                           struct GNUNET_TIME_Timestamp t2);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_absolute_get_remaining (struct GNUNET_TIME_Absolute future);
 
 
bool
GNUNET_TIME_absolute_approx_eq (struct GNUNET_TIME_Absolute a1,
                                struct GNUNET_TIME_Absolute a2,
                                struct GNUNET_TIME_Relative t);
 
 
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_absolute_get_difference (struct GNUNET_TIME_Absolute start,
                                     struct GNUNET_TIME_Absolute end);
 
 
struct GNUNET_TIME_Relative
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_Absolute
GNUNET_TIME_absolute_subtract (struct GNUNET_TIME_Absolute start,
                               struct GNUNET_TIME_Relative duration);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_multiply_double (struct GNUNET_TIME_Relative rel,
                                      double factor);
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_multiply (struct GNUNET_TIME_Relative rel,
                               unsigned long long factor);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_saturating_multiply (struct GNUNET_TIME_Relative rel,
                                          unsigned long long factor);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_divide (struct GNUNET_TIME_Relative rel,
                             unsigned long long factor);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_add (struct GNUNET_TIME_Relative a1,
                          struct GNUNET_TIME_Relative a2);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_subtract (struct GNUNET_TIME_Relative a1,
                               struct GNUNET_TIME_Relative a2);
 
 
struct GNUNET_TIME_RelativeNBO
GNUNET_TIME_relative_hton (struct GNUNET_TIME_Relative a);
 
 
struct GNUNET_TIME_Relative
GNUNET_TIME_relative_ntoh (struct GNUNET_TIME_RelativeNBO a);
 
 
struct GNUNET_TIME_AbsoluteNBO
GNUNET_TIME_absolute_hton (struct GNUNET_TIME_Absolute a);
 
 
struct GNUNET_TIME_TimestampNBO
GNUNET_TIME_timestamp_hton (struct GNUNET_TIME_Timestamp t);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_from_ms (uint64_t ms_after_epoch);
 
 
bool
GNUNET_TIME_absolute_is_never (struct GNUNET_TIME_Absolute abs);
 
 
bool
GNUNET_TIME_absolute_is_past (struct GNUNET_TIME_Absolute abs);
 
 
bool
GNUNET_TIME_absolute_is_zero (struct GNUNET_TIME_Absolute abs);
 
 
bool
GNUNET_TIME_absolute_is_future (struct GNUNET_TIME_Absolute abs);
 
 
bool
GNUNET_TIME_relative_is_forever (struct GNUNET_TIME_Relative rel);
 
 
bool
GNUNET_TIME_relative_is_zero (struct GNUNET_TIME_Relative rel);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_from_s (uint64_t s_after_epoch);
 
 
struct GNUNET_TIME_Timestamp
GNUNET_TIME_timestamp_from_s (uint64_t s_after_epoch);
 
 
uint64_t
GNUNET_TIME_timestamp_to_s (struct GNUNET_TIME_Timestamp ts);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_ntoh (struct GNUNET_TIME_AbsoluteNBO a);
 
 
struct GNUNET_TIME_Timestamp
GNUNET_TIME_timestamp_ntoh (struct GNUNET_TIME_TimestampNBO tn);
 
 
void
GNUNET_TIME_set_offset (long long offset);
 
 
long long
GNUNET_TIME_get_offset (void);
 
 
unsigned int
GNUNET_TIME_get_current_year (void);
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_year_to_time (unsigned int year);
 
 
unsigned int
GNUNET_TIME_time_to_year (struct GNUNET_TIME_Absolute at);
 
 
struct GNUNET_CONFIGURATION_Handle;
 
 
struct GNUNET_TIME_Absolute
GNUNET_TIME_absolute_get_monotonic (
  const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_TIME_LIB_H */
#endif
 
 
 
/* end of gnunet_time_lib.h */