Merge branch 'license/spdx'
[oweals/gnunet.git] / src / ats-tests / ats-testing.h
index 86c26eb81f5c4e0be5f427071a06b7a73bd950e0..9c4353b520ec775ffbfdace4198590ff9f66a354 100644 (file)
@@ -1,21 +1,21 @@
 /*
  This file is part of GNUnet.
- (C) 2010-2013 Christian Grothoff (and other contributing authors)
+ 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 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
- General Public License for more details.
Affero 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., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ 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_core_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;
@@ -72,9 +82,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
@@ -84,8 +95,7 @@ typedef void (*GNUNET_ATS_TEST_TopologySetupDoneCallback) (void *cls,
  * @param address_active is address active
  * @param bandwidth_out bandwidth outbound
  * @param bandwidth_in bandwidth inbound
- * @param ats ats information
- * @param ats_count number of ats inforation
+ * @param prop performance information
  */
 typedef void
 (*GNUNET_ATS_TEST_LogRequest) (void *cls,
@@ -93,8 +103,7 @@ typedef void
     int address_active,
     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
-    const struct GNUNET_ATS_Information *ats,
-    uint32_t ats_count);
+    const struct GNUNET_ATS_Properties *prop);
 
 /**
  * Information we track for a peer in the testbed.
@@ -148,14 +157,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:
@@ -167,7 +176,7 @@ struct BenchmarkPeer
    * Masters only
    * Progress task
    */
-  GNUNET_SCHEDULER_TaskIdentifier ats_task;
+  struct GNUNET_SCHEDULER_Task * ats_task;
 
   /**
    * Masters only
@@ -232,7 +241,7 @@ struct TrafficGenerator
   long int max_rate;
   struct GNUNET_TIME_Relative duration_period;
 
-  GNUNET_SCHEDULER_TaskIdentifier send_task;
+  struct GNUNET_SCHEDULER_Task * send_task;
   struct GNUNET_TIME_Absolute next_ping_transmission;
   struct GNUNET_TIME_Absolute time_start;
 };
@@ -255,7 +264,7 @@ struct PreferenceGenerator
   struct GNUNET_TIME_Relative duration_period;
   struct GNUNET_TIME_Relative frequency;
 
-  GNUNET_SCHEDULER_TaskIdentifier set_task;
+  struct GNUNET_SCHEDULER_Task * set_task;
   struct GNUNET_TIME_Absolute next_ping_transmission;
   struct GNUNET_TIME_Absolute time_start;
 };
@@ -276,16 +285,18 @@ struct BenchmarkPartner
   struct BenchmarkPeer *dest;
 
   /**
-   * Core transmit handles
+   * Message queue handle.
    */
-  struct GNUNET_CORE_TransmitHandle *cth;
+  struct GNUNET_MQ_Handle *mq;
 
   /**
-   * Transport transmit handles
+   * Handle for traffic generator
    */
-  struct GNUNET_TRANSPORT_TransmitHandle *tth;
-
   struct TrafficGenerator *tg;
+
+  /**
+   * Handle for preference generator
+   */
   struct PreferenceGenerator *pg;
 
   /**
@@ -318,32 +329,34 @@ struct BenchmarkPartner
    */
   unsigned int bytes_received;
 
-  /* Current ATS properties */
-
-  uint32_t ats_distance;
-
-  uint32_t ats_delay;
+  /**
+   * Current ATS properties
+   */
+  struct GNUNET_ATS_Properties props;
 
+  /**
+   * Bandwidth assigned inbound
+   */
   uint32_t bandwidth_in;
 
+  /**
+   * Bandwidth assigned outbound
+   */
   uint32_t bandwidth_out;
 
-  uint32_t ats_utilization_up;
-
-  uint32_t ats_utilization_down;
-
-  uint32_t ats_network_type;
-
-  uint32_t ats_cost_wan;
-
-  uint32_t ats_cost_lan;
-
-  uint32_t ats_cost_wlan;
-
+  /**
+   * Current preference values for bandwidth
+   */
   double pref_bandwidth;
+
+  /**
+   * Current preference values for delay
+   */
   double pref_delay;
+
 };
 
+
 /**
  * Overall state of the performance benchmark
  */
@@ -378,22 +391,18 @@ struct BenchmarkState
 
 struct GNUNET_ATS_TEST_Topology
 {
-  /**
-   * Shutdown task
-   */
-  GNUNET_SCHEDULER_TaskIdentifier shutdown_task;
-
   /**
    * Progress task
    */
-  GNUNET_SCHEDULER_TaskIdentifier progress_task;
+  struct GNUNET_SCHEDULER_Task *progress_task;
 
   /**
    * Test result
    */
   int result;
 
-  /**Test core (GNUNET_YES) or transport (GNUNET_NO)
+  /**
+   * Test core (#GNUNET_YES) or transport (#GNUNET_NO)
    */
   int test_core;
 
@@ -452,12 +461,10 @@ struct GNUNET_ATS_TEST_Topology
    */
   struct BenchmarkState state;
 
-  struct GNUNET_CORE_MessageHandler *handlers;
-
-  GNUNET_TRANSPORT_ReceiveCallback transport_recv_cb;
-
   GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb;
+
   GNUNET_ATS_AddressInformationCallback ats_perf_cb;
+
   void *done_cb_cls;
 };
 
@@ -473,11 +480,13 @@ 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
@@ -496,7 +505,7 @@ struct GNUNET_ATS_TEST_Operation
   struct GNUNET_TIME_Relative frequency;
 
   enum OperationType type;
-  enum GeneratorType tg_type;
+  enum GeneratorType gen_type;
   enum GNUNET_ATS_PreferenceKind pref_type;
 };
 
@@ -524,17 +533,15 @@ struct Experiment
   unsigned int num_episodes;
   struct Episode *start;
 
-  GNUNET_SCHEDULER_TaskIdentifier experiment_timeout_task;
-  GNUNET_SCHEDULER_TaskIdentifier 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;
 
 /**
@@ -546,8 +553,9 @@ extern struct GNUNET_CONFIGURATION_Handle *cfg;
  */
 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_TESTING_EpisodeDoneCallback ep_done_cb,
+                                     GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb);
+
 
 /**
  * Load an experiment from a file
@@ -556,7 +564,7 @@ GNUNET_ATS_TEST_experimentation_run (struct Experiment *e,
  * @return the Experiment or NULL on failure
  */
 struct Experiment *
-GNUNET_ATS_TEST_experimentation_load (char *filename);
+GNUNET_ATS_TEST_experimentation_load (const char *filename);
 
 
 /**
@@ -567,13 +575,11 @@ GNUNET_ATS_TEST_experimentation_load (char *filename);
 void
 GNUNET_ATS_TEST_experimentation_stop (struct Experiment *e);
 
-/*
- * Traffic related functions
- */
 
 void
 GNUNET_ATS_TEST_traffic_handle_ping (struct BenchmarkPartner *p);
 
+
 void
 GNUNET_ATS_TEST_traffic_handle_pong (struct BenchmarkPartner *p);
 
@@ -593,41 +599,57 @@ GNUNET_ATS_TEST_traffic_handle_pong (struct BenchmarkPartner *p);
  */
 struct TrafficGenerator *
 GNUNET_ATS_TEST_generate_traffic_start (struct BenchmarkPeer *src,
-    struct BenchmarkPartner *dest,
-    enum GeneratorType type,
-    long int base_rate,
-    long int max_rate,
-    struct GNUNET_TIME_Relative period,
-    struct GNUNET_TIME_Relative duration);
+                                        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);
 
+
 /**
  * Stop all traffic generators
  */
 void
-GNUNET_ATS_TEST_generate_traffic_stop_all ();
+GNUNET_ATS_TEST_generate_traffic_stop_all (void);
 
+
+/**
+ * Generate between the source master and the partner and set preferences with a
+ * value depending on the generator.
+ *
+ * @param src source
+ * @param dest partner
+ * @param type type of preferences to generate
+ * @param base_value traffic base rate to send data with
+ * @param value_rate  traffic maximum rate to send data with
+ * @param period duration of a period of preferences generation (~ 1/frequency)
+ * @param frequency how long to generate preferences
+ * @param kind ATS preference to generate
+ * @return the traffic generator
+ */
 struct PreferenceGenerator *
 GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src,
-    struct BenchmarkPartner *dest,
-    enum GeneratorType type,
-    long int base_value,
-    long int value_rate,
-    struct GNUNET_TIME_Relative period,
-    struct GNUNET_TIME_Relative frequency,
-    enum GNUNET_ATS_PreferenceKind kind);
+                                            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);
 
+
 void
-GNUNET_ATS_TEST_generate_preferences_stop_all ();
+GNUNET_ATS_TEST_generate_preferences_stop_all (void);
 
-/*
- * Logging related functions
- */
 
 /**
  * Start logging
@@ -635,13 +657,19 @@ GNUNET_ATS_TEST_generate_preferences_stop_all ();
  * @param log_frequency the logging frequency
  * @param testname the testname
  * @param masters the master peers used for benchmarking
- * @param num_master the number of master peers
+ * @param num_masters the number of master peers
+ * @param num_slaves the number of slave peers
+ * @param verbose verbose logging
  * @return the logging handle or NULL on error
  */
 struct LoggingHandle *
-GNUNET_ATS_TEST_logging_start(struct GNUNET_TIME_Relative log_frequency,
-    char *testname, struct BenchmarkPeer *masters, int num_masters, int num_slaves,
-    int verbose);
+GNUNET_ATS_TEST_logging_start (struct GNUNET_TIME_Relative log_frequency,
+                              const char *testname,
+                              struct BenchmarkPeer *masters,
+                              int num_masters,
+                              int num_slaves,
+                              int verbose);
+
 
 /**
  * Stop logging
@@ -651,6 +679,7 @@ GNUNET_ATS_TEST_logging_start(struct GNUNET_TIME_Relative log_frequency,
 void
 GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
 
+
 /**
  * Stop logging
  *
@@ -659,6 +688,7 @@ GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
 void
 GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l);
 
+
 /**
  * Log all data now
  *
@@ -673,22 +703,25 @@ GNUNET_ATS_TEST_logging_now (struct LoggingHandle *l);
  *
  * @param l logging handle to use
  * @param test_name name of the current test
- * @param plots create gnuplots: GNUNET_YES or GNUNET_NO
+ * @param plots create gnuplots: #GNUNET_YES or #GNUNET_NO
  */
 void
 GNUNET_ATS_TEST_logging_write_to_file (struct LoggingHandle *l,
-    char *test_name, int plots);
+                                       const char *test_name,
+                                       int plots);
 
-/*
+
+/**
  * Topology related functions
  */
-
 struct BenchmarkPeer *
 GNUNET_ATS_TEST_get_peer (int src);
 
+
 struct BenchmarkPartner *
 GNUNET_ATS_TEST_get_partner (int src, int dest);
 
+
 /**
  * Create a topology for ats testing
  *
@@ -696,21 +729,21 @@ 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 recv_cb callback to call when data are received
- * @param perf_cb callback to call when performance info are received
+ * @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_TRANSPORT_ReceiveCallback recv_cb,
-    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
@@ -718,4 +751,5 @@ GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file,
 void
 GNUNET_ATS_TEST_shutdown_topology (void);
 
+
 /* end of file ats-testing.h */