2 This file is part of GNUnet
3 (C) 2008--2012 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file testbed/testbed_api_peers.c
23 * @brief management of the knowledge about peers in this library
24 * (we know the peer ID, its host, pending operations, etc.)
25 * @author Christian Grothoff
26 * @author Sree Harsha Totakura
30 #include "testbed_api_peers.h"
31 #include "testbed_api.h"
33 #include "testbed_api_hosts.h"
34 #include "testbed_api_operations.h"
37 * Function to call to start a peer_create type operation once all
38 * queues the operation is part of declare that the
39 * operation can be activated.
41 * @param cls the closure from GNUNET_TESTBED_operation_create_()
44 opstart_peer_create (void *cls)
46 struct OperationContext *opc = cls;
47 struct PeerCreateData *data;
48 struct GNUNET_TESTBED_PeerCreateMessage *msg;
55 GNUNET_assert (OP_PEER_CREATE == opc->type);
57 GNUNET_assert (NULL != data);
58 GNUNET_assert (NULL != data->peer);
59 opc->state = OPC_STATE_STARTED;
60 config = GNUNET_CONFIGURATION_serialize (data->cfg, &c_size);
61 xc_size = GNUNET_TESTBED_compress_config_ (config, c_size, &xconfig);
63 msize = xc_size + sizeof (struct GNUNET_TESTBED_PeerCreateMessage);
64 msg = GNUNET_realloc (xconfig, msize);
65 memmove (&msg[1], msg, xc_size);
66 msg->header.size = htons (msize);
67 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER);
68 msg->operation_id = GNUNET_htonll (opc->id);
69 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (data->peer->host));
70 msg->peer_id = htonl (data->peer->unique_id);
71 msg->config_size = htonl (c_size);
72 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
73 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
78 * Callback which will be called when peer_create type operation is released
80 * @param cls the closure from GNUNET_TESTBED_operation_create_()
83 oprelease_peer_create (void *cls)
85 struct OperationContext *opc = cls;
87 if (OPC_STATE_FINISHED != opc->state)
89 GNUNET_free (((struct PeerCreateData *) opc->data)->peer);
90 GNUNET_free (opc->data);
91 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
98 * Function called when a peer destroy operation is ready
100 * @param cls the closure from GNUNET_TESTBED_operation_create_()
103 opstart_peer_destroy (void *cls)
105 struct OperationContext *opc = cls;
106 struct GNUNET_TESTBED_Peer *peer;
107 struct GNUNET_TESTBED_PeerDestroyMessage *msg;
109 GNUNET_assert (OP_PEER_DESTROY == opc->type);
111 GNUNET_assert (NULL != peer);
112 opc->state = OPC_STATE_STARTED;
113 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerDestroyMessage));
114 msg->header.size = htons (sizeof (struct GNUNET_TESTBED_PeerDestroyMessage));
115 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER);
116 msg->peer_id = htonl (peer->unique_id);
117 msg->operation_id = GNUNET_htonll (opc->id);
118 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head,
119 opc->c->ocq_tail, opc);
120 GNUNET_TESTBED_queue_message_ (peer->controller, &msg->header);
125 * Callback which will be called when peer_create type operation is released
127 * @param cls the closure from GNUNET_TESTBED_operation_create_()
130 oprelease_peer_destroy (void *cls)
132 struct OperationContext *opc = cls;
134 if (OPC_STATE_FINISHED != opc->state)
135 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
141 * Function called when a peer start operation is ready
143 * @param cls the closure from GNUNET_TESTBED_operation_create_()
146 opstart_peer_start (void *cls)
148 struct OperationContext *opc = cls;
149 struct GNUNET_TESTBED_PeerStartMessage *msg;
150 struct GNUNET_TESTBED_Peer *peer;
152 GNUNET_assert (OP_PEER_START == opc->type);
153 GNUNET_assert (NULL != opc->data);
155 GNUNET_assert ((PS_CREATED == peer->state) || (PS_STOPPED == peer->state));
156 opc->state = OPC_STATE_STARTED;
157 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerStartMessage));
158 msg->header.size = htons (sizeof (struct GNUNET_TESTBED_PeerStartMessage));
159 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_STARTPEER);
160 msg->peer_id = htonl (peer->unique_id);
161 msg->operation_id = GNUNET_htonll (opc->id);
162 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
163 GNUNET_TESTBED_queue_message_ (peer->controller, &msg->header);
168 * Callback which will be called when peer start type operation is released
170 * @param cls the closure from GNUNET_TESTBED_operation_create_()
173 oprelease_peer_start (void *cls)
175 struct OperationContext *opc = cls;
177 if (OPC_STATE_FINISHED != opc->state)
178 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
184 * Function called when a peer stop operation is ready
186 * @param cls the closure from GNUNET_TESTBED_operation_create_()
189 opstart_peer_stop (void *cls)
191 struct OperationContext *opc = cls;
192 struct GNUNET_TESTBED_PeerStopMessage *msg;
193 struct GNUNET_TESTBED_Peer *peer;
195 GNUNET_assert (NULL != opc->data);
197 GNUNET_assert (PS_STARTED == peer->state);
198 opc->state = OPC_STATE_STARTED;
199 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerStopMessage));
200 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_STOPPEER);
201 msg->header.size = htons (sizeof (struct GNUNET_TESTBED_PeerStopMessage));
202 msg->peer_id = htonl (peer->unique_id);
203 msg->operation_id = GNUNET_htonll (opc->id);
204 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
205 GNUNET_TESTBED_queue_message_ (peer->controller, &msg->header);
210 * Callback which will be called when peer stop type operation is released
212 * @param cls the closure from GNUNET_TESTBED_operation_create_()
215 oprelease_peer_stop (void *cls)
217 struct OperationContext *opc = cls;
219 if (OPC_STATE_FINISHED != opc->state)
220 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
226 * Function called when a peer get information operation is ready
228 * @param cls the closure from GNUNET_TESTBED_operation_create_()
231 opstart_peer_getinfo (void *cls)
233 struct OperationContext *opc = cls;
234 struct PeerInfoData *data;
235 struct GNUNET_TESTBED_PeerGetConfigurationMessage *msg;
238 GNUNET_assert (NULL != data);
239 opc->state = OPC_STATE_STARTED;
240 msg = GNUNET_malloc (sizeof (struct
241 GNUNET_TESTBED_PeerGetConfigurationMessage));
242 msg->header.size = htons
243 (sizeof (struct GNUNET_TESTBED_PeerGetConfigurationMessage));
244 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_GETPEERCONFIG);
245 msg->peer_id = htonl (data->peer->unique_id);
246 msg->operation_id = GNUNET_htonll (opc->id);
247 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
248 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
253 * Callback which will be called when peer stop type operation is released
255 * @param cls the closure from GNUNET_TESTBED_operation_create_()
258 oprelease_peer_getinfo (void *cls)
260 struct OperationContext *opc = cls;
261 struct PeerInfoData2 *data;
263 if (OPC_STATE_FINISHED != opc->state)
265 GNUNET_free_non_null (opc->data);
266 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
271 GNUNET_assert (NULL != data);
274 case GNUNET_TESTBED_PIT_CONFIGURATION:
275 GNUNET_CONFIGURATION_destroy (data->details.cfg);
277 case GNUNET_TESTBED_PIT_IDENTITY:
278 GNUNET_free (data->details.peer_identity);
281 GNUNET_assert (0); /* We should never reach here */
290 * Function called when a overlay connect operation is ready
292 * @param cls the closure from GNUNET_TESTBED_operation_create_()
295 opstart_overlay_connect (void *cls)
297 struct OperationContext *opc = cls;
298 struct GNUNET_TESTBED_OverlayConnectMessage *msg;
299 struct OverlayConnectData *data;
301 opc->state = OPC_STATE_STARTED;
303 GNUNET_assert (NULL != data);
304 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_OverlayConnectMessage));
305 msg->header.size = htons (sizeof
306 (struct GNUNET_TESTBED_OverlayConnectMessage));
307 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_OLCONNECT);
308 msg->peer1 = htonl (data->p1->unique_id);
309 msg->peer2 = htonl (data->p2->unique_id);
310 msg->operation_id = GNUNET_htonll (opc->id);
311 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
312 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
317 * Callback which will be called when overlay connect operation is released
319 * @param cls the closure from GNUNET_TESTBED_operation_create_()
322 oprelease_overlay_connect (void *cls)
324 struct OperationContext *opc = cls;
326 if (OPC_STATE_FINISHED != opc->state)
328 GNUNET_free (opc->data);
329 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
336 * Lookup a peer by ID.
338 * @param id global peer ID assigned to the peer
339 * @return handle to the host, NULL on error
341 struct GNUNET_TESTBED_Peer *
342 GNUNET_TESTBED_peer_lookup_by_id_ (uint32_t id)
350 * Create the given peer at the specified host using the given
351 * controller. If the given controller is not running on the target
352 * host, it should find or create a controller at the target host and
353 * delegate creating the peer. Explicit delegation paths can be setup
354 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
355 * path exists, a direct link with a subordinate controller is setup
356 * for the first delegated peer to a particular host; the subordinate
357 * controller is then destroyed once the last peer that was delegated
358 * to the remote host is stopped. This function is used in particular
359 * if some other controller has already assigned a unique ID to the
362 * Creating the peer only creates the handle to manipulate and further
363 * configure the peer; use "GNUNET_TESTBED_peer_start" and
364 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
367 * Note that the given configuration will be adjusted by the
368 * controller to avoid port/path conflicts with other peers.
369 * The "final" configuration can be obtained using
370 * 'GNUNET_TESTBED_peer_get_information'.
372 * @param unique_id unique ID for this peer
373 * @param controller controller process to use
374 * @param host host to run the peer on
375 * @param cfg Template configuration to use for the peer. Should exist until
376 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
377 * @param cb the callback to call when the peer has been created
378 * @param cls the closure to the above callback
379 * @return the operation handle
381 struct GNUNET_TESTBED_Operation *
382 GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
383 struct GNUNET_TESTBED_Controller *controller,
384 struct GNUNET_TESTBED_Host *host,
385 const struct GNUNET_CONFIGURATION_Handle *cfg,
386 GNUNET_TESTBED_PeerCreateCallback cb,
389 struct GNUNET_TESTBED_Peer *peer;
390 struct PeerCreateData *data;
391 struct OperationContext *opc;
393 peer = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer));
394 peer->controller = controller;
396 peer->unique_id = unique_id;
397 peer->state = PS_INVALID;
398 data = GNUNET_malloc (sizeof (struct PeerCreateData));
404 opc = GNUNET_malloc (sizeof (struct OperationContext));
407 opc->id = controller->operation_counter++;
408 opc->type = OP_PEER_CREATE;
409 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_create,
410 &oprelease_peer_create);
411 GNUNET_TESTBED_operation_queue_insert_ (controller->opq_peer_create, opc->op);
417 * Create the given peer at the specified host using the given
418 * controller. If the given controller is not running on the target
419 * host, it should find or create a controller at the target host and
420 * delegate creating the peer. Explicit delegation paths can be setup
421 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
422 * path exists, a direct link with a subordinate controller is setup
423 * for the first delegated peer to a particular host; the subordinate
424 * controller is then destroyed once the last peer that was delegated
425 * to the remote host is stopped.
427 * Creating the peer only creates the handle to manipulate and further
428 * configure the peer; use "GNUNET_TESTBED_peer_start" and
429 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
432 * Note that the given configuration will be adjusted by the
433 * controller to avoid port/path conflicts with other peers.
434 * The "final" configuration can be obtained using
435 * 'GNUNET_TESTBED_peer_get_information'.
437 * @param controller controller process to use
438 * @param host host to run the peer on
439 * @param cfg Template configuration to use for the peer. Should exist until
440 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
441 * @param cb the callback to call when the peer has been created
442 * @param cls the closure to the above callback
443 * @return the operation handle
445 struct GNUNET_TESTBED_Operation *
446 GNUNET_TESTBED_peer_create (struct GNUNET_TESTBED_Controller *controller,
447 struct GNUNET_TESTBED_Host *host,
448 const struct GNUNET_CONFIGURATION_Handle *cfg,
449 GNUNET_TESTBED_PeerCreateCallback cb,
452 static uint32_t id_gen;
454 return GNUNET_TESTBED_peer_create_with_id_ (++id_gen,
463 * Start the given peer.
465 * @param peer peer to start
466 * @return handle to the operation
468 struct GNUNET_TESTBED_Operation *
469 GNUNET_TESTBED_peer_start (struct GNUNET_TESTBED_Peer *peer)
471 struct OperationContext *opc;
473 opc = GNUNET_malloc (sizeof (struct OperationContext));
474 opc->c = peer->controller;
476 opc->id = opc->c->operation_counter++;
477 opc->type = OP_PEER_START;
478 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_start,
479 &oprelease_peer_start);
480 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create, opc->op);
486 * Stop the given peer. The handle remains valid (use
487 * "GNUNET_TESTBED_peer_destroy" to fully clean up the
488 * state of the peer).
490 * @param peer peer to stop
491 * @return handle to the operation
493 struct GNUNET_TESTBED_Operation *
494 GNUNET_TESTBED_peer_stop (struct GNUNET_TESTBED_Peer *peer)
496 struct OperationContext *opc;
498 opc = GNUNET_malloc (sizeof (struct OperationContext));
499 opc->c = peer->controller;
501 opc->id = opc->c->operation_counter++;
502 opc->type = OP_PEER_STOP;
503 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_stop,
504 &oprelease_peer_stop);
505 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create, opc->op);
511 * Request information about a peer.
513 * @param peer peer to request information about
514 * @param pit desired information
515 * @return handle to the operation
517 struct GNUNET_TESTBED_Operation *
518 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
519 enum GNUNET_TESTBED_PeerInformationType pit)
521 struct OperationContext *opc;
522 struct PeerInfoData *data;
524 GNUNET_assert (GNUNET_TESTBED_PIT_GENERIC != pit);
525 data = GNUNET_malloc (sizeof (struct PeerInfoData));
528 opc = GNUNET_malloc (sizeof (struct OperationContext));
529 opc->c = peer->controller;
531 opc->type = OP_PEER_INFO;
532 opc->id = opc->c->operation_counter++;
533 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_getinfo,
534 &oprelease_peer_getinfo);
535 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create, opc->op);
541 * Change peer configuration. Must only be called while the
542 * peer is stopped. Ports and paths cannot be changed this
545 * @param peer peer to change configuration for
546 * @param cfg new configuration (differences to existing
547 * configuration only)
548 * @return handle to the operation
550 struct GNUNET_TESTBED_Operation *
551 GNUNET_TESTBED_peer_update_configuration (struct GNUNET_TESTBED_Peer *peer,
552 const struct GNUNET_CONFIGURATION_Handle *cfg)
554 // FIXME: handle locally or delegate...
561 * Destroy the given peer; the peer should have been
562 * stopped first (if it was started).
564 * @param peer peer to stop
565 * @return handle to the operation
567 struct GNUNET_TESTBED_Operation *
568 GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer)
570 struct OperationContext *opc;
572 opc = GNUNET_malloc (sizeof (struct OperationContext));
574 opc->c = peer->controller;
575 opc->id = peer->controller->operation_counter++;
576 opc->type = OP_PEER_DESTROY;
577 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_destroy,
578 &oprelease_peer_destroy);
579 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create,
586 * Manipulate the P2P underlay topology by configuring a link
589 * @param op_cls closure argument to give with the operation event
590 * @param p1 first peer
591 * @param p2 second peer
592 * @param co option to change
593 * @param ... option-specific values
594 * @return handle to the operation, NULL if configuring the link at this
595 * time is not allowed
597 struct GNUNET_TESTBED_Operation *
598 GNUNET_TESTBED_underlay_configure_link (void *op_cls,
599 struct GNUNET_TESTBED_Peer *p1,
600 struct GNUNET_TESTBED_Peer *p2,
601 enum GNUNET_TESTBED_ConnectOption co, ...)
610 * Both peers must have been started before calling this function.
611 * This function then obtains a HELLO from 'p1', gives it to 'p2'
612 * and asks 'p2' to connect to 'p1'.
614 * @param op_cls closure argument to give with the operation event
615 * @param p1 first peer
616 * @param p2 second peer
617 * @return handle to the operation, NULL if connecting these two
618 * peers is fundamentally not possible at this time (peers
619 * not running or underlay disallows)
621 struct GNUNET_TESTBED_Operation *
622 GNUNET_TESTBED_overlay_connect (void *op_cls,
623 struct GNUNET_TESTBED_Peer *p1,
624 struct GNUNET_TESTBED_Peer *p2)
626 struct OperationContext *opc;
627 struct OverlayConnectData *data;
629 GNUNET_assert ((PS_STARTED == p1->state) && (PS_STARTED == p2->state));
630 GNUNET_assert (p1->controller == p2->controller);
631 data = GNUNET_malloc (sizeof (struct OverlayConnectData));
634 opc = GNUNET_malloc (sizeof (struct OperationContext));
636 opc->c = p1->controller;
637 opc->id = opc->c->operation_counter++;
638 opc->type = OP_OVERLAY_CONNECT;
639 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_overlay_connect,
640 &oprelease_overlay_connect);
641 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create,
648 /* end of testbed_api_peers.c */