summaryrefslogtreecommitdiff
path: root/src/set/gnunet-service-set_union.c
blob: 05b125047a422e0838753b9bc2a5ee70d5456f70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
/*
      This file is part of GNUnet
      (C) 2013 Christian Grothoff (and other contributing authors)

      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
      by the Free Software Foundation; either version 2, 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
      General Public License for more details.

      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
      Boston, MA 02111-1307, USA.
*/

/**
 * @file set/gnunet-service-set.c
 * @brief two-peer set operations
 * @author Florian Dold
 */


#include "gnunet-service-set.h"
#include "gnunet_container_lib.h"
#include "gnunet_crypto_lib.h"
#include "ibf.h"
#include "strata_estimator.h"
#include "set_protocol.h"
#include <gcrypt.h>


/**
 * Number of IBFs in a strata estimator.
 */
#define SE_STRATA_COUNT 32
/**
 * Size of the IBFs in the strata estimator.
 */
#define SE_IBF_SIZE 80
/**
 * hash num parameter for the difference digests and strata estimators
 */
#define SE_IBF_HASH_NUM 3

/**
 * Number of buckets that can be transmitted in one message.
 */
#define MAX_BUCKETS_PER_MESSAGE ((1<<15) / IBF_BUCKET_SIZE)

/**
 * The maximum size of an ibf we use is 2^(MAX_IBF_ORDER).
 * Choose this value so that computing the IBF is still cheaper
 * than transmitting all values.
 */
#define MAX_IBF_ORDER (16)


/**
 * Current phase we are in for a union operation
 */
enum UnionOperationPhase
{
  /**
   * We sent the request message, and expect a strata estimator
   */
  PHASE_EXPECT_SE,
  /**
   * We sent the strata estimator, and expect an IBF
   */
  PHASE_EXPECT_IBF,
  /**
   * We know what type of IBF the other peer wants to send us,
   * and expect the remaining parts
   */
  PHASE_EXPECT_IBF_CONT,
  /**
   * We are sending request and elements,
   * and thus only expect elements from the other peer.
   */
  PHASE_EXPECT_ELEMENTS,
  /**
   * We are expecting elements and requests, and send
   * requested elements back to the other peer.
   */
  PHASE_EXPECT_ELEMENTS_AND_REQUESTS,
  /**
   * The protocol is over.
   * Results may still have to be sent to the client.
   */
  PHASE_FINISHED
};


/**
 * State of an evaluate operation
 * with another peer.
 */
struct UnionEvaluateOperation
{
  /**
   * Local set the operation is evaluated on.
   */
  struct Set *set;

  /**
   * Peer with the remote set
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * Application-specific identifier
   */
  struct GNUNET_HashCode app_id;

  /**
   * Context message, given to us
   * by the client, may be NULL.
   */
  struct GNUNET_MessageHeader *context_msg;

  /**
   * Stream socket connected to the other peer
   */
  struct GNUNET_STREAM_Socket *socket;

  /**
   * Message queue for the peer on the other
   * end
   */
  struct GNUNET_MQ_MessageQueue *mq;

  /**
   * Request ID to multiplex set operations to
   * the client inhabiting the set.
   */
  uint32_t request_id;

  /**
   * Number of ibf buckets received
   */
  unsigned int ibf_buckets_received;

  /**
   * Copy of the set's strata estimator at the time of
   * creation of this operation
   */
  struct StrataEstimator *se;

  /**
   * The ibf we currently receive
   */
  struct InvertibleBloomFilter *remote_ibf;

  /**
   * IBF of the set's element.
   */
  struct InvertibleBloomFilter *local_ibf;

  /**
   * Maps IBF-Keys (specific to the current salt) to elements.
   */
  struct GNUNET_CONTAINER_MultiHashMap32 *key_to_element;

  /**
   * Current state of the operation.
   */
  enum UnionOperationPhase phase;

  /**
   * Salt to use for this operation.
   */
  uint16_t salt;

  /**
   * Generation in which the operation handle
   * was created.
   */
  unsigned int generation_created;
  
  /**
   * Evaluate operations are held in
   * a linked list.
   */
  struct UnionEvaluateOperation *next;
  
   /**
   * Evaluate operations are held in
   * a linked list.
   */
  struct UnionEvaluateOperation *prev;
};


/**
 * Information about the element in a set.
 * All elements are stored in a hash-table
 * from their hash-code to their 'struct Element',
 * so that the remove and add operations are reasonably
 * fast.
 */
struct ElementEntry
{
  /**
   * The actual element. The data for the element
   * should be allocated at the end of this struct.
   */
  struct GNUNET_SET_Element element;

  /**
   * Hash of the element.
   * Will be used to derive the different IBF keys
   * for different salts.
   */
  struct GNUNET_HashCode element_hash;

  /**
   * Generation the element was added by the client.
   * Operations of earlier generations will not consider the element.
   */
  unsigned int generation_added;

  /**
   * GNUNET_YES if the element has been removed in some generation.
   */
  int removed;

  /**
   * Generation the element was removed by the client. 
   * Operations of later generations will not consider the element.
   * Only valid if is_removed is GNUNET_YES.
   */
  unsigned int generation_removed;

  /**
   * GNUNET_YES if the element is a remote element, and does not belong
   * to the operation's set.
   */
  int remote;
};


/**
 * Information about the element used for 
 * a specific union operation.
 */
struct KeyEntry
{
  /**
   * IBF key for the entry, derived from the current salt.
   */
  struct IBF_Key ibf_key;

  /**
   * The actual element associated with the key
   */
  struct ElementEntry *element;

  /**
   * Element that collides with this element
   * on the ibf key
   */
  struct KeyEntry *next_colliding;
};

/**
 * Used as a closure for sending elements
 * with a specific IBF key.
 */
struct SendElementClosure
{
  /**
   * The IBF key whose matching elements should be
   * sent.
   */
  struct IBF_Key ibf_key;

  /**
   * Operation for which the elements
   * should be sent.
   */
  struct UnionEvaluateOperation *eo;
};


/**
 * Extra state required for efficient set union.
 */
struct UnionState
{
  /**
   * The strata estimator is only generated once for
   * each set.
   * The IBF keys are derived from the element hashes with
   * salt=0.
   */
  struct StrataEstimator *se;

  /**
   * Maps 'struct GNUNET_HashCode' to 'struct ElementEntry'.
   */
  struct GNUNET_CONTAINER_MultiHashMap *elements;

  /**
   * Evaluate operations are held in
   * a linked list.
   */
  struct UnionEvaluateOperation *ops_head;

  /**
   * Evaluate operations are held in
   * a linked list.
   */
  struct UnionEvaluateOperation *ops_tail;

  /**
   * Current generation, that is, number of
   * previously executed operations on this set
   */
  unsigned int current_generation;
};



/**
 * Iterator over hash map entries.
 *
 * @param cls closure
 * @param key current key code
 * @param value value in the hash map
 * @return GNUNET_YES if we should continue to
 *         iterate,
 *         GNUNET_NO if not.
 */
static int
destroy_elements_iterator (void *cls,
                           const struct GNUNET_HashCode * key,
                           void *value)
{
  struct ElementEntry *ee = value;

  GNUNET_free (ee);
  return GNUNET_YES;
}


/**
 * Destroy the elements belonging to a union set.
 *
 * @param us union state that contains the elements
 */
static void
destroy_elements (struct UnionState *us)
{
  if (NULL == us->elements)
    return;
  GNUNET_CONTAINER_multihashmap_iterate (us->elements, destroy_elements_iterator, NULL);
  GNUNET_CONTAINER_multihashmap_destroy (us->elements);
  us->elements = NULL;
}



/**
 * Iterator over hash map entries.
 *
 * @param cls closure
 * @param key current key code
 * @param value value in the hash map
 * @return GNUNET_YES if we should continue to
 *         iterate,
 *         GNUNET_NO if not.
 */
static int
destroy_key_to_element_iter (void *cls,
                             uint32_t key,
                             void *value)
{
  struct KeyEntry *k = value;
  
  while (NULL != k)
  {
    struct KeyEntry *k_tmp = k;
    k = k->next_colliding;
    GNUNET_free (k_tmp);
  }
  return GNUNET_YES;
}


/**
 * Destroy a union operation, and free all resources
 * associated with it.
 *
 * @param eo the union operation to destroy
 */
static void
destroy_union_operation (struct UnionEvaluateOperation *eo)
{
  if (NULL != eo->mq)
  {
    GNUNET_MQ_destroy (eo->mq);
    eo->mq = NULL;
  }
  if (NULL != eo->socket)
  {
    GNUNET_STREAM_close (eo->socket);
    eo->socket = NULL;
  }
  if (NULL != eo->remote_ibf)
  {
    ibf_destroy (eo->remote_ibf);
    eo->remote_ibf = NULL;
  }
  if (NULL != eo->local_ibf)
  {
    ibf_destroy (eo->local_ibf);
    eo->local_ibf = NULL;
  }
  if (NULL != eo->se)
  {
    strata_estimator_destroy (eo->se);
    eo->se = NULL;
  }
  if (NULL != eo->key_to_element)
  {
    GNUNET_CONTAINER_multihashmap32_iterate (eo->key_to_element, destroy_key_to_element_iter, NULL);
    GNUNET_CONTAINER_multihashmap32_destroy (eo->key_to_element);
    eo->key_to_element = NULL;
  }


  GNUNET_CONTAINER_DLL_remove (eo->set->state.u->ops_head,
                               eo->set->state.u->ops_tail,
                               eo);
  GNUNET_free (eo);
  /* FIXME: free and destroy everything else */
}


/**
 * Inform the client that the union operation has failed,
 * and proceed to destroy the evaluate operation.
 *
 * @param eo the union operation to fail
 */
static void
fail_union_operation (struct UnionEvaluateOperation *eo)
{
  struct GNUNET_MQ_Message *mqm;
  struct ResultMessage *msg;

  mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_RESULT);
  msg->result_status = htons (GNUNET_SET_STATUS_FAILURE);
  msg->request_id = htonl (eo->request_id);
  GNUNET_MQ_send (eo->set->client_mq, mqm);
  destroy_union_operation (eo);
}


/**
 * Derive the IBF key from a hash code and 
 * a salt.
 *
 * @param src the hash code
 * @param salt salt to use
 * @return the derived IBF key
 */
static struct IBF_Key
get_ibf_key (struct GNUNET_HashCode *src, uint16_t salt)
{
  struct IBF_Key key;

  GNUNET_CRYPTO_hkdf (&key, sizeof (key),
		      GCRY_MD_SHA512, GCRY_MD_SHA256,
                      src, sizeof *src,
		      &salt, sizeof (salt),
		      NULL, 0);
  return key;
}


/**
 * Send a request for the evaluate operation to a remote peer
 *
 * @param eo operation with the other peer
 */
static void
send_operation_request (struct UnionEvaluateOperation *eo)
{
  struct GNUNET_MQ_Message *mqm;
  struct OperationRequestMessage *msg;

  mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST);
  if (NULL != eo->context_msg)
    if (GNUNET_OK != GNUNET_MQ_nest (mqm, eo->context_msg, ntohs (eo->context_msg->size)))
    {
      /* the context message is too large */
      GNUNET_break (0);
      GNUNET_SERVER_client_disconnect (eo->set->client);
      GNUNET_MQ_discard (mqm);
      return;
    }
  msg->operation = htons (GNUNET_SET_OPERATION_UNION);
  msg->app_id = eo->app_id;
  GNUNET_MQ_send (eo->mq, mqm);

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "sent op request\n");
}


/**
 * Iterator to create the mapping between ibf keys
 * and element entries.
 *
 * @param cls closure
 * @param key current key code
 * @param value value in the hash map
 * @return GNUNET_YES if we should continue to
 *         iterate,
 *         GNUNET_NO if not.
 */
static int
insert_element_iterator (void *cls,
                         uint32_t key,
                         void *value)
{
  struct KeyEntry *const new_k = cls;
  struct KeyEntry *old_k = value;

  GNUNET_assert (NULL != old_k);
  do
  {
    if (old_k->ibf_key.key_val == new_k->ibf_key.key_val)
    {
      new_k->next_colliding = old_k;
      old_k->next_colliding = new_k;
      return GNUNET_NO;
    }
    old_k = old_k->next_colliding;
  } while (NULL != old_k);
  return GNUNET_YES;
}


/**
 * Insert an element into the union operation's
 * key-to-element mapping
 *
 * @param the union operation
 * @param ee the element entry
 */
static void
insert_element (struct UnionEvaluateOperation *eo, struct ElementEntry *ee)
{
  int ret;
  struct IBF_Key ibf_key;
  struct KeyEntry *k;

  ibf_key = get_ibf_key (&ee->element_hash, eo->salt);
  k = GNUNET_new (struct KeyEntry);
  k->element = ee;
  k->ibf_key = ibf_key;
  ret = GNUNET_CONTAINER_multihashmap32_get_multiple (eo->key_to_element,
                                                      (uint32_t) ibf_key.key_val,
                                                      insert_element_iterator, k);
  /* was the element inserted into a colliding bucket? */
  if (GNUNET_SYSERR == ret)
  {
    GNUNET_assert (NULL != k->next_colliding);
    return;
  }
  GNUNET_CONTAINER_multihashmap32_put (eo->key_to_element, (uint32_t) ibf_key.key_val, k,
                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
}


/**
 * Insert a key into an ibf.
 *
 * @param cls the ibf
 * @param key unused
 * @param value the key entry to get the key from
 */
static int
prepare_ibf_iterator (void *cls,
                      uint32_t key,
                      void *value)
{
  struct InvertibleBloomFilter *ibf = cls;
  struct KeyEntry *ke = value;

  ibf_insert (ibf, ke->ibf_key);
  return GNUNET_YES;
}


/**
 * Iterator for initializing the
 * key-to-element mapping of a union operation
 *
 * @param cls the union operation
 * @param key unised
 * @param value the element entry to insert
 *        into the key-to-element mapping
 */
static int
init_key_to_element_iterator (void *cls,
                              const struct GNUNET_HashCode *key,
                              void *value)
{
  struct UnionEvaluateOperation *eo = cls;
  struct ElementEntry *e = value;

  /* make sure that the element belongs to the set at the time
   * of creating the operation */
  if ( (e->generation_added > eo->generation_created) ||
       ( (GNUNET_YES == e->removed) &&
         (e->generation_removed < eo->generation_created)))
    return GNUNET_YES;

  insert_element (eo, e);
  return GNUNET_YES;
}


/**
 * Create an ibf with the operation's elements
 * of the specified size
 *
 * @param eo the union operation
 * @param size size of the ibf to create
 */
static void
prepare_ibf (struct UnionEvaluateOperation *eo, uint16_t size)
{
  if (NULL == eo->key_to_element)
  {
    unsigned int len;
    len = GNUNET_CONTAINER_multihashmap_size (eo->set->state.u->elements);
    eo->key_to_element = GNUNET_CONTAINER_multihashmap32_create (len + 1);
    GNUNET_CONTAINER_multihashmap_iterate (eo->set->state.u->elements,
                                             init_key_to_element_iterator, eo);
  }
  if (NULL != eo->local_ibf)
    ibf_destroy (eo->local_ibf);
  eo->local_ibf = ibf_create (size, SE_IBF_HASH_NUM);
  GNUNET_CONTAINER_multihashmap32_iterate (eo->key_to_element,
                                           prepare_ibf_iterator, eo->local_ibf);
}


/**
 * Send an ibf of appropriate size.
 *
 * @param eo the union operation
 * @param ibf_order order of the ibf to send, size=2^order
 */
static void
send_ibf (struct UnionEvaluateOperation *eo, uint16_t ibf_order)
{
  unsigned int buckets_sent = 0;
  struct InvertibleBloomFilter *ibf;

  prepare_ibf (eo, 1<<ibf_order);

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "sending ibf of size %u\n", 1<<ibf_order);

  ibf = eo->local_ibf;

  while (buckets_sent < (1 << ibf_order))
  {
    unsigned int buckets_in_message;
    struct GNUNET_MQ_Message *mqm;
    struct IBFMessage *msg;

    buckets_in_message = (1 << ibf_order) - buckets_sent;
    /* limit to maximum */
    if (buckets_in_message > MAX_BUCKETS_PER_MESSAGE)
      buckets_in_message = MAX_BUCKETS_PER_MESSAGE;

    mqm = GNUNET_MQ_msg_extra (msg, buckets_in_message * IBF_BUCKET_SIZE,
                               GNUNET_MESSAGE_TYPE_SET_P2P_IBF);
    msg->order = ibf_order;
    msg->offset = htons (buckets_sent);
    ibf_write_slice (ibf, buckets_sent,
                     buckets_in_message, &msg[1]);
    buckets_sent += buckets_in_message;
    GNUNET_MQ_send (eo->mq, mqm);
  }

  eo->phase = PHASE_EXPECT_ELEMENTS_AND_REQUESTS;
}


/**
 * Send a strata estimator to the remote peer.
 *
 * @param eo the union operation with the remote peer
 */
static void
send_strata_estimator (struct UnionEvaluateOperation *eo)
{
  struct GNUNET_MQ_Message *mqm;
  struct GNUNET_MessageHeader *strata_msg;

  mqm = GNUNET_MQ_msg_header_extra (strata_msg,
                                    SE_STRATA_COUNT * IBF_BUCKET_SIZE * SE_IBF_SIZE,
                                    GNUNET_MESSAGE_TYPE_SET_P2P_SE);
  strata_estimator_write (eo->set->state.u->se, &strata_msg[1]);
  GNUNET_MQ_send (eo->mq, mqm);
  eo->phase = PHASE_EXPECT_IBF;
}


/**
 * Compute the necessary order of an ibf
 * from the size of the symmetric set difference.
 *
 * @param diff the difference
 * @return the required size of the ibf
 */
static unsigned int
get_order_from_difference (unsigned int diff)
{
  unsigned int ibf_order;

  ibf_order = 2;
  while ((1<<ibf_order) < (2 * diff))
    ibf_order++;
  if (ibf_order > MAX_IBF_ORDER)
    ibf_order = MAX_IBF_ORDER;
  return ibf_order;
}


/**
 * Handle a strata estimator from a remote peer
 *
 * @param the union operation
 * @param mh the message
 */
static void
handle_p2p_strata_estimator (void *cls, const struct GNUNET_MessageHeader *mh)
{
  struct UnionEvaluateOperation *eo = cls;
  struct StrataEstimator *remote_se;
  int diff;


  if (eo->phase != PHASE_EXPECT_SE)
  {
    fail_union_operation (eo);
    GNUNET_break (0);
    return;
  }
  remote_se = strata_estimator_create (SE_STRATA_COUNT, SE_IBF_SIZE,
                                       SE_IBF_HASH_NUM);
  strata_estimator_read (&mh[1], remote_se);
  GNUNET_assert (NULL != eo->se);
  diff = strata_estimator_difference (remote_se, eo->se);
  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "got se, diff=%d\n", diff);
  strata_estimator_destroy (remote_se);
  strata_estimator_destroy (eo->se);
  eo->se = NULL;
  send_ibf (eo, get_order_from_difference (diff));
}



/**
 * Iterator to send elements to a remote peer
 *
 * @param cls closure with the element key and the union operation
 * @param key ignored
 * @param value the key entry
 */
static int
send_element_iterator (void *cls,
                      uint32_t key,
                      void *value)
{
  struct SendElementClosure *sec = cls;
  struct IBF_Key ibf_key = sec->ibf_key;
  struct UnionEvaluateOperation *eo = sec->eo;
  struct KeyEntry *ke = value;

  if (ke->ibf_key.key_val != ibf_key.key_val)
    return GNUNET_YES;
  while (NULL != ke)
  {
    const struct GNUNET_SET_Element *const element = &ke->element->element;
    struct GNUNET_MQ_Message *mqm;

    GNUNET_assert (ke->ibf_key.key_val == ibf_key.key_val);
    mqm = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS);
    if (GNUNET_OK != GNUNET_MQ_nest (mqm, element->data, element->size))
    {
      GNUNET_break (0);
      GNUNET_MQ_discard (mqm);
      continue;
    }
    GNUNET_MQ_send (eo->mq, mqm);
    ke = ke->next_colliding;
  }
  return GNUNET_NO;
}

/**
 * Send all elements that have the specified IBF key
 * to the remote peer of the union operation
 *
 * @param eo union operation
 * @param ibf_key IBF key of interest
 */
static void
send_elements_for_key (struct UnionEvaluateOperation *eo, struct IBF_Key ibf_key)
{
  struct SendElementClosure send_cls;

  send_cls.ibf_key = ibf_key;
  send_cls.eo = eo;
  GNUNET_CONTAINER_multihashmap32_get_multiple (eo->key_to_element, (uint32_t) ibf_key.key_val,
                                                send_element_iterator, &send_cls);
}


/**
 * Decode which elements are missing on each side, and
 * send the appropriate elemens and requests
 *
 * @param eo union operation
 */
static void
decode_and_send (struct UnionEvaluateOperation *eo)
{
  struct IBF_Key key;
  int side;
  struct InvertibleBloomFilter *diff_ibf;

  GNUNET_assert (PHASE_EXPECT_ELEMENTS == eo->phase);

  prepare_ibf (eo, eo->remote_ibf->size);
  diff_ibf = ibf_dup (eo->local_ibf);
  ibf_subtract (diff_ibf, eo->remote_ibf);

  while (1)
  {
    int res;

    res = ibf_decode (diff_ibf, &side, &key);
    if (GNUNET_SYSERR == res)
    {
      int next_order;
      next_order = 0;
      while (1<<next_order < diff_ibf->size)
        next_order++;
      next_order++;
      if (next_order <= MAX_IBF_ORDER)
      {
        GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "decoding failed, sending larger ibf (size %u)\n",
                    1<<next_order);
        send_ibf (eo, next_order);
      }
      else
      {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "set union failed: reached ibf limit\n");
      }
      break;
    }
    if (GNUNET_NO == res)
    {
      struct GNUNET_MQ_Message *mqm;

      GNUNET_log (GNUNET_ERROR_TYPE_INFO, "transmitted all values, sending DONE\n");
      mqm = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_P2P_DONE);
      GNUNET_MQ_send (eo->mq, mqm);
      break;
    }
    if (1 == side)
    {
      send_elements_for_key (eo, key);
    }
    else
    {
      struct GNUNET_MQ_Message *mqm;
      struct GNUNET_MessageHeader *msg;

      /* FIXME: before sending the request, check if we may just have the element */
      /* FIXME: merge multiple requests */
      mqm = GNUNET_MQ_msg_header_extra (msg, sizeof (struct IBF_Key),
                                        GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS);
      *(struct IBF_Key *) &msg[1] = key;
      GNUNET_MQ_send (eo->mq, mqm);
    }
  }
  ibf_destroy (diff_ibf);
}


/**
 * Handle an IBF message from a remote peer.
 *
 * @param cls the union operation
 * @param mh the header of the message
 */
static void
handle_p2p_ibf (void *cls, const struct GNUNET_MessageHeader *mh)
{
  struct UnionEvaluateOperation *eo = cls;
  struct IBFMessage *msg = (struct IBFMessage *) mh;
  unsigned int buckets_in_message;

  if ( (eo->phase == PHASE_EXPECT_ELEMENTS_AND_REQUESTS) ||
       (eo->phase == PHASE_EXPECT_IBF) )
  {
    eo->phase = PHASE_EXPECT_IBF_CONT;
    GNUNET_assert (NULL == eo->remote_ibf);
    GNUNET_log (GNUNET_ERROR_TYPE_INFO, "creating new ibf of order %u\n", 1<<msg->order);
    eo->remote_ibf = ibf_create (1<<msg->order, SE_IBF_HASH_NUM);
    if (0 != ntohs (msg->offset))
    {
      GNUNET_break (0);
      fail_union_operation (eo);
    }
  }
  else if (eo->phase == PHASE_EXPECT_IBF_CONT)
  {
    if ( (ntohs (msg->offset) != eo->ibf_buckets_received) ||
         (1<<msg->order != eo->remote_ibf->size) )
    {
      GNUNET_break (0);
      fail_union_operation (eo);
      return;
    }
  }

  buckets_in_message = (ntohs (msg->header.size) - sizeof *msg) / IBF_BUCKET_SIZE;

  if ((ntohs (msg->header.size) - sizeof *msg) != buckets_in_message * IBF_BUCKET_SIZE)
  {
    GNUNET_break (0);
    fail_union_operation (eo);
    return;
  }
  
  ibf_read_slice (&msg[1], eo->ibf_buckets_received, buckets_in_message, eo->remote_ibf);
  eo->ibf_buckets_received += buckets_in_message;

  if (eo->ibf_buckets_received == eo->remote_ibf->size)
  {

    GNUNET_log (GNUNET_ERROR_TYPE_INFO, "received full strata estimator\n");
    eo->phase = PHASE_EXPECT_ELEMENTS;
    decode_and_send (eo);
  }
}


/**
 * Send a result message to the client indicating
 * that there is a new element.
 *
 * @param eo union operation
 * @param element element to send
 */
static void
send_client_element (struct UnionEvaluateOperation *eo,
                     struct GNUNET_SET_Element *element)
{
  struct GNUNET_MQ_Message *mqm;
  struct ResultMessage *rm;

  GNUNET_assert (0 != eo->request_id);
  mqm = GNUNET_MQ_msg (rm, GNUNET_MESSAGE_TYPE_SET_RESULT);
  rm->result_status = htons (GNUNET_SET_STATUS_OK);
  rm->request_id = htonl (eo->request_id);
  if (GNUNET_OK != GNUNET_MQ_nest (mqm, element->data, element->size))
  {
    GNUNET_MQ_discard (mqm);
    GNUNET_break (0);
    return;
  }

  GNUNET_MQ_send (eo->set->client_mq, mqm);
}


/**
 * Callback used for notifications
 *
 * @param cls closure
 */
static void
client_done_sent_cb (void *cls)
{
  //struct UnionEvaluateOperation *eo = cls;
  /* FIXME: destroy eo */
}


/**
 * Send a result message to the client indicating
 * that the operation is over.
 * After the result done message has been sent to the client,
 * destroy the evaluate operation.
 *
 * @param eo union operation
 * @param element element to send
 */
static void
send_client_done_and_destroy (struct UnionEvaluateOperation *eo)
{
  struct GNUNET_MQ_Message *mqm;
  struct ResultMessage *rm;

  GNUNET_assert (0 != eo->request_id);
  mqm = GNUNET_MQ_msg (rm, GNUNET_MESSAGE_TYPE_SET_RESULT);
  rm->request_id = htonl (eo->request_id);
  rm->result_status = htons (GNUNET_SET_STATUS_DONE);
  GNUNET_MQ_notify_sent (mqm, client_done_sent_cb, eo);
  GNUNET_MQ_send (eo->set->client_mq, mqm);

  /* FIXME: destroy the eo */
}


/**
 * Handle an element message from a remote peer.
 *
 * @param cls the union operation
 * @param mh the message
 */
static void
handle_p2p_elements (void *cls, const struct GNUNET_MessageHeader *mh)
{
  struct UnionEvaluateOperation *eo = cls;
  struct ElementEntry *ee;
  uint16_t element_size;

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "got element from peer\n");

  if ( (eo->phase != PHASE_EXPECT_ELEMENTS) &&
       (eo->phase != PHASE_EXPECT_ELEMENTS_AND_REQUESTS) )
  {
    fail_union_operation (eo);
    GNUNET_break (0);
    return;
  }
  element_size = ntohs (mh->size) - sizeof (struct GNUNET_MessageHeader);
  ee = GNUNET_malloc (sizeof *eo + element_size);
  ee->element.data = &ee[1];
  memcpy (ee->element.data, &mh[1], element_size);
  ee->remote = GNUNET_YES;

  insert_element (eo, ee);
  send_client_element (eo, &ee->element);

  GNUNET_free (ee);
}


/**
 * Handle an element request from a remote peer.
 *
 * @param cls the union operation
 * @param mh the message
 */
static void
handle_p2p_element_requests (void *cls, const struct GNUNET_MessageHeader *mh)
{
  struct UnionEvaluateOperation *eo = cls;
  struct IBF_Key *ibf_key;
  unsigned int num_keys;

  /* look up elements and send them */
  if (eo->phase != PHASE_EXPECT_ELEMENTS_AND_REQUESTS)
  {
    GNUNET_break (0);
    fail_union_operation (eo);
    return;
  }

  num_keys = (ntohs (mh->size) - sizeof *mh) / sizeof (struct IBF_Key);

  if ((ntohs (mh->size) - sizeof *mh) != num_keys * sizeof (struct IBF_Key))
  {
    GNUNET_break (0);
    fail_union_operation (eo);
    return;
  }

  ibf_key = (struct IBF_Key *) &mh[1];
  while (0 != num_keys--)
  {
    send_elements_for_key (eo, *ibf_key);
    ibf_key++;
  }
}


/**
 * Callback used for notifications
 *
 * @param cls closure
 */
static void
peer_done_sent_cb (void *cls)
{
  struct UnionEvaluateOperation *eo = cls;

  send_client_done_and_destroy (eo);
}


/**
 * Handle a done message from a remote peer
 * 
 * @param cls the union operation
 * @param mh the message
 */
static void
handle_p2p_done (void *cls, const struct GNUNET_MessageHeader *mh)
{
  struct UnionEvaluateOperation *eo = cls;

  if (eo->phase == PHASE_EXPECT_ELEMENTS_AND_REQUESTS)
  {
    /* we got all requests, but still have to send our elements as response */
    struct GNUNET_MQ_Message *mqm;

    GNUNET_log (GNUNET_ERROR_TYPE_INFO, "got DONE, sending final DONE after elements\n");
    eo->phase = PHASE_FINISHED;
    mqm = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_P2P_DONE);
    GNUNET_MQ_notify_sent (mqm, peer_done_sent_cb, eo);
    GNUNET_MQ_send (eo->mq, mqm);
    return;
  }
  if (eo->phase == PHASE_EXPECT_ELEMENTS)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_INFO, "got final DONE\n");
    eo->phase = PHASE_FINISHED;
    send_client_done_and_destroy (eo);
    return;
  }
  GNUNET_break (0);
  fail_union_operation (eo);
}


/**
 * The handlers array, used for both evaluate and accept
 */
static const struct GNUNET_MQ_Handler union_handlers[] = {
  {handle_p2p_elements, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENTS},
  {handle_p2p_strata_estimator, GNUNET_MESSAGE_TYPE_SET_P2P_SE},
  {handle_p2p_ibf, GNUNET_MESSAGE_TYPE_SET_P2P_IBF},
  {handle_p2p_element_requests, GNUNET_MESSAGE_TYPE_SET_P2P_ELEMENT_REQUESTS},
  {handle_p2p_done, GNUNET_MESSAGE_TYPE_SET_P2P_DONE},
  GNUNET_MQ_HANDLERS_END
};


/**
 * Functions of this type will be called when a stream is established
 * 
 * @param cls the closure from GNUNET_STREAM_open
 * @param socket socket to use to communicate with the
 *        other side (read/write)
 */
static void
stream_open_cb (void *cls,
                struct GNUNET_STREAM_Socket *socket)
{
  struct UnionEvaluateOperation *eo = cls;

  GNUNET_assert (NULL == eo->mq);
  GNUNET_assert (socket == eo->socket);

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "open cb successful\n");

  eo->mq = GNUNET_MQ_queue_for_stream_socket (eo->socket,
                                              union_handlers, eo);
  /* we started the operation, thus we have to send the operation request */
  send_operation_request (eo);
  eo->phase = PHASE_EXPECT_SE;
}


/**
 * Evaluate a union operation with
 * a remote peer.
 *
 * @param m the evaluate request message from the client
 * @parem set the set to evaluate the operation with
 */
void
_GSS_union_evaluate (struct EvaluateMessage *m, struct Set *set)
{
  struct UnionEvaluateOperation *eo;

  eo = GNUNET_new (struct UnionEvaluateOperation);
  eo->peer = m->peer;
  eo->set = set;
  eo->request_id = htonl (m->request_id);
  GNUNET_assert (0 != eo->request_id);
  eo->se = strata_estimator_dup (set->state.u->se);
  eo->salt = ntohs (m->salt);
  eo->app_id = m->app_id;

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "evaluating union operation, (app %s)\n", 
              GNUNET_h2s (&eo->app_id));

  eo->socket = 
      GNUNET_STREAM_open (configuration, &eo->peer, GNUNET_APPLICATION_TYPE_SET,
                          stream_open_cb, eo,
                          GNUNET_STREAM_OPTION_END);


  GNUNET_CONTAINER_DLL_insert (eo->set->state.u->ops_head,
                               eo->set->state.u->ops_tail,
                               eo);
  /* the stream open callback will kick off the operation */
}


/**
 * Accept an union operation request from a remote peer
 *
 * @param m the accept message from the client
 * @param set the set of the client
 * @param incoming information about the requesting remote peer
 */
void
_GSS_union_accept (struct AcceptMessage *m, struct Set *set,
                   struct Incoming *incoming)
{
  struct UnionEvaluateOperation *eo;

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "accepting set union operation\n");

  eo = GNUNET_new (struct UnionEvaluateOperation);
  eo->generation_created = set->state.u->current_generation++;
  eo->set = set;
  eo->peer = incoming->peer;
  eo->salt = ntohs (incoming->salt);
  GNUNET_assert (0 != ntohl (m->request_id));
  eo->request_id = ntohl (m->request_id);
  eo->se = strata_estimator_dup (set->state.u->se);
  eo->set = set;
  eo->mq = incoming->mq;
  /* transfer ownership of mq and socket from incoming to eo */
  incoming->mq = NULL;
  eo->socket = incoming->socket;
  incoming->socket = NULL;
  /* the peer's socket is now ours, we'll receive all messages */
  GNUNET_MQ_replace_handlers (eo->mq, union_handlers, eo);

  GNUNET_CONTAINER_DLL_insert (eo->set->state.u->ops_head,
                               eo->set->state.u->ops_tail,
                               eo);

  /* kick off the operation */
  send_strata_estimator (eo);
}


/**
 * Create a new set supporting the union operation
 *
 * @return the newly created set
 */
struct Set *
_GSS_union_set_create (void)
{
  struct Set *set;

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "union set created\n");
  
  set = GNUNET_malloc (sizeof (struct Set) + sizeof (struct UnionState));
  set->state.u = (struct UnionState *) &set[1];
  set->operation = GNUNET_SET_OPERATION_UNION;
  /* keys of the hash map are stored in the element entrys, thus we do not
   * want the hash map to copy them */
  set->state.u->elements = GNUNET_CONTAINER_multihashmap_create (1, GNUNET_YES);
  set->state.u->se = strata_estimator_create (SE_STRATA_COUNT,
                                              SE_IBF_SIZE, SE_IBF_HASH_NUM);  
  return set;
}


/**
 * Add the element from the given element message to the set.
 *
 * @param m message with the element
 * @param set set to add the element to
 */
void
_GSS_union_add (struct ElementMessage *m, struct Set *set)
{
  struct ElementEntry *ee;
  struct ElementEntry *ee_dup;
  uint16_t element_size;

  GNUNET_log (GNUNET_ERROR_TYPE_INFO, "adding element\n");

  GNUNET_assert (GNUNET_SET_OPERATION_UNION == set->operation);
  element_size = ntohs (m->header.size) - sizeof *m;
  ee = GNUNET_malloc (element_size + sizeof *ee);
  ee->element.size = element_size;
  ee->element.data = &ee[1];
  ee->generation_added = set->state.u->current_generation;
  memcpy (ee->element.data, &m[1], element_size);
  GNUNET_CRYPTO_hash (ee->element.data, element_size, &ee->element_hash);
  ee_dup = GNUNET_CONTAINER_multihashmap_get (set->state.u->elements, &ee->element_hash);
  if (NULL != ee_dup)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "element inserted twice, ignoring\n");
    GNUNET_free (ee);
    return;
  }
  GNUNET_CONTAINER_multihashmap_put (set->state.u->elements, &ee->element_hash, ee,
                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
  strata_estimator_insert (set->state.u->se, get_ibf_key (&ee->element_hash, 0));
}


/**
 * Destroy a set that supports the union operation
 *
 * @param the set to destroy, must be of type GNUNET_SET_OPERATION_UNION
 */
void
_GSS_union_set_destroy (struct Set *set)
{
  GNUNET_assert (GNUNET_SET_OPERATION_UNION == set->operation);
  if (NULL != set->client)
  {
    GNUNET_SERVER_client_drop (set->client);
    set->client = NULL;
  }
  if (NULL != set->client_mq)
  {
    GNUNET_MQ_destroy (set->client_mq);
    set->client_mq = NULL;
  }

  if (NULL != set->state.u->se)
  {
    strata_estimator_destroy (set->state.u->se);
    set->state.u->se = NULL;
  }

  destroy_elements (set->state.u);

  while (NULL != set->state.u->ops_head)
    destroy_union_operation (set->state.u->ops_head);
}

/**
 * Remove the element given in the element message from the set.
 * Only marks the element as removed, so that older set operations can still exchange it.
 *
 * @param m message with the element
 * @param set set to remove the element from
 */
void
_GSS_union_remove (struct ElementMessage *m, struct Set *set)
{
  struct GNUNET_HashCode hash;
  struct ElementEntry *ee;

  GNUNET_assert (GNUNET_SET_OPERATION_UNION == set->operation);
  GNUNET_CRYPTO_hash (&m[1], ntohs (m->header.size), &hash);
  ee = GNUNET_CONTAINER_multihashmap_get (set->state.u->elements, &hash);
  if (NULL == ee)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "client tried to remove non-existing element\n");
    return;
  }
  if (GNUNET_YES == ee->removed)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "client tried to remove element twice\n");
    return;
  }
  ee->removed = GNUNET_YES;
  ee->generation_removed = set->state.u->current_generation;
}