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
28 #include "testbed_api_peers.h"
29 #include "testbed_api.h"
31 #include "testbed_api_hosts.h"
32 #include "testbed_api_operations.h"
35 * Function to call to start a peer_create type operation once all
36 * queues the operation is part of declare that the
37 * operation can be activated.
39 * @param cls the closure from GNUNET_TESTBED_operation_create_()
42 opstart_peer_create (void *cls)
44 struct OperationContext *opc = cls;
45 struct PeerCreateData *data;
46 struct GNUNET_TESTBED_PeerCreateMessage *msg;
53 GNUNET_assert (OP_PEER_CREATE == opc->type);
55 GNUNET_assert (NULL != data);
56 GNUNET_assert (NULL != data->peer);
57 opc->state = OPC_STATE_STARTED;
58 config = GNUNET_CONFIGURATION_serialize (data->cfg, &c_size);
59 xc_size = GNUNET_TESTBED_compress_config_ (config, c_size, &xconfig);
61 msize = xc_size + sizeof (struct GNUNET_TESTBED_PeerCreateMessage);
62 msg = GNUNET_realloc (xconfig, msize);
63 memmove (&msg[1], msg, xc_size);
64 msg->header.size = htons (msize);
65 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER);
66 msg->operation_id = GNUNET_htonll (opc->id);
67 msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (data->peer->host));
68 msg->peer_id = htonl (data->peer->unique_id);
69 msg->config_size = htonl (c_size);
70 GNUNET_CONTAINER_DLL_insert_tail (opc->c->ocq_head,
71 opc->c->ocq_tail, opc);
72 GNUNET_TESTBED_queue_message_ (opc->c,
73 (struct GNUNET_MessageHeader *) msg);
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 to 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 to 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 to 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 to 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 */
291 * Lookup a peer by ID.
293 * @param id global peer ID assigned to the peer
294 * @return handle to the host, NULL on error
296 struct GNUNET_TESTBED_Peer *
297 GNUNET_TESTBED_peer_lookup_by_id_ (uint32_t id)
305 * Create the given peer at the specified host using the given
306 * controller. If the given controller is not running on the target
307 * host, it should find or create a controller at the target host and
308 * delegate creating the peer. Explicit delegation paths can be setup
309 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
310 * path exists, a direct link with a subordinate controller is setup
311 * for the first delegated peer to a particular host; the subordinate
312 * controller is then destroyed once the last peer that was delegated
313 * to the remote host is stopped. This function is used in particular
314 * if some other controller has already assigned a unique ID to the
317 * Creating the peer only creates the handle to manipulate and further
318 * configure the peer; use "GNUNET_TESTBED_peer_start" and
319 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
322 * Note that the given configuration will be adjusted by the
323 * controller to avoid port/path conflicts with other peers.
324 * The "final" configuration can be obtained using
325 * 'GNUNET_TESTBED_peer_get_information'.
327 * @param unique_id unique ID for this peer
328 * @param controller controller process to use
329 * @param host host to run the peer on
330 * @param cfg Template configuration to use for the peer. Should exist until
331 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
332 * @param cb the callback to call when the peer has been created
333 * @param cls the closure to the above callback
334 * @return the operation handle
336 struct GNUNET_TESTBED_Operation *
337 GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
338 struct GNUNET_TESTBED_Controller *controller,
339 struct GNUNET_TESTBED_Host *host,
340 const struct GNUNET_CONFIGURATION_Handle *cfg,
341 GNUNET_TESTBED_PeerCreateCallback cb,
344 struct GNUNET_TESTBED_Peer *peer;
345 struct PeerCreateData *data;
346 struct OperationContext *opc;
348 peer = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer));
349 peer->controller = controller;
351 peer->unique_id = unique_id;
352 peer->state = PS_INVALID;
353 data = GNUNET_malloc (sizeof (struct PeerCreateData));
359 opc = GNUNET_malloc (sizeof (struct OperationContext));
362 opc->id = controller->operation_counter++;
363 opc->type = OP_PEER_CREATE;
364 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_create,
365 &oprelease_peer_create);
366 GNUNET_TESTBED_operation_queue_insert_ (controller->opq_peer_create, opc->op);
372 * Create the given peer at the specified host using the given
373 * controller. If the given controller is not running on the target
374 * host, it should find or create a controller at the target host and
375 * delegate creating the peer. Explicit delegation paths can be setup
376 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
377 * path exists, a direct link with a subordinate controller is setup
378 * for the first delegated peer to a particular host; the subordinate
379 * controller is then destroyed once the last peer that was delegated
380 * to the remote host is stopped.
382 * Creating the peer only creates the handle to manipulate and further
383 * configure the peer; use "GNUNET_TESTBED_peer_start" and
384 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
387 * Note that the given configuration will be adjusted by the
388 * controller to avoid port/path conflicts with other peers.
389 * The "final" configuration can be obtained using
390 * 'GNUNET_TESTBED_peer_get_information'.
392 * @param controller controller process to use
393 * @param host host to run the peer on
394 * @param cfg Template configuration to use for the peer. Should exist until
395 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
396 * @param cb the callback to call when the peer has been created
397 * @param cls the closure to the above callback
398 * @return the operation handle
400 struct GNUNET_TESTBED_Operation *
401 GNUNET_TESTBED_peer_create (struct GNUNET_TESTBED_Controller *controller,
402 struct GNUNET_TESTBED_Host *host,
403 const struct GNUNET_CONFIGURATION_Handle *cfg,
404 GNUNET_TESTBED_PeerCreateCallback cb,
407 static uint32_t id_gen;
409 return GNUNET_TESTBED_peer_create_with_id_ (++id_gen,
418 * Start the given peer.
420 * @param peer peer to start
421 * @return handle to the operation
423 struct GNUNET_TESTBED_Operation *
424 GNUNET_TESTBED_peer_start (struct GNUNET_TESTBED_Peer *peer)
426 struct OperationContext *opc;
428 opc = GNUNET_malloc (sizeof (struct OperationContext));
429 opc->c = peer->controller;
431 opc->id = opc->c->operation_counter++;
432 opc->type = OP_PEER_START;
433 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_start,
434 &oprelease_peer_start);
435 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create, opc->op);
441 * Stop the given peer. The handle remains valid (use
442 * "GNUNET_TESTBED_peer_destroy" to fully clean up the
443 * state of the peer).
445 * @param peer peer to stop
446 * @return handle to the operation
448 struct GNUNET_TESTBED_Operation *
449 GNUNET_TESTBED_peer_stop (struct GNUNET_TESTBED_Peer *peer)
451 struct OperationContext *opc;
453 opc = GNUNET_malloc (sizeof (struct OperationContext));
454 opc->c = peer->controller;
456 opc->id = opc->c->operation_counter++;
457 opc->type = OP_PEER_STOP;
458 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_stop,
459 &oprelease_peer_stop);
460 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create, opc->op);
466 * Request information about a peer.
468 * @param peer peer to request information about
469 * @param pit desired information
470 * @return handle to the operation
472 struct GNUNET_TESTBED_Operation *
473 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
474 enum GNUNET_TESTBED_PeerInformationType pit)
476 struct OperationContext *opc;
477 struct PeerInfoData *data;
479 GNUNET_assert (GNUNET_TESTBED_PIT_GENERIC != pit);
480 data = GNUNET_malloc (sizeof (struct PeerInfoData));
483 opc = GNUNET_malloc (sizeof (struct OperationContext));
484 opc->c = peer->controller;
486 opc->type = OP_PEER_INFO;
487 opc->id = opc->c->operation_counter++;
488 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_getinfo,
489 &oprelease_peer_getinfo);
490 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create, opc->op);
496 * Change peer configuration. Must only be called while the
497 * peer is stopped. Ports and paths cannot be changed this
500 * @param peer peer to change configuration for
501 * @param cfg new configuration (differences to existing
502 * configuration only)
503 * @return handle to the operation
505 struct GNUNET_TESTBED_Operation *
506 GNUNET_TESTBED_peer_update_configuration (struct GNUNET_TESTBED_Peer *peer,
507 const struct GNUNET_CONFIGURATION_Handle *cfg)
509 // FIXME: handle locally or delegate...
516 * Destroy the given peer; the peer should have been
517 * stopped first (if it was started).
519 * @param peer peer to stop
520 * @return handle to the operation
522 struct GNUNET_TESTBED_Operation *
523 GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer)
525 struct OperationContext *opc;
527 opc = GNUNET_malloc (sizeof (struct OperationContext));
529 opc->c = peer->controller;
530 opc->id = peer->controller->operation_counter++;
531 opc->type = OP_PEER_DESTROY;
532 opc->op = GNUNET_TESTBED_operation_create_ (opc, &opstart_peer_destroy,
533 &oprelease_peer_destroy);
534 GNUNET_TESTBED_operation_queue_insert_ (opc->c->opq_peer_create,
541 * Manipulate the P2P underlay topology by configuring a link
544 * @param op_cls closure argument to give with the operation event
545 * @param p1 first peer
546 * @param p2 second peer
547 * @param co option to change
548 * @param ... option-specific values
549 * @return handle to the operation, NULL if configuring the link at this
550 * time is not allowed
552 struct GNUNET_TESTBED_Operation *
553 GNUNET_TESTBED_underlay_configure_link (void *op_cls,
554 struct GNUNET_TESTBED_Peer *p1,
555 struct GNUNET_TESTBED_Peer *p2,
556 enum GNUNET_TESTBED_ConnectOption co, ...)
565 * Both peers must have been started before calling this function.
566 * This function then obtains a HELLO from 'p1', gives it to 'p2'
567 * and asks 'p2' to connect to 'p1'.
569 * @param op_cls closure argument to give with the operation event
570 * @param p1 first peer
571 * @param p2 second peer
572 * @return handle to the operation, NULL if connecting these two
573 * peers is fundamentally not possible at this time (peers
574 * not running or underlay disallows)
576 struct GNUNET_TESTBED_Operation *
577 GNUNET_TESTBED_overlay_connect (void *op_cls,
578 struct GNUNET_TESTBED_Peer *p1,
579 struct GNUNET_TESTBED_Peer *p2)
581 struct GNUNET_TESTBED_Operation *op;
582 struct OverlayConnectData *data;
583 struct GNUNET_TESTBED_OverlayConnectMessage *msg;
585 GNUNET_assert ((PS_STARTED == p1->state) && (PS_STARTED == p2->state));
586 GNUNET_assert (p1->controller == p2->controller);
587 data = GNUNET_malloc (sizeof (struct OverlayConnectData));
590 op = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Operation));
591 op->controller = p1->controller;
592 op->operation_id = op->controller->operation_counter++;
593 op->type = OP_OVERLAY_CONNECT;
595 msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_OverlayConnectMessage));
596 msg->header.size = htons (sizeof (struct
597 GNUNET_TESTBED_OverlayConnectMessage));
598 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_OLCONNECT);
599 msg->peer1 = htonl (p1->unique_id);
600 msg->peer2 = htonl (p2->unique_id);
601 msg->operation_id = GNUNET_htonll (op->operation_id);
602 GNUNET_CONTAINER_DLL_insert_tail (op->controller->op_head,
603 op->controller->op_tail, op);
604 GNUNET_TESTBED_queue_message_ (op->controller,
605 (struct GNUNET_MessageHeader *) msg);
611 /* end of testbed_api_peers.c */