Merge branch 'master' of git+ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / util / speedup.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2011-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      SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
21 /**
22  * @file util/speedup.c
23  * @author Matthias Wachs
24  * @brief functions to speedup peer execution by manipulation system time
25  */
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "speedup.h"
29
30 #define LOG(kind,...) GNUNET_log_from (kind, "util-speedup", __VA_ARGS__)
31
32
33 static struct GNUNET_TIME_Relative interval;
34
35 static struct GNUNET_TIME_Relative delta;
36
37 static struct GNUNET_SCHEDULER_Task *speedup_task;
38
39
40 static void
41 do_speedup (void *cls)
42 {
43   static long long current_offset;
44
45   (void) cls;
46   speedup_task = NULL;
47   current_offset += delta.rel_value_us;
48   GNUNET_TIME_set_offset (current_offset);
49   LOG (GNUNET_ERROR_TYPE_DEBUG,
50        "Speeding up execution time by %s\n",
51        GNUNET_STRINGS_relative_time_to_string (delta, GNUNET_NO));
52   speedup_task = GNUNET_SCHEDULER_add_delayed (interval,
53                                                &do_speedup,
54                                                NULL);
55 }
56
57
58 /**
59  * Start task that may speed up our system clock artificially
60  *
61  * @param cfg configuration to use
62  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the speedup was not configured
63  */
64 int
65 GNUNET_SPEEDUP_start_ (const struct GNUNET_CONFIGURATION_Handle *cfg)
66 {
67   GNUNET_assert (NULL == speedup_task);
68   if (GNUNET_OK !=
69       GNUNET_CONFIGURATION_get_value_time (cfg,
70                                            "testing",
71                                            "SPEEDUP_INTERVAL",
72                                            &interval))
73     return GNUNET_SYSERR;
74   if (GNUNET_OK !=
75       GNUNET_CONFIGURATION_get_value_time (cfg,
76                                            "testing",
77                                            "SPEEDUP_DELTA",
78                                            &delta))
79     return GNUNET_SYSERR;
80
81   if ( (0 == interval.rel_value_us) ||
82        (0 == delta.rel_value_us) )
83   {
84     LOG (GNUNET_ERROR_TYPE_DEBUG,
85          "Speed up disabled\n");
86     return GNUNET_OK;
87   }
88   LOG (GNUNET_ERROR_TYPE_DEBUG,
89        "Speed up execution by %s\n",
90        GNUNET_STRINGS_relative_time_to_string (delta, GNUNET_NO));
91   LOG (GNUNET_ERROR_TYPE_DEBUG,
92        "Speed up executed every %s\n",
93        GNUNET_STRINGS_relative_time_to_string (interval, GNUNET_NO));
94   speedup_task = GNUNET_SCHEDULER_add_now_with_lifeness (GNUNET_NO,
95                                                          &do_speedup,
96                                                          NULL);
97   return GNUNET_OK;
98 }
99
100
101 /**
102  * Stop tasks that modify clock behavior.
103  */
104 void
105 GNUNET_SPEEDUP_stop_ ()
106 {
107   if (NULL != speedup_task)
108   {
109     GNUNET_SCHEDULER_cancel (speedup_task);
110     speedup_task = NULL;
111   }
112   if ( (0 != interval.rel_value_us) &&
113        (0 != delta.rel_value_us) )
114     LOG (GNUNET_ERROR_TYPE_DEBUG,
115          "Stopped execution speed up\n");
116 }
117
118 /* end of speedup.c */