src/set/gnunet-service-set_protocol.h

   1 /*
   2      This file is part of GNUnet.
   3      (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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, 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 struct IBFMessage
  62 {
  63   /**
  64    * Type: #GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF
  65    */
  66   struct GNUNET_MessageHeader header;
  67
  68   /**
  69    * Order of the whole ibf, where
  70    * num_buckets = 2^order
  71    */
  72   uint8_t order;
  73
  74   /**
  75    * Padding, must be 0.
  76    */
  77   uint8_t reserved;
  78
  79   /**
  80    * Offset of the strata in the rest of the message
  81    */
  82   uint16_t offset GNUNET_PACKED;
  83
  84   /**
  85    * Salt used when hashing elements for this IBF.
  86    */
  87   uint32_t salt GNUNET_PACKED;
  88
  89   /* rest: strata */
  90 };
  91
  92
  93 /**
  94  * During intersection, the first (and possibly second) message
  95  * send it the number of elements in the set, to allow the peers
  96  * to decide who should start with the Bloom filter.
  97  */
  98 struct IntersectionElementInfoMessage
  99 {
 100   /**
 101    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO
 102    */
 103   struct GNUNET_MessageHeader header;
 104
 105   /**
 106    * mutator used with this bloomfilter.
 107    */
 108   uint32_t sender_element_count GNUNET_PACKED;
 109
 110 };
 111
 112
 113 /**
 114  * Bloom filter messages exchanged for set intersection calculation.
 115  */
 116 struct BFMessage
 117 {
 118   /**
 119    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF
 120    */
 121   struct GNUNET_MessageHeader header;
 122
 123   /**
 124    * Number of elements the sender still has in the set.
 125    */
 126   uint32_t sender_element_count GNUNET_PACKED;
 127
 128   /**
 129    * XOR of all hashes over all elements remaining in the set.
 130    * Used to determine termination.
 131    */
 132   struct GNUNET_HashCode element_xor_hash;
 133
 134   /**
 135    * Mutator used with this bloomfilter.
 136    */
 137   uint32_t sender_mutator GNUNET_PACKED;
 138
 139   /**
 140    * Total length of the bloomfilter data.
 141    */
 142   uint32_t bloomfilter_total_length GNUNET_PACKED;
 143
 144   /**
 145    * Number of bits (k-value) used in encoding the bloomfilter.
 146    */
 147   uint32_t bits_per_element GNUNET_PACKED;
 148
 149   /**
 150    * rest: the sender's bloomfilter
 151    */
 152 };
 153
 154
 155 /**
 156  * Last message, send to confirm the final set.  Contains the element
 157  * count as it is possible that the peer determined that we were done
 158  * by getting the empty set, which in that case also needs to be
 159  * communicated.
 160  */
 161 struct IntersectionDoneMessage
 162 {
 163   /**
 164    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_DONE
 165    */
 166   struct GNUNET_MessageHeader header;
 167
 168   /**
 169    * Final number of elements in intersection.
 170    */
 171   uint32_t final_element_count GNUNET_PACKED;
 172
 173   /**
 174    * XOR of all hashes over all elements remaining in the set.
 175    */
 176   struct GNUNET_HashCode element_xor_hash;
 177 };
 178
 179 GNUNET_NETWORK_STRUCT_END
 180
 181 #endif