uncrustify as demanded.
[oweals/gnunet.git] / src / ats-tests / ats-testing.h
index c6e679b0bce9a8a034dbd5a687012169d21b3f3e..ff3a40837bf382bdd2cc85c4046dc3a80559710d 100644 (file)
@@ -1,21 +1,21 @@
 /*
- This file is part of GNUnet.
- Copyright (C) 2010-2013 GNUnet e.V.
-
- GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, 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
- General Public License for more details.
-
You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING.  If not, write to the
- Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
  This file is part of GNUnet.
  Copyright (C) 2010-2013 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
  */
 /**
  * @file ats-tests/ats-testing.h
@@ -28,6 +28,7 @@
 #include "gnunet_testbed_service.h"
 #include "gnunet_ats_service.h"
 #include "gnunet_core_service.h"
+#include "gnunet_transport_service.h"
 
 #define TEST_ATS_PREFERENCE_DEFAULT 1.0
 
  */
 #define TEST_MESSAGE_SIZE 100
 
+
+struct TestMessage {
+  struct GNUNET_MessageHeader header;
+
+  uint8_t padding[TEST_MESSAGE_SIZE - sizeof(struct GNUNET_MessageHeader)];
+};
+
+
 struct BenchmarkPartner;
 
 struct BenchmarkPeer;
@@ -56,8 +65,7 @@ struct TrafficGenerator;
 
 struct LoggingHandle;
 
-enum GeneratorType
-{
+enum GeneratorType {
   GNUNET_ATS_TEST_TG_LINEAR,
   GNUNET_ATS_TEST_TG_CONSTANT,
   GNUNET_ATS_TEST_TG_RANDOM,
@@ -72,10 +80,10 @@ enum GeneratorType
  * @param masters array of master peers
  * @param slaves array of master peers
  */
-typedef void
-(*GNUNET_ATS_TEST_TopologySetupDoneCallback) (void *cls,
-                                             struct BenchmarkPeer *masters,
-                                             struct BenchmarkPeer *slaves);
+typedef void (*GNUNET_ATS_TEST_TopologySetupDoneCallback) (
+  void *cls,
+  struct BenchmarkPeer *masters,
+  struct BenchmarkPeer *slaves);
 
 /**
  * Callback called when logging is required for the data contained
@@ -87,19 +95,18 @@ typedef void
  * @param bandwidth_in bandwidth inbound
  * @param prop performance information
  */
-typedef void
-(*GNUNET_ATS_TEST_LogRequest) (void *cls,
-    const struct GNUNET_HELLO_Address *address,
-    int address_active,
-    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
-    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
-    const struct GNUNET_ATS_Properties *prop);
+typedef void (*GNUNET_ATS_TEST_LogRequest) (
+  void *cls,
+  const struct GNUNET_HELLO_Address *address,
+  int address_active,
+  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
+  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+  const struct GNUNET_ATS_Properties *prop);
 
 /**
  * Information we track for a peer in the testbed.
  */
-struct BenchmarkPeer
-{
+struct BenchmarkPeer {
   /**
    * Handle with testbed.
    */
@@ -147,14 +154,14 @@ struct BenchmarkPeer
   struct TestbedConnectOperation *core_connect_ops;
 
   /**
-   *  Core handle
+   * Core handle
    */
   struct GNUNET_CORE_Handle *ch;
 
   /**
-   *  Core handle
+   * Transport handle
    */
-  struct GNUNET_TRANSPORT_Handle *th;
+  struct GNUNET_TRANSPORT_CoreHandle *th;
 
   /**
    * Masters only:
@@ -166,7 +173,7 @@ struct BenchmarkPeer
    * Masters only
    * Progress task
    */
-  struct GNUNET_SCHEDULER_Task * ats_task;
+  struct GNUNET_SCHEDULER_Task *ats_task;
 
   /**
    * Masters only
@@ -217,8 +224,7 @@ struct BenchmarkPeer
   unsigned int total_bytes_received;
 };
 
-struct TrafficGenerator
-{
+struct TrafficGenerator {
   struct TrafficGenerator *prev;
   struct TrafficGenerator *next;
 
@@ -231,14 +237,13 @@ struct TrafficGenerator
   long int max_rate;
   struct GNUNET_TIME_Relative duration_period;
 
-  struct GNUNET_SCHEDULER_Task * send_task;
+  struct GNUNET_SCHEDULER_Task *send_task;
   struct GNUNET_TIME_Absolute next_ping_transmission;
   struct GNUNET_TIME_Absolute time_start;
 };
 
 
-struct PreferenceGenerator
-{
+struct PreferenceGenerator {
   struct PreferenceGenerator *prev;
   struct PreferenceGenerator *next;
 
@@ -254,7 +259,7 @@ struct PreferenceGenerator
   struct GNUNET_TIME_Relative duration_period;
   struct GNUNET_TIME_Relative frequency;
 
-  struct GNUNET_SCHEDULER_Task * set_task;
+  struct GNUNET_SCHEDULER_Task *set_task;
   struct GNUNET_TIME_Absolute next_ping_transmission;
   struct GNUNET_TIME_Absolute time_start;
 };
@@ -262,8 +267,7 @@ struct PreferenceGenerator
 /**
  * Information about a benchmarking partner
  */
-struct BenchmarkPartner
-{
+struct BenchmarkPartner {
   /**
    * The peer itself this partner belongs to
    */
@@ -275,15 +279,9 @@ struct BenchmarkPartner
   struct BenchmarkPeer *dest;
 
   /**
-   * Core transmit handles
-   */
-  struct GNUNET_CORE_TransmitHandle *cth;
-
-  /**
-   * Transport transmit handles
+   * Message queue handle.
    */
-  struct GNUNET_TRANSPORT_TransmitHandle *tth;
-
+  struct GNUNET_MQ_Handle *mq;
 
   /**
    * Handle for traffic generator
@@ -325,29 +323,37 @@ struct BenchmarkPartner
    */
   unsigned int bytes_received;
 
-  /* Current ATS properties */
+  /**
+   * Current ATS properties
+   */
   struct GNUNET_ATS_Properties props;
 
-  /* Bandwidth assigned inbound */
+  /**
+   * Bandwidth assigned inbound
+   */
   uint32_t bandwidth_in;
 
-  /* Bandwidth assigned outbound */
+  /**
+   * Bandwidth assigned outbound
+   */
   uint32_t bandwidth_out;
 
-  /* Current preference values for bandwidth */
+  /**
+   * Current preference values for bandwidth
+   */
   double pref_bandwidth;
 
-  /* Current preference values for delay */
+  /**
+   * Current preference values for delay
+   */
   double pref_delay;
-
-
 };
 
+
 /**
  * Overall state of the performance benchmark
  */
-struct BenchmarkState
-{
+struct BenchmarkState {
   /**
    * Are we connected to ATS service of all peers: GNUNET_YES/NO
    */
@@ -375,8 +381,7 @@ struct BenchmarkState
 };
 
 
-struct GNUNET_ATS_TEST_Topology
-{
+struct GNUNET_ATS_TEST_Topology {
   /**
    * Progress task
    */
@@ -387,7 +392,8 @@ struct GNUNET_ATS_TEST_Topology
    */
   int result;
 
-  /**Test core (GNUNET_YES) or transport (GNUNET_NO)
+  /**
+   * Test core (#GNUNET_YES) or transport (#GNUNET_NO)
    */
   int test_core;
 
@@ -446,15 +452,14 @@ struct GNUNET_ATS_TEST_Topology
    */
   struct BenchmarkState state;
 
-  struct GNUNET_CORE_MessageHandler *handlers;
-
   GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb;
+
   GNUNET_ATS_AddressInformationCallback ats_perf_cb;
+
   void *done_cb_cls;
 };
 
-enum OperationType
-{
+enum OperationType {
   START_SEND,
   STOP_SEND,
   START_PREFERENCE,
@@ -465,17 +470,17 @@ struct Episode;
 
 struct Experiment;
 
-typedef void (*GNUNET_ATS_TESTING_EpisodeDoneCallback) (
-    struct Episode *e);
+typedef void (*GNUNET_ATS_TESTING_EpisodeDoneCallback) (struct Episode *e);
 
-typedef void (*GNUNET_ATS_TESTING_ExperimentDoneCallback) (struct Experiment *e,
-    struct GNUNET_TIME_Relative duration,int success);
+typedef void (*GNUNET_ATS_TESTING_ExperimentDoneCallback) (
+  struct Experiment *e,
+  struct GNUNET_TIME_Relative duration,
+  int success);
 
 /**
  * An operation in an experiment
  */
-struct GNUNET_ATS_TEST_Operation
-{
+struct GNUNET_ATS_TEST_Operation {
   struct GNUNET_ATS_TEST_Operation *next;
   struct GNUNET_ATS_TEST_Operation *prev;
 
@@ -492,8 +497,7 @@ struct GNUNET_ATS_TEST_Operation
   enum GNUNET_ATS_PreferenceKind pref_type;
 };
 
-struct Episode
-{
+struct Episode {
   int id;
   struct Episode *next;
   struct GNUNET_TIME_Relative duration;
@@ -503,8 +507,7 @@ struct Episode
 };
 
 
-struct Experiment
-{
+struct Experiment {
   char *name;
   char *cfg_file;
   unsigned long long int num_masters;
@@ -516,17 +519,15 @@ struct Experiment
   unsigned int num_episodes;
   struct Episode *start;
 
-  struct GNUNET_SCHEDULER_Task * experiment_timeout_task;
-  struct GNUNET_SCHEDULER_Task * episode_timeout_task;
+  struct GNUNET_SCHEDULER_Task *experiment_timeout_task;
+  struct GNUNET_SCHEDULER_Task *episode_timeout_task;
   struct Episode *cur;
 
   GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb;
   GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb;
 };
 
-/*
- * Experiment related functions
- */
+
 extern struct GNUNET_CONFIGURATION_Handle *cfg;
 
 /**
@@ -537,9 +538,10 @@ extern struct GNUNET_CONFIGURATION_Handle *cfg;
  * @param e_done_cb the experiment is completed
  */
 void
-GNUNET_ATS_TEST_experimentation_run (struct Experiment *e,
-                                     GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb,
-                                     GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb);
+GNUNET_ATS_TEST_experimentation_run(
+  struct Experiment *e,
+  GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb,
+  GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb);
 
 
 /**
@@ -549,7 +551,7 @@ GNUNET_ATS_TEST_experimentation_run (struct Experiment *e,
  * @return the Experiment or NULL on failure
  */
 struct Experiment *
-GNUNET_ATS_TEST_experimentation_load (const char *filename);
+GNUNET_ATS_TEST_experimentation_load(const char *filename);
 
 
 /**
@@ -558,17 +560,15 @@ GNUNET_ATS_TEST_experimentation_load (const char *filename);
  * @param e the experiment
  */
 void
-GNUNET_ATS_TEST_experimentation_stop (struct Experiment *e);
+GNUNET_ATS_TEST_experimentation_stop(struct Experiment *e);
 
-/*
- * Traffic related functions
- */
 
 void
-GNUNET_ATS_TEST_traffic_handle_ping (struct BenchmarkPartner *p);
+GNUNET_ATS_TEST_traffic_handle_ping(struct BenchmarkPartner *p);
+
 
 void
-GNUNET_ATS_TEST_traffic_handle_pong (struct BenchmarkPartner *p);
+GNUNET_ATS_TEST_traffic_handle_pong(struct BenchmarkPartner *p);
 
 
 /**
@@ -585,23 +585,24 @@ GNUNET_ATS_TEST_traffic_handle_pong (struct BenchmarkPartner *p);
  * @return the traffic generator
  */
 struct TrafficGenerator *
-GNUNET_ATS_TEST_generate_traffic_start (struct BenchmarkPeer *src,
-                                        struct BenchmarkPartner *dest,
-                                        enum GeneratorType type,
-                                        unsigned int base_rate,
-                                        unsigned int max_rate,
-                                        struct GNUNET_TIME_Relative period,
-                                        struct GNUNET_TIME_Relative duration);
+GNUNET_ATS_TEST_generate_traffic_start(struct BenchmarkPeer *src,
+                                       struct BenchmarkPartner *dest,
+                                       enum GeneratorType type,
+                                       unsigned int base_rate,
+                                       unsigned int max_rate,
+                                       struct GNUNET_TIME_Relative period,
+                                       struct GNUNET_TIME_Relative duration);
 
 
 void
-GNUNET_ATS_TEST_generate_traffic_stop (struct TrafficGenerator *tg);
+GNUNET_ATS_TEST_generate_traffic_stop(struct TrafficGenerator *tg);
+
 
 /**
  * Stop all traffic generators
  */
 void
-GNUNET_ATS_TEST_generate_traffic_stop_all (void);
+GNUNET_ATS_TEST_generate_traffic_stop_all(void);
 
 
 /**
@@ -619,25 +620,24 @@ GNUNET_ATS_TEST_generate_traffic_stop_all (void);
  * @return the traffic generator
  */
 struct PreferenceGenerator *
-GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src,
-                                            struct BenchmarkPartner *dest,
-                                            enum GeneratorType type,
-                                            unsigned int base_value,
-                                            unsigned int value_rate,
-                                            struct GNUNET_TIME_Relative period,
-                                            struct GNUNET_TIME_Relative frequency,
-                                            enum GNUNET_ATS_PreferenceKind kind);
+GNUNET_ATS_TEST_generate_preferences_start(
+  struct BenchmarkPeer *src,
+  struct BenchmarkPartner *dest,
+  enum GeneratorType type,
+  unsigned int base_value,
+  unsigned int value_rate,
+  struct GNUNET_TIME_Relative period,
+  struct GNUNET_TIME_Relative frequency,
+  enum GNUNET_ATS_PreferenceKind kind);
+
 
 void
-GNUNET_ATS_TEST_generate_preferences_stop (struct PreferenceGenerator *pg);
+GNUNET_ATS_TEST_generate_preferences_stop(struct PreferenceGenerator *pg);
 
 
 void
-GNUNET_ATS_TEST_generate_preferences_stop_all (void);
+GNUNET_ATS_TEST_generate_preferences_stop_all(void);
 
-/*
- * Logging related functions
- */
 
 /**
  * Start logging
@@ -665,7 +665,7 @@ GNUNET_ATS_TEST_logging_start(struct GNUNET_TIME_Relative log_frequency,
  * @param l the logging handle
  */
 void
-GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
+GNUNET_ATS_TEST_logging_clean_up(struct LoggingHandle *l);
 
 
 /**
@@ -674,7 +674,7 @@ GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
  * @param l the logging handle
  */
 void
-GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l);
+GNUNET_ATS_TEST_logging_stop(struct LoggingHandle *l);
 
 
 /**
@@ -683,7 +683,7 @@ GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l);
  * @param l logging handle to use
  */
 void
-GNUNET_ATS_TEST_logging_now (struct LoggingHandle *l);
+GNUNET_ATS_TEST_logging_now(struct LoggingHandle *l);
 
 
 /**
@@ -694,20 +694,20 @@ GNUNET_ATS_TEST_logging_now (struct LoggingHandle *l);
  * @param plots create gnuplots: #GNUNET_YES or #GNUNET_NO
  */
 void
-GNUNET_ATS_TEST_logging_write_to_file (struct LoggingHandle *l,
-                                       const char *test_name,
-                                       int plots);
+GNUNET_ATS_TEST_logging_write_to_file(struct LoggingHandle *l,
+                                      const char *test_name,
+                                      int plots);
 
 
 /**
  * Topology related functions
  */
 struct BenchmarkPeer *
-GNUNET_ATS_TEST_get_peer (int src);
+GNUNET_ATS_TEST_get_peer(int src);
 
 
 struct BenchmarkPartner *
-GNUNET_ATS_TEST_get_partner (int src, int dest);
+GNUNET_ATS_TEST_get_partner(int src, int dest);
 
 
 /**
@@ -717,27 +717,29 @@ GNUNET_ATS_TEST_get_partner (int src, int dest);
  * @param cfg_file configuration file to use for the peers
  * @param num_slaves number of slaves
  * @param num_masters number of masters
- * @param test_core connect to CORE service (#GNUNET_YES) or transport (#GNUNET_NO)
+ * @param test_core connect to CORE service (#GNUNET_YES) or transport
+ * (#GNUNET_NO)
  * @param done_cb function to call when topology is setup
  * @param done_cb_cls cls for callback
  * @param log_request_cb callback to call when logging is required
  */
 void
-GNUNET_ATS_TEST_create_topology (char *name,
-                                 char *cfg_file,
-                                 unsigned int num_slaves,
-                                 unsigned int num_masters,
-                                 int test_core,
-                                 GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb,
-                                 void *done_cb_cls,
-                                 GNUNET_ATS_TEST_LogRequest ats_perf_cb);
+GNUNET_ATS_TEST_create_topology(
+  char *name,
+  char *cfg_file,
+  unsigned int num_slaves,
+  unsigned int num_masters,
+  int test_core,
+  GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb,
+  void *done_cb_cls,
+  GNUNET_ATS_TEST_LogRequest ats_perf_cb);
 
 
 /**
  * Shutdown topology
  */
 void
-GNUNET_ATS_TEST_shutdown_topology (void);
+GNUNET_ATS_TEST_shutdown_topology(void);
 
 
 /* end of file ats-testing.h */