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, opc->c->ocq_tail, opc);
119 GNUNET_TESTBED_queue_message_ (peer->controller, &msg->header);
124 * Callback which will be called when peer_create type operation is released
126 * @param cls the closure from GNUNET_TESTBED_operation_create_()
129 oprelease_peer_destroy (void *cls)
131 struct OperationContext *opc = cls;
133 if (OPC_STATE_FINISHED != opc->state)
134 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
140 * Function called when a peer start operation is ready
142 * @param cls the closure from GNUNET_TESTBED_operation_create_()
145 opstart_peer_start (void *cls)
147 struct OperationContext *opc = cls;
148 struct GNUNET_TESTBED_PeerStartMessage *msg;
149 struct GNUNET_TESTBED_Peer *peer;
151 GNUNET_assert (OP_PEER_START == opc->type);
152 GNUNET_assert (NULL != opc->data);
154 GNUNET_assert ((PS_CREATED == peer->state) || (PS_STOPPED == peer->state));
155 opc->state = OPC_STATE_STARTED;
156 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerStartMessage));
157 msg->header.size = htons (sizeof (struct GNUNET_TESTBED_PeerStartMessage));
158 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_STARTPEER);
159 msg->peer_id = htonl (peer->unique_id);
160 msg->operation_id = GNUNET_htonll (opc->id);
161 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
162 GNUNET_TESTBED_queue_message_ (peer->controller, &msg->header);
167 * Callback which will be called when peer start type operation is released
169 * @param cls the closure from GNUNET_TESTBED_operation_create_()
172 oprelease_peer_start (void *cls)
174 struct OperationContext *opc = cls;
176 if (OPC_STATE_FINISHED != opc->state)
177 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
183 * Function called when a peer stop operation is ready
185 * @param cls the closure from GNUNET_TESTBED_operation_create_()
188 opstart_peer_stop (void *cls)
190 struct OperationContext *opc = cls;
191 struct GNUNET_TESTBED_PeerStopMessage *msg;
192 struct GNUNET_TESTBED_Peer *peer;
194 GNUNET_assert (NULL != opc->data);
196 GNUNET_assert (PS_STARTED == peer->state);
197 opc->state = OPC_STATE_STARTED;
198 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerStopMessage));
199 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_STOPPEER);
200 msg->header.size = htons (sizeof (struct GNUNET_TESTBED_PeerStopMessage));
201 msg->peer_id = htonl (peer->unique_id);
202 msg->operation_id = GNUNET_htonll (opc->id);
203 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
204 GNUNET_TESTBED_queue_message_ (peer->controller, &msg->header);
209 * Callback which will be called when peer stop type operation is released
211 * @param cls the closure from GNUNET_TESTBED_operation_create_()
214 oprelease_peer_stop (void *cls)
216 struct OperationContext *opc = cls;
218 if (OPC_STATE_FINISHED != opc->state)
219 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
225 * Generate PeerGetConfigurationMessage
227 * @param peer_id the id of the peer whose information we have to get
228 * @param operation_id the ip of the operation that should be represented in
230 * @return the PeerGetConfigurationMessage
232 struct GNUNET_TESTBED_PeerGetConfigurationMessage *
233 GNUNET_TESTBED_generate_peergetconfig_msg_ (uint32_t peer_id,
234 uint64_t operation_id)
236 struct GNUNET_TESTBED_PeerGetConfigurationMessage *msg;
239 GNUNET_malloc (sizeof
240 (struct GNUNET_TESTBED_PeerGetConfigurationMessage));
242 htons (sizeof (struct GNUNET_TESTBED_PeerGetConfigurationMessage));
243 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_GETPEERCONFIG);
244 msg->peer_id = htonl (peer_id);
245 msg->operation_id = GNUNET_htonll (operation_id);
251 * Function called when a peer get information operation is ready
253 * @param cls the closure from GNUNET_TESTBED_operation_create_()
256 opstart_peer_getinfo (void *cls)
258 struct OperationContext *opc = cls;
259 struct PeerInfoData *data;
260 struct GNUNET_TESTBED_PeerGetConfigurationMessage *msg;
263 GNUNET_assert (NULL != data);
264 opc->state = OPC_STATE_STARTED;
266 GNUNET_TESTBED_generate_peergetconfig_msg_ (data->peer->unique_id,
268 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
269 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
274 * Callback which will be called when peer stop type operation is released
276 * @param cls the closure from GNUNET_TESTBED_operation_create_()
279 oprelease_peer_getinfo (void *cls)
281 struct OperationContext *opc = cls;
282 struct PeerInfoData2 *data;
284 if (OPC_STATE_FINISHED != opc->state)
286 GNUNET_free_non_null (opc->data);
287 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
292 GNUNET_assert (NULL != data);
295 case GNUNET_TESTBED_PIT_CONFIGURATION:
296 GNUNET_CONFIGURATION_destroy (data->details.cfg);
298 case GNUNET_TESTBED_PIT_IDENTITY:
299 GNUNET_free (data->details.peer_identity);
302 GNUNET_assert (0); /* We should never reach here */
311 * Function called when a overlay connect operation is ready
313 * @param cls the closure from GNUNET_TESTBED_operation_create_()
316 opstart_overlay_connect (void *cls)
318 struct OperationContext *opc = cls;
319 struct GNUNET_TESTBED_OverlayConnectMessage *msg;
320 struct OverlayConnectData *data;
322 opc->state = OPC_STATE_STARTED;
324 GNUNET_assert (NULL != data);
325 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_OverlayConnectMessage));
327 htons (sizeof (struct GNUNET_TESTBED_OverlayConnectMessage));
328 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_OLCONNECT);
329 msg->peer1 = htonl (data->p1->unique_id);
330 msg->peer2 = htonl (data->p2->unique_id);
331 msg->operation_id = GNUNET_htonll (opc->id);
332 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head, opc->c->ocq_tail, opc);
333 GNUNET_TESTBED_queue_message_ (opc->c, &msg->header);
338 * Callback which will be called when overlay connect operation is released
340 * @param cls the closure from GNUNET_TESTBED_operation_create_()
343 oprelease_overlay_connect (void *cls)
345 struct OperationContext *opc = cls;
347 if (OPC_STATE_FINISHED != opc->state)
349 GNUNET_free (opc->data);
350 GNUNET_CONTAINER_DLL_remove (opc->c->ocq_head, opc->c->ocq_tail, opc);
357 * Lookup a peer by ID.
359 * @param id global peer ID assigned to the peer
360 * @return handle to the host, NULL on error
362 struct GNUNET_TESTBED_Peer *
363 GNUNET_TESTBED_peer_lookup_by_id_ (uint32_t id)
371 * Create the given peer at the specified host using the given
372 * controller. If the given controller is not running on the target
373 * host, it should find or create a controller at the target host and
374 * delegate creating the peer. Explicit delegation paths can be setup
375 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
376 * path exists, a direct link with a subordinate controller is setup
377 * for the first delegated peer to a particular host; the subordinate
378 * controller is then destroyed once the last peer that was delegated
379 * to the remote host is stopped. This function is used in particular
380 * if some other controller has already assigned a unique ID to the
383 * Creating the peer only creates the handle to manipulate and further
384 * configure the peer; use "GNUNET_TESTBED_peer_start" and
385 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
388 * Note that the given configuration will be adjusted by the
389 * controller to avoid port/path conflicts with other peers.
390 * The "final" configuration can be obtained using
391 * 'GNUNET_TESTBED_peer_get_information'.
393 * @param unique_id unique ID for this peer
394 * @param controller controller process to use
395 * @param host host to run the peer on
396 * @param cfg Template configuration to use for the peer. Should exist until
397 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
398 * @param cb the callback to call when the peer has been created
399 * @param cls the closure to the above callback
400 * @return the operation handle
402 struct GNUNET_TESTBED_Operation *
403 GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
404 struct GNUNET_TESTBED_Controller
406 struct GNUNET_TESTBED_Host *host,
407 const struct GNUNET_CONFIGURATION_Handle
408 *cfg, GNUNET_TESTBED_PeerCreateCallback cb,
411 struct GNUNET_TESTBED_Peer *peer;
412 struct PeerCreateData *data;
413 struct OperationContext *opc;
415 peer = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer));
416 peer->controller = controller;
418 peer->unique_id = unique_id;
419 peer->state = PS_INVALID;
420 data = GNUNET_malloc (sizeof (struct PeerCreateData));
426 opc = GNUNET_malloc (sizeof (struct OperationContext));
429 opc->id = controller->operation_counter++;
430 opc->type = OP_PEER_CREATE;
432 GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_create,
433 &oprelease_peer_create);
434 GNUNET_TESTBED_operation_queue_insert_ (controller->opq_parallel_operations,
441 * Create the given peer at the specified host using the given
442 * controller. If the given controller is not running on the target
443 * host, it should find or create a controller at the target host and
444 * delegate creating the peer. Explicit delegation paths can be setup
445 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
446 * path exists, a direct link with a subordinate controller is setup
447 * for the first delegated peer to a particular host; the subordinate
448 * controller is then destroyed once the last peer that was delegated
449 * to the remote host is stopped.
451 * Creating the peer only creates the handle to manipulate and further
452 * configure the peer; use "GNUNET_TESTBED_peer_start" and
453 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
456 * Note that the given configuration will be adjusted by the
457 * controller to avoid port/path conflicts with other peers.
458 * The "final" configuration can be obtained using
459 * 'GNUNET_TESTBED_peer_get_information'.
461 * @param controller controller process to use
462 * @param host host to run the peer on
463 * @param cfg Template configuration to use for the peer. Should exist until
464 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
465 * @param cb the callback to call when the peer has been created
466 * @param cls the closure to the above callback
467 * @return the operation handle
469 struct GNUNET_TESTBED_Operation *
470 GNUNET_TESTBED_peer_create (struct GNUNET_TESTBED_Controller *controller,
471 struct GNUNET_TESTBED_Host *host,
472 const struct GNUNET_CONFIGURATION_Handle *cfg,
473 GNUNET_TESTBED_PeerCreateCallback cb, void *cls)
475 static uint32_t id_gen;
477 return GNUNET_TESTBED_peer_create_with_id_ (id_gen++, controller, host, cfg,
483 * Start the given peer.
485 * @param peer peer to start
486 * @return handle to the operation
488 struct GNUNET_TESTBED_Operation *
489 GNUNET_TESTBED_peer_start (struct GNUNET_TESTBED_Peer *peer)
491 struct OperationContext *opc;
493 opc = GNUNET_malloc (sizeof (struct OperationContext));
494 opc->c = peer->controller;
496 opc->id = opc->c->operation_counter++;
497 opc->type = OP_PEER_START;
499 GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_start,
500 &oprelease_peer_start);
501 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_parallel_operations,
508 * Stop the given peer. The handle remains valid (use
509 * "GNUNET_TESTBED_peer_destroy" to fully clean up the
510 * state of the peer).
512 * @param peer peer to stop
513 * @return handle to the operation
515 struct GNUNET_TESTBED_Operation *
516 GNUNET_TESTBED_peer_stop (struct GNUNET_TESTBED_Peer *peer)
518 struct OperationContext *opc;
520 opc = GNUNET_malloc (sizeof (struct OperationContext));
521 opc->c = peer->controller;
523 opc->id = opc->c->operation_counter++;
524 opc->type = OP_PEER_STOP;
526 GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_stop,
527 &oprelease_peer_stop);
528 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_parallel_operations,
535 * Request information about a peer.
537 * @param peer peer to request information about
538 * @param pit desired information
539 * @return handle to the operation
541 struct GNUNET_TESTBED_Operation *
542 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
543 enum GNUNET_TESTBED_PeerInformationType
546 struct OperationContext *opc;
547 struct PeerInfoData *data;
549 GNUNET_assert (GNUNET_TESTBED_PIT_GENERIC != pit);
550 data = GNUNET_malloc (sizeof (struct PeerInfoData));
553 opc = GNUNET_malloc (sizeof (struct OperationContext));
554 opc->c = peer->controller;
556 opc->type = OP_PEER_INFO;
557 opc->id = opc->c->operation_counter++;
559 GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_getinfo,
560 &oprelease_peer_getinfo);
561 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_parallel_operations,
568 * Change peer configuration. Must only be called while the
569 * peer is stopped. Ports and paths cannot be changed this
572 * @param peer peer to change configuration for
573 * @param cfg new configuration (differences to existing
574 * configuration only)
575 * @return handle to the operation
577 struct GNUNET_TESTBED_Operation *
578 GNUNET_TESTBED_peer_update_configuration (struct GNUNET_TESTBED_Peer *peer,
580 GNUNET_CONFIGURATION_Handle *cfg)
582 // FIXME: handle locally or delegate...
589 * Destroy the given peer; the peer should have been
590 * stopped first (if it was started).
592 * @param peer peer to stop
593 * @return handle to the operation
595 struct GNUNET_TESTBED_Operation *
596 GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer)
598 struct OperationContext *opc;
600 opc = GNUNET_malloc (sizeof (struct OperationContext));
602 opc->c = peer->controller;
603 opc->id = peer->controller->operation_counter++;
604 opc->type = OP_PEER_DESTROY;
606 GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_destroy,
607 &oprelease_peer_destroy);
608 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_parallel_operations,
615 * Manipulate the P2P underlay topology by configuring a link
618 * @param op_cls closure argument to give with the operation event
619 * @param p1 first peer
620 * @param p2 second peer
621 * @param co option to change
622 * @param ... option-specific values
623 * @return handle to the operation, NULL if configuring the link at this
624 * time is not allowed
626 struct GNUNET_TESTBED_Operation *
627 GNUNET_TESTBED_underlay_configure_link (void *op_cls,
628 struct GNUNET_TESTBED_Peer *p1,
629 struct GNUNET_TESTBED_Peer *p2,
630 enum GNUNET_TESTBED_ConnectOption co,
640 * Both peers must have been started before calling this function.
641 * This function then obtains a HELLO from 'p1', gives it to 'p2'
642 * and asks 'p2' to connect to 'p1'.
644 * @param op_cls closure argument to give with the operation event
645 * @param p1 first peer
646 * @param p2 second peer
647 * @return handle to the operation, NULL if connecting these two
648 * peers is fundamentally not possible at this time (peers
649 * not running or underlay disallows)
651 struct GNUNET_TESTBED_Operation *
652 GNUNET_TESTBED_overlay_connect (void *op_cls, struct GNUNET_TESTBED_Peer *p1,
653 struct GNUNET_TESTBED_Peer *p2)
655 struct OperationContext *opc;
656 struct OverlayConnectData *data;
658 GNUNET_assert ((PS_STARTED == p1->state) && (PS_STARTED == p2->state));
659 GNUNET_assert (p1->controller == p2->controller);
660 data = GNUNET_malloc (sizeof (struct OverlayConnectData));
663 opc = GNUNET_malloc (sizeof (struct OperationContext));
665 opc->c = p1->controller;
666 opc->id = opc->c->operation_counter++;
667 opc->type = OP_OVERLAY_CONNECT;
669 GNUNET_TESTBED_operation_create_ (opc, &opstart_overlay_connect,
670 &oprelease_overlay_connect);
671 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_parallel_operations,
678 /* end of testbed_api_peers.c */