cadet.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2001 - 2011 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 CADET_H_
#define CADET_H_

#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif

#include <stdint.h>

#if ! defined(GNUNET_CULL_LOGGING)
#define CADET_TIMING_START                 \
  struct GNUNET_TIME_Absolute __timestamp; \
  __timestamp = GNUNET_TIME_absolute_get ()

#define CADET_TIMING_END                                        \
  struct GNUNET_TIME_Relative __duration;                       \
  __duration = GNUNET_TIME_absolute_get_duration (__timestamp); \
  LOG (GNUNET_ERROR_TYPE_INFO,                                  \
       " %s duration %s\n",                                     \
       __FUNCTION__,                                            \
       GNUNET_STRINGS_relative_time_to_string (__duration, GNUNET_YES));
#else
#define CADET_TIMING_START
#define CADET_TIMING_END
#endif


#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_peer_lib.h"
#include "gnunet_core_service.h"
#include "gnunet_cadet_service.h"
#include "gnunet_protocols.h"
#include "gnunet_cadet_service.h"

/******************************************************************************/
/**************************       CONSTANTS      ******************************/
/******************************************************************************/

#define GNUNET_CADET_LOCAL_CHANNEL_ID_CLI 0x80000000U

#define HIGH_PID 0xFF000000

#define LOW_PID 0x00FFFFFF


#define PID_OVERFLOW(pid, max) (((pid) > HIGH_PID) && ((max) < LOW_PID))

/******************************************************************************/
/**************************        MESSAGES      ******************************/
/******************************************************************************/

GNUNET_NETWORK_STRUCT_BEGIN

struct GNUNET_CADET_ClientChannelNumber
{
  uint32_t channel_of_client GNUNET_PACKED;
};

struct GNUNET_CADET_Channel
{

  struct GNUNET_PeerIdentity peer;

  struct GNUNET_CADET_Handle *cadet;

  struct GNUNET_CADET_Port *incoming_port;

  void *ctx;

  struct GNUNET_MQ_Handle *mq;

  struct GNUNET_SCHEDULER_Task *mq_cont;

  struct GNUNET_MQ_Envelope *pending_env;

  GNUNET_CADET_WindowSizeEventHandler window_changes;

  GNUNET_CADET_DisconnectEventHandler disconnects;

  struct GNUNET_CADET_ClientChannelNumber ccn;

  unsigned int allow_send;
};

struct GNUNET_CADET_PortMessage
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_HashCode port GNUNET_PACKED;
};


struct GNUNET_CADET_LocalChannelCreateMessage
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_CADET_ClientChannelNumber ccn;

  struct GNUNET_PeerIdentity peer;

  struct GNUNET_HashCode port;

  uint32_t opt GNUNET_PACKED;
};


struct GNUNET_CADET_LocalChannelDestroyMessage
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_CADET_ClientChannelNumber ccn;
};


struct GNUNET_CADET_LocalData
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_CADET_ClientChannelNumber ccn;

  uint32_t pp GNUNET_PACKED;

};


struct GNUNET_CADET_LocalAck
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_CADET_ClientChannelNumber ccn;
};


struct GNUNET_CADET_LocalInfo
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_CADET_ClientChannelNumber ccn;

  struct GNUNET_PeerIdentity peer;
};

struct GNUNET_CADET_RequestDropCadetMessage
{

  struct GNUNET_MessageHeader header;

  uint16_t type;

  struct GNUNET_CADET_ClientChannelNumber ccn;

};

struct GNUNET_CADET_RequestPathInfoMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t resered GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;
};


struct GNUNET_CADET_ChannelInfoMessage
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_PeerIdentity root;

  struct GNUNET_PeerIdentity dest;

  /* FIXME: expand! */
};


struct GNUNET_CADET_RequestChannelInfoMessage
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_PeerIdentity target;
};


struct GNUNET_CADET_LocalInfoPath
{
  struct GNUNET_MessageHeader header;

  uint32_t off GNUNET_PACKED;
};


struct GNUNET_CADET_LocalInfoPeers
{
  struct GNUNET_MessageHeader header;

  uint16_t paths GNUNET_PACKED;

  int16_t tunnel GNUNET_PACKED;

  uint32_t best_path_length GNUNET_PACKED;

  struct GNUNET_PeerIdentity destination;
};


struct GNUNET_CADET_LocalInfoTunnel
{
  struct GNUNET_MessageHeader header;

  uint32_t channels GNUNET_PACKED;

  struct GNUNET_PeerIdentity destination;

  uint32_t connections GNUNET_PACKED;

  uint16_t estate GNUNET_PACKED;

  uint16_t cstate GNUNET_PACKED;

  /* If TUNNEL (no 'S'): struct GNUNET_CADET_ConnectionTunnelIdentifier connection_ids[connections] */
  /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */
};


GNUNET_NETWORK_STRUCT_END


char *
GC_f2s (int fwd);


int
GC_is_pid_bigger (uint32_t bigger, uint32_t smaller);


uint32_t
GC_max_pid (uint32_t a, uint32_t b);


uint32_t
GC_min_pid (uint32_t a, uint32_t b);


size_t
GC_bin2s (void *bin, unsigned int len, char **output);


const char *
GC_m2s (uint16_t m);

#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif

#endif