- refactor channel nack
[oweals/gnunet.git] / src / ats / test_ats_simplistic_pref_aging.c
1 /*
2      This file is part of GNUnet.
3      (C) 2010,2011 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      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      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20 /**
21  * @file ats/test_ats_mlp.c
22  * @brief test for the MLP solver
23  * @author Christian Grothoff
24  * @author Matthias Wachs
25
26  */
27 /**
28  * @file ats/test_ats_api_scheduling_add_address.c
29  * @brief test for ats proportional solver preference aging:
30  *      Add 2 addresses and set high preference for one. Expect higher bw for this
31  *      address, wait. Preferences should age and so bw assigned should decrease.
32  * @author Christian Grothoff
33  * @author Matthias Wachs
34  */
35 #include "platform.h"
36 #include "gnunet_ats_service.h"
37 #include "gnunet_testing_lib.h"
38 #include "ats.h"
39 #include "test_ats_api_common.h"
40
41 #define DEBUG_ATS_INFO GNUNET_NO
42
43 static GNUNET_SCHEDULER_TaskIdentifier die_task;
44
45 /**
46  * Scheduling handle
47  */
48 static struct GNUNET_ATS_SchedulingHandle *sched_ats;
49
50 /**
51  * Performance handle
52  */
53 static struct GNUNET_ATS_PerformanceHandle *perf_ats;
54
55 /**
56  * Return value
57  */
58 static int ret;
59
60 /**
61  * Test address
62  */
63 static struct Test_Address test_addr[2];
64
65 /**
66  * Test peer
67  */
68 static struct PeerContext p[2];
69
70
71 /**
72  * HELLO address
73  */
74 struct GNUNET_HELLO_Address test_hello_address[2];
75
76 /**
77  * Session
78  */
79 static void *test_session[2];
80
81 /**
82  * Test ats info
83  */
84 struct GNUNET_ATS_Information test_ats_info[2];
85
86 /**
87  * Test ats count
88  */
89 uint32_t test_ats_count;
90
91 /**
92  * Configured WAN out quota
93  */
94 unsigned long long wan_quota_out;
95
96 /**
97  * Configured WAN in quota
98  */
99 unsigned long long wan_quota_in;
100
101
102 static void
103 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
104 {
105   die_task = GNUNET_SCHEDULER_NO_TASK;
106   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Error! Shutting down\n");
107   if (sched_ats != NULL)
108   {
109     GNUNET_ATS_scheduling_done (sched_ats);
110     sched_ats = NULL;
111   }
112   if (perf_ats != NULL)
113   {
114     GNUNET_ATS_performance_done (perf_ats);
115     perf_ats = NULL;
116   }
117   free_test_address (&test_addr[0]);
118   ret = GNUNET_SYSERR;
119 }
120
121
122 static void
123 end ()
124 {
125   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutting down\n");
126   if (die_task != GNUNET_SCHEDULER_NO_TASK)
127   {
128     GNUNET_SCHEDULER_cancel (die_task);
129     die_task = GNUNET_SCHEDULER_NO_TASK;
130   }
131
132   GNUNET_ATS_suggest_address_cancel (sched_ats, &p[0].id);
133   GNUNET_ATS_suggest_address_cancel (sched_ats, &p[1].id);
134
135   if (NULL != sched_ats)
136         GNUNET_ATS_scheduling_done (sched_ats);
137   if (NULL != perf_ats)
138   GNUNET_ATS_performance_done (perf_ats);
139   sched_ats = NULL;
140   perf_ats = NULL;
141   free_test_address (&test_addr[0]);
142   free_test_address (&test_addr[1]);
143 }
144
145
146 static void
147 address_suggest_cb (void *cls, const struct GNUNET_HELLO_Address *address,
148                     struct Session *session,
149                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
150                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
151                     const struct GNUNET_ATS_Information *atsi,
152                     uint32_t ats_count)
153 {
154   static int stage = 0;
155   static int sug_p0 = GNUNET_NO;
156   static int sug_p1 = GNUNET_NO;
157
158   static uint32_t p0_last_bandwidth_out;
159   static uint32_t p0_last_bandwidth_in;
160
161   static uint32_t p1_last_bandwidth_out;
162   static uint32_t p1_last_bandwidth_in;
163
164   uint32_t cur_bandwidth_out = ntohl (bandwidth_out.value__);
165   uint32_t cur_bandwidth_in = ntohl (bandwidth_in.value__);
166
167   if (0 == stage)
168   {
169     /* Callback for initial suggestion */
170     if (0 == memcmp (&address->peer, &p[0].id, sizeof (p[0].id)))
171     {
172       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
173                   "Stage %u: Callback for peer 0 `%s': (in/out) %u/%u\n",
174                   stage,
175                   GNUNET_i2s (&address->peer),
176                   (unsigned int) ntohl (bandwidth_in.value__),
177                   (unsigned int) ntohl (bandwidth_out.value__));
178       sug_p0 = GNUNET_YES;
179       p0_last_bandwidth_out = ntohl(bandwidth_out.value__);
180       p0_last_bandwidth_in = ntohl(bandwidth_in.value__);
181     }
182     if (0 == memcmp (&address->peer, &p[1].id, sizeof (p[1].id)))
183     {
184       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
185                   "Stage %u: Callback for peer 1 `%s': (in/out) %u/%u\n",
186                   stage,
187                   GNUNET_i2s (&address->peer),
188                   (unsigned int) ntohl (bandwidth_in.value__),
189                   (unsigned int) ntohl (bandwidth_out.value__));
190       sug_p1 = GNUNET_YES;
191       p1_last_bandwidth_out = ntohl(bandwidth_out.value__);
192       p1_last_bandwidth_in = ntohl(bandwidth_in.value__);
193     }
194     if ((GNUNET_YES == sug_p0) && (GNUNET_YES == sug_p1))
195     {
196       /* Changing preference for peer 0 */
197       stage ++;
198       GNUNET_ATS_performance_change_preference (perf_ats, &p[0].id, GNUNET_ATS_PREFERENCE_BANDWIDTH,(double) 1000, GNUNET_ATS_PREFERENCE_END);
199       sug_p0 = GNUNET_NO;
200       sug_p1 = GNUNET_NO;
201       return;
202     }
203   }
204   if (1 == stage)
205   {
206     /* Callback due to preference change */
207     if (0 == memcmp (&address->peer, &p[0].id, sizeof (p[0].id)))
208     {
209       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
210                   "Stage %u: Callback for peer 0 `%s': (in/out) %u/%u\n",
211                   stage,
212                   GNUNET_i2s (&address->peer),
213                   (unsigned int) ntohl (bandwidth_in.value__),
214                   (unsigned int) ntohl (bandwidth_out.value__));
215       sug_p0 = GNUNET_YES;
216
217       /* Peer 0 should get more bandwidth */
218       if (cur_bandwidth_out <= p0_last_bandwidth_out)
219         GNUNET_break (0);
220       if (cur_bandwidth_in <= p0_last_bandwidth_in)
221         GNUNET_break (0);
222       p0_last_bandwidth_out = ntohl(bandwidth_out.value__);
223       p0_last_bandwidth_in = ntohl(bandwidth_in.value__);
224     }
225     if (0 == memcmp (&address->peer, &p[1].id, sizeof (p[1].id)))
226     {
227       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
228                   "Stage %u: Callback for peer 1 `%s': (in/out) %u/%u\n",
229                   stage,
230                   GNUNET_i2s (&address->peer),
231                   (unsigned int) ntohl (bandwidth_in.value__),
232                   (unsigned int) ntohl (bandwidth_out.value__));
233       sug_p1 = GNUNET_YES;
234
235       /* Peer 1 should get less bandwidth */
236       if (cur_bandwidth_out >= p1_last_bandwidth_out)
237       {
238         GNUNET_break (0);
239         goto error;
240       }
241       if (cur_bandwidth_in >= p1_last_bandwidth_in)
242       {
243         GNUNET_break (0);
244         goto error;
245       }
246       p1_last_bandwidth_out = ntohl(bandwidth_out.value__);
247       p1_last_bandwidth_in = ntohl(bandwidth_in.value__);
248     }
249     if ((GNUNET_YES == sug_p0) && (GNUNET_YES == sug_p1))
250     {
251       stage ++;
252       sug_p0 = GNUNET_NO;
253       sug_p1 = GNUNET_NO;
254       return;
255     }
256   }
257   if (2 == stage)
258   {
259     /* Callback due to preference aging */
260     if (0 == memcmp (&address->peer, &p[0].id, sizeof (p[0].id)))
261     {
262       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
263                   "Stage %u: Callback for peer 0 `%s': (in/out) %u/%u\n",
264                   stage,
265                   GNUNET_i2s (&address->peer),
266                   (unsigned int) ntohl (bandwidth_in.value__),
267                   (unsigned int) ntohl (bandwidth_out.value__));
268       sug_p0 = GNUNET_YES;
269
270       /* Peer 0 should get less bandwidth */
271       if (cur_bandwidth_out <= p0_last_bandwidth_out)
272         GNUNET_break (0);
273       if (cur_bandwidth_in <= p0_last_bandwidth_in)
274         GNUNET_break (0);
275       p0_last_bandwidth_out = ntohl(bandwidth_out.value__);
276       p0_last_bandwidth_in = ntohl(bandwidth_in.value__);
277     }
278     if (0 == memcmp (&address->peer, &p[1].id, sizeof (p[1].id)))
279     {
280       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
281                   "Stage %u: Callback for peer 1 `%s': (in/out) %u/%u\n",
282                   stage,
283                   GNUNET_i2s (&address->peer),
284                   (unsigned int) ntohl (bandwidth_in.value__),
285                   (unsigned int) ntohl (bandwidth_out.value__));
286       sug_p1 = GNUNET_YES;
287       /* Peer 1 should get more bandwidth */
288       if (cur_bandwidth_out <= p1_last_bandwidth_out)
289       {
290         GNUNET_break (0);
291         goto error;
292       }
293       if (cur_bandwidth_in <= p1_last_bandwidth_in)
294       {
295         GNUNET_break (0);
296         goto error;
297       }
298       p0_last_bandwidth_out = ntohl(bandwidth_out.value__);
299       p0_last_bandwidth_in = ntohl(bandwidth_in.value__);
300     }
301
302     if ((GNUNET_YES == sug_p0) && (GNUNET_YES == sug_p1))
303     {
304       /* Done ! */
305       GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Done!\n");
306       stage ++;
307       ret = 0;
308       GNUNET_SCHEDULER_add_now (&end,NULL);
309       return;
310     }
311   }
312   return;
313
314 error:
315   /* Error ! */
316   ret = 1;
317   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Error!\n");
318   GNUNET_SCHEDULER_add_now (&end,NULL);
319 }
320
321
322 static void
323 run (void *cls,
324      const struct GNUNET_CONFIGURATION_Handle *cfg,
325      struct GNUNET_TESTING_Peer *peer)
326 {
327   char *quota_str;
328
329   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string(cfg, "ats", "WAN_QUOTA_OUT", &quota_str))
330   {
331       fprintf (stderr, "Cannot load WAN outbound quota from configuration, exit!\n");
332       ret = 1;
333       return;
334   }
335   if  (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_str, &wan_quota_out))
336   {
337       fprintf (stderr, "Cannot load WAN outbound quota from configuration, exit!\n");
338       ret = 1;
339       GNUNET_free (quota_str);
340       return;
341   }
342   GNUNET_free (quota_str);
343   quota_str = NULL;
344
345   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string(cfg, "ats", "WAN_QUOTA_IN", &quota_str))
346   {
347       fprintf (stderr, "Cannot load WAN inbound quota from configuration, exit!\n");
348       ret = 1;
349       return;
350   }
351   if  (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_str, &wan_quota_in))
352   {
353       fprintf (stderr, "Cannot load WAN inbound quota from configuration, exit!\n");
354       GNUNET_free (quota_str);
355       ret = 1;
356       return;
357   }
358   GNUNET_free (quota_str);
359   quota_str = NULL;
360   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Configured WAN inbound quota: %llu\n", wan_quota_in);
361   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Configured WAN outbound quota: %llu\n", wan_quota_out);
362
363
364   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
365
366   /* Connect to ATS scheduling */
367   sched_ats = GNUNET_ATS_scheduling_init (cfg, &address_suggest_cb, NULL);
368   if (sched_ats == NULL)
369   {
370     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not connect to ATS scheduling!\n");
371     ret = 1;
372     end ();
373     return;
374   }
375
376   /* Connect to ATS performance */
377   perf_ats = GNUNET_ATS_performance_init(cfg, NULL, NULL);
378   if (sched_ats == NULL)
379   {
380     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not connect to ATS scheduling!\n");
381     ret = 1;
382     end ();
383     return;
384   }
385
386
387   /* Set up peer 0 */
388   if (GNUNET_SYSERR == GNUNET_CRYPTO_hash_from_string(PEERID0, &p[0].id.hashPubKey))
389   {
390       GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not setup peer!\n");
391       ret = GNUNET_SYSERR;
392       end ();
393       return;
394   }
395
396   GNUNET_assert (0 == strcmp (PEERID0, GNUNET_i2s_full (&p[0].id)));
397
398   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Created peer `%s'\n",
399               GNUNET_i2s(&p[0].id));
400
401   /* Set up peer 1*/
402   if (GNUNET_SYSERR == GNUNET_CRYPTO_hash_from_string(PEERID1, &p[1].id.hashPubKey))
403   {
404       GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not setup peer!\n");
405       ret = GNUNET_SYSERR;
406       end ();
407       return;
408   }
409
410   GNUNET_assert (0 == strcmp (PEERID1, GNUNET_i2s_full (&p[1].id)));
411
412   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Created peer `%s'\n",
413               GNUNET_i2s(&p[1].id));
414
415   /* Prepare ATS Information */
416   test_ats_info[0].type = htonl (GNUNET_ATS_NETWORK_TYPE);
417   test_ats_info[0].value = htonl(GNUNET_ATS_NET_WAN);
418   test_ats_info[1].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
419   test_ats_info[1].value = htonl(1);
420   test_ats_count = 2;
421
422   /* Peer 0: Adding address with session */
423   test_session[0] = &test_addr[0];
424   create_test_address (&test_addr[0], "test0", test_session[0], "test0", strlen ("test0") + 1);
425   test_hello_address[0].peer = p[0].id;
426   test_hello_address[0].transport_name = test_addr[0].plugin;
427   test_hello_address[0].address = test_addr[0].addr;
428   test_hello_address[0].address_length = test_addr[0].addr_len;
429   GNUNET_ATS_address_add (sched_ats, &test_hello_address[0], test_session[0], test_ats_info, test_ats_count);
430
431   /* Peer 1: Adding address with session */
432   test_session[1] = &test_addr[1];
433   create_test_address (&test_addr[1], "test1", test_session[1], "test1", strlen ("test1") + 1);
434   test_hello_address[1].peer = p[1].id;
435   test_hello_address[1].transport_name = test_addr[1].plugin;
436   test_hello_address[1].address = test_addr[1].addr;
437   test_hello_address[1].address_length = test_addr[1].addr_len;
438   GNUNET_ATS_address_add (sched_ats, &test_hello_address[1], test_session[1], test_ats_info, test_ats_count);
439
440   GNUNET_ATS_suggest_address (sched_ats, &p[0].id);
441   GNUNET_ATS_suggest_address (sched_ats, &p[1].id);
442 }
443
444
445 int
446 main (int argc, char *argv[])
447 {
448   if (0 != GNUNET_TESTING_peer_run ("test_ats_proportional_pref_aging",
449                                     "test_ats_api.conf",
450                                     &run, NULL))
451     return 1;
452   return ret;
453 }
454
455
456 /* end of file test_ats_simplistic_pref_aging.c */