src/testbed/testbed_api_services.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_services.c
  23  * @brief convenience functions for accessing services
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "testbed_api.h"
  28 #include "testbed_api_peers.h"
  29 #include "testbed_api_operations.h"
  30
  31
  32 /**
  33  * States for Service connect operations
  34  */
  35 enum State
  36 {
  37     /**
  38      * Initial state
  39      */
  40   INIT,
  41
  42     /**
  43      * The configuration request has been sent
  44      */
  45   CFG_REQUEST_QUEUED,
  46
  47     /**
  48      * connected to service
  49      */
  50   SERVICE_CONNECTED,
  51
  52 };
  53
  54
  55 /**
  56  * Data accessed during service connections
  57  */
  58 struct ServiceConnectData
  59 {
  60   /**
  61    * helper function callback to establish the connection
  62    */
  63   GNUNET_TESTBED_ConnectAdapter ca;
  64
  65   /**
  66    * helper function callback to close the connection
  67    */
  68   GNUNET_TESTBED_DisconnectAdapter da;
  69
  70   /**
  71    * Closure to the above callbacks
  72    */
  73   void *cada_cls;
  74
  75   /**
  76    * Service name
  77    */
  78   char *service_name;
  79
  80   /**
  81    * Closure for operation event
  82    */
  83   void *op_cls;
  84
  85   /**
  86    * The operation which created this structure
  87    */
  88   struct GNUNET_TESTBED_Operation *operation;
  89
  90   /**
  91    * The operation context from GNUNET_TESTBED_forward_operation_msg_()
  92    */
  93   struct OperationContext *opc;
  94
  95   /**
  96    * The peer handle
  97    */
  98   struct GNUNET_TESTBED_Peer *peer;
  99
 100   /**
 101    * The acquired configuration of the peer
 102    */
 103   struct GNUNET_CONFIGURATION_Handle *cfg;
 104
 105   /**
 106    * The op_result pointer from ConnectAdapter
 107    */
 108   void *op_result;
 109
 110   /**
 111    * The operation completion callback
 112    */
 113   GNUNET_TESTBED_ServiceConnectCompletionCallback cb;
 114
 115   /**
 116    * The closure for operation completion callback
 117    */
 118   void *cb_cls;
 119
 120   /**
 121    * State information
 122    */
 123   enum State state;
 124
 125 };
 126
 127
 128 /**
 129  * Type of a function to call when we receive a message
 130  * from the service.
 131  *
 132  * @param cls ServiceConnectData
 133  * @param msg message received, NULL on timeout or fatal error
 134  */
 135 static void
 136 configuration_receiver (void *cls, const struct GNUNET_MessageHeader *msg)
 137 {
 138   struct ServiceConnectData *data = cls;
 139   const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *imsg;
 140   struct GNUNET_TESTBED_Controller *c;
 141   struct GNUNET_TESTBED_EventInformation info;
 142   uint16_t mtype;
 143
 144   mtype = ntohs (msg->type);
 145   if (GNUNET_MESSAGE_TYPE_TESTBED_OPERATIONFAILEVENT == mtype)
 146   {
 147     GNUNET_assert (0);          /* FIXME: Add notification for failure */
 148   }
 149   imsg =
 150       (const struct GNUNET_TESTBED_PeerConfigurationInformationMessage *) msg;
 151   data->cfg = GNUNET_TESTBED_get_config_from_peerinfo_msg_ (imsg);
 152   data->op_result = data->ca (data->cada_cls, data->cfg);
 153   info.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
 154   info.details.operation_finished.operation = data->operation;
 155   info.details.operation_finished.op_cls = data->op_cls;
 156   info.details.operation_finished.emsg = NULL;
 157   info.details.operation_finished.generic = data->op_result;
 158   c = data->peer->controller;
 159   data->state = SERVICE_CONNECTED;
 160   if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
 161       (NULL != c->cc))
 162     c->cc (c->cc_cls, &info);
 163   if (NULL != data->cb)
 164     data->cb (data->cb_cls, data->operation, data->op_result, NULL);
 165 }
 166
 167
 168 /**
 169  * Function called when a service connect operation is ready
 170  *
 171  * @param cls the closure from GNUNET_TESTBED_operation_create_()
 172  */
 173 static void
 174 opstart_service_connect (void *cls)
 175 {
 176   struct ServiceConnectData *data = cls;
 177   struct GNUNET_TESTBED_PeerGetConfigurationMessage *msg;
 178   struct GNUNET_TESTBED_Controller *c;
 179   uint64_t op_id;
 180
 181   GNUNET_assert (NULL != data);
 182   GNUNET_assert (NULL != data->peer);
 183   c = data->peer->controller;
 184   op_id = c->operation_counter++;
 185   msg =
 186       GNUNET_TESTBED_generate_peergetconfig_msg_ (data->peer->unique_id, op_id);
 187   data->opc =
 188       GNUNET_TESTBED_forward_operation_msg_ (c, op_id, &msg->header,
 189                                              &configuration_receiver, data);
 190   GNUNET_free (msg);
 191   data->state = CFG_REQUEST_QUEUED;
 192 }
 193
 194
 195 /**
 196  * Callback which will be called when service connect type operation is
 197  * released
 198  *
 199  * @param cls the closure from GNUNET_TESTBED_operation_create_()
 200  */
 201 static void
 202 oprelease_service_connect (void *cls)
 203 {
 204   struct ServiceConnectData *data = cls;
 205
 206   switch (data->state)
 207   {
 208   case INIT:
 209     break;
 210   case CFG_REQUEST_QUEUED:
 211     GNUNET_assert (NULL != data->opc);
 212     GNUNET_TESTBED_forward_operation_msg_cancel_ (data->opc);
 213     break;
 214   case SERVICE_CONNECTED:
 215     GNUNET_assert (NULL != data->cfg);
 216     GNUNET_CONFIGURATION_destroy (data->cfg);
 217     if (NULL != data->da)
 218       data->da (data->cada_cls, data->op_result);
 219     break;
 220   }
 221   GNUNET_free (data);
 222 }
 223
 224
 225 /**
 226  * Connect to a service offered by the given peer.  Will ensure that
 227  * the request is queued to not overwhelm our ability to create and
 228  * maintain connections with other systems.  The actual service
 229  * handle is then returned via the 'op_result' member in the event
 230  * callback.  The 'ca' callback is used to create the connection
 231  * when the time is right; the 'da' callback will be used to
 232  * destroy the connection (upon 'GNUNET_TESTBED_operation_done').
 233  * 'GNUNET_TESTBED_operation_cancel' can be used to abort this
 234  * operation until the event callback has been called.
 235  *
 236  * @param op_cls closure to pass in operation event
 237  * @param peer peer that runs the service
 238  * @param service_name name of the service to connect to
 239  * @param cb the callback to call when this operation finishes
 240  * @param cb_cls closure for the above callback
 241  * @param ca helper function to establish the connection
 242  * @param da helper function to close the connection
 243  * @param cada_cls closure for ca and da
 244  * @return handle for the operation
 245  */
 246 struct GNUNET_TESTBED_Operation *
 247 GNUNET_TESTBED_service_connect (void *op_cls,
 248                                 struct GNUNET_TESTBED_Peer *peer,
 249                                 const char *service_name,
 250                                 GNUNET_TESTBED_ServiceConnectCompletionCallback cb,
 251                                 void *cb_cls,
 252                                 GNUNET_TESTBED_ConnectAdapter ca,
 253                                 GNUNET_TESTBED_DisconnectAdapter da,
 254                                 void *cada_cls)
 255 {
 256   struct ServiceConnectData *data;
 257
 258   data = GNUNET_malloc (sizeof (struct ServiceConnectData));
 259   data->ca = ca;
 260   data->da = da;
 261   data->cada_cls = cada_cls;
 262   data->op_cls = op_cls;
 263   data->peer = peer;
 264   data->state = INIT;
 265   data->cb = cb;
 266   data->cb_cls = cb_cls;
 267   data->operation =
 268       GNUNET_TESTBED_operation_create_ (data, &opstart_service_connect,
 269                                         &oprelease_service_connect);
 270   GNUNET_TESTBED_operation_queue_insert_ (peer->
 271                                           controller->opq_parallel_service_connections,
 272                                           data->operation);
 273   GNUNET_TESTBED_operation_queue_insert_ (peer->
 274                                           controller->opq_parallel_operations,
 275                                           data->operation);
 276   return data->operation;
 277 }
 278
 279 /* end of testbed_api_services.c */