aboutsummaryrefslogtreecommitdiff
path: root/src/fragmentation/fragmentation.c
blob: ecd82b2c4ba4e1809ebfa6fae1bcaa28b46b0b61 (plain) (blame)
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
/*
     This file is part of GNUnet
     (C) 2004, 2006, 2009 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 3, 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 fragmentation/fragmentation.c
 * @brief fragmentation and defragmentation, this code allows
 *        sending and receiving messages that are larger than
 *        the MTU of the transport.  Messages are still limited
 *        to a maximum size of 65535 bytes, which is a good
 *        idea because otherwise we may need ungainly fragmentation
 *        buffers.  Each connected peer can have at most one
 *        fragmented packet at any given point in time (prevents
 *        DoS attacks).  Fragmented messages that have not been
 *        completed after a certain amount of time are discarded.
 * @author Ji Lu
 */

#include "platform.h"
#include "gnunet_fragmentation_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_util_lib.h"

/**
 * Message fragment.  This header is followed
 * by the actual data of the fragment.
 */

struct Fragment
{

	struct GNUNET_MessageHeader header;

	/**
	 * Fragment offset.
	 */
	uint16_t off GNUNET_PACKED;

	/**
	* "unique" id for the fragment
	 */
	uint32_t id GNUNET_PACKED;
	uint16_t mtu;
	uint16_t totalNum;
	uint16_t totalSize;

};

struct GNUNET_FRAGEMENT_Ctxbuffer{
	struct GNUNET_FRAGEMENT_Ctxbuffer *next;
	uint32_t id;
	uint16_t size;
	char * buff;
	int counter;
	struct GNUNET_TIME_Absolute receivedTime;
	struct GNUNET_PeerIdentity peerID;
	int * num;
};


/**
 * Defragmentation context.
 */
struct GNUNET_FRAGMENT_Context
{
	uint32_t maxNum;
	struct GNUNET_FRAGEMENT_Ctxbuffer *buffer;
	GNUNET_FRAGMENT_MessageProcessor proc;
	void *proc_cls;
};


/**
 * Fragment an over-sized message.
 *
 * @param msg the message to fragment
 * @param mtu the maximum message size
 * @param proc function to call for each fragment
 * @param proc_cls closure for proc
 */
void
GNUNET_FRAGMENT_fragment (const struct GNUNET_MessageHeader *msg,
		uint16_t mtu,
		GNUNET_FRAGMENT_MessageProcessor proc,
		void *proc_cls)
{
	uint32_t id = GNUNET_CRYPTO_random_u32(GNUNET_CRYPTO_QUALITY_WEAK, 256);
	size_t size = sizeof(struct Fragment);

	if(ntohs(msg->size) > mtu-size){
		uint16_t lastSize;
		uint16_t num;
		uint16_t i;
		uint16_t actualNum;
		lastSize = ntohs(msg->size) % (mtu-size);
		num	= ntohs(msg->size) / (mtu - size);
		actualNum = num;
		if(lastSize!=0){
			actualNum = num+1;
		}
		for(i = 0; i<actualNum; i++)
		{
			struct Fragment *frag;
			if(actualNum != num){
				if(i!=actualNum-1){
					frag = (struct Fragment *)GNUNET_malloc(mtu);
				}
				else{
					frag = (struct Fragment *)GNUNET_malloc(lastSize+size);
					}
				}
			else{
					frag = (struct Fragment *)GNUNET_malloc(mtu);
				}
			frag->header.type = htons(GNUNET_MESSAGE_TYPE_FRAGMENT);
			frag->id = htonl(id);
			frag->off = htons((mtu-size)*i);
			frag->mtu = htons(mtu);
			frag->totalNum = htons(actualNum);
			frag->totalSize = msg->size;
			char *tmpMsg =  (char *)msg;
			if(actualNum != num){
				if(i!=actualNum-1){
					frag->header.size = htons(mtu);
					memcpy(&frag[1], tmpMsg + (mtu-size)*i, mtu - size);
				}
				else{
					frag->header.size = htons(lastSize+size);
					memcpy(&frag[1], tmpMsg + (mtu-size)*i, lastSize);
				}
			}
			else{
				frag->header.size = htons(mtu);
				memcpy(&frag[1], tmpMsg + (mtu-size)*i, mtu - size);
			}
			proc(proc_cls, &frag->header);
			GNUNET_free(frag);
		}
	}
}

/**
 * Create a defragmentation context.
 *
 * @param stats statistics context
 * @param proc function to call with defragmented messages
 * @param proc_cls closure for proc
 * @return the defragmentation context
 */
struct GNUNET_FRAGMENT_Context *
GNUNET_FRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
		GNUNET_FRAGMENT_MessageProcessor proc,
		void *proc_cls)
		{
	struct GNUNET_FRAGMENT_Context *ctx = (struct GNUNET_FRAGMENT_Context*)GNUNET_malloc(sizeof(struct GNUNET_FRAGMENT_Context));
	ctx->maxNum = 100;
	ctx->proc = proc;
	ctx->proc_cls = proc_cls;
	ctx->buffer = NULL;
	return ctx;
		}


/**
 * Destroy the given defragmentation context.
 */
void
GNUNET_FRAGMENT_context_destroy (struct GNUNET_FRAGMENT_Context *ctx)
{
	struct GNUNET_FRAGEMENT_Ctxbuffer *buffer;
	struct GNUNET_FRAGEMENT_Ctxbuffer *temp;
	buffer = ctx->buffer;

	while (buffer != NULL)
	  {
            temp = buffer->next;
            GNUNET_free(buffer->num);
            GNUNET_free(buffer);
            buffer = temp;
          }
	GNUNET_free(ctx);
	GNUNET_assert (0);
}


/**
 * We have received a fragment.  Process it.
 *
 * @param ctx the context
 * @param sender who transmitted the fragment
 * @param msg the message that was received
 */
void
GNUNET_FRAGMENT_process (struct GNUNET_FRAGMENT_Context *ctx,
		const struct GNUNET_PeerIdentity *sender,
		const struct GNUNET_MessageHeader *msg)
{
	uint16_t type = ntohs(msg->type);
	int exist = 0, received = 0;
	if(type!=GNUNET_MESSAGE_TYPE_FRAGMENT){
		return;
	}
	struct Fragment *frag = (struct Fragment *)msg;
	struct GNUNET_FRAGEMENT_Ctxbuffer* buffer;
	struct GNUNET_FRAGEMENT_Ctxbuffer* prev;
	prev = NULL;
	buffer = ctx->buffer;
	while (buffer != NULL)
	{
		if ((buffer->id == ntohl(frag->id))&&(0 == memcmp (&buffer->peerID,
                             sender, sizeof (struct GNUNET_PeerIdentity)))){
			exist = 1;
			break;
		}
		prev = buffer;
		buffer = buffer->next;
	}

	if (exist)
	{
		int i;
		for(i = 0; i<ntohs(frag->totalNum); i++){
			if(buffer->num[i]==ntohs(frag->off)/(ntohs(frag->mtu)-sizeof(struct Fragment))){
				received = 1;
				break;
				}
		}
	}

	if(!exist){
		buffer = GNUNET_malloc(sizeof(struct GNUNET_FRAGEMENT_Ctxbuffer));
		buffer->num = GNUNET_malloc(ntohs(frag->totalNum)*sizeof(int));
		int j;
		for(j = 0; j<ntohs(frag->totalNum); j++){
			buffer->num[j] = -10;
		}
		buffer->peerID = *sender;
		buffer->id = ntohl(frag->id);
		buffer->receivedTime = GNUNET_TIME_absolute_get ();
		uint16_t si = ntohs(frag->totalSize);
		buffer->size = si;
		buffer->buff = GNUNET_malloc(si);
		buffer->next = ctx->buffer;
		ctx->buffer = buffer;
	}

	if(!received){
		buffer->num[buffer->counter++]=ntohs(frag->off)/(ntohs(frag->mtu)-sizeof(struct Fragment));
		uint16_t sizeoffrag = ntohs(frag->header.size) - sizeof(struct Fragment);
		memcpy(&buffer->buff[ntohs(frag->off)], &frag[1], sizeoffrag);
		buffer->receivedTime = GNUNET_TIME_absolute_get ();
	}

	if(buffer->counter == ntohs(frag->totalNum))
	{
		ctx->proc(ctx->proc_cls, (struct GNUNET_MessageHeader *)buffer->buff);
		if(prev==NULL){
			ctx->buffer = buffer->next;
		}
		else{
			prev->next = buffer->next;
		}
		GNUNET_free(buffer);
		return;
	}
}



#if 0

/**
 * How many buckets does the fragment hash table
 * have?
 */
#define DEFRAG_BUCKET_COUNT 16

/**
 * After how long do fragments time out?
 */
#ifndef DEFRAGMENTATION_TIMEOUT
#define DEFRAGMENTATION_TIMEOUT (3 * GNUNET_CRON_MINUTES)
#endif

/**
 * Entry in the linked list of fragments.
 */
typedef struct FL
{
	struct FL *link;
	P2P_fragmentation_MESSAGE *frag;
} FL;

/**
 * Entry in the GNUNET_hash table of fragments.
 */
typedef struct FC
{
	struct FC *next;
	FL *head;
	GNUNET_PeerIdentity sender;
	int id;
	GNUNET_CronTime ttl;
} FC;

#define FRAGSIZE(fl) ((ntohs(fl->frag->header.size)-sizeof(P2P_fragmentation_MESSAGE)))

static GNUNET_CoreAPIForPlugins *coreAPI;

static GNUNET_Stats_ServiceAPI *stats;

static int stat_defragmented;

static int stat_fragmented;

static int stat_discarded;

/**
 * Hashtable *with* collision management!
 */
static FC *defragmentationCache[DEFRAG_BUCKET_COUNT];

/**
 * Lock for the defragmentation cache.
 */
static struct GNUNET_Mutex *defragCacheLock;

static void
freeFL (FL * fl, int c)
{
	while (fl != NULL)
	{
		FL *link = fl->link;
		if (stats != NULL)
			stats->change (stat_discarded, c);
		GNUNET_free (fl->frag);
		GNUNET_free (fl);
		fl = link;
	}
}

/**
 * This cron job ensures that we purge buffers of fragments
 * that have timed out.  It can run in much longer intervals
 * than the defragmentationCron, e.g. every 60s.
 * <p>
 * This method goes through the hashtable, finds entries that
 * have timed out and removes them (and all the fragments that
 * belong to the entry).  It's a bit more complicated as the
 * collision list is also collapsed.
 */
static void
defragmentationPurgeCron (void *unused)
{
	int i;
	FC *smf;
	FC *next;
	FC *last;

	GNUNET_mutex_lock (defragCacheLock);
	for (i = 0; i < DEFRAG_BUCKET_COUNT; i++)
	{
		last = NULL;
		smf = defragmentationCache[i];
		while (smf != NULL)
		{
			if (smf->ttl < GNUNET_get_time ())
			{
				/* free linked list of fragments */
				freeFL (smf->head, 1);
				next = smf->next;
				GNUNET_free (smf);
				if (last == NULL)
					defragmentationCache[i] = next;
				else
					last->next = next;
				smf = next;
			}
			else
			{
				last = smf;
				smf = smf->next;
			}
		}                       /* while smf != NULL */
	}                           /* for all buckets */
	GNUNET_mutex_unlock (defragCacheLock);
}

/**
 * Check if this fragment-list is complete.  If yes, put it together,
 * process and free all buffers.  Does not free the pep
 * itself (but sets the TTL to 0 to have the cron free it
 * in the next iteration).
 *
 * @param pep the entry in the GNUNET_hash table
 */
static void
checkComplete (FC * pep)
{
	FL *pos;
	unsigned short off;
	unsigned short len;
	char *msg;

	GNUNET_GE_ASSERT (NULL, pep != NULL);
	pos = pep->head;
	if (pos == NULL)
		return;
	len = ntohs (pos->frag->len);
	if (len == 0)
		goto CLEANUP;               /* really bad error! */
	off = 0;
	while ((pos != NULL) && (ntohs (pos->frag->off) <= off))
	{
		if (off >= off + FRAGSIZE (pos))
			goto CLEANUP;           /* error! */
		if (ntohs (pos->frag->off) + FRAGSIZE (pos) > off)
			off = ntohs (pos->frag->off) + FRAGSIZE (pos);
		else
			goto CLEANUP;           /* error! */
		pos = pos->link;
	}
	if (off < len)
		return;                     /* some fragment is still missing */

	msg = GNUNET_malloc (len);
	pos = pep->head;
	while (pos != NULL)
	{
		memcpy (&msg[ntohs (pos->frag->off)], &pos->frag[1], FRAGSIZE (pos));
		pos = pos->link;
	}
	if (stats != NULL)
		stats->change (stat_defragmented, 1);
#if 0
	printf ("Finished defragmentation!\n");
#endif
	/* handle message! */
	coreAPI->loopback_send (&pep->sender, msg, len, GNUNET_YES, NULL);
	GNUNET_free (msg);
	CLEANUP:
	/* free fragment buffers */
	freeFL (pep->head, 0);
	pep->head = NULL;
	pep->ttl = 0;
}

/**
 * See if the new fragment is a part of this entry and join them if
 * yes.  Return GNUNET_SYSERR if the fragments do not match.  Return GNUNET_OK if
 * the fragments do match and the fragment has been processed.  The
 * defragCacheLock is already acquired by the caller whenever this
 * method is called.<p>
 *
 * @param entry the entry in the cache
 * @param pep the new entry
 * @param packet the ip part in the new entry
 */
static int
tryJoin (FC * entry,
		const GNUNET_PeerIdentity * sender,
		const P2P_fragmentation_MESSAGE * packet)
{
	/* frame before ours; may end in the middle of
     our frame or before it starts; NULL if we are
     the earliest position we have received so far */
	FL *before;
	/* frame after ours; may start in the middle of
     our frame or after it; NULL if we are the last
     fragment we have received so far */
	FL *after;
	/* current position in the frame-list */
	FL *pos;
	/* the new entry that we're inserting */
	FL *pep;
	FL *tmp;
	unsigned short end;

	GNUNET_GE_ASSERT (NULL, entry != NULL);
	if (0 != memcmp (sender, &entry->sender, sizeof (GNUNET_PeerIdentity)))
		return GNUNET_SYSERR;       /* wrong fragment list, try another! */
	if (ntohl (packet->id) != entry->id)
		return GNUNET_SYSERR;       /* wrong fragment list, try another! */
#if 0
	printf ("Received fragment %u from %u to %u\n",
			ntohl (packet->id),
			ntohs (packet->off),
			ntohs (packet->off) + ntohs (packet->header.size) -
			sizeof (P2P_fragmentation_MESSAGE));
#endif
	pos = entry->head;
	if ((pos != NULL) && (packet->len != pos->frag->len))
		return GNUNET_SYSERR;       /* wrong fragment size */

	before = NULL;
	/* find the before-frame */
	while ((pos != NULL) && (ntohs (pos->frag->off) < ntohs (packet->off)))
	{
		before = pos;
		pos = pos->link;
	}

	/* find the after-frame */
	end =
			ntohs (packet->off) + ntohs (packet->header.size) -
			sizeof (P2P_fragmentation_MESSAGE);
	if (end <= ntohs (packet->off))
	{
		GNUNET_GE_LOG (NULL,
				GNUNET_GE_DEVELOPER | GNUNET_GE_DEBUG | GNUNET_GE_BULK,
				"Received invalid fragment at %s:%d\n", __FILE__,
				__LINE__);
		return GNUNET_SYSERR;     /* yuck! integer overflow! */
	}

	if (before != NULL)
		after = before;
	else
		after = entry->head;
	while ((after != NULL) && (ntohs (after->frag->off) < end))
		after = after->link;

	if ((before != NULL) && (before == after))
	{
		/* this implies after or before != NULL and thereby the new
         fragment is redundant as it is fully enclosed in an earlier
         fragment */
		if (stats != NULL)
			stats->change (stat_defragmented, 1);
		return GNUNET_OK;         /* drop, there is a packet that spans our range! */
	}

	if ((before != NULL) &&
			(after != NULL) &&
			((htons (before->frag->off) +
					FRAGSIZE (before)) >= htons (after->frag->off)))
	{
		/* this implies that the fragment that starts before us and the
         fragment that comes after this one leave no space in the middle
         or even overlap; thus we can drop this redundant piece */
		if (stats != NULL)
			stats->change (stat_defragmented, 1);
		return GNUNET_OK;
	}

	/* allocate pep */
	pep = GNUNET_malloc (sizeof (FC));
	pep->frag = GNUNET_malloc (ntohs (packet->header.size));
	memcpy (pep->frag, packet, ntohs (packet->header.size));
	pep->link = NULL;

	if (before == NULL)
	{
		pep->link = after;
		pos = entry->head;
		while (pos != after)
		{
			tmp = pos->link;
			GNUNET_free (pos->frag);
			GNUNET_free (pos);
			pos = tmp;
		}
		entry->head = pep;
		goto FINISH;
		/* end of insert first */
	}

	if (after == NULL)
	{
		/* insert last: find the end, free everything after it */
		freeFL (before->link, 1);
		before->link = pep;
		goto FINISH;
	}

	/* ok, we are filling the middle between two fragments; insert.  If
     there is anything else in the middle, it can be dropped as we're
     bigger & cover that area as well */
	/* free everything between before and after */
	pos = before->link;
	while (pos != after)
	{
		tmp = pos->link;
		GNUNET_free (pos->frag);
		GNUNET_free (pos);
		pos = tmp;
	}
	before->link = pep;
	pep->link = after;

	FINISH:
	entry->ttl = GNUNET_get_time () + DEFRAGMENTATION_TIMEOUT;
	checkComplete (entry);
	return GNUNET_OK;
}

/**
 * Defragment the given fragment and pass to handler once
 * defragmentation is complete.
 *
 * @param frag the packet to defragment
 * @return GNUNET_SYSERR if the fragment is invalid
 */
static int
processFragment (const GNUNET_PeerIdentity * sender,
		const GNUNET_MessageHeader * frag)
{
	unsigned int hash;
	FC *smf;

	if (ntohs (frag->size) < sizeof (P2P_fragmentation_MESSAGE))
		return GNUNET_SYSERR;

	GNUNET_mutex_lock (defragCacheLock);
	hash = sender->hashPubKey.bits[0] % DEFRAG_BUCKET_COUNT;
	smf = defragmentationCache[hash];
	while (smf != NULL)
	{
		if (GNUNET_OK ==
				tryJoin (smf, sender, (P2P_fragmentation_MESSAGE *) frag))
		{
			GNUNET_mutex_unlock (defragCacheLock);
			return GNUNET_OK;
		}
		if (0 == memcmp (sender, &smf->sender, sizeof (GNUNET_PeerIdentity)))
		{
			freeFL (smf->head, 1);
			break;
		}
		smf = smf->next;
	}
	if (smf == NULL)
	{
		smf = GNUNET_malloc (sizeof (FC));
		smf->next = defragmentationCache[hash];
		defragmentationCache[hash] = smf;
		smf->ttl = GNUNET_get_time () + DEFRAGMENTATION_TIMEOUT;
		smf->sender = *sender;
	}
	smf->id = ntohl (((P2P_fragmentation_MESSAGE *) frag)->id);
	smf->head = GNUNET_malloc (sizeof (FL));
	smf->head->link = NULL;
	smf->head->frag = GNUNET_malloc (ntohs (frag->size));
	memcpy (smf->head->frag, frag, ntohs (frag->size));

	GNUNET_mutex_unlock (defragCacheLock);
	return GNUNET_OK;
}

typedef struct
{
	GNUNET_PeerIdentity sender;
	/* maximums size of each fragment */
	unsigned short mtu;
	/** how long is this message part expected to be? */
	unsigned short len;
	/** when did we intend to transmit? */
	GNUNET_CronTime transmissionTime;
} FragmentBMC;

/**
 * Send a message that had to be fragmented (right now!).  First grabs
 * the first part of the message (obtained from ctx->se) and stores
 * that in a P2P_fragmentation_MESSAGE envelope.  The remaining fragments are
 * added to the send queue with GNUNET_EXTREME_PRIORITY (to ensure that they
 * will be transmitted next).  The logic here is that if the priority
 * for the first fragment was sufficiently high, the priority should
 * also have been sufficiently high for all of the other fragments (at
 * this time) since they have the same priority.  And we want to make
 * sure that we send all of them since just sending the first fragment
 * and then going to other messages of equal priority would not be
 * such a great idea (i.e. would just waste bandwidth).
 */
static int
fragmentBMC (void *buf, void *cls, unsigned short len)
{
	FragmentBMC *ctx = cls;
	static int idGen = 0;
	P2P_fragmentation_MESSAGE *frag;
	unsigned int pos;
	int id;
	unsigned short mlen;

	if ((len < ctx->mtu) || (buf == NULL))
	{
		GNUNET_free (ctx);
		return GNUNET_SYSERR;
	}
	if (stats != NULL)
		stats->change (stat_fragmented, 1);
	id = (idGen++) + GNUNET_random_u32 (GNUNET_RANDOM_QUALITY_WEAK, 512);
	/* write first fragment to buf */
	frag = (P2P_fragmentation_MESSAGE *) buf;
	frag->header.size = htons (len);
	frag->header.type = htons (GNUNET_P2P_PROTO_MESSAGE_FRAGMENT);
	frag->id = id;
	frag->off = htons (0);
	frag->len = htons (ctx->len);
	memcpy (&frag[1], &ctx[1], len - sizeof (P2P_fragmentation_MESSAGE));

	/* create remaining fragments, add to queue! */
	pos = len - sizeof (P2P_fragmentation_MESSAGE);
	frag = GNUNET_malloc (ctx->mtu);
	while (pos < ctx->len)
	{
		mlen = sizeof (P2P_fragmentation_MESSAGE) + ctx->len - pos;
		if (mlen > ctx->mtu)
			mlen = ctx->mtu;
		GNUNET_GE_ASSERT (NULL, mlen > sizeof (P2P_fragmentation_MESSAGE));
		frag->header.size = htons (mlen);
		frag->header.type = htons (GNUNET_P2P_PROTO_MESSAGE_FRAGMENT);
		frag->id = id;
		frag->off = htons (pos);
		frag->len = htons (ctx->len);
		memcpy (&frag[1],
				&((char *) (&ctx[1]))[pos],
				mlen - sizeof (P2P_fragmentation_MESSAGE));
		coreAPI->ciphertext_send (&ctx->sender,
				&frag->header,
				GNUNET_EXTREME_PRIORITY,
				ctx->transmissionTime - GNUNET_get_time ());
		pos += mlen - sizeof (P2P_fragmentation_MESSAGE);
	}
	GNUNET_GE_ASSERT (NULL, pos == ctx->len);
	GNUNET_free (frag);
	GNUNET_free (ctx);
	return GNUNET_OK;
}

/**
 * The given message must be fragmented.  Produce a placeholder that
 * corresponds to the first fragment.  Once that fragment is scheduled
 * for transmission, the placeholder should automatically add all of
 * the other fragments (with very high priority).
 */
void
fragment (const GNUNET_PeerIdentity * peer,
		unsigned int mtu,
		unsigned int prio,
		unsigned int targetTime,
		unsigned int len, GNUNET_BuildMessageCallback bmc, void *bmcClosure)
{
	FragmentBMC *fbmc;
	int xlen;

	GNUNET_GE_ASSERT (NULL, len > mtu);
	GNUNET_GE_ASSERT (NULL, mtu > sizeof (P2P_fragmentation_MESSAGE));
	fbmc = GNUNET_malloc (sizeof (FragmentBMC) + len);
	fbmc->mtu = mtu;
	fbmc->sender = *peer;
	fbmc->transmissionTime = targetTime;
	fbmc->len = len;
	if (bmc == NULL)
	{
		memcpy (&fbmc[1], bmcClosure, len);
		GNUNET_free (bmcClosure);
	}
	else
	{
		if (GNUNET_SYSERR == bmc (&fbmc[1], bmcClosure, len))
		{
			GNUNET_free (fbmc);
			return;
		}
	}
	xlen = mtu - sizeof (P2P_fragmentation_MESSAGE);
	coreAPI->ciphertext_send_with_callback (peer, &fragmentBMC, fbmc, mtu, prio * xlen / len,     /* compute new priority */
			targetTime);
}

/**
 * Initialize Fragmentation module.
 */
GNUNET_Fragmentation_ServiceAPI *
provide_module_fragmentation (GNUNET_CoreAPIForPlugins * capi)
{
	static GNUNET_Fragmentation_ServiceAPI ret;
	int i;

	coreAPI = capi;
	stats = coreAPI->service_request ("stats");
	if (stats != NULL)
	{
		stat_defragmented =
				stats->create (gettext_noop ("# messages defragmented"));
		stat_fragmented =
				stats->create (gettext_noop ("# messages fragmented"));
		stat_discarded = stats->create (gettext_noop ("# fragments discarded"));
	}
	for (i = 0; i < DEFRAG_BUCKET_COUNT; i++)
		defragmentationCache[i] = NULL;
	defragCacheLock = GNUNET_mutex_create (GNUNET_NO);
	GNUNET_cron_add_job (coreAPI->cron,
			&defragmentationPurgeCron,
			60 * GNUNET_CRON_SECONDS, 60 * GNUNET_CRON_SECONDS,
			NULL);
	GNUNET_GE_LOG (capi->ectx,
			GNUNET_GE_INFO | GNUNET_GE_USER | GNUNET_GE_REQUEST,
			_("`%s' registering handler %d\n"), "fragmentation",
			GNUNET_P2P_PROTO_MESSAGE_FRAGMENT);
	capi->p2p_ciphertext_handler_register (GNUNET_P2P_PROTO_MESSAGE_FRAGMENT,
			&processFragment);

	ret.fragment = &fragment;
	return &ret;
}

/**
 * Shutdown fragmentation.
 */
void
release_module_fragmentation ()
{
	int i;

	coreAPI->p2p_ciphertext_handler_unregister
	(GNUNET_P2P_PROTO_MESSAGE_FRAGMENT, &processFragment);
	GNUNET_cron_del_job (coreAPI->cron, &defragmentationPurgeCron,
			60 * GNUNET_CRON_SECONDS, NULL);
	for (i = 0; i < DEFRAG_BUCKET_COUNT; i++)
	{
		FC *pos = defragmentationCache[i];
		while (pos != NULL)
		{
			FC *next = pos->next;
			freeFL (pos->head, 1);
			GNUNET_free (pos);
			pos = next;
		}
	}
	if (stats != NULL)
	{
		coreAPI->service_release (stats);
		stats = NULL;
	}
	GNUNET_mutex_destroy (defragCacheLock);
	defragCacheLock = NULL;
	coreAPI = NULL;
}

#endif

/* end of fragmentation.c */