src/testbed/testbed_api_peers.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2012 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 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  */
  27 #include "platform.h"
  28 #include "testbed_api_peers.h"
  29 #include "testbed_api.h"
  30 #include "testbed.h"
  31 #include "testbed_api_hosts.h"
  32
  33
  34 /**
  35  * Lookup a peer by ID.
  36  *
  37  * @param id global peer ID assigned to the peer
  38  * @return handle to the host, NULL on error
  39  */
  40 struct GNUNET_TESTBED_Peer *
  41 GNUNET_TESTBED_peer_lookup_by_id_ (uint32_t id)
  42 {
  43   GNUNET_break (0);
  44   return NULL;
  45 }
  46
  47
  48 /**
  49  * Create the given peer at the specified host using the given
  50  * controller.  If the given controller is not running on the target
  51  * host, it should find or create a controller at the target host and
  52  * delegate creating the peer.  Explicit delegation paths can be setup
  53  * using 'GNUNET_TESTBED_controller_link'.  If no explicit delegation
  54  * path exists, a direct link with a subordinate controller is setup
  55  * for the first delegated peer to a particular host; the subordinate
  56  * controller is then destroyed once the last peer that was delegated
  57  * to the remote host is stopped.  This function is used in particular
  58  * if some other controller has already assigned a unique ID to the
  59  * peer.
  60  *
  61  * Creating the peer only creates the handle to manipulate and further
  62  * configure the peer; use "GNUNET_TESTBED_peer_start" and
  63  * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
  64  * processes.
  65  *
  66  * Note that the given configuration will be adjusted by the
  67  * controller to avoid port/path conflicts with other peers.
  68  * The "final" configuration can be obtained using
  69  * 'GNUNET_TESTBED_peer_get_information'.
  70  *
  71  * @param unique_id unique ID for this peer
  72  * @param controller controller process to use
  73  * @param host host to run the peer on
  74  * @param cfg configuration to use for the peer
  75  * @return handle to the peer (actual startup will happen asynchronously)
  76  */
  77 struct GNUNET_TESTBED_Peer *
  78 GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
  79                                      struct GNUNET_TESTBED_Controller *controller,
  80                                      struct GNUNET_TESTBED_Host *host,
  81                                      const struct GNUNET_CONFIGURATION_Handle *cfg)
  82 {
  83   struct GNUNET_TESTBED_Peer *peer;
  84   struct GNUNET_TESTBED_PeerCreateMessage *msg;
  85   char *config;
  86   char *xconfig;
  87   size_t c_size;
  88   size_t xc_size;
  89   uint16_t msize;
  90
  91   peer = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer));
  92   peer->controller = controller;
  93   peer->host = host;
  94   peer->unique_id = unique_id;
  95   config = GNUNET_CONFIGURATION_serialize (cfg, &c_size);
  96   xc_size = GNUNET_TESTBED_compress_config (config, c_size, &xconfig);
  97   GNUNET_free (config);
  98   msize = xc_size + sizeof (struct GNUNET_TESTBED_PeerCreateMessage);
  99   msg = GNUNET_realloc (xconfig, msize);
 100   memmove (&msg[1], msg, xc_size); /* Move the compressed config */
 101   msg->header.size = htons (msize);
 102   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER);
 103   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (peer->host));
 104   msg->peer_id = htonl (peer->unique_id);
 105   msg->config_size = htonl (c_size);
 106   GNUNET_TESTBED_queue_message (controller,
 107                                 (struct GNUNET_MessageHeader *) msg);
 108   return peer;
 109 }
 110
 111
 112 /**
 113  * Create the given peer at the specified host using the given
 114  * controller.  If the given controller is not running on the target
 115  * host, it should find or create a controller at the target host and
 116  * delegate creating the peer.  Explicit delegation paths can be setup
 117  * using 'GNUNET_TESTBED_controller_link'.  If no explicit delegation
 118  * path exists, a direct link with a subordinate controller is setup
 119  * for the first delegated peer to a particular host; the subordinate
 120  * controller is then destroyed once the last peer that was delegated
 121  * to the remote host is stopped.
 122  *
 123  * Creating the peer only creates the handle to manipulate and further
 124  * configure the peer; use "GNUNET_TESTBED_peer_start" and
 125  * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
 126  * processes.
 127  *
 128  * Note that the given configuration will be adjusted by the
 129  * controller to avoid port/path conflicts with other peers.
 130  * The "final" configuration can be obtained using
 131  * 'GNUNET_TESTBED_peer_get_information'.
 132  *
 133  * @param controller controller process to use
 134  * @param host host to run the peer on
 135  * @param cfg configuration to use for the peer
 136  * @return handle to the peer (actual startup will happen asynchronously)
 137  */
 138 struct GNUNET_TESTBED_Peer *
 139 GNUNET_TESTBED_peer_create (struct GNUNET_TESTBED_Controller *controller,
 140                             struct GNUNET_TESTBED_Host *host,
 141                             const struct GNUNET_CONFIGURATION_Handle *cfg)
 142 {
 143   static uint32_t id_gen;
 144
 145   return GNUNET_TESTBED_peer_create_with_id_ (++id_gen,
 146                                               controller,
 147                                               host,
 148                                               cfg);
 149 }
 150
 151
 152 /**
 153  * Start the given peer.
 154  *
 155  * @param peer peer to start
 156  * @return handle to the operation
 157  */
 158 struct GNUNET_TESTBED_Operation *
 159 GNUNET_TESTBED_peer_start (struct GNUNET_TESTBED_Peer *peer)
 160 {
 161   // FIXME: start locally or delegate...
 162   GNUNET_break (0);
 163   return NULL;
 164 }
 165
 166
 167 /**
 168  * Stop the given peer.  The handle remains valid (use
 169  * "GNUNET_TESTBED_peer_destroy" to fully clean up the
 170  * state of the peer).
 171  *
 172  * @param peer peer to stop
 173  * @return handle to the operation
 174  */
 175 struct GNUNET_TESTBED_Operation *
 176 GNUNET_TESTBED_peer_stop (struct GNUNET_TESTBED_Peer *peer)
 177 {
 178   // FIXME: stop locally or delegate...
 179   GNUNET_break (0);
 180   return NULL;
 181 }
 182
 183
 184 /**
 185  * Request information about a peer.
 186  *
 187  * @param peer peer to request information about
 188  * @param pit desired information
 189  * @return handle to the operation
 190  */
 191 struct GNUNET_TESTBED_Operation *
 192 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
 193                                      enum GNUNET_TESTBED_PeerInformationType pit)
 194 {
 195   // FIXME: handle locally or delegate...
 196   GNUNET_break (0);
 197   return NULL;
 198 }
 199
 200
 201 /**
 202  * Change peer configuration.  Must only be called while the
 203  * peer is stopped.  Ports and paths cannot be changed this
 204  * way.
 205  *
 206  * @param peer peer to change configuration for
 207  * @param cfg new configuration (differences to existing
 208  *            configuration only)
 209  * @return handle to the operation
 210  */
 211 struct GNUNET_TESTBED_Operation *
 212 GNUNET_TESTBED_peer_update_configuration (struct GNUNET_TESTBED_Peer *peer,
 213                                           const struct GNUNET_CONFIGURATION_Handle *cfg)
 214 {
 215   // FIXME: handle locally or delegate...
 216   GNUNET_break (0);
 217   return NULL;
 218 }
 219
 220
 221 /**
 222  * Destroy the given peer; the peer should have been
 223  * stopped first (if it was started).
 224  *
 225  * @param peer peer to stop
 226  * @return handle to the operation
 227  */
 228 struct GNUNET_TESTBED_Operation *
 229 GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer)
 230 {
 231   struct GNUNET_TESTBED_Operation *op;
 232   struct PeerDestroyData *data;
 233   struct GNUNET_TESTBED_PeerDestroyMessage *msg;
 234
 235   data = GNUNET_malloc (sizeof (struct PeerDestroyData));
 236   data->peer = peer;
 237   op = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Operation));
 238   op->operation_id = peer->controller->operation_counter++;
 239   op->type = OP_PEER_DESTROY;
 240   op->data = data;
 241   msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_PeerDestroyMessage));
 242   msg->header.size = htons (sizeof (struct GNUNET_TESTBED_PeerDestroyMessage));
 243   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER);
 244   msg->peer_id = htonl (peer->unique_id);
 245   msg->operation_id = GNUNET_htonll (op->operation_id);
 246   GNUNET_CONTAINER_DLL_insert_tail (peer->controller->op_head,
 247                                     peer->controller->op_tail, op);
 248   GNUNET_TESTBED_queue_message (peer->controller,
 249                                 (struct GNUNET_MessageHeader *) msg);
 250   return op;
 251 }
 252
 253
 254 /**
 255  * Manipulate the P2P underlay topology by configuring a link
 256  * between two peers.
 257  *
 258  * @param op_cls closure argument to give with the operation event
 259  * @param p1 first peer
 260  * @param p2 second peer
 261  * @param co option to change
 262  * @param ... option-specific values
 263  * @return handle to the operation, NULL if configuring the link at this
 264  *         time is not allowed
 265  */
 266 struct GNUNET_TESTBED_Operation *
 267 GNUNET_TESTBED_underlay_configure_link (void *op_cls,
 268                                         struct GNUNET_TESTBED_Peer *p1,
 269                                         struct GNUNET_TESTBED_Peer *p2,
 270                                         enum GNUNET_TESTBED_ConnectOption co, ...)
 271 {
 272   GNUNET_break (0);
 273   return NULL;
 274 }
 275
 276
 277
 278 /**
 279  * Both peers must have been started before calling this function.
 280  * This function then obtains a HELLO from 'p1', gives it to 'p2'
 281  * and asks 'p2' to connect to 'p1'.
 282  *
 283  * @param op_cls closure argument to give with the operation event
 284  * @param p1 first peer
 285  * @param p2 second peer
 286  * @return handle to the operation, NULL if connecting these two
 287  *         peers is fundamentally not possible at this time (peers
 288  *         not running or underlay disallows)
 289  */
 290 struct GNUNET_TESTBED_Operation *
 291 GNUNET_TESTBED_overlay_connect (void *op_cls,
 292                                 struct GNUNET_TESTBED_Peer *p1,
 293                                 struct GNUNET_TESTBED_Peer *p2)
 294 {
 295   GNUNET_break (0);
 296   return NULL;
 297 }
 298
 299
 300
 301 /* end of testbed_api_peers.c */