src/set/gnunet-service-set_protocol.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2013, 2014 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @author Florian Dold
  22  * @author Christian Grothoff
  23  * @file set/gnunet-service-set_protocol.h
  24  * @brief Peer-to-Peer messages for gnunet set
  25  */
  26 #ifndef SET_PROTOCOL_H
  27 #define SET_PROTOCOL_H
  28
  29 #include "platform.h"
  30 #include "gnunet_common.h"
  31
  32
  33 GNUNET_NETWORK_STRUCT_BEGIN
  34
  35 struct OperationRequestMessage
  36 {
  37   /**
  38    * Type: #GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
  39    */
  40   struct GNUNET_MessageHeader header;
  41
  42   /**
  43    * Operation to request, values from `enum GNUNET_SET_OperationType`
  44    */
  45   uint32_t operation GNUNET_PACKED;
  46
  47   /**
  48    * For Intersection: my element count
  49    */
  50   uint32_t element_count GNUNET_PACKED;
  51
  52   /**
  53    * Application-specific identifier of the request.
  54    */
  55   struct GNUNET_HashCode app_id;
  56
  57   /* rest: optional message */
  58 };
  59
  60
  61 /**
  62  * Message containing buckets of an invertible bloom filter.
  63  *
  64  * If an IBF has too many buckets for an IBF message,
  65  * it is split into multiple messages.
  66  */
  67 struct IBFMessage
  68 {
  69   /**
  70    * Type: #GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF
  71    */
  72   struct GNUNET_MessageHeader header;
  73
  74   /**
  75    * Order of the whole ibf, where
  76    * num_buckets = 2^order
  77    */
  78   uint8_t order;
  79
  80   /**
  81    * Padding, must be 0.
  82    */
  83   uint8_t reserved;
  84
  85   /**
  86    * Offset of the strata in the rest of the message
  87    */
  88   uint16_t offset GNUNET_PACKED;
  89
  90   /**
  91    * Salt used when hashing elements for this IBF.
  92    */
  93   uint32_t salt GNUNET_PACKED;
  94
  95   /* rest: buckets */
  96 };
  97
  98
  99 /**
 100  * During intersection, the first (and possibly second) message
 101  * send it the number of elements in the set, to allow the peers
 102  * to decide who should start with the Bloom filter.
 103  */
 104 struct IntersectionElementInfoMessage
 105 {
 106   /**
 107    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO
 108    */
 109   struct GNUNET_MessageHeader header;
 110
 111   /**
 112    * mutator used with this bloomfilter.
 113    */
 114   uint32_t sender_element_count GNUNET_PACKED;
 115
 116 };
 117
 118
 119 /**
 120  * Bloom filter messages exchanged for set intersection calculation.
 121  */
 122 struct BFMessage
 123 {
 124   /**
 125    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF
 126    */
 127   struct GNUNET_MessageHeader header;
 128
 129   /**
 130    * Number of elements the sender still has in the set.
 131    */
 132   uint32_t sender_element_count GNUNET_PACKED;
 133
 134   /**
 135    * XOR of all hashes over all elements remaining in the set.
 136    * Used to determine termination.
 137    */
 138   struct GNUNET_HashCode element_xor_hash;
 139
 140   /**
 141    * Mutator used with this bloomfilter.
 142    */
 143   uint32_t sender_mutator GNUNET_PACKED;
 144
 145   /**
 146    * Total length of the bloomfilter data.
 147    */
 148   uint32_t bloomfilter_total_length GNUNET_PACKED;
 149
 150   /**
 151    * Number of bits (k-value) used in encoding the bloomfilter.
 152    */
 153   uint32_t bits_per_element GNUNET_PACKED;
 154
 155   /**
 156    * rest: the sender's bloomfilter
 157    */
 158 };
 159
 160
 161 /**
 162  * Last message, send to confirm the final set.  Contains the element
 163  * count as it is possible that the peer determined that we were done
 164  * by getting the empty set, which in that case also needs to be
 165  * communicated.
 166  */
 167 struct IntersectionDoneMessage
 168 {
 169   /**
 170    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_DONE
 171    */
 172   struct GNUNET_MessageHeader header;
 173
 174   /**
 175    * Final number of elements in intersection.
 176    */
 177   uint32_t final_element_count GNUNET_PACKED;
 178
 179   /**
 180    * XOR of all hashes over all elements remaining in the set.
 181    */
 182   struct GNUNET_HashCode element_xor_hash;
 183 };
 184
 185 GNUNET_NETWORK_STRUCT_END
 186
 187 #endif