testbed.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_H
#define TESTBED_H
 
#include "gnunet_util_lib.h"
 
GNUNET_NETWORK_STRUCT_BEGIN
struct GNUNET_TESTBED_InitMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t host_id GNUNET_PACKED;
 
  uint64_t event_mask GNUNET_PACKED;
 
  /* Followed by 0-terminated hostname of the controller */
};
 
 
struct GNUNET_TESTBED_AddHostMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t host_id GNUNET_PACKED;
 
  uint16_t ssh_port GNUNET_PACKED;
 
  uint16_t username_length GNUNET_PACKED;
 
  uint16_t hostname_length GNUNET_PACKED;
 
  uint16_t config_size GNUNET_PACKED;
 
  /* followed by non 0-terminated user name */
 
  /* followed by non 0-terminated host name */
 
  /* followed by gzip compressed configuration to start or connect to a
     controller on this host.  While starting the controller this configuration
     is used as a template */
};
 
 
struct GNUNET_TESTBED_HostConfirmedMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t host_id GNUNET_PACKED;
 
  /* followed by the 0-terminated error message (on failure)
   * (typical errors include host-id already in use) */
};
 
 
struct GNUNET_TESTBED_ControllerLinkRequest
{
  struct GNUNET_MessageHeader header;
 
  uint32_t delegated_host_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  uint32_t slave_host_id GNUNET_PACKED;
 
  uint8_t is_subordinate;
};
 
 
struct GNUNET_TESTBED_ControllerLinkResponse
{
  struct GNUNET_MessageHeader header;
 
  uint16_t config_size GNUNET_PACKED;
 
  uint16_t success GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  /* If controller linking is successful and configuration is present, then here
   * comes the serialized gzip configuration with which the controller is
   * running at the delegate host */
 
  /* In case of failure, here comes the error message (without \0 termination)*/
};
 
 
struct GNUNET_TESTBED_PeerCreateMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t host_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint16_t config_size GNUNET_PACKED;
 
  /* followed by serialized peer configuration;
  * gzip'ed configuration file in INI format */
};
 
 
struct GNUNET_TESTBED_PeerReconfigureMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  uint16_t config_size GNUNET_PACKED;
 
  /* followed by serialized peer configuration;
  * gzip'ed configuration file in INI format */
};
 
 
struct GNUNET_TESTBED_PeerStartMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_PeerStopMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_PeerDestroyMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_ConfigureUnderlayLinkMessage
{
  struct GNUNET_MessageHeader header;
 
  int32_t connect_option GNUNET_PACKED;
 
  uint32_t peer1 GNUNET_PACKED;
 
  uint32_t peer2 GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  /* followed by option-dependent variable-size values */
};
 
 
struct GNUNET_TESTBED_OverlayConnectMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer1 GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  uint32_t peer2 GNUNET_PACKED;
 
  uint32_t peer2_host_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_RemoteOverlayConnectMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  struct GNUNET_PeerIdentity peer_identity;
 
  struct GNUNET_MessageHeader hello[0];
  // FIXME: we usually do not use this gcc-hack as some
  // compilers / tools really get messed up by it...
};
 
 
struct GNUNET_TESTBED_PeerEventMessage
{
  struct GNUNET_MessageHeader header;
 
  int32_t event_type GNUNET_PACKED;
 
  uint32_t host_id GNUNET_PACKED;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_ConnectionEventMessage
{
  struct GNUNET_MessageHeader header;
 
  int32_t event_type GNUNET_PACKED;
 
  uint32_t peer1 GNUNET_PACKED;
 
  uint32_t peer2 GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_OperationFailureEventMessage
{
  struct GNUNET_MessageHeader header;
 
  int32_t event_type GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  /* followed by 0-terminated error message */
};
 
 
struct GNUNET_TESTBED_PeerCreateSuccessEventMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_GenericOperationSuccessEventMessage
{
  struct GNUNET_MessageHeader header;
 
  int32_t event_type GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_PeerGetConfigurationMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_PeerConfigurationInformationMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  struct GNUNET_PeerIdentity peer_identity;
 
  uint16_t config_size GNUNET_PACKED;
 
  /* followed by gzip-compressed configuration of the peer */
};
 
 
struct GNUNET_TESTBED_SlaveGetConfigurationMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t slave_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_SlaveConfiguration
{
  struct GNUNET_MessageHeader header;
 
  uint32_t slave_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  uint16_t config_size GNUNET_PACKED;
 
  /* followed by gzip-compressed configuration of the peer */
};
 
 
struct GNUNET_TESTBED_ShutdownPeersMessage
{
  struct GNUNET_MessageHeader header;
 
  uint64_t operation_id GNUNET_PACKED;
};
 
 
struct GNUNET_TESTBED_ManagePeerServiceMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t peer_id GNUNET_PACKED;
 
  uint64_t operation_id GNUNET_PACKED;
 
  uint8_t start;
 
};
 
 
struct GNUNET_TESTBED_UnderlayLinkModelMsg
{
  struct GNUNET_MessageHeader header;
 
  uint32_t nentries GNUNET_PACKED;
 
  uint32_t nprops GNUNET_PACKED;
 
};
 
 
/**************************************/
/* Barriers IPC messages and protocol */
/**************************************/
 
 
#define ENV_TESTBED_CONFIG "GNUNET_TESTBED_CONTROLLER_CONFIG"
 
 
struct GNUNET_TESTBED_BarrierInit
{
  struct GNUNET_MessageHeader header;
 
  uint8_t quorum;
 
  char name[0];
};
 
 
struct GNUNET_TESTBED_BarrierCancel
{
  struct GNUNET_MessageHeader header;
 
  char name[0];
};
 
 
struct GNUNET_TESTBED_BarrierStatusMsg
{
  struct GNUNET_MessageHeader header;
 
  uint16_t status GNUNET_PACKED;
 
  uint16_t name_len GNUNET_PACKED;
 
  char data[0];
};
 
 
struct GNUNET_TESTBED_BarrierWait
{
  struct GNUNET_MessageHeader header;
 
  char name[0];
};
 
 
GNUNET_NETWORK_STRUCT_END
#endif
/* end of testbed.h */