testbed_api.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2008--2013 GNUnet e.V.
 
      GNUnet is free software: you can redistribute it and/or modify it
      under the terms of the GNU Affero General Public License as published
      by the Free Software Foundation, either version 3 of the License,
      or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      Affero General Public License for more details.
 
      You should have received a copy of the GNU Affero General Public License
      along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef TESTBED_API_H
#define TESTBED_API_H
 
#include "gnunet_util_lib.h"
#include "gnunet_testbed_service.h"
#include "testbed.h"
#include "testbed_helper.h"
 
#define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
 
 
enum OperationType
{
  OP_PEER_CREATE,
 
  OP_PEER_START,
 
  OP_PEER_STOP,
 
  OP_PEER_DESTROY,
 
  OP_PEER_INFO,
 
  OP_PEER_RECONFIGURE,
 
  OP_OVERLAY_CONNECT,
 
  OP_FORWARDED,
 
  OP_LINK_CONTROLLERS,
 
  OP_GET_SLAVE_CONFIG,
 
  OP_SHUTDOWN_PEERS,
 
  OP_MANAGE_SERVICE
};
 
 
enum OperationContextState
{
  OPC_STATE_INIT = 0,
 
  OPC_STATE_STARTED,
 
  OPC_STATE_FINISHED
};
 
 
struct OperationContext
{
  struct GNUNET_TESTBED_Controller *c;
 
  struct GNUNET_TESTBED_Operation *op;
 
  void *op_cls;
 
  void *data;
 
  uint64_t id;
 
  enum OperationType type;
 
  enum OperationContextState state;
};
 
 
typedef void
(*TESTBED_opcq_empty_cb) (void *cls);
 
 
struct GNUNET_TESTBED_Controller
{
  struct GNUNET_TESTBED_Host *host;
 
  GNUNET_TESTBED_ControllerCallback cc;
 
  void *cc_cls;
 
  struct GNUNET_CONFIGURATION_Handle *cfg;
 
  struct GNUNET_MQ_Handle *mq;
 
  struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 
  struct GNUNET_CONTAINER_MultiHashMap32 *opc_map;
 
  TESTBED_opcq_empty_cb opcq_empty_cb;
 
  void *opcq_empty_cls;
 
  struct OperationQueue *opq_parallel_operations;
 
  struct OperationQueue *opq_parallel_service_connections;
 
  struct OperationQueue *opq_parallel_topology_config_operations;
 
  struct GNUNET_CONTAINER_MultiHashMap *barrier_map;
 
  uint64_t event_mask;
 
  uint32_t operation_counter;
};
 
 
struct GNUNET_TESTBED_Barrier
{
  struct GNUNET_HashCode key;
 
  struct GNUNET_TESTBED_Controller *c;
 
  char *name;
 
  GNUNET_TESTBED_barrier_status_cb cb;
 
  void *cls;
 
  int echo;
};
 
 
void
GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
                               struct GNUNET_MessageHeader *msg);
 
 
void
GNUNET_TESTBED_insert_opc_ (struct GNUNET_TESTBED_Controller *c,
                            struct OperationContext *opc);
 
 
void
GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c,
                            struct OperationContext *opc);
 
 
size_t
GNUNET_TESTBED_compress_config_ (const char *config,
                                 size_t size,
                                 char **xconfig);
 
 
char *
GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg,
                              size_t *size,
                              size_t *xsize);
 
 
struct GNUNET_TESTBED_HelperInit *
GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
                                        const char *hostname,
                                        const struct
                                        GNUNET_CONFIGURATION_Handle *cfg);
 
 
struct OperationContext *
GNUNET_TESTBED_forward_operation_msg_ (struct
                                       GNUNET_TESTBED_Controller *controller,
                                       uint64_t operation_id,
                                       const struct GNUNET_MessageHeader *msg,
                                       GNUNET_MQ_MessageCallback cc,
                                       void *cc_cls);
 
void
GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
 
 
struct GNUNET_CONFIGURATION_Handle *
GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg);
 
 
const char *
GNUNET_TESTBED_parse_error_string_ (const struct
                                    GNUNET_TESTBED_OperationFailureEventMessage
                                    *msg);
 
 
uint64_t
GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller);
 
 
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_get_slave_config_ (void *op_cls,
                                  struct GNUNET_TESTBED_Controller *master,
                                  uint32_t slave_host_id);
 
 
struct GNUNET_TESTBED_Barrier *
GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller,
                              const char *name,
                              unsigned int quorum,
                              GNUNET_TESTBED_barrier_status_cb cb,
                              void *cls,
                              int echo);
 
 
void
GNUNET_TESTBED_barrier_remove_ (struct GNUNET_TESTBED_Barrier *barrier);
 
 
#endif
/* end of testbed_api.h */