src/testbed/testbed_api.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.c
  23  * @brief API for accessing the GNUnet testing service.
  24  *        This library is supposed to make it easier to write
  25  *        testcases and script large-scale benchmarks.
  26  * @author Christian Grothoff
  27  */
  28 #include "platform.h"
  29 #include "gnunet_testbed_service.h"
  30 #include "gnunet_core_service.h"
  31 #include "gnunet_constants.h"
  32 #include "gnunet_transport_service.h"
  33 #include "gnunet_hello_lib.h"
  34
  35 #include "testbed.h"
  36 #include "testbed_api_hosts.h"
  37
  38
  39 #define LOG(kind, ...)                          \
  40   GNUNET_log_from (kind, "testbed-api", __VA_ARGS__);
  41
  42
  43 /**
  44  * The message queue for sending messages to the controller service
  45  */
  46 struct MessageQueue
  47 {
  48   /**
  49    * The message to be sent
  50    */
  51   struct GNUNET_MessageHeader *msg;
  52
  53   /**
  54    * next pointer for DLL
  55    */
  56   struct MessageQueue *next;
  57
  58   /**
  59    * prev pointer for DLL
  60    */
  61   struct MessageQueue *prev;
  62 };
  63
  64
  65 /**
  66  * Handle to interact with a GNUnet testbed controller.  Each
  67  * controller has at least one master handle which is created when the
  68  * controller is created; this master handle interacts with the
  69  * controller process, destroying it destroys the controller (by
  70  * closing stdin of the controller process).  Additionally,
  71  * controllers can interact with each other (in a P2P fashion); those
  72  * links are established via TCP/IP on the controller's service port.
  73  */
  74 struct GNUNET_TESTBED_Controller
  75 {
  76
  77   /**
  78    * The host where the controller is running
  79    */
  80   const struct GNUNET_TESTBED_Host *host;
  81
  82   /**
  83    * The helper handle
  84    */
  85   struct GNUNET_HELPER_Handle *h;
  86
  87   /**
  88    * The controller callback
  89    */
  90   GNUNET_TESTBED_ControllerCallback cc;
  91
  92   /**
  93    * The closure for controller callback
  94    */
  95   void *cc_cls;
  96
  97   /**
  98    * The configuration to use while connecting to controller
  99    */
 100   struct GNUNET_CONFIGURATION_Handle *cfg;
 101
 102   /**
 103    * The client connection handle to the controller service
 104    */
 105   struct GNUNET_CLIENT_Connection *client;
 106
 107   /**
 108    * The head of the message queue
 109    */
 110   struct MessageQueue *mq_head;
 111
 112   /**
 113    * The tail of the message queue
 114    */
 115   struct MessageQueue *mq_tail;
 116
 117   /**
 118    * The client transmit handle
 119    */
 120   struct GNUNET_CLIENT_TransmitHandle *th;
 121
 122   /**
 123    * The controller event mask
 124    */
 125   uint64_t event_mask;
 126 };
 127
 128
 129 /**
 130  * Function called to notify a client about the connection begin ready to queue
 131  * more data.  "buf" will be NULL and "size" zero if the connection was closed
 132  * for writing in the meantime.
 133  *
 134  * @param cls closure
 135  * @param size number of bytes available in buf
 136  * @param buf where the callee should write the message
 137  * @return number of bytes written to buf
 138  */
 139 static size_t
 140 transmit_ready_notify (void *cls, size_t size, void *buf)
 141 {
 142   struct GNUNET_TESTBED_Controller *c = cls;
 143   struct MessageQueue *mq_entry;
 144
 145   mq_entry = c->mq_head;
 146   GNUNET_assert (NULL != mq_entry);
 147   GNUNET_assert (ntohs (mq_entry->msg->size) <= size);
 148   size = ntohs (mq_entry->msg->size);
 149   memcpy (buf, mq_entry->msg, size);
 150   GNUNET_free (mq_entry->msg);
 151   GNUNET_CONTAINER_DLL_remove (c->mq_head, c->mq_tail, mq_entry);
 152   GNUNET_free (mq_entry);
 153   mq_entry = c->mq_head;
 154   if (NULL != mq_entry)
 155     c->th =
 156       GNUNET_CLIENT_notify_transmit_ready (c->client,
 157                                            ntohs (mq_entry->msg->size),
 158                                            GNUNET_TIME_UNIT_FOREVER_REL,
 159                                            GNUNET_NO, &transmit_ready_notify,
 160                                            c);
 161   return size;
 162 }
 163
 164
 165 /**
 166  * Queues a message in send queue for sending to the service
 167  *
 168  * @param controller the handle to the controller
 169  * @param msg the message to queue
 170  */
 171 static void
 172 queue_message (struct GNUNET_TESTBED_Controller *controller,
 173                struct GNUNET_MessageHeader *msg)
 174 {
 175   struct MessageQueue *mq_entry;
 176   uint16_t type;
 177   uint16_t size;
 178
 179   type = ntohs (msg->type);
 180   size = ntohs (msg->size);
 181   GNUNET_assert ((GNUNET_MESSAGE_TYPE_TESTBED_INIT <= type) &&
 182                  (GNUNET_MESSAGE_TYPE_TESTBED_MAX > type));
 183   mq_entry = GNUNET_malloc (sizeof (struct MessageQueue));
 184   mq_entry->msg = msg;
 185   LOG (GNUNET_ERROR_TYPE_DEBUG,
 186        "Queueing message of type %u, size %u for sending\n", type,
 187        ntohs (msg->size));
 188   GNUNET_CONTAINER_DLL_insert_tail (controller->mq_head, controller->mq_tail,
 189                                     mq_entry);
 190   if (NULL == controller->th)
 191     controller->th =
 192       GNUNET_CLIENT_notify_transmit_ready (controller->client, size,
 193                                            GNUNET_TIME_UNIT_FOREVER_REL,
 194                                            GNUNET_NO, &transmit_ready_notify,
 195                                            controller);
 196  }
 197
 198
 199 /**
 200  * Handler for messages from controller (testbed service)
 201  *
 202  * @param cls the controller handler
 203  * @param msg message received, NULL on timeout or fatal error
 204  */
 205 static void
 206 message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 207 {
 208   struct GNUNET_TESTBED_Controller *c = cls;
 209
 210   /* FIXME: Add checks for message integrity */
 211   switch (ntohs (msg->type))
 212   {
 213   default:
 214     GNUNET_break (0);
 215   }
 216   GNUNET_CLIENT_receive (c->client, &message_handler, c,
 217                          GNUNET_TIME_UNIT_FOREVER_REL);
 218 }
 219
 220
 221 /**
 222  * ?Callback for messages recevied from server?
 223  *
 224  * Do not call GNUNET_SERVER_mst_destroy in callback
 225  *
 226  * @param cls closure
 227  * @param client identification of the client
 228  * @param message the actual message
 229  *
 230  * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
 231  */
 232 static int
 233 server_mst_cb (void *cls, void *client,
 234                const struct GNUNET_MessageHeader *message)
 235 {
 236   struct GNUNET_TESTBED_Controller *c = cls;
 237   struct GNUNET_TESTBED_Message *msg;
 238
 239   c->client = GNUNET_CLIENT_connect ("testbed", c->cfg);
 240   if (NULL == c->client)
 241     return GNUNET_SYSERR;       /* FIXME: Call controller startup_cb ? */
 242   GNUNET_CLIENT_receive (c->client, &message_handler, c,
 243                          GNUNET_TIME_UNIT_FOREVER_REL);
 244   msg = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Message));
 245   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_INIT);
 246   msg->header.size = htons (sizeof (struct GNUNET_TESTBED_Message));
 247   msg->host_id = htonl (GNUNET_TESTBED_host_get_id_ (c->host));
 248   msg->event_mask = GNUNET_htonll (c->event_mask);
 249   queue_message (c, (struct GNUNET_MessageHeader *) msg);
 250   return GNUNET_OK;
 251 }
 252
 253
 254 /**
 255  * Start a controller process using the given configuration at the
 256  * given host.
 257  *
 258  * @param cfg configuration to use
 259  * @param host host to run the controller on, NULL for 'localhost'
 260  * @param event_mask bit mask with set of events to call 'cc' for;
 261  *                   or-ed values of "1LL" shifted by the
 262  *                   respective 'enum GNUNET_TESTBED_EventType'
 263  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
 264  * @param cc controller callback to invoke on events
 265  * @param cc_cls closure for cc
 266  * @return handle to the controller
 267  */
 268 struct GNUNET_TESTBED_Controller *
 269 GNUNET_TESTBED_controller_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 270                                  struct GNUNET_TESTBED_Host *host,
 271                                  uint64_t event_mask,
 272                                  GNUNET_TESTBED_ControllerCallback cc,
 273                                  void *cc_cls)
 274 {
 275   struct GNUNET_TESTBED_Controller *controller;
 276   char * binary_argv[] = {"gnunet-service-testbed",
 277                           "gnunet-service-testbed",
 278                           NULL};
 279   controller = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Controller));
 280   controller->h = GNUNET_TESTBED_host_run_ (host, binary_argv,
 281                                             &server_mst_cb, controller);
 282   if (NULL == controller->h)
 283   {
 284     GNUNET_free (controller);
 285     return NULL;
 286   }
 287   controller->host = host;
 288   controller->cc = cc;
 289   controller->cc_cls = cc_cls;
 290   controller->event_mask = event_mask;
 291   controller->cfg = GNUNET_CONFIGURATION_dup (cfg);
 292   return controller;
 293 }
 294
 295
 296 /**
 297  * Configure shared services at a controller.  Using this function,
 298  * you can specify that certain services (such as "resolver")
 299  * should not be run for each peer but instead be shared
 300  * across N peers on the specified host.  This function
 301  * must be called before any peers are created at the host.
 302  *
 303  * @param controller controller to configure
 304  * @param service_name name of the service to share
 305  * @param num_peers number of peers that should share one instance
 306  *        of the specified service (1 for no sharing is the default),
 307  *        use 0 to disable the service
 308  */
 309 void
 310 GNUNET_TESTBED_controller_configure_sharing (struct GNUNET_TESTBED_Controller *controller,
 311                                              const char *service_name,
 312                                              uint32_t num_peers)
 313 {
 314   GNUNET_break (0);
 315 }
 316
 317
 318 /**
 319  * Stop the given controller (also will terminate all peers and
 320  * controllers dependent on this controller).  This function
 321  * blocks until the testbed has been fully terminated (!).
 322  *
 323  * @param controller handle to controller to stop
 324  */
 325 void
 326 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_Controller *controller)
 327 {
 328   GNUNET_break (0);
 329 }
 330
 331
 332 /**
 333  * Create a link from a 'master' controller to a slave controller.
 334  * Whenever the master controller is asked to start a peer at the
 335  * given 'delegated_host', it will delegate the request to the
 336  * specified slave controller.  Note that the slave controller runs at
 337  * the 'slave_host', which may or may not be the same host as the
 338  * 'delegated_host' (for hierarchical delegations).  The configuration
 339  * of the slave controller is given and to be used to either create
 340  * the slave controller or to connect to an existing slave controller
 341  * process.  'is_subordinate' specifies if the given slave controller
 342  * should be started and managed by the master controller, or if the
 343  * slave already has a master and this is just a secondary master that
 344  * is also allowed to use the existing slave.
 345  *
 346  * @param master handle to the master controller who creates the association
 347  * @param delegated_host requests to which host should be delegated
 348  * @param slave_host which host is used to run the slave controller
 349  * @param slave_cfg configuration to use for the slave controller
 350  * @param is_subordinate GNUNET_YES if the slave should be started (and stopped)
 351  *                       by the master controller; GNUNET_NO if we are just
 352  *                       allowed to use the slave via TCP/IP
 353  */
 354 void
 355 GNUNET_TESTBED_controller_link (struct GNUNET_TESTBED_Controller *master,
 356                                 struct GNUNET_TESTBED_Host *delegated_host,
 357                                 struct GNUNET_TESTBED_Host *slave_host,
 358                                 const struct GNUNET_CONFIGURATION_Handle *slave_cfg,
 359                                 int is_subordinate)
 360 {
 361   GNUNET_break (0);
 362 }
 363
 364
 365 /**
 366  * Ask the testbed controller to write the current overlay topology to
 367  * a file.  Naturally, the file will only contain a snapshot as the
 368  * topology may evolve all the time.
 369  *
 370  * @param controller overlay controller to inspect
 371  * @param filename name of the file the topology should
 372  *        be written to.
 373  */
 374 void
 375 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
 376                                                const char *filename)
 377 {
 378 }
 379
 380
 381
 382 /* end of testbed_api.c */