/*
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
#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
+/**
+ * Message type sent for traffic generation
+ */
#define TEST_MESSAGE_TYPE_PING 12345
+
+/**
+ * Message type sent as response during traffic generation
+ */
#define TEST_MESSAGE_TYPE_PONG 12346
-#define TEST_MESSAGE_SIZE 1000
+
+/**
+ * Size of test messages
+ */
+#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;
+
struct GNUNET_ATS_TEST_Topology;
+
struct TrafficGenerator;
-typedef void (*GNUNET_ATS_TESTING_TopologySetupDoneCallback) (void *cls,
- struct BenchmarkPeer *masters,
- struct BenchmarkPeer *slaves);
+struct LoggingHandle;
+
+enum GeneratorType
+{
+ GNUNET_ATS_TEST_TG_LINEAR,
+ GNUNET_ATS_TEST_TG_CONSTANT,
+ GNUNET_ATS_TEST_TG_RANDOM,
+ GNUNET_ATS_TEST_TG_SINUS
+};
+
+
+/**
+ * Callback to call when topology setup is completed
+ *
+ * @param cls the closure
+ * @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);
+
+/**
+ * Callback called when logging is required for the data contained
+ *
+ * @param cls the closure
+ * @param address an address
+ * @param address_active is address active
+ * @param bandwidth_out bandwidth outbound
+ * @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);
/**
* Information we track for a peer in the testbed.
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:
* Masters only
* Progress task
*/
- GNUNET_SCHEDULER_TaskIdentifier ats_task;
+ struct GNUNET_SCHEDULER_Task *ats_task;
/**
* Masters only
unsigned int total_bytes_received;
};
+struct TrafficGenerator
+{
+ struct TrafficGenerator *prev;
+ struct TrafficGenerator *next;
+
+ enum GeneratorType type;
+
+ struct BenchmarkPeer *src;
+ struct BenchmarkPartner *dest;
+
+ long int base_rate;
+ long int max_rate;
+ struct GNUNET_TIME_Relative duration_period;
+
+ struct GNUNET_SCHEDULER_Task *send_task;
+ struct GNUNET_TIME_Absolute next_ping_transmission;
+ struct GNUNET_TIME_Absolute time_start;
+};
+
+
+struct PreferenceGenerator
+{
+ struct PreferenceGenerator *prev;
+ struct PreferenceGenerator *next;
+
+ enum GeneratorType type;
+
+ struct BenchmarkPeer *src;
+ struct BenchmarkPartner *dest;
+
+ enum GNUNET_ATS_PreferenceKind kind;
+
+ long int base_value;
+ long int max_value;
+ struct GNUNET_TIME_Relative duration_period;
+ struct GNUNET_TIME_Relative frequency;
+
+ struct GNUNET_SCHEDULER_Task *set_task;
+ struct GNUNET_TIME_Absolute next_ping_transmission;
+ struct GNUNET_TIME_Absolute time_start;
+};
/**
* Information about a benchmarking partner
struct BenchmarkPeer *dest;
/**
- * Core transmit handles
+ * Message queue handle.
+ */
+ struct GNUNET_MQ_Handle *mq;
+
+ /**
+ * Handle for traffic generator
*/
- struct GNUNET_CORE_TransmitHandle *cth;
+ struct TrafficGenerator *tg;
/**
- * Transport transmit handles
+ * Handle for preference generator
*/
- struct GNUNET_TRANSPORT_TransmitHandle *tth;
+ struct PreferenceGenerator *pg;
/**
* Timestamp to calculate communication layer delay
*/
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;
+ /**
+ * Current preference values for bandwidth
+ */
+ double pref_bandwidth;
- uint32_t ats_utilization_down;
+ /**
+ * Current preference values for delay
+ */
+ double pref_delay;
+};
- uint32_t ats_network_type;
- uint32_t ats_cost_wan;
+/**
+ * Overall state of the performance benchmark
+ */
+struct BenchmarkState
+{
+ /**
+ * Are we connected to ATS service of all peers: GNUNET_YES/NO
+ */
+ int connected_ATS_service;
+
+ /**
+ * Are we connected to CORE service of all peers: GNUNET_YES/NO
+ */
+ int connected_COMM_service;
- uint32_t ats_cost_lan;
+ /**
+ * Are we connected to all peers: GNUNET_YES/NO
+ */
+ int connected_PEERS;
- uint32_t ats_cost_wlan;
+ /**
+ * Are we connected to all slave peers on CORE level: GNUNET_YES/NO
+ */
+ int connected_CORE;
+
+ /**
+ * Are we connected to CORE service of all peers: GNUNET_YES/NO
+ */
+ int benchmarking;
};
+
+struct GNUNET_ATS_TEST_Topology
+{
+ /**
+ * Progress task
+ */
+ struct GNUNET_SCHEDULER_Task *progress_task;
+
+ /**
+ * Test result
+ */
+ int result;
+
+ /**
+ * Test core (#GNUNET_YES) or transport (#GNUNET_NO)
+ */
+ int test_core;
+
+ /**
+ * Solver string
+ */
+ char *solver;
+
+ /**
+ * Preference string
+ */
+ char *testname;
+
+ /**
+ * Preference string
+ */
+ char *pref_str;
+
+ /**
+ * ATS preference value
+ */
+ int pref_val;
+
+ /**
+ * Number master peers
+ */
+ unsigned int num_masters;
+
+ /**
+ * Array of master peers
+ */
+ struct BenchmarkPeer *mps;
+
+ /**
+ * Number slave peers
+ */
+ unsigned int num_slaves;
+
+ /**
+ * Array of slave peers
+ */
+ struct BenchmarkPeer *sps;
+
+ /**
+ * Benchmark duration
+ */
+ struct GNUNET_TIME_Relative perf_duration;
+
+ /**
+ * Logging frequency
+ */
+ struct GNUNET_TIME_Relative log_frequency;
+
+ /**
+ * Benchmark state
+ */
+ struct BenchmarkState state;
+
+ GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb;
+
+ GNUNET_ATS_AddressInformationCallback ats_perf_cb;
+
+ void *done_cb_cls;
+};
+
+enum OperationType
+{
+ START_SEND,
+ STOP_SEND,
+ START_PREFERENCE,
+ STOP_PREFERENCE
+};
+
+struct Episode;
+
+struct Experiment;
+
+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);
+
+/**
+ * An operation in an experiment
+ */
+struct GNUNET_ATS_TEST_Operation
+{
+ struct GNUNET_ATS_TEST_Operation *next;
+ struct GNUNET_ATS_TEST_Operation *prev;
+
+ long long unsigned int src_id;
+ long long unsigned int dest_id;
+
+ long long unsigned int base_rate;
+ long long unsigned int max_rate;
+ struct GNUNET_TIME_Relative period;
+ struct GNUNET_TIME_Relative frequency;
+
+ enum OperationType type;
+ enum GeneratorType gen_type;
+ enum GNUNET_ATS_PreferenceKind pref_type;
+};
+
+struct Episode
+{
+ int id;
+ struct Episode *next;
+ struct GNUNET_TIME_Relative duration;
+
+ struct GNUNET_ATS_TEST_Operation *head;
+ struct GNUNET_ATS_TEST_Operation *tail;
+};
+
+
+struct Experiment
+{
+ char *name;
+ char *cfg_file;
+ unsigned long long int num_masters;
+ unsigned long long int num_slaves;
+ struct GNUNET_TIME_Relative log_freq;
+ struct GNUNET_TIME_Relative max_duration;
+ struct GNUNET_TIME_Relative total_duration;
+ struct GNUNET_TIME_Absolute start_time;
+ unsigned int num_episodes;
+ struct Episode *start;
+
+ 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;
+};
+
+
+extern struct GNUNET_CONFIGURATION_Handle *cfg;
+
+/**
+ * Execute the specified experiment
+ *
+ * @param e the Experiment
+ * @param ep_done_cb a episode is completed
+ * @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);
+
+
+/**
+ * Load an experiment from a file
+ *
+ * @param filename the file
+ * @return the Experiment or NULL on failure
+ */
+struct Experiment *
+GNUNET_ATS_TEST_experimentation_load (const char *filename);
+
+
+/**
+ * Stop an experiment
+ *
+ * @param e the experiment
+ */
+void
+GNUNET_ATS_TEST_experimentation_stop (struct Experiment *e);
+
+
+void
+GNUNET_ATS_TEST_traffic_handle_ping (struct BenchmarkPartner *p);
+
+
+void
+GNUNET_ATS_TEST_traffic_handle_pong (struct BenchmarkPartner *p);
+
+
+/**
+ * Generate between the source master and the partner and send traffic with a
+ * maximum rate.
+ *
+ * @param src traffic source
+ * @param dest traffic partner
+ * @param type type of traffic to generate
+ * @param base_rate traffic base rate to send data with
+ * @param max_rate traffic maximum rate to send data with
+ * @param period duration of a period of traffic generation (~ 1/frequency)
+ * @param duration how long to generate traffic
+ * @return the traffic generator
+ */
struct TrafficGenerator *
GNUNET_ATS_TEST_generate_traffic_start (struct BenchmarkPeer *src,
- struct BenchmarkPartner *dest, unsigned int rate,
- 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 (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,
+ 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 (void);
+
+
+/**
+ * Start logging
+ *
+ * @param log_frequency the logging frequency
+ * @param testname the testname
+ * @param masters the master peers used for benchmarking
+ * @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);
+ const char *testname,
+ struct BenchmarkPeer *masters,
+ int num_masters,
+ int num_slaves,
+ int verbose);
+
+
+/**
+ * Stop logging
+ *
+ * @param l the logging handle
+ */
+void
+GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
+
+/**
+ * Stop logging
+ *
+ * @param l the logging handle
+ */
void
-GNUNET_ATS_TEST_logging_now (void);
+GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l);
+
+/**
+ * Log all data now
+ *
+ * @param l logging handle to use
+ */
void
-GNUNET_ATS_TEST_logging_stop (void);
+GNUNET_ATS_TEST_logging_now (struct LoggingHandle *l);
+
+/**
+ * Write logging data to file
+ *
+ * @param l logging handle to use
+ * @param test_name name of the current test
+ * @param plots create gnuplots: #GNUNET_YES or #GNUNET_NO
+ */
void
-GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file,
- unsigned int num_slaves,
- unsigned int num_masters,
- int test_core,
- GNUNET_ATS_TESTING_TopologySetupDoneCallback done_cb,
- void *done_cb_cls,
- GNUNET_TRANSPORT_ReceiveCallback transport_recv_cb,
- GNUNET_ATS_AddressInformationCallback ats_perf_cb);
+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);
+
+
+struct BenchmarkPartner *
+GNUNET_ATS_TEST_get_partner (int src, int dest);
+
+
+/**
+ * Create a topology for ats testing
+ *
+ * @param name test name
+ * @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 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);
+
+
+/**
+ * Shutdown topology
+ */
void
GNUNET_ATS_TEST_shutdown_topology (void);
+
/* end of file ats-testing.h */
projects / oweals / gnunet.git / blobdiff