changes
[oweals/gnunet.git] / src / experimentation / gnunet-daemon-experimentation_nodes.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009 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 /**
22  * @file experimentation/gnunet-daemon-experimentation_nodes.c
23  * @brief experimentation daemon: node management
24  * @author Christian Grothoff
25  * @author Matthias Wachs
26  */
27 #include "platform.h"
28 #include "gnunet_getopt_lib.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_core_service.h"
31 #include "gnunet_statistics_service.h"
32 #include "gnunet-daemon-experimentation.h"
33
34
35 /**
36  * Core handle
37  */
38 static struct GNUNET_CORE_Handle *ch;
39
40
41 /**
42  * Peer's own identity
43  */
44 static struct GNUNET_PeerIdentity me;
45
46
47 /**
48  * Nodes with a pending request
49  */
50 struct GNUNET_CONTAINER_MultiHashMap *nodes_requested;
51
52
53 /**
54  * Active experimentation nodes
55  */
56 struct GNUNET_CONTAINER_MultiHashMap *nodes_active;
57
58
59 /**
60  * Inactive experimentation nodes
61  * To be excluded from future requests
62  */
63 struct GNUNET_CONTAINER_MultiHashMap *nodes_inactive;
64
65
66 /**
67  * Update statistics
68  *
69  * @param m hashmap to update values from
70  */
71 static void update_stats (struct GNUNET_CONTAINER_MultiHashMap *m)
72 {
73         GNUNET_assert (NULL != m);
74         GNUNET_assert (NULL != GSE_stats);
75
76         if (m == nodes_active)
77         {
78                         GNUNET_STATISTICS_set (GSE_stats, "# nodes active",
79                                         GNUNET_CONTAINER_multihashmap_size(m), GNUNET_NO);
80         }
81         else if (m == nodes_inactive)
82         {
83                         GNUNET_STATISTICS_set (GSE_stats, "# nodes inactive",
84                                         GNUNET_CONTAINER_multihashmap_size(m), GNUNET_NO);
85         }
86         else if (m == nodes_requested)
87         {
88                         GNUNET_STATISTICS_set (GSE_stats, "# nodes requested",
89                                         GNUNET_CONTAINER_multihashmap_size(m), GNUNET_NO);
90         }
91         else
92                 GNUNET_break (0);
93
94 }
95
96
97 /**
98  * Clean up nodes
99  *
100  * @param cls the hashmap to clean up
101  * @param key key of the current node
102  * @param value related node object
103  * @return always GNUNET_OK
104  */
105 static int
106 cleanup_nodes (void *cls,
107                                                          const struct GNUNET_HashCode * key,
108                                                          void *value)
109 {
110         struct Node *n;
111         struct GNUNET_CONTAINER_MultiHashMap *cur = cls;
112
113         n = value;
114         if (GNUNET_SCHEDULER_NO_TASK != n->timeout_task)
115         {
116                 GNUNET_SCHEDULER_cancel (n->timeout_task);
117                 n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
118         }
119         if (NULL != n->cth)
120         {
121                 GNUNET_CORE_notify_transmit_ready_cancel (n->cth);
122                 n->cth = NULL;
123         }
124         GNUNET_free_non_null (n->issuer_id);
125
126         GNUNET_CONTAINER_multihashmap_remove (cur, key, value);
127         GNUNET_free (value);
128         return GNUNET_OK;
129 }
130
131
132 /**
133  * Check if id passed is my id
134  *
135  * @param id the id to check
136  * @return GNUNET_YES or GNUNET_NO
137  */
138 static int is_me (const struct GNUNET_PeerIdentity *id)
139 {
140         if (0 == memcmp (&me, id, sizeof (me)))
141                 return GNUNET_YES;
142         else
143                 return GNUNET_NO;
144 }
145
146 /**
147  * Core startup callback
148  *
149  * @param cls unused
150  * @param server core service's server handle
151  * @param my_identity my id
152  */
153 static void
154 core_startup_handler (void *cls,
155                                                                                         struct GNUNET_CORE_Handle *server,
156                       const struct GNUNET_PeerIdentity *my_identity)
157 {
158         me = *my_identity;
159 }
160
161
162 /**
163  * Remove experimentation request due to timeout
164  *
165  * @param cls the related node
166  * @param tc scheduler's task context
167  */
168 static void
169 remove_request (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
170 {
171         struct Node *n = cls;
172
173         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Removing request for peer %s due to timeout\n"),
174                         GNUNET_i2s (&n->id));
175
176         if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_contains (nodes_requested, &n->id.hashPubKey))
177         {
178                         GNUNET_CONTAINER_multihashmap_remove (nodes_requested, &n->id.hashPubKey, n);
179                         update_stats (nodes_requested);
180                         GNUNET_CONTAINER_multihashmap_put (nodes_inactive, &n->id.hashPubKey, n,
181                                         GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
182                         update_stats (nodes_inactive);
183         }
184
185         n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
186         if (NULL != n->cth)
187         {
188                 GNUNET_CORE_notify_transmit_ready_cancel (n->cth);
189                 n->cth = NULL;
190         }
191 }
192
193
194 /**
195  * Core's transmit notify callback to send request
196  *
197  * @param cls the related node
198  * @param bufsize buffer size
199  * @param buf the buffer to copy to
200  * @return bytes passed
201  */
202 size_t send_request_cb (void *cls, size_t bufsize, void *buf)
203 {
204         struct Node *n = cls;
205         struct Experimentation_Request msg;
206         size_t msg_size = sizeof (msg);
207         size_t ri_size = sizeof (struct Experimentation_Issuer) * GSE_my_issuer_count;
208         size_t total_size = msg_size + ri_size;
209
210         memset (buf, '0', bufsize);
211         n->cth = NULL;
212   if (buf == NULL)
213   {
214     /* client disconnected */
215     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client disconnected\n");
216     if (GNUNET_SCHEDULER_NO_TASK != n->timeout_task)
217                 GNUNET_SCHEDULER_cancel (n->timeout_task);
218     GNUNET_SCHEDULER_add_now (&remove_request, n);
219     return 0;
220   }
221   GNUNET_assert (bufsize >= total_size);
222
223         msg.msg.size = htons (total_size);
224         msg.msg.type = htons (GNUNET_MESSAGE_TYPE_EXPERIMENTATION_REQUEST);
225         msg.capabilities = htonl (GSE_node_capabilities);
226         msg.issuer_count = htonl (GSE_my_issuer_count);
227         memcpy (buf, &msg, msg_size);
228         memcpy (&buf[msg_size], GSE_my_issuer, ri_size);
229
230         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Sending request to peer %s\n"),
231                         GNUNET_i2s (&n->id));
232         return total_size;
233 }
234
235
236 /**
237  * Send request
238  *
239  * @param peer the peer to send to
240  */
241 static void send_request (const struct GNUNET_PeerIdentity *peer)
242 {
243         struct Node *n;
244         size_t size;
245         size_t c_issuers;
246
247         c_issuers = GSE_my_issuer_count;
248
249         size = sizeof (struct Experimentation_Request) +
250                                  c_issuers * sizeof (struct Experimentation_Issuer);
251         n = GNUNET_malloc (sizeof (struct Node));
252         n->id = *peer;
253         n->timeout_task = GNUNET_SCHEDULER_add_delayed (EXP_RESPONSE_TIMEOUT, &remove_request, n);
254         n->capabilities = NONE;
255         n->cth = GNUNET_CORE_notify_transmit_ready(ch, GNUNET_NO, 0,
256                                                                 GNUNET_TIME_relative_get_forever_(),
257                                                                 peer, size, send_request_cb, n);
258
259         GNUNET_assert (GNUNET_OK == GNUNET_CONTAINER_multihashmap_put (nodes_requested,
260                         &peer->hashPubKey, n, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
261         update_stats (nodes_requested);
262 }
263
264
265 /**
266  * Core's transmit notify callback to send response
267  *
268  * @param cls the related node
269  * @param bufsize buffer size
270  * @param buf the buffer to copy to
271  * @return bytes passed
272  */
273 size_t send_response_cb (void *cls, size_t bufsize, void *buf)
274 {
275         struct Node *n = cls;
276         struct Experimentation_Response msg;
277         size_t ri_size = GSE_my_issuer_count * sizeof (struct Experimentation_Issuer);
278         size_t msg_size = sizeof (msg);
279         size_t total_size = msg_size;
280
281         n->cth = NULL;
282   if (buf == NULL)
283   {
284     /* client disconnected */
285     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client disconnected\n");
286     return 0;
287   }
288   GNUNET_assert (bufsize >= total_size);
289
290         msg.msg.size = htons (total_size);
291         msg.msg.type = htons (GNUNET_MESSAGE_TYPE_EXPERIMENTATION_RESPONSE);
292         msg.capabilities = htonl (GSE_node_capabilities);
293         memcpy (buf, &msg, msg_size);
294         memcpy (&buf[msg_size], GSE_my_issuer, ri_size);
295
296         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Sending response to peer %s\n"),
297                         GNUNET_i2s (&n->id));
298         return total_size;
299 }
300
301
302 static void
303 get_experiments_cb (struct Node *n, struct Experiment *e)
304 {
305         static int counter = 0;
306         if (NULL == e)
307         {
308                         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Added %u experiments for peer %s\n"),
309                                         counter, GNUNET_i2s (&n->id));
310                         return;
311         }
312
313         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Starting experiment `%s' with peer %s\n"),
314                         e->name,
315                         GNUNET_i2s (&n->id));
316         //GNUNET_EXPERIMENTATION_scheduler_add (e);
317         counter ++;
318 }
319
320 /**
321  * Set a specific node as active
322  *
323  * @param n the node
324  */
325 static void node_make_active (struct Node *n)
326 {
327         int c1;
328   GNUNET_CONTAINER_multihashmap_put (nodes_active,
329                         &n->id.hashPubKey, n, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
330         update_stats (nodes_active);
331         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Added peer `%s' as active node\n"),
332                         GNUNET_i2s (&n->id));
333
334         /* Request experiments for this node to start them */
335         for (c1 = 0; c1 < n->issuer_count; c1++)
336         {
337
338                 GNUNET_EXPERIMENTATION_experiments_get (n, &n->issuer_id[c1], &get_experiments_cb);
339         }
340 }
341
342
343 /**
344  * Handle a request and send a response
345  *
346  * @param peer the source
347  * @param message the message
348  */
349 static void handle_request (const struct GNUNET_PeerIdentity *peer,
350                                                                                                                 const struct GNUNET_MessageHeader *message)
351 {
352         struct Node *n;
353         struct Experimentation_Request *rm = (struct Experimentation_Request *) message;
354         struct Experimentation_Issuer *rmi = (struct Experimentation_Issuer *) &rm[1];
355         int c1;
356         int c2;
357         uint32_t ic;
358         uint32_t ic_accepted;
359         int make_active;
360
361         if (ntohs (message->size) < sizeof (struct Experimentation_Request))
362         {
363                 GNUNET_break (0);
364                 return;
365         }
366         ic = ntohl (rm->issuer_count);
367         if (ntohs (message->size) != sizeof (struct Experimentation_Request) + ic * sizeof (struct Experimentation_Issuer))
368         {
369                 GNUNET_break (0);
370                 return;
371         }
372
373         make_active = GNUNET_NO;
374         if (NULL != (n = GNUNET_CONTAINER_multihashmap_get (nodes_active, &peer->hashPubKey)))
375         {
376                         /* Nothing to do */
377         }
378         else if (NULL != (n = GNUNET_CONTAINER_multihashmap_get (nodes_requested, &peer->hashPubKey)))
379         {
380                         GNUNET_CONTAINER_multihashmap_remove (nodes_requested, &peer->hashPubKey, n);
381                         if (GNUNET_SCHEDULER_NO_TASK != n->timeout_task)
382                         {
383                                 GNUNET_SCHEDULER_cancel (n->timeout_task);
384                                 n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
385                         }
386                         if (NULL != n->cth)
387                         {
388                                 GNUNET_CORE_notify_transmit_ready_cancel (n->cth);
389                                 n->cth = NULL;
390                         }
391                         update_stats (nodes_requested);
392                         make_active = GNUNET_YES;
393         }
394         else if (NULL != (n = GNUNET_CONTAINER_multihashmap_get (nodes_inactive, &peer->hashPubKey)))
395         {
396                         GNUNET_CONTAINER_multihashmap_remove (nodes_inactive, &peer->hashPubKey, n);
397                         update_stats (nodes_inactive);
398                         make_active = GNUNET_YES;
399         }
400         else
401         {
402                         /* Create new node */
403                         n = GNUNET_malloc (sizeof (struct Node));
404                         n->id = *peer;
405                         n->capabilities = NONE;
406                         make_active = GNUNET_YES;
407         }
408
409         /* Update node */
410         n->capabilities = ntohl (rm->capabilities);
411
412         /* Filter accepted issuer */
413         ic_accepted = 0;
414         for (c1 = 0; c1 < ic; c1++)
415         {
416                 if (GNUNET_YES == GNUNET_EXPERIMENTATION_experiments_issuer_accepted(&rmi[c1].issuer_id))
417                         ic_accepted ++;
418         }
419         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Request from peer `%s' with %u issuers, we accepted %u issuer \n"),
420                         GNUNET_i2s (peer), ic, ic_accepted);
421         GNUNET_free_non_null (n->issuer_id);
422         n->issuer_id = GNUNET_malloc (ic_accepted * sizeof (struct GNUNET_PeerIdentity));
423         c2 = 0;
424         for (c1 = 0; c1 < ic; c1++)
425         {
426                         if (GNUNET_YES == GNUNET_EXPERIMENTATION_experiments_issuer_accepted(&rmi[c1].issuer_id))
427                         {
428                                 n->issuer_id[c2] = rmi[c1].issuer_id;
429                                 c2 ++;
430                         }
431         }
432         n->issuer_count = ic_accepted;
433
434         if (GNUNET_YES == make_active)
435                 node_make_active (n);
436
437         /* Send response */
438         n->cth = GNUNET_CORE_notify_transmit_ready (ch, GNUNET_NO, 0,
439                                                                 GNUNET_TIME_relative_get_forever_(),
440                                                                 peer,
441                                                                 sizeof (struct Experimentation_Response) +
442                                                                 GSE_my_issuer_count * sizeof (struct Experimentation_Issuer),
443                                                                 send_response_cb, n);
444 }
445
446
447 /**
448  * Handle a response
449  *
450  * @param peer the source
451  * @param message the message
452  */
453 static void handle_response (const struct GNUNET_PeerIdentity *peer,
454                                                                                                                  const struct GNUNET_MessageHeader *message)
455 {
456         struct Node *n;
457         struct Experimentation_Request *rm = (struct Experimentation_Request *) message;
458
459         if (NULL != (n = GNUNET_CONTAINER_multihashmap_get (nodes_active, &peer->hashPubKey)))
460         {
461                         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Received %s from %s peer `%s'\n"),
462                                         "RESPONSE", "active", GNUNET_i2s (peer));
463                         n->capabilities = ntohl (rm->capabilities);
464         }
465         else if (NULL != (n = GNUNET_CONTAINER_multihashmap_get (nodes_requested, &peer->hashPubKey)))
466         {
467                         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Received %s from %s peer `%s'\n"),
468                                         "RESPONSE", "requested", GNUNET_i2s (peer));
469                         n->capabilities = ntohl (rm->capabilities);
470                         GNUNET_CONTAINER_multihashmap_remove (nodes_requested, &peer->hashPubKey, n);
471                         if (GNUNET_SCHEDULER_NO_TASK != n->timeout_task)
472                         {
473                                 GNUNET_SCHEDULER_cancel (n->timeout_task);
474                                 n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
475                         }
476                         if (NULL != n->cth)
477                         {
478                                 GNUNET_CORE_notify_transmit_ready_cancel (n->cth);
479                                 n->cth = NULL;
480                         }
481                         update_stats (nodes_requested);
482                         node_make_active (n);
483         }
484         else if (NULL != (n = GNUNET_CONTAINER_multihashmap_get (nodes_inactive, &peer->hashPubKey)))
485         {
486                         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Received %s from peer `%s'\n"),
487                                         "RESPONSE", "inactive", GNUNET_i2s (peer));
488                         n->capabilities = ntohl (rm->capabilities);
489                         GNUNET_CONTAINER_multihashmap_remove (nodes_inactive, &peer->hashPubKey, n);
490                         update_stats (nodes_inactive);
491                         node_make_active (n);
492         }
493         else
494         {
495                         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Received %s from %s peer `%s'\n"),
496                                         "RESPONSE", "unknown", GNUNET_i2s (peer));
497                         return;
498         }
499 }
500
501 /**
502  * Method called whenever a given peer connects.
503  *
504  * @param cls closure
505  * @param peer peer identity this notification is about
506  */
507 void core_connect_handler (void *cls,
508                            const struct GNUNET_PeerIdentity *peer)
509 {
510         if (GNUNET_YES == is_me(peer))
511                 return;
512
513         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Connected to peer %s\n"),
514                         GNUNET_i2s (peer));
515
516         if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_contains (nodes_requested, &peer->hashPubKey))
517                 return; /* We already sent a request */
518
519         if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_contains (nodes_active, &peer->hashPubKey))
520                 return; /* This peer is known as active  */
521
522         if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_contains (nodes_inactive, &peer->hashPubKey))
523                 return; /* This peer is known as inactive  */
524
525         send_request (peer);
526
527 }
528
529
530 /**
531  * Method called whenever a given peer disconnects.
532  *
533  * @param cls closure
534  * @param peer peer identity this notification is about
535  */
536 void core_disconnect_handler (void *cls,
537                            const struct GNUNET_PeerIdentity * peer)
538 {
539         if (GNUNET_YES == is_me(peer))
540                 return;
541
542         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Disconnected from peer %s\n"),
543                         GNUNET_i2s (peer));
544
545 }
546
547
548 /**
549  * Handle a request and send a response
550  *
551  * @param cls unused
552  * @param other the sender
553  * @param message the message
554  * @return GNUNET_OK to keep connection, GNUNET_SYSERR on error
555  */
556 static int
557 core_receive_handler (void *cls,
558                                                                                         const struct GNUNET_PeerIdentity *other,
559                                                                                         const struct GNUNET_MessageHeader *message)
560 {
561         if (ntohs (message->size) < sizeof (struct GNUNET_MessageHeader))
562         {
563                         GNUNET_break (0);
564                         return GNUNET_SYSERR;
565         }
566
567         switch (ntohs (message->type)) {
568                 case GNUNET_MESSAGE_TYPE_EXPERIMENTATION_REQUEST:
569                         handle_request (other, message);
570                         break;
571                 case GNUNET_MESSAGE_TYPE_EXPERIMENTATION_RESPONSE:
572                         handle_response (other, message);
573                         break;
574                 default:
575                         break;
576         }
577
578         return GNUNET_OK;
579 }
580
581
582
583 /**
584  * Start the nodes management
585  */
586 void
587 GNUNET_EXPERIMENTATION_nodes_start ()
588 {
589         /* Connecting to core service to find partners */
590         ch = GNUNET_CORE_connect (GSE_cfg, NULL,
591                                                                                                                 &core_startup_handler,
592                                                                                                                 &core_connect_handler,
593                                                                                                                 &core_disconnect_handler,
594                                                                                                                 &core_receive_handler,
595                                                                                                                 GNUNET_NO, NULL, GNUNET_NO, NULL);
596         if (NULL == ch)
597         {
598                         GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Failed to connect to CORE service!\n"));
599                         return;
600         }
601
602         nodes_requested = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
603         nodes_active = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
604         nodes_inactive = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
605 }
606
607
608 /**
609  * Stop the nodes management
610  */
611 void
612 GNUNET_EXPERIMENTATION_nodes_stop ()
613 {
614   if (NULL != ch)
615   {
616                 GNUNET_CORE_disconnect (ch);
617                 ch = NULL;
618   }
619
620   if (NULL != nodes_requested)
621   {
622                 GNUNET_CONTAINER_multihashmap_iterate (nodes_requested,
623                                                                                                                                                                          &cleanup_nodes,
624                                                                                                                                                                          nodes_requested);
625                 update_stats (nodes_requested);
626                 GNUNET_CONTAINER_multihashmap_destroy (nodes_requested);
627                 nodes_requested = NULL;
628   }
629
630   if (NULL != nodes_active)
631   {
632                 GNUNET_CONTAINER_multihashmap_iterate (nodes_active,
633                                                                                                                                                                          &cleanup_nodes,
634                                                                                                                                                                          nodes_active);
635                 update_stats (nodes_active);
636                 GNUNET_CONTAINER_multihashmap_destroy (nodes_active);
637                 nodes_active = NULL;
638   }
639
640   if (NULL != nodes_inactive)
641   {
642                 GNUNET_CONTAINER_multihashmap_iterate (nodes_inactive,
643                                                                                                                                                                          &cleanup_nodes,
644                                                                                                                                                                          nodes_inactive);
645                 update_stats (nodes_inactive);
646                 GNUNET_CONTAINER_multihashmap_destroy (nodes_inactive);
647                 nodes_inactive = NULL;
648   }
649 }
650
651 /* end of gnunet-daemon-experimentation_nodes.c */