src/testbed/testbed_api_services.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, 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  * Data accessed during service connections
  56  */
  57 struct ServiceConnectData
  58 {
  59   /**
  60    * helper function callback to establish the connection
  61    */
  62   GNUNET_TESTBED_ConnectAdapter ca;
  63
  64   /**
  65    * helper function callback to close the connection
  66    */
  67   GNUNET_TESTBED_DisconnectAdapter da;
  68
  69   /**
  70    * Closure to the above callbacks
  71    */
  72   void *cada_cls;
  73
  74   /**
  75    * Service name
  76    */
  77   char *service_name;
  78
  79   /**
  80    * Closure for operation event
  81    */
  82   void *op_cls;
  83
  84   /**
  85    * The operation which created this structure
  86    */
  87   struct GNUNET_TESTBED_Operation *operation;
  88
  89   /**
  90    * The operation context from GNUNET_TESTBED_forward_operation_msg_()
  91    */
  92   struct OperationContext *opc;
  93
  94   /**
  95    * The peer handle
  96    */
  97   struct GNUNET_TESTBED_Peer *peer;
  98
  99   /**
 100    * The acquired configuration of the peer
 101    */
 102   struct GNUNET_CONFIGURATION_Handle *cfg;
 103
 104   /**
 105    * The op_result pointer from ConnectAdapter
 106    */
 107   void *op_result;
 108
 109   /**
 110    * The operation completion callback
 111    */
 112   GNUNET_TESTBED_ServiceConnectCompletionCallback cb;
 113
 114   /**
 115    * The closure for operation completion callback
 116    */
 117   void *cb_cls;
 118
 119   /**
 120    * State information
 121    */
 122   enum State state;
 123
 124 };
 125
 126
 127 /**
 128  * Type of a function to call when we receive a message
 129  * from the service.
 130  *
 131  * @param cls ServiceConnectData
 132  * @param msg message received, NULL on timeout or fatal error
 133  */
 134 static void
 135 configuration_receiver (void *cls, const struct GNUNET_MessageHeader *msg)
 136 {
 137   struct ServiceConnectData *data = cls;
 138   struct GNUNET_TESTBED_Controller *c;
 139   const char *emsg;
 140   struct GNUNET_TESTBED_EventInformation info;
 141   uint16_t mtype;
 142
 143   c = data->peer->controller;
 144   mtype = ntohs (msg->type);
 145   emsg = NULL;
 146   info.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
 147   info.op = data->operation;
 148   info.op_cls = data->op_cls;
 149   if (GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT == mtype)
 150   {
 151     emsg =
 152         GNUNET_TESTBED_parse_error_string_ ((const struct
 153                                              GNUNET_TESTBED_OperationFailureEventMessage
 154                                              *) msg);
 155     if (NULL == emsg)
 156       emsg = "Unknown error";
 157     info.details.operation_finished.emsg = emsg;
 158     info.details.operation_finished.generic = NULL;
 159     goto call_cb;
 160   }
 161   data->cfg = GNUNET_TESTBED_extract_config_ (msg);
 162   GNUNET_assert (NULL == data->op_result);
 163   data->op_result = data->ca (data->cada_cls, data->cfg);
 164   info.details.operation_finished.emsg = NULL;
 165   info.details.operation_finished.generic = data->op_result;
 166   data->state = SERVICE_CONNECTED;
 167
 168 call_cb:
 169   if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
 170       (NULL != c->cc))
 171     c->cc (c->cc_cls, &info);
 172   if (NULL != data->cb)
 173     data->cb (data->cb_cls, data->operation, data->op_result, emsg);
 174 }
 175
 176
 177 /**
 178  * Function called when a service connect operation is ready
 179  *
 180  * @param cls the closure from GNUNET_TESTBED_operation_create_()
 181  */
 182 static void
 183 opstart_service_connect (void *cls)
 184 {
 185   struct ServiceConnectData *data = cls;
 186   struct GNUNET_TESTBED_PeerGetConfigurationMessage *msg;
 187   struct GNUNET_TESTBED_Controller *c;
 188   uint64_t op_id;
 189
 190   GNUNET_assert (NULL != data);
 191   GNUNET_assert (NULL != data->peer);
 192   c = data->peer->controller;
 193   op_id = GNUNET_TESTBED_get_next_op_id (c);
 194   msg =
 195       GNUNET_TESTBED_generate_peergetconfig_msg_ (data->peer->unique_id, op_id);
 196   data->opc =
 197       GNUNET_TESTBED_forward_operation_msg_ (c, op_id, &msg->header,
 198                                              &configuration_receiver, data);
 199   GNUNET_free (msg);
 200   data->state = CFG_REQUEST_QUEUED;
 201 }
 202
 203
 204 /**
 205  * Callback which will be called when service connect type operation is
 206  * released
 207  *
 208  * @param cls the closure from GNUNET_TESTBED_operation_create_()
 209  */
 210 static void
 211 oprelease_service_connect (void *cls)
 212 {
 213   struct ServiceConnectData *data = cls;
 214
 215   switch (data->state)
 216   {
 217   case INIT:
 218     break;
 219   case CFG_REQUEST_QUEUED:
 220     GNUNET_assert (NULL != data->opc);
 221     GNUNET_TESTBED_forward_operation_msg_cancel_ (data->opc);
 222     break;
 223   case SERVICE_CONNECTED:
 224     GNUNET_assert (NULL != data->cfg);
 225     GNUNET_CONFIGURATION_destroy (data->cfg);
 226     if (NULL != data->da)
 227       data->da (data->cada_cls, data->op_result);
 228     break;
 229   }
 230   GNUNET_free (data);
 231 }
 232
 233
 234 /**
 235  * Connect to a service offered by the given peer.  Will ensure that
 236  * the request is queued to not overwhelm our ability to create and
 237  * maintain connections with other systems.  The actual service
 238  * handle is then returned via the 'op_result' member in the event
 239  * callback.  The 'ca' callback is used to create the connection
 240  * when the time is right; the 'da' callback will be used to
 241  * destroy the connection (upon 'GNUNET_TESTBED_operation_done').
 242  * 'GNUNET_TESTBED_operation_done' can be used to abort this
 243  * operation until the event callback has been called.
 244  *
 245  * @param op_cls closure to pass in operation event
 246  * @param peer peer that runs the service
 247  * @param service_name name of the service to connect to
 248  * @param cb the callback to call when this operation finishes
 249  * @param cb_cls closure for the above callback
 250  * @param ca helper function to establish the connection
 251  * @param da helper function to close the connection
 252  * @param cada_cls closure for ca and da
 253  * @return handle for the operation
 254  */
 255 struct GNUNET_TESTBED_Operation *
 256 GNUNET_TESTBED_service_connect (void *op_cls, struct GNUNET_TESTBED_Peer *peer,
 257                                 const char *service_name,
 258                                 GNUNET_TESTBED_ServiceConnectCompletionCallback
 259                                 cb, void *cb_cls,
 260                                 GNUNET_TESTBED_ConnectAdapter ca,
 261                                 GNUNET_TESTBED_DisconnectAdapter da,
 262                                 void *cada_cls)
 263 {
 264   struct ServiceConnectData *data;
 265
 266   data = GNUNET_new (struct ServiceConnectData);
 267   data->ca = ca;
 268   data->da = da;
 269   data->cada_cls = cada_cls;
 270   data->op_cls = op_cls;
 271   data->peer = peer;
 272   data->state = INIT;
 273   data->cb = cb;
 274   data->cb_cls = cb_cls;
 275   data->operation =
 276       GNUNET_TESTBED_operation_create_ (data, &opstart_service_connect,
 277                                         &oprelease_service_connect);
 278   GNUNET_TESTBED_operation_queue_insert_ (peer->
 279                                           controller->opq_parallel_service_connections,
 280                                           data->operation);
 281   GNUNET_TESTBED_operation_queue_insert_ (peer->
 282                                           controller->opq_parallel_operations,
 283                                           data->operation);
 284   GNUNET_TESTBED_operation_begin_wait_ (data->operation);
 285   return data->operation;
 286 }
 287
 288 /* end of testbed_api_services.c */