source: trunk/libtransmission/peer-msgs.c @ 3825

Last change on this file since 3825 was 3825, checked in by charles, 15 years ago

more of the same

  • Property svn:keywords set to Date Rev Author Id
File size: 50.8 KB
Line 
1/*
2 * This file Copyright (C) 2007 Charles Kerr <charles@rebelbase.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: peer-msgs.c 3825 2007-11-15 05:47:23Z charles $
11 */
12
13#include <assert.h>
14#include <ctype.h>
15#include <errno.h>
16#include <stdio.h>
17#include <stdlib.h>
18#include <string.h>
19#include <libgen.h> /* basename */
20
21#include <netinet/in.h> /* struct in_addr */
22
23#include <event.h>
24
25#include "transmission.h"
26#include "bencode.h"
27#include "completion.h"
28#include "inout.h"
29#include "list.h"
30#include "peer-io.h"
31#include "peer-mgr.h"
32#include "peer-mgr-private.h"
33#include "peer-msgs.h"
34#include "ratecontrol.h"
35#include "trevent.h"
36#include "utils.h"
37
38/**
39***
40**/
41
42enum
43{
44    BT_CHOKE                = 0,
45    BT_UNCHOKE              = 1,
46    BT_INTERESTED           = 2,
47    BT_NOT_INTERESTED       = 3,
48    BT_HAVE                 = 4,
49    BT_BITFIELD             = 5,
50    BT_REQUEST              = 6,
51    BT_PIECE                = 7,
52    BT_CANCEL               = 8,
53    BT_PORT                 = 9,
54    BT_SUGGEST              = 13,
55    BT_HAVE_ALL             = 14,
56    BT_HAVE_NONE            = 15,
57    BT_REJECT               = 16,
58    BT_ALLOWED_FAST         = 17,
59    BT_LTEP                 = 20,
60
61    LTEP_HANDSHAKE          = 0,
62
63    OUR_LTEP_PEX            = 1,
64
65    MAX_REQUEST_BYTE_COUNT  = (16 * 1024), /* drop requests who want too much */
66
67    /* idle seconds before we send a keepalive */
68    KEEPALIVE_INTERVAL_SECS = 90,
69
70    PEX_INTERVAL            = (60 * 1000), /* msec between calls to sendPex() */
71    PEER_PULSE_INTERVAL     = (100),       /* msec between calls to pulse() */
72    RATE_PULSE_INTERVAL     = (333),       /* msec between calls to ratePulse() */
73     
74    /* Fast Peers Extension constants */
75    MAX_FAST_ALLOWED_COUNT   = 10,          /* max. number of pieces we fast-allow to another peer */
76    MAX_FAST_ALLOWED_THRESHOLD = 10,        /* max threshold for allowing fast-pieces requests */
77
78};
79
80enum
81{
82    AWAITING_BT_LENGTH,
83    AWAITING_BT_MESSAGE
84};
85
86struct peer_request
87{
88    uint32_t index;
89    uint32_t offset;
90    uint32_t length;
91    time_t time_requested;
92};
93
94static int
95compareRequest( const void * va, const void * vb )
96{
97    int i;
98    const struct peer_request * a = va;
99    const struct peer_request * b = vb;
100    if(( i = tr_compareUint32( a->index, b->index ))) return i;
101    if(( i = tr_compareUint32( a->offset, b->offset ))) return i;
102    if(( i = tr_compareUint32( a->length, b->length ))) return i;
103    return 0;
104}
105
106struct tr_peermsgs
107{
108    tr_peer * info;
109
110    tr_handle * handle;
111    tr_torrent * torrent;
112    tr_peerIo * io;
113
114    tr_publisher_t * publisher;
115
116    struct evbuffer * outBlock;    /* buffer of all the current piece message */
117    struct evbuffer * outMessages; /* buffer of all the non-piece messages */
118    tr_list * peerAskedFor;
119    tr_list * peerAskedForFast;
120    tr_list * clientAskedFor;
121    tr_list * clientWillAskFor;
122
123    tr_timer * rateTimer;
124    tr_timer * pulseTimer;
125    tr_timer * pexTimer;
126
127    time_t lastReqAddedAt;
128    time_t clientSentPexAt;
129    time_t clientSentAnythingAt;
130
131    unsigned int notListening             : 1;
132    unsigned int peerSupportsPex          : 1;
133    unsigned int clientSentLtepHandshake  : 1;
134    unsigned int peerSentLtepHandshake    : 1;
135   
136    tr_bitfield * clientAllowedPieces;
137    tr_bitfield * peerAllowedPieces;
138   
139    tr_bitfield * clientSuggestedPieces;
140   
141    uint8_t state;
142    uint8_t ut_pex_id;
143    uint16_t pexCount;
144    uint32_t incomingMessageLength;
145    uint32_t maxActiveRequests;
146    uint32_t minActiveRequests;
147
148    tr_pex * pex;
149};
150
151/**
152***
153**/
154
155static void
156myDebug( const char * file, int line,
157         const struct tr_peermsgs * msgs,
158         const char * fmt, ... )
159{
160    FILE * fp = tr_getLog( );
161    if( fp != NULL )
162    {
163        va_list args;
164        char timestr[64];
165        struct evbuffer * buf = evbuffer_new( );
166        char * myfile = tr_strdup( file );
167
168        evbuffer_add_printf( buf, "[%s] %s - %s [%s]: ",
169                             tr_getLogTimeStr( timestr, sizeof(timestr) ),
170                             msgs->torrent->info.name,
171                             tr_peerIoGetAddrStr( msgs->io ),
172                             msgs->info->client );
173        va_start( args, fmt );
174        evbuffer_add_vprintf( buf, fmt, args );
175        va_end( args );
176        evbuffer_add_printf( buf, " (%s:%d)\n", basename(myfile), line );
177        fwrite( EVBUFFER_DATA(buf), 1, EVBUFFER_LENGTH(buf), fp );
178
179        tr_free( myfile );
180        evbuffer_free( buf );
181    }
182}
183
184#define dbgmsg(msgs, fmt...) myDebug(__FILE__, __LINE__, msgs, ##fmt )
185
186/**
187***
188**/
189
190static void
191protocolSendRequest( tr_peermsgs * msgs, const struct peer_request * req )
192{
193    tr_peerIo * io = msgs->io;
194    struct evbuffer * out = msgs->outMessages;
195
196    dbgmsg( msgs, "requesting %u:%u->%u", req->index, req->offset, req->length );
197    tr_peerIoWriteUint32( io, out, sizeof(uint8_t) + 3*sizeof(uint32_t) );
198    tr_peerIoWriteUint8 ( io, out, BT_REQUEST );
199    tr_peerIoWriteUint32( io, out, req->index );
200    tr_peerIoWriteUint32( io, out, req->offset );
201    tr_peerIoWriteUint32( io, out, req->length );
202}
203
204static void
205protocolSendCancel( tr_peermsgs * msgs, const struct peer_request * req )
206{
207    tr_peerIo * io = msgs->io;
208    struct evbuffer * out = msgs->outMessages;
209
210    dbgmsg( msgs, "cancelling %u:%u->%u", req->index, req->offset, req->length );
211    tr_peerIoWriteUint32( io, out, sizeof(uint8_t) + 3*sizeof(uint32_t) );
212    tr_peerIoWriteUint8 ( io, out, BT_CANCEL );
213    tr_peerIoWriteUint32( io, out, req->index );
214    tr_peerIoWriteUint32( io, out, req->offset );
215    tr_peerIoWriteUint32( io, out, req->length );
216}
217
218static void
219protocolSendHave( tr_peermsgs * msgs, uint32_t index )
220{
221    tr_peerIo * io = msgs->io;
222    struct evbuffer * out = msgs->outMessages;
223
224    dbgmsg( msgs, "sending Have %u", index );
225    tr_peerIoWriteUint32( io, out, sizeof(uint8_t) + sizeof(uint32_t) );
226    tr_peerIoWriteUint8 ( io, out, BT_HAVE );
227    tr_peerIoWriteUint32( io, out, index );
228}
229
230static void
231protocolSendChoke( tr_peermsgs * msgs, int choke )
232{
233    tr_peerIo * io = msgs->io;
234    struct evbuffer * out = msgs->outMessages;
235
236    dbgmsg( msgs, "sending %s", (choke ? "Choke" : "Unchoke") );
237    tr_peerIoWriteUint32( io, out, sizeof(uint8_t) );
238    tr_peerIoWriteUint8 ( io, out, choke ? BT_CHOKE : BT_UNCHOKE );
239}
240
241/**
242***  EVENTS
243**/
244
245static const tr_peermsgs_event blankEvent = { 0, 0, 0, 0, 0.0f };
246
247static void
248publish( tr_peermsgs * msgs, tr_peermsgs_event * e )
249{
250    tr_publisherPublish( msgs->publisher, msgs->info, e );
251}
252
253static void
254fireGotAssertError( tr_peermsgs * msgs )
255{
256    tr_peermsgs_event e = blankEvent;
257    e.eventType = TR_PEERMSG_GOT_ASSERT_ERROR;
258    publish( msgs, &e );
259}
260
261static void
262fireGotError( tr_peermsgs * msgs )
263{
264    tr_peermsgs_event e = blankEvent;
265    e.eventType = TR_PEERMSG_GOT_ERROR;
266    publish( msgs, &e );
267}
268
269static void
270fireNeedReq( tr_peermsgs * msgs )
271{
272    tr_peermsgs_event e = blankEvent;
273    e.eventType = TR_PEERMSG_NEED_REQ;
274    publish( msgs, &e );
275}
276
277static void
278firePeerProgress( tr_peermsgs * msgs )
279{
280    tr_peermsgs_event e = blankEvent;
281    e.eventType = TR_PEERMSG_PEER_PROGRESS;
282    e.progress = msgs->info->progress;
283    publish( msgs, &e );
284}
285
286static void
287fireClientHave( tr_peermsgs * msgs, uint32_t pieceIndex )
288{
289    tr_peermsgs_event e = blankEvent;
290    e.eventType = TR_PEERMSG_CLIENT_HAVE;
291    e.pieceIndex = pieceIndex;
292    publish( msgs, &e );
293}
294
295static void
296fireGotBlock( tr_peermsgs * msgs, const struct peer_request * req )
297{
298    tr_peermsgs_event e = blankEvent;
299    e.eventType = TR_PEERMSG_CLIENT_BLOCK;
300    e.pieceIndex = req->index;
301    e.offset = req->offset;
302    e.length = req->length;
303    publish( msgs, &e );
304}
305
306static void
307fireCancelledReq( tr_peermsgs * msgs, const struct peer_request * req )
308{
309    tr_peermsgs_event e = blankEvent;
310    e.eventType = TR_PEERMSG_CANCEL;
311    e.pieceIndex = req->index;
312    e.offset = req->offset;
313    e.length = req->length;
314    publish( msgs, &e );
315}
316
317/**
318***  INTEREST
319**/
320
321static int
322isPieceInteresting( const tr_peermsgs   * peer,
323                    int                   piece )
324{
325    const tr_torrent * torrent = peer->torrent;
326    if( torrent->info.pieces[piece].dnd ) /* we don't want it */
327        return FALSE;
328    if( tr_cpPieceIsComplete( torrent->completion, piece ) ) /* we have it */
329        return FALSE;
330    if( !tr_bitfieldHas( peer->info->have, piece ) ) /* peer doesn't have it */
331        return FALSE;
332    if( tr_bitfieldHas( peer->info->banned, piece ) ) /* peer is banned */
333        return FALSE;
334    return TRUE;
335}
336
337/* "interested" means we'll ask for piece data if they unchoke us */
338static int
339isPeerInteresting( const tr_peermsgs * msgs )
340{
341    int i;
342    const tr_torrent * torrent;
343    const tr_bitfield * bitfield;
344    const int clientIsSeed = tr_torrentIsSeed( msgs->torrent );
345
346    if( clientIsSeed )
347        return FALSE;
348
349    torrent = msgs->torrent;
350    bitfield = tr_cpPieceBitfield( torrent->completion );
351
352    if( !msgs->info->have )
353        return TRUE;
354
355    assert( bitfield->len == msgs->info->have->len );
356    for( i=0; i<torrent->info.pieceCount; ++i )
357        if( isPieceInteresting( msgs, i ) )
358            return TRUE;
359
360    return FALSE;
361}
362
363static void
364sendInterest( tr_peermsgs * msgs, int weAreInterested )
365{
366    assert( msgs != NULL );
367    assert( weAreInterested==0 || weAreInterested==1 );
368
369    msgs->info->clientIsInterested = weAreInterested;
370    dbgmsg( msgs, "Sending %s",
371            weAreInterested ? "Interested" : "Not Interested");
372
373    tr_peerIoWriteUint32( msgs->io, msgs->outMessages, sizeof(uint8_t) );
374    tr_peerIoWriteUint8 ( msgs->io, msgs->outMessages,
375                   weAreInterested ? BT_INTERESTED : BT_NOT_INTERESTED );
376}
377
378static void
379updateInterest( tr_peermsgs * msgs )
380{
381    const int i = isPeerInteresting( msgs );
382    if( i != msgs->info->clientIsInterested )
383        sendInterest( msgs, i );
384    if( i )
385        fireNeedReq( msgs );
386}
387
388#define MIN_CHOKE_PERIOD_SEC 10
389
390static void
391cancelAllRequestsToClientExceptFast( tr_peermsgs * msgs )
392{
393    tr_list_free( &msgs->peerAskedFor, tr_free );
394}
395
396void
397tr_peerMsgsSetChoke( tr_peermsgs * msgs, int choke )
398{
399    const time_t fibrillationTime = time(NULL) - MIN_CHOKE_PERIOD_SEC;
400
401    assert( msgs != NULL );
402    assert( msgs->info != NULL );
403    assert( choke==0 || choke==1 );
404
405    if( msgs->info->chokeChangedAt > fibrillationTime )
406    {
407        dbgmsg( msgs, "Not changing choke to %d to avoid fibrillation", choke );
408    }
409    else if( msgs->info->peerIsChoked != choke )
410    {
411        msgs->info->peerIsChoked = choke;
412        if( choke )
413            cancelAllRequestsToClientExceptFast( msgs );
414        protocolSendChoke( msgs, choke );
415        msgs->info->chokeChangedAt = time( NULL );
416    }
417}
418
419/**
420***
421**/
422
423void
424tr_peerMsgsHave( tr_peermsgs * msgs,
425                 uint32_t      index )
426{
427    protocolSendHave( msgs, index );
428
429    /* since we have more pieces now, we might not be interested in this peer */
430    updateInterest( msgs );
431}
432#if 0
433static void
434sendFastSuggest( tr_peermsgs * msgs,
435                 uint32_t      pieceIndex )
436{
437    assert( msgs != NULL );
438   
439    if( tr_peerIoSupportsFEXT( msgs->io ) )
440    {
441        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, sizeof(uint8_t) + sizeof(uint32_t) );
442        tr_peerIoWriteUint8( msgs->io, msgs->outMessages, BT_SUGGEST );
443        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, pieceIndex );
444    }
445}
446#endif
447static void
448sendFastHave( tr_peermsgs * msgs, int all )
449{
450    assert( msgs != NULL );
451   
452    if( tr_peerIoSupportsFEXT( msgs->io ) )
453    {
454        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, sizeof(uint8_t) );
455        tr_peerIoWriteUint8( msgs->io, msgs->outMessages, ( all ? BT_HAVE_ALL
456                                                                : BT_HAVE_NONE ) );
457        updateInterest( msgs );
458    }
459}
460
461static void
462sendFastReject( tr_peermsgs * msgs,
463                uint32_t      pieceIndex,
464                uint32_t      offset,
465                uint32_t      length )
466{
467    assert( msgs != NULL );
468
469    if( tr_peerIoSupportsFEXT( msgs->io ) )
470    {
471        const uint32_t len = sizeof(uint8_t) + 3 * sizeof(uint32_t);
472        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, len );
473        tr_peerIoWriteUint8( msgs->io, msgs->outMessages, BT_REJECT );
474        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, pieceIndex );
475        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, offset );
476        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, length );
477    }
478}
479
480static void
481sendFastAllowed( tr_peermsgs * msgs,
482                 uint32_t      pieceIndex)
483{
484    assert( msgs != NULL );
485   
486    if( tr_peerIoSupportsFEXT( msgs->io ) )
487    {
488        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, sizeof(uint8_t) + sizeof(uint32_t) );
489        tr_peerIoWriteUint8( msgs->io, msgs->outMessages, BT_ALLOWED_FAST );
490        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, pieceIndex );
491    }
492}
493
494
495
496static void
497sendFastAllowedSet( tr_peermsgs * msgs )
498{
499    int i = 0;
500    while (i <= msgs->torrent->info.pieceCount )
501    {
502        if ( tr_bitfieldHas( msgs->peerAllowedPieces, i) )
503            sendFastAllowed( msgs, i );
504        i++;
505    }
506}
507
508
509/**
510***
511**/
512
513static int
514reqIsValid( const tr_peermsgs   * msgs,
515            uint32_t              index,
516            uint32_t              offset,
517            uint32_t              length )
518{
519    const tr_torrent * tor = msgs->torrent;
520
521    if( index >= (uint32_t) tor->info.pieceCount )
522        return FALSE;
523    if ( (int)offset >= tr_torPieceCountBytes( tor, (int)index ) )
524        return FALSE;
525    if( length > MAX_REQUEST_BYTE_COUNT )
526        return FALSE;
527    if( tr_pieceOffset( tor, index, offset, length ) > tor->info.totalSize )
528        return FALSE;
529
530    return TRUE;
531}
532
533static int
534requestIsValid( const tr_peermsgs * msgs, const struct peer_request * req )
535{
536    return reqIsValid( msgs, req->index, req->offset, req->length );
537}
538
539static void
540pumpRequestQueue( tr_peermsgs * msgs )
541{
542    const int max = msgs->maxActiveRequests;
543    const int min = msgs->minActiveRequests;
544    int count = tr_list_size( msgs->clientAskedFor );
545    int sent = 0;
546
547    if( count > min )
548        return;
549    if( msgs->info->clientIsChoked )
550        return;
551
552    while( ( count < max ) && ( msgs->clientWillAskFor != NULL ) )
553    {
554        struct peer_request * r = tr_list_pop_front( &msgs->clientWillAskFor );
555        protocolSendRequest( msgs, r );
556        r->time_requested = msgs->lastReqAddedAt = time( NULL );
557        tr_list_append( &msgs->clientAskedFor, r );
558        ++count;
559        ++sent;
560    }
561
562    if( sent )
563        dbgmsg( msgs, "pump sent %d requests, now have %d active and %d queued",
564                sent,
565                tr_list_size(msgs->clientAskedFor),
566                tr_list_size(msgs->clientWillAskFor) );
567
568    if( count < max )
569        fireNeedReq( msgs );
570}
571
572static int
573pulse( void * vmsgs );
574
575int
576tr_peerMsgsAddRequest( tr_peermsgs * msgs,
577                       uint32_t      index, 
578                       uint32_t      offset, 
579                       uint32_t      length )
580{
581    const int req_max = msgs->maxActiveRequests;
582    struct peer_request tmp, *req;
583
584    assert( msgs != NULL );
585    assert( msgs->torrent != NULL );
586    assert( reqIsValid( msgs, index, offset, length ) );
587
588    /**
589    ***  Reasons to decline the request
590    **/
591
592    /* don't send requests to choked clients */
593    if( msgs->info->clientIsChoked ) {
594        dbgmsg( msgs, "declining request because they're choking us" );
595        return TR_ADDREQ_CLIENT_CHOKED;
596    }
597
598    /* peer doesn't have this piece */
599    if( !tr_bitfieldHas( msgs->info->have, index ) )
600        return TR_ADDREQ_MISSING;
601
602    /* peer's queue is full */
603    if( tr_list_size( msgs->clientWillAskFor ) >= req_max ) {
604        dbgmsg( msgs, "declining request because we're full" );
605        return TR_ADDREQ_FULL;
606    }
607
608    /* have we already asked for this piece? */
609    tmp.index = index;
610    tmp.offset = offset;
611    tmp.length = length;
612    if( tr_list_find( msgs->clientAskedFor, &tmp, compareRequest ) ) {
613        dbgmsg( msgs, "declining because it's a duplicate" );
614        return TR_ADDREQ_DUPLICATE;
615    }
616    if( tr_list_find( msgs->clientWillAskFor, &tmp, compareRequest ) ) {
617        dbgmsg( msgs, "declining because it's a duplicate" );
618        return TR_ADDREQ_DUPLICATE;
619    }
620
621    /**
622    ***  Accept this request
623    **/
624
625    dbgmsg( msgs, "added req for piece %d, offset %d", (int)index, (int)offset );
626    req = tr_new0( struct peer_request, 1 );
627    *req = tmp;
628    tr_list_append( &msgs->clientWillAskFor, req );
629    pulse( msgs );
630    return TR_ADDREQ_OK;
631}
632
633static void
634cancelAllRequestsToPeer( tr_peermsgs * msgs )
635{
636    struct peer_request * req;
637
638    while(( req = tr_list_pop_front( &msgs->clientWillAskFor ) ))
639    {
640        fireCancelledReq( msgs, req );
641        tr_free( req );
642    }
643
644    while(( req = tr_list_pop_front( &msgs->clientAskedFor ) ))
645    {
646        fireCancelledReq( msgs, req );
647        protocolSendCancel( msgs, req );
648        tr_free( req );
649    }
650}
651
652void
653tr_peerMsgsCancel( tr_peermsgs * msgs,
654                   uint32_t      pieceIndex,
655                   uint32_t      offset,
656                   uint32_t      length )
657{
658    struct peer_request *req, tmp;
659
660    assert( msgs != NULL );
661    assert( length > 0 );
662
663    /* have we asked the peer for this piece? */
664    tmp.index = pieceIndex;
665    tmp.offset = offset;
666    tmp.length = length;
667
668    /* if it's only in the queue and hasn't been sent yet, free it */
669    if(( req = tr_list_remove( &msgs->clientWillAskFor, &tmp, compareRequest ) ))
670    {
671        fireCancelledReq( msgs, req );
672        tr_free( req );
673    }
674
675    /* if it's already been sent, send a cancel message too */
676    if(( req = tr_list_remove( &msgs->clientAskedFor, &tmp, compareRequest ) ))
677    {
678        protocolSendCancel( msgs, req );
679        fireCancelledReq( msgs, req );
680        tr_free( req );
681    }
682}
683
684/**
685***
686**/
687
688static void
689sendLtepHandshake( tr_peermsgs * msgs )
690{
691    benc_val_t val, *m;
692    char * buf;
693    int len;
694    int pex;
695    const char * v = TR_NAME " " USERAGENT_PREFIX;
696    const int port = tr_getPublicPort( msgs->handle );
697    struct evbuffer * outbuf;
698
699    if( msgs->clientSentLtepHandshake )
700        return;
701
702    outbuf = evbuffer_new( );
703    dbgmsg( msgs, "sending an ltep handshake" );
704    msgs->clientSentLtepHandshake = 1;
705
706    /* decide if we want to advertise pex support */
707    if( !tr_torrentIsPexEnabled( msgs->torrent ) )
708        pex = 0;
709    else if( msgs->peerSentLtepHandshake )
710        pex = msgs->peerSupportsPex ? 1 : 0;
711    else
712        pex = 1;
713
714    tr_bencInit( &val, TYPE_DICT );
715    tr_bencDictReserve( &val, 4 );
716    tr_bencInitInt( tr_bencDictAdd( &val, "e" ), 1 );
717    m  = tr_bencDictAdd( &val, "m" );
718    tr_bencInit( m, TYPE_DICT );
719    if( pex ) {
720        tr_bencDictReserve( m, 1 );
721        tr_bencInitInt( tr_bencDictAdd( m, "ut_pex" ), OUR_LTEP_PEX );
722    }
723    if( port > 0 )
724        tr_bencInitInt( tr_bencDictAdd( &val, "p" ), port );
725    tr_bencInitStr( tr_bencDictAdd( &val, "v" ), v, 0, 1 );
726    buf = tr_bencSave( &val, &len );
727
728    tr_peerIoWriteUint32( msgs->io, outbuf, 2*sizeof(uint8_t) + len );
729    tr_peerIoWriteUint8 ( msgs->io, outbuf, BT_LTEP );
730    tr_peerIoWriteUint8 ( msgs->io, outbuf, LTEP_HANDSHAKE );
731    tr_peerIoWriteBytes ( msgs->io, outbuf, buf, len );
732
733    tr_peerIoWriteBuf( msgs->io, outbuf );
734
735#if 0
736    dbgmsg( msgs, "here is the ltep handshake we sent:" );
737    tr_bencPrint( &val );
738#endif
739
740    /* cleanup */
741    tr_bencFree( &val );
742    tr_free( buf );
743    evbuffer_free( outbuf );
744}
745
746static void
747parseLtepHandshake( tr_peermsgs * msgs, int len, struct evbuffer * inbuf )
748{
749    benc_val_t val, * sub;
750    uint8_t * tmp = tr_new( uint8_t, len );
751
752    tr_peerIoReadBytes( msgs->io, inbuf, tmp, len );
753    msgs->peerSentLtepHandshake = 1;
754
755    if( tr_bencLoad( tmp, len, &val, NULL ) || val.type!=TYPE_DICT ) {
756        dbgmsg( msgs, "GET  extended-handshake, couldn't get dictionary" );
757        tr_free( tmp );
758        return;
759    }
760
761#if 0
762    dbgmsg( msgs, "here is the ltep handshake we read:" );
763    tr_bencPrint( &val );
764#endif
765
766    /* does the peer prefer encrypted connections? */
767    sub = tr_bencDictFind( &val, "e" );
768    if( tr_bencIsInt( sub ) )
769        msgs->info->encryption_preference = sub->val.i
770                                      ? ENCRYPTION_PREFERENCE_YES
771                                      : ENCRYPTION_PREFERENCE_NO;
772
773    /* check supported messages for utorrent pex */
774    sub = tr_bencDictFind( &val, "m" );
775    if( tr_bencIsDict( sub ) ) {
776        sub = tr_bencDictFind( sub, "ut_pex" );
777        if( tr_bencIsInt( sub ) ) {
778            msgs->peerSupportsPex = 1;
779            msgs->ut_pex_id = (uint8_t) sub->val.i;
780            dbgmsg( msgs, "msgs->ut_pex is %d", (int)msgs->ut_pex_id );
781        }
782    }
783
784    /* get peer's listening port */
785    sub = tr_bencDictFind( &val, "p" );
786    if( tr_bencIsInt( sub ) ) {
787        msgs->info->port = htons( (uint16_t)sub->val.i );
788        dbgmsg( msgs, "msgs->port is now %hu", msgs->info->port );
789    }
790
791    tr_bencFree( &val );
792    tr_free( tmp );
793}
794
795static void
796parseUtPex( tr_peermsgs * msgs, int msglen, struct evbuffer * inbuf )
797{
798    benc_val_t val, * sub;
799    uint8_t * tmp;
800
801    if( !tr_torrentIsPexEnabled( msgs->torrent ) ) /* no sharing! */
802        return;
803
804    tmp = tr_new( uint8_t, msglen );
805    tr_peerIoReadBytes( msgs->io, inbuf, tmp, msglen );
806
807    if( tr_bencLoad( tmp, msglen, &val, NULL ) || !tr_bencIsDict( &val ) ) {
808        dbgmsg( msgs, "GET can't read extended-pex dictionary" );
809        tr_free( tmp );
810        return;
811    }
812
813    sub = tr_bencDictFind( &val, "added" );
814    if( tr_bencIsStr(sub) && ((sub->val.s.i % 6) == 0)) {
815        const int n = sub->val.s.i / 6 ;
816        dbgmsg( msgs, "got %d peers from uT pex", n );
817        tr_peerMgrAddPeers( msgs->handle->peerMgr,
818                            msgs->torrent->info.hash,
819                            TR_PEER_FROM_PEX,
820                            (uint8_t*)sub->val.s.s, n );
821    }
822
823    tr_bencFree( &val );
824    tr_free( tmp );
825}
826
827static void
828sendPex( tr_peermsgs * msgs );
829
830static void
831parseLtep( tr_peermsgs * msgs, int msglen, struct evbuffer * inbuf )
832{
833    uint8_t ltep_msgid;
834
835    tr_peerIoReadUint8( msgs->io, inbuf, &ltep_msgid );
836    msglen--;
837
838    if( ltep_msgid == LTEP_HANDSHAKE )
839    {
840        dbgmsg( msgs, "got ltep handshake" );
841        parseLtepHandshake( msgs, msglen, inbuf );
842        sendLtepHandshake( msgs );
843        sendPex( msgs );
844    }
845    else if( ltep_msgid == msgs->ut_pex_id )
846    {
847        dbgmsg( msgs, "got ut pex" );
848        msgs->peerSupportsPex = 1;
849        parseUtPex( msgs, msglen, inbuf );
850    }
851    else
852    {
853        dbgmsg( msgs, "skipping unknown ltep message (%d)", (int)ltep_msgid );
854        evbuffer_drain( inbuf, msglen );
855    }
856}
857
858static int
859readBtLength( tr_peermsgs * msgs, struct evbuffer * inbuf )
860{
861    uint32_t len;
862    const size_t needlen = sizeof(uint32_t);
863
864    if( EVBUFFER_LENGTH(inbuf) < needlen )
865        return READ_MORE;
866
867    tr_peerIoReadUint32( msgs->io, inbuf, &len );
868
869    if( len == 0 ) /* peer sent us a keepalive message */
870        dbgmsg( msgs, "got KeepAlive" );
871    else {
872        msgs->incomingMessageLength = len;
873        msgs->state = AWAITING_BT_MESSAGE;
874    }
875
876    return READ_AGAIN;
877}
878
879static void
880updatePeerProgress( tr_peermsgs * msgs )
881{
882    msgs->info->progress = tr_bitfieldCountTrueBits( msgs->info->have ) / (float)msgs->torrent->info.pieceCount;
883    dbgmsg( msgs, "peer progress is %f", msgs->info->progress );
884    updateInterest( msgs );
885    firePeerProgress( msgs );
886}
887
888static int
889clientCanSendFastBlock( const tr_peermsgs * msgs UNUSED )
890{
891    /* We can't send a fast piece if a peer has more than MAX_FAST_ALLOWED_THRESHOLD pieces */
892    if( tr_bitfieldCountTrueBits( msgs->info->have ) > MAX_FAST_ALLOWED_THRESHOLD )
893        return FALSE;
894   
895    /* ...or if we don't have ourself enough pieces */
896    if( tr_bitfieldCountTrueBits( tr_cpPieceBitfield( msgs->torrent->completion ) ) < MAX_FAST_ALLOWED_THRESHOLD )
897        return FALSE;
898
899    /* Maybe a bandwidth limit ? */
900    return TRUE;
901}
902
903static void
904peerMadeRequest( tr_peermsgs * msgs, const struct peer_request * req )
905{
906    const int reqIsValid = requestIsValid( msgs, req );
907    const int clientHasPiece = reqIsValid && tr_cpPieceIsComplete( msgs->torrent->completion, req->index );
908    const int peerIsChoked = msgs->info->peerIsChoked;
909    const int peerIsFast = tr_peerIoSupportsFEXT( msgs->io );
910    const int pieceIsFast = reqIsValid && tr_bitfieldHas( msgs->peerAllowedPieces, req->index );
911    const int canSendFast = clientCanSendFastBlock( msgs );
912
913    if( !reqIsValid ) /* bad request */
914    {
915        dbgmsg( msgs, "rejecting an invalid request." );
916        sendFastReject( msgs, req->index, req->offset, req->length );
917    }
918    else if( !clientHasPiece ) /* we don't have it */
919    {
920        dbgmsg( msgs, "rejecting request for a piece we don't have." );
921        sendFastReject( msgs, req->index, req->offset, req->length );
922    }
923    else if( peerIsChoked && !peerIsFast ) /* doesn't he know he's choked? */
924    {
925        tr_peerMsgsSetChoke( msgs, 1 );
926        sendFastReject( msgs, req->index, req->offset, req->length );
927    }
928    else if( peerIsChoked && peerIsFast && ( !pieceIsFast || !canSendFast ) )
929    {
930        sendFastReject( msgs, req->index, req->offset, req->length );
931    }
932    else /* YAY */
933    {
934        struct peer_request * tmp = tr_new( struct peer_request, 1 );
935        *tmp = *req;
936        if( peerIsFast && pieceIsFast )
937            tr_list_append( &msgs->peerAskedForFast, tmp );
938        else
939            tr_list_append( &msgs->peerAskedFor, tmp );
940    }
941}
942
943static int
944messageLengthIsCorrect( const tr_peermsgs * msg, uint8_t id, uint32_t len )
945{
946    switch( id )
947    {
948        case BT_CHOKE:
949        case BT_UNCHOKE:
950        case BT_INTERESTED:
951        case BT_NOT_INTERESTED:
952        case BT_HAVE_ALL:
953        case BT_HAVE_NONE:
954            return len==1;
955
956        case BT_HAVE:
957        case BT_SUGGEST:
958        case BT_ALLOWED_FAST:
959            return len==5;
960
961        case BT_BITFIELD:
962            return len == (msg->torrent->info.pieceCount+7u)/8u + 1u;
963       
964        case BT_REQUEST:
965        case BT_CANCEL:
966        case BT_REJECT:
967            return len==13;
968
969        case BT_PIECE:
970            return len>9 && len<=16393;
971
972        case BT_PORT:
973            return len==3;
974
975        case BT_LTEP:
976            return len >= 2;
977
978        default:
979            return FALSE;
980    }
981}
982
983static int
984clientGotBlock( tr_peermsgs * msgs, const uint8_t * block, const struct peer_request * req );
985
986static int
987readBtMessage( tr_peermsgs * msgs, struct evbuffer * inbuf )
988{
989    int ret;
990    uint8_t id;
991    uint32_t ui32;
992    uint32_t msglen = msgs->incomingMessageLength;
993    const size_t startBufLen = EVBUFFER_LENGTH( inbuf );
994
995    if( EVBUFFER_LENGTH(inbuf) < msglen )
996        return READ_MORE;
997
998    tr_peerIoReadUint8( msgs->io, inbuf, &id );
999    dbgmsg( msgs, "got BT id %d, len %d, buffer size is %d", (int)id, (int)msglen, (int)EVBUFFER_LENGTH(inbuf) );
1000
1001    if( !messageLengthIsCorrect( msgs, id, msglen ) )
1002    {
1003        dbgmsg( msgs, "bad packet - BT message #%d with a length of %d", (int)id, (int)msglen );
1004        fireGotError( msgs );
1005        return READ_DONE;
1006    }
1007
1008    --msglen;
1009    ret = 0;
1010    switch( id )
1011    {
1012        case BT_CHOKE:
1013            dbgmsg( msgs, "got Choke" );
1014            msgs->info->clientIsChoked = 1;
1015            cancelAllRequestsToPeer( msgs );
1016            cancelAllRequestsToClientExceptFast( msgs );
1017            break;
1018
1019        case BT_UNCHOKE:
1020            dbgmsg( msgs, "got Unchoke" );
1021            msgs->info->clientIsChoked = 0;
1022            fireNeedReq( msgs );
1023            break;
1024
1025        case BT_INTERESTED:
1026            dbgmsg( msgs, "got Interested" );
1027            msgs->info->peerIsInterested = 1;
1028            tr_peerMsgsSetChoke( msgs, 0 );
1029            break;
1030
1031        case BT_NOT_INTERESTED:
1032            dbgmsg( msgs, "got Not Interested" );
1033            msgs->info->peerIsInterested = 0;
1034            break;
1035           
1036        case BT_HAVE:
1037            tr_peerIoReadUint32( msgs->io, inbuf, &ui32 );
1038            dbgmsg( msgs, "got Have: %u", ui32 );
1039            tr_bitfieldAdd( msgs->info->have, ui32 );
1040            /* If this is a fast-allowed piece for this peer, mark it as normal now */
1041            if( msgs->clientAllowedPieces != NULL && tr_bitfieldHas( msgs->clientAllowedPieces, ui32 ) )
1042                tr_bitfieldRem( msgs->clientAllowedPieces, ui32 );
1043            updatePeerProgress( msgs );
1044            tr_rcTransferred( msgs->torrent->swarmspeed, msgs->torrent->info.pieceSize );
1045            break;
1046
1047        case BT_BITFIELD: {
1048            const int clientIsSeed = tr_torrentIsSeed( msgs->torrent );
1049            dbgmsg( msgs, "got a bitfield" );
1050            tr_peerIoReadBytes( msgs->io, inbuf, msgs->info->have->bits, msglen );
1051            updatePeerProgress( msgs );
1052            tr_peerMsgsSetChoke( msgs, !clientIsSeed || (msgs->info->progress<1.0) );
1053            fireNeedReq( msgs );
1054            break;
1055        }
1056
1057        case BT_REQUEST: {
1058            struct peer_request req;
1059            tr_peerIoReadUint32( msgs->io, inbuf, &req.index );
1060            tr_peerIoReadUint32( msgs->io, inbuf, &req.offset );
1061            tr_peerIoReadUint32( msgs->io, inbuf, &req.length );
1062            dbgmsg( msgs, "got Request: %u:%u->%u", req.index, req.offset, req.length );
1063            peerMadeRequest( msgs, &req );
1064            break;
1065        }
1066
1067        case BT_CANCEL: {
1068            struct peer_request req;
1069            tr_peerIoReadUint32( msgs->io, inbuf, &req.index );
1070            tr_peerIoReadUint32( msgs->io, inbuf, &req.offset );
1071            tr_peerIoReadUint32( msgs->io, inbuf, &req.length );
1072            dbgmsg( msgs, "got a Cancel %u:%u->%u", req.index, req.offset, req.length );
1073            tr_free( tr_list_remove( &msgs->peerAskedForFast, &req, compareRequest ) );
1074            tr_free( tr_list_remove( &msgs->peerAskedFor, &req, compareRequest ) );
1075            break;
1076        }
1077
1078        case BT_PIECE: {
1079            uint8_t * block;
1080            struct peer_request req;
1081            tr_peerIoReadUint32( msgs->io, inbuf, &req.index );
1082            tr_peerIoReadUint32( msgs->io, inbuf, &req.offset );
1083            req.length = msglen - 8;
1084            block = tr_new( uint8_t, req.length );
1085            tr_peerIoReadBytes( msgs->io, inbuf, block, req.length );
1086            dbgmsg( msgs, "got a Block %u:%u->%u", req.index, req.offset, req.length );
1087            ret = clientGotBlock( msgs, block, &req );
1088            tr_free( block );
1089            break;
1090        }
1091       
1092        case BT_PORT:
1093            dbgmsg( msgs, "Got a BT_PORT" );
1094            tr_peerIoReadUint16( msgs->io, inbuf, &msgs->info->port );
1095            break;
1096           
1097        case BT_SUGGEST: {
1098            dbgmsg( msgs, "Got a BT_SUGGEST" );
1099            tr_peerIoReadUint32( msgs->io, inbuf, &ui32 );
1100            const tr_bitfield * bt = tr_cpPieceBitfield( msgs->torrent->completion );
1101            if( tr_bitfieldHas( bt, ui32 ) )
1102                tr_bitfieldAdd( msgs->clientSuggestedPieces, ui32 );
1103            break;
1104        }
1105           
1106        case BT_HAVE_ALL:
1107            dbgmsg( msgs, "Got a BT_HAVE_ALL" );
1108            tr_bitfieldAddRange( msgs->info->have, 0, msgs->torrent->info.pieceCount );
1109            updatePeerProgress( msgs );
1110            break;
1111       
1112       
1113        case BT_HAVE_NONE:
1114            dbgmsg( msgs, "Got a BT_HAVE_NONE" );
1115            tr_bitfieldClear( msgs->info->have );
1116            updatePeerProgress( msgs );
1117            break;
1118       
1119        case BT_REJECT: {
1120            struct peer_request req;
1121            dbgmsg( msgs, "Got a BT_REJECT" );
1122            tr_peerIoReadUint32( msgs->io, inbuf, &req.index );
1123            tr_peerIoReadUint32( msgs->io, inbuf, &req.offset );
1124            tr_peerIoReadUint32( msgs->io, inbuf, &req.length );
1125            tr_free( tr_list_remove( &msgs->clientAskedFor, &req, compareRequest ) );
1126            break;
1127        }
1128
1129        case BT_ALLOWED_FAST: {
1130            dbgmsg( msgs, "Got a BT_ALLOWED_FAST" );
1131            tr_peerIoReadUint32( msgs->io, inbuf, &ui32 );
1132            tr_bitfieldAdd( msgs->clientAllowedPieces, ui32 );
1133            break;
1134        }
1135
1136        case BT_LTEP:
1137            dbgmsg( msgs, "Got a BT_LTEP" );
1138            parseLtep( msgs, msglen, inbuf );
1139            break;
1140
1141        default:
1142            dbgmsg( msgs, "peer sent us an UNKNOWN: %d", (int)id );
1143            tr_peerIoDrain( msgs->io, inbuf, msglen );
1144assert( 0 );
1145            break;
1146    }
1147
1148    dbgmsg( msgs, "startBufLen was %d, msglen was %d, current inbuf len is %d", (int)startBufLen, (int)(msglen+1), (int)EVBUFFER_LENGTH(inbuf) );
1149
1150    if( ret == (int)TR_ERROR_ASSERT )
1151    {
1152        fireGotAssertError( msgs );
1153        return READ_DONE;
1154    }
1155    else if( ret == TR_OK )
1156    {
1157        assert( msglen + 1 == msgs->incomingMessageLength );
1158        assert( EVBUFFER_LENGTH(inbuf) == startBufLen - msgs->incomingMessageLength );
1159
1160        msgs->incomingMessageLength = -1;
1161        msgs->state = AWAITING_BT_LENGTH;
1162        return READ_AGAIN;
1163    }
1164    else
1165    {
1166        fireGotError( msgs );
1167        return READ_DONE;
1168    }
1169}
1170
1171static void
1172clientGotBytes( tr_peermsgs * msgs, uint32_t byteCount )
1173{
1174    tr_torrent * tor = msgs->torrent;
1175    tor->activityDate = tr_date( );
1176    tor->downloadedCur += byteCount;
1177    msgs->info->pieceDataActivityDate = time( NULL );
1178    tr_rcTransferred( msgs->info->rcToClient, byteCount );
1179    tr_rcTransferred( tor->download, byteCount );
1180    tr_rcTransferred( tor->handle->download, byteCount );
1181}
1182
1183static void
1184peerGotBytes( tr_peermsgs * msgs, uint32_t byteCount )
1185{
1186    tr_torrent * tor = msgs->torrent;
1187    tor->activityDate = tr_date( );
1188    tor->uploadedCur += byteCount;
1189    msgs->info->pieceDataActivityDate = time( NULL );
1190    tr_rcTransferred( msgs->info->rcToPeer, byteCount );
1191    tr_rcTransferred( tor->upload, byteCount );
1192    tr_rcTransferred( tor->handle->upload, byteCount );
1193}
1194
1195static int
1196canDownload( const tr_peermsgs * msgs )
1197{
1198    tr_torrent * tor = msgs->torrent;
1199
1200    if( tor->downloadLimitMode == TR_SPEEDLIMIT_GLOBAL )
1201        return !tor->handle->useDownloadLimit || tr_rcCanTransfer( tor->handle->download );
1202
1203    if( tor->downloadLimitMode == TR_SPEEDLIMIT_SINGLE )
1204        return tr_rcCanTransfer( tor->download );
1205
1206    return TRUE;
1207}
1208
1209static void
1210reassignBytesToCorrupt( tr_peermsgs * msgs, uint32_t byteCount )
1211{
1212    tr_torrent * tor = msgs->torrent;
1213
1214    /* increment the `corrupt' field */
1215    tor->corruptCur += byteCount;
1216
1217    /* decrement the `downloaded' field */
1218    if( tor->downloadedCur >= byteCount )
1219        tor->downloadedCur -= byteCount;
1220    else
1221        tor->downloadedCur = 0;
1222}
1223
1224
1225static void
1226gotBadPiece( tr_peermsgs * msgs, uint32_t pieceIndex )
1227{
1228    const uint32_t byteCount = tr_torPieceCountBytes( msgs->torrent, (int)pieceIndex );
1229    reassignBytesToCorrupt( msgs, byteCount );
1230}
1231
1232static void
1233clientGotUnwantedBlock( tr_peermsgs * msgs, const struct peer_request * req )
1234{
1235    reassignBytesToCorrupt( msgs, req->length );
1236}
1237
1238static void
1239addPeerToBlamefield( tr_peermsgs * msgs, uint32_t index )
1240{
1241    if( !msgs->info->blame )
1242         msgs->info->blame = tr_bitfieldNew( msgs->torrent->info.pieceCount );
1243    tr_bitfieldAdd( msgs->info->blame, index );
1244}
1245
1246static int
1247clientGotBlock( tr_peermsgs * msgs, const uint8_t * data, const struct peer_request * req )
1248{
1249    int i;
1250    tr_torrent * tor = msgs->torrent;
1251    const int block = _tr_block( tor, req->index, req->offset );
1252    struct peer_request *myreq;
1253
1254    assert( msgs != NULL );
1255    assert( req != NULL );
1256
1257    if( req->length != (uint32_t)tr_torBlockCountBytes( msgs->torrent, block ) )
1258    {
1259        dbgmsg( msgs, "wrong block size -- expected %u, got %d",
1260                tr_torBlockCountBytes( msgs->torrent, block ), req->length );
1261        return TR_ERROR_ASSERT;
1262    }
1263
1264    /* save the block */
1265    dbgmsg( msgs, "got block %u:%u->%u", req->index, req->offset, req->length );
1266
1267    /**
1268    *** Remove the block from our `we asked for this' list
1269    **/
1270
1271    myreq = tr_list_remove( &msgs->clientAskedFor, req, compareRequest );
1272    if( myreq == NULL ) {
1273        clientGotUnwantedBlock( msgs, req );
1274        dbgmsg( msgs, "we didn't ask for this message..." );
1275        return 0;
1276    }
1277
1278    dbgmsg( msgs, "got block %u:%u->%u (turnaround time %d secs)", 
1279                  myreq->index, myreq->offset, myreq->length,
1280                  (int)(time(NULL) - myreq->time_requested) );
1281    dbgmsg( msgs, "peer has %d more blocks we've asked for",
1282                  tr_list_size(msgs->clientAskedFor));
1283
1284    /**
1285    *** Error checks
1286    **/
1287
1288    if( tr_cpBlockIsComplete( tor->completion, block ) ) {
1289        dbgmsg( msgs, "we have this block already..." );
1290        clientGotUnwantedBlock( msgs, req );
1291        return 0;
1292    }
1293
1294    /**
1295    ***  Save the block
1296    **/
1297
1298    msgs->info->peerSentPieceDataAt = time( NULL );
1299    clientGotBytes( msgs, req->length );
1300    i = tr_ioWrite( tor, req->index, req->offset, req->length, data );
1301    if( i )
1302        return 0;
1303
1304    tr_cpBlockAdd( tor->completion, block );
1305
1306    addPeerToBlamefield( msgs, req->index );
1307
1308    fireGotBlock( msgs, req );
1309
1310    /**
1311    ***  Handle if this was the last block in the piece
1312    **/
1313
1314    if( tr_cpPieceIsComplete( tor->completion, req->index ) )
1315    {
1316        if( tr_ioHash( tor, req->index ) )
1317        {
1318            gotBadPiece( msgs, req->index );
1319            return 0;
1320        }
1321
1322        fireClientHave( msgs, req->index );
1323    }
1324
1325    return 0;
1326}
1327
1328static ReadState
1329canRead( struct bufferevent * evin, void * vmsgs )
1330{
1331    ReadState ret;
1332    tr_peermsgs * msgs = (tr_peermsgs *) vmsgs;
1333    struct evbuffer * inbuf = EVBUFFER_INPUT ( evin );
1334
1335    if( !canDownload( msgs ) )
1336    {
1337        msgs->notListening = 1;
1338        tr_peerIoSetIOMode ( msgs->io, 0, EV_READ );
1339        ret = READ_DONE;
1340    }
1341    else switch( msgs->state )
1342    {
1343        case AWAITING_BT_LENGTH:  ret = readBtLength  ( msgs, inbuf ); break;
1344        case AWAITING_BT_MESSAGE: ret = readBtMessage ( msgs, inbuf ); break;
1345        default: assert( 0 );
1346    }
1347
1348    return ret;
1349}
1350
1351static void
1352sendKeepalive( tr_peermsgs * msgs )
1353{
1354    dbgmsg( msgs, "sending a keepalive message" );
1355    tr_peerIoWriteUint32( msgs->io, msgs->outMessages, 0 );
1356}
1357
1358/**
1359***
1360**/
1361
1362static int
1363canWrite( const tr_peermsgs * msgs )
1364{
1365    /* don't let our outbuffer get too large */
1366    if( tr_peerIoWriteBytesWaiting( msgs->io ) > 4096 )
1367        return FALSE;
1368
1369    return TRUE;
1370}
1371
1372static size_t
1373getUploadMax( const tr_peermsgs * msgs )
1374{
1375    static const size_t maxval = ~0;
1376    const tr_torrent * tor = msgs->torrent;
1377
1378    if( !canWrite( msgs ) )
1379        return 0;
1380
1381    if( tor->uploadLimitMode == TR_SPEEDLIMIT_GLOBAL )
1382        return tor->handle->useUploadLimit
1383            ? tr_rcBytesLeft( tor->handle->upload ) : maxval;
1384
1385    if( tor->uploadLimitMode == TR_SPEEDLIMIT_SINGLE )
1386        return tr_rcBytesLeft( tor->upload );
1387
1388    return maxval;
1389}
1390
1391static int
1392ratePulse( void * vmsgs )
1393{
1394    tr_peermsgs * msgs = (tr_peermsgs *) vmsgs;
1395    msgs->info->rateToClient = tr_rcRate( msgs->info->rcToClient );
1396    msgs->info->rateToPeer = tr_rcRate( msgs->info->rcToPeer );
1397    msgs->maxActiveRequests = MIN( 8 + (int)(msgs->info->rateToClient/5), 100 );
1398    msgs->minActiveRequests = msgs->maxActiveRequests / 3;
1399    return TRUE;
1400}
1401
1402static struct peer_request*
1403popNextRequest( tr_peermsgs * msgs )
1404{
1405    struct peer_request * ret;
1406    ret = tr_list_pop_front( &msgs->peerAskedForFast );
1407    if( !ret )
1408        ret = tr_list_pop_front( &msgs->peerAskedFor);
1409    return ret;
1410}
1411
1412static int
1413pulse( void * vmsgs )
1414{
1415    const time_t now = time( NULL );
1416    tr_peermsgs * msgs = vmsgs;
1417    struct peer_request * r;
1418    size_t len;
1419
1420    /* if we froze out a downloaded block because of speed limits,
1421       start listening to the peer again */
1422    if( msgs->notListening && canDownload( msgs ) )
1423    {
1424        msgs->notListening = 0;
1425        tr_peerIoSetIOMode ( msgs->io, EV_READ, 0 );
1426    }
1427
1428    pumpRequestQueue( msgs );
1429
1430    if( !canWrite( msgs ) )
1431    {
1432    }
1433    else if(( len = EVBUFFER_LENGTH( msgs->outBlock ) ))
1434    {
1435        const size_t uploadMax = getUploadMax( msgs );
1436        const size_t outlen = MIN( len, uploadMax );
1437        tr_peerIoWrite( msgs->io, EVBUFFER_DATA( msgs->outBlock ), outlen );
1438        evbuffer_drain( msgs->outBlock, outlen );
1439        msgs->clientSentAnythingAt = now;
1440        peerGotBytes( msgs, outlen );
1441        len -= outlen;
1442        dbgmsg( msgs, "wrote %d bytes; %d left in block", (int)outlen, (int)len );
1443        fflush( stdout );
1444    }
1445    else if(( len = EVBUFFER_LENGTH( msgs->outMessages ) ))
1446    {
1447        tr_peerIoWriteBuf( msgs->io, msgs->outMessages );
1448        msgs->clientSentAnythingAt = now;
1449    }
1450    else if( ( now - msgs->clientSentAnythingAt ) > KEEPALIVE_INTERVAL_SECS )
1451    {
1452        sendKeepalive( msgs );
1453    }
1454
1455    if( !EVBUFFER_LENGTH( msgs->outBlock )
1456        && (( r = popNextRequest( msgs )))
1457        && requestIsValid( msgs, r )
1458        && tr_cpPieceIsComplete( msgs->torrent->completion, r->index ) )
1459    {
1460        uint8_t * buf = tr_new( uint8_t, r->length );
1461
1462        if( !tr_ioRead( msgs->torrent, r->index, r->offset, r->length, buf ) )
1463        {
1464            tr_peerIo * io = msgs->io;
1465            struct evbuffer * out = msgs->outBlock;
1466
1467            dbgmsg( msgs, "sending block %u:%u->%u", r->index, r->offset, r->length );
1468            tr_peerIoWriteUint32( io, out, sizeof(uint8_t) + 2*sizeof(uint32_t) + r->length );
1469            tr_peerIoWriteUint8 ( io, out, BT_PIECE );
1470            tr_peerIoWriteUint32( io, out, r->index );
1471            tr_peerIoWriteUint32( io, out, r->offset );
1472            tr_peerIoWriteBytes ( io, out, buf, r->length );
1473        }
1474
1475        tr_free( buf );
1476        tr_free( r );
1477
1478        pulse( msgs ); /* start sending it right away */
1479    }
1480
1481    return TRUE; /* loop forever */
1482}
1483
1484static void
1485didWrite( struct bufferevent * evin UNUSED, void * vmsgs )
1486{
1487    pulse( vmsgs );
1488}
1489
1490static void
1491gotError( struct bufferevent * evbuf UNUSED, short what, void * vmsgs )
1492{
1493    dbgmsg( vmsgs, "libevent got an error! what=%d, errno=%d (%s)",
1494            (int)what, errno, strerror(errno) );
1495    fireGotError( vmsgs );
1496}
1497
1498static void
1499sendBitfield( tr_peermsgs * msgs )
1500{
1501    const tr_bitfield * bitfield = tr_cpPieceBitfield( msgs->torrent->completion );
1502    struct evbuffer * out = msgs->outMessages;
1503
1504    dbgmsg( msgs, "sending peer a bitfield message" );
1505    tr_peerIoWriteUint32( msgs->io, out, sizeof(uint8_t) + bitfield->len );
1506    tr_peerIoWriteUint8 ( msgs->io, out, BT_BITFIELD );
1507    tr_peerIoWriteBytes ( msgs->io, out, bitfield->bits, bitfield->len );
1508}
1509
1510/**
1511***
1512**/
1513
1514/* some peers give us error messages if we send
1515   more than this many peers in a single pex message */
1516#define MAX_PEX_DIFFS 200
1517
1518typedef struct
1519{
1520    tr_pex * added;
1521    tr_pex * dropped;
1522    tr_pex * elements;
1523    int addedCount;
1524    int droppedCount;
1525    int elementCount;
1526    int diffCount;
1527}
1528PexDiffs;
1529
1530static void
1531pexAddedCb( void * vpex, void * userData )
1532{
1533    PexDiffs * diffs = (PexDiffs *) userData;
1534    tr_pex * pex = (tr_pex *) vpex;
1535    if( diffs->diffCount < MAX_PEX_DIFFS )
1536    {
1537        diffs->diffCount++;
1538        diffs->added[diffs->addedCount++] = *pex;
1539        diffs->elements[diffs->elementCount++] = *pex;
1540    }
1541}
1542
1543static void
1544pexRemovedCb( void * vpex, void * userData )
1545{
1546    PexDiffs * diffs = (PexDiffs *) userData;
1547    tr_pex * pex = (tr_pex *) vpex;
1548    if( diffs->diffCount < MAX_PEX_DIFFS )
1549    {
1550        diffs->diffCount++;
1551        diffs->dropped[diffs->droppedCount++] = *pex;
1552    }
1553}
1554
1555static void
1556pexElementCb( void * vpex, void * userData )
1557{
1558    PexDiffs * diffs = (PexDiffs *) userData;
1559    tr_pex * pex = (tr_pex *) vpex;
1560    if( diffs->diffCount < MAX_PEX_DIFFS )
1561    {
1562        diffs->diffCount++;
1563        diffs->elements[diffs->elementCount++] = *pex;
1564    }
1565}
1566
1567static void
1568sendPex( tr_peermsgs * msgs )
1569{
1570    if( msgs->peerSupportsPex && tr_torrentIsPexEnabled( msgs->torrent ) )
1571    {
1572        int i;
1573        tr_pex * newPex = NULL;
1574        const int newCount = tr_peerMgrGetPeers( msgs->handle->peerMgr, msgs->torrent->info.hash, &newPex );
1575        PexDiffs diffs;
1576        benc_val_t val, *added, *dropped, *flags;
1577        uint8_t *tmp, *walk;
1578        char * benc;
1579        int bencLen;
1580
1581        /* build the diffs */
1582        diffs.added = tr_new( tr_pex, newCount );
1583        diffs.addedCount = 0;
1584        diffs.dropped = tr_new( tr_pex, msgs->pexCount );
1585        diffs.droppedCount = 0;
1586        diffs.elements = tr_new( tr_pex, newCount + msgs->pexCount );
1587        diffs.elementCount = 0;
1588        diffs.diffCount = 0;
1589        tr_set_compare( msgs->pex, msgs->pexCount,
1590                        newPex, newCount,
1591                        tr_pexCompare, sizeof(tr_pex),
1592                        pexRemovedCb, pexAddedCb, pexElementCb, &diffs );
1593        dbgmsg( msgs, "pex: old peer count %d, new peer count %d, added %d, removed %d", msgs->pexCount, newCount, diffs.addedCount, diffs.droppedCount );
1594
1595        /* update peer */
1596        tr_free( msgs->pex );
1597        msgs->pex = diffs.elements;
1598        msgs->pexCount = diffs.elementCount;
1599
1600        /* build the pex payload */
1601        tr_bencInit( &val, TYPE_DICT );
1602        tr_bencDictReserve( &val, 3 );
1603
1604        /* "added" */
1605        added = tr_bencDictAdd( &val, "added" );
1606        tmp = walk = tr_new( uint8_t, diffs.addedCount * 6 );
1607        for( i=0; i<diffs.addedCount; ++i ) {
1608            memcpy( walk, &diffs.added[i].in_addr, 4 ); walk += 4;
1609            memcpy( walk, &diffs.added[i].port, 2 ); walk += 2;
1610        }
1611        assert( ( walk - tmp ) == diffs.addedCount * 6 );
1612        tr_bencInitStr( added, tmp, walk-tmp, FALSE );
1613
1614        /* "added.f" */
1615        flags = tr_bencDictAdd( &val, "added.f" );
1616        tmp = walk = tr_new( uint8_t, diffs.addedCount );
1617        for( i=0; i<diffs.addedCount; ++i )
1618            *walk++ = diffs.added[i].flags;
1619        assert( ( walk - tmp ) == diffs.addedCount );
1620        tr_bencInitStr( flags, tmp, walk-tmp, FALSE );
1621
1622        /* "dropped" */
1623        dropped = tr_bencDictAdd( &val, "dropped" );
1624        tmp = walk = tr_new( uint8_t, diffs.droppedCount * 6 );
1625        for( i=0; i<diffs.droppedCount; ++i ) {
1626            memcpy( walk, &diffs.dropped[i].in_addr, 4 ); walk += 4;
1627            memcpy( walk, &diffs.dropped[i].port, 2 ); walk += 2;
1628        }
1629        assert( ( walk - tmp ) == diffs.droppedCount * 6 );
1630        tr_bencInitStr( dropped, tmp, walk-tmp, FALSE );
1631
1632        /* write the pex message */
1633        benc = tr_bencSave( &val, &bencLen );
1634        tr_peerIoWriteUint32( msgs->io, msgs->outMessages, 2*sizeof(uint8_t) + bencLen );
1635        tr_peerIoWriteUint8 ( msgs->io, msgs->outMessages, BT_LTEP );
1636        tr_peerIoWriteUint8 ( msgs->io, msgs->outMessages, OUR_LTEP_PEX );
1637        tr_peerIoWriteBytes ( msgs->io, msgs->outMessages, benc, bencLen );
1638
1639        /* cleanup */
1640        tr_free( benc );
1641        tr_bencFree( &val );
1642        tr_free( diffs.added );
1643        tr_free( diffs.dropped );
1644        tr_free( newPex );
1645
1646        msgs->clientSentPexAt = time( NULL );
1647    }
1648}
1649
1650static int
1651pexPulse( void * vpeer )
1652{
1653    sendPex( vpeer );
1654    return TRUE;
1655}
1656
1657/**
1658***
1659**/
1660
1661tr_peermsgs*
1662tr_peerMsgsNew( struct tr_torrent * torrent,
1663                struct tr_peer    * info,
1664                tr_delivery_func    func,
1665                void              * userData,
1666                tr_publisher_tag  * setme )
1667{
1668    tr_peermsgs * m;
1669
1670    assert( info != NULL );
1671    assert( info->io != NULL );
1672
1673    m = tr_new0( tr_peermsgs, 1 );
1674    m->publisher = tr_publisherNew( );
1675    m->info = info;
1676    m->handle = torrent->handle;
1677    m->torrent = torrent;
1678    m->io = info->io;
1679    m->info->clientIsChoked = 1;
1680    m->info->peerIsChoked = 1;
1681    m->info->clientIsInterested = 0;
1682    m->info->peerIsInterested = 0;
1683    m->info->have = tr_bitfieldNew( torrent->info.pieceCount );
1684    m->pulseTimer = tr_timerNew( m->handle, pulse, m, PEER_PULSE_INTERVAL );
1685    m->rateTimer = tr_timerNew( m->handle, ratePulse, m, RATE_PULSE_INTERVAL );
1686    m->pexTimer = tr_timerNew( m->handle, pexPulse, m, PEX_INTERVAL );
1687    m->outMessages = evbuffer_new( );
1688    m->outBlock = evbuffer_new( );
1689    m->peerAllowedPieces = NULL;
1690    m->clientAllowedPieces = NULL;
1691    m->clientSuggestedPieces = NULL;
1692    *setme = tr_publisherSubscribe( m->publisher, func, userData );
1693   
1694    if ( tr_peerIoSupportsFEXT( m->io ) )
1695    {
1696        /* This peer is fastpeer-enabled, generate its allowed set
1697         * (before registering our callbacks) */
1698        if ( !m->peerAllowedPieces ) {
1699            const struct in_addr *peerAddr = tr_peerIoGetAddress( m->io, NULL );
1700           
1701            m->peerAllowedPieces = tr_peerMgrGenerateAllowedSet( MAX_FAST_ALLOWED_COUNT,
1702                                                                 m->torrent->info.pieceCount,
1703                                                                 m->torrent->info.hash,
1704                                                                 peerAddr );
1705        }
1706        m->clientAllowedPieces = tr_bitfieldNew( m->torrent->info.pieceCount );
1707       
1708        m->clientSuggestedPieces = tr_bitfieldNew( m->torrent->info.pieceCount );
1709    }
1710   
1711    tr_peerIoSetTimeoutSecs( m->io, 150 ); /* timeout after N seconds of inactivity */
1712    tr_peerIoSetIOFuncs( m->io, canRead, didWrite, gotError, m );
1713    tr_peerIoSetIOMode( m->io, EV_READ|EV_WRITE, 0 );
1714    ratePulse( m );
1715
1716    if ( tr_peerIoSupportsLTEP( m->io ) )
1717        sendLtepHandshake( m );
1718
1719    if ( !tr_peerIoSupportsFEXT( m->io ) )
1720        sendBitfield( m );
1721    else {
1722        /* This peer is fastpeer-enabled, send it have-all or have-none if appropriate */
1723        uint32_t peerProgress;
1724        float completion = tr_cpPercentComplete( m->torrent->completion );
1725        if ( completion == 0.0f ) {
1726            sendFastHave( m, 0 );
1727        } else if ( completion == 1.0f ) {
1728            sendFastHave( m, 1 );
1729        } else {
1730            sendBitfield( m );
1731        }
1732        peerProgress = m->torrent->info.pieceCount * m->info->progress;
1733       
1734        if ( peerProgress < MAX_FAST_ALLOWED_COUNT )
1735            sendFastAllowedSet( m );
1736    }
1737
1738    return m;
1739}
1740
1741void
1742tr_peerMsgsFree( tr_peermsgs* msgs )
1743{
1744    if( msgs != NULL )
1745    {
1746        tr_timerFree( &msgs->pulseTimer );
1747        tr_timerFree( &msgs->rateTimer );
1748        tr_timerFree( &msgs->pexTimer );
1749        tr_publisherFree( &msgs->publisher );
1750        tr_list_free( &msgs->clientWillAskFor, tr_free );
1751        tr_list_free( &msgs->clientAskedFor, tr_free );
1752        tr_list_free( &msgs->peerAskedForFast, tr_free );
1753        tr_list_free( &msgs->peerAskedFor, tr_free );
1754        evbuffer_free( msgs->outMessages );
1755        evbuffer_free( msgs->outBlock );
1756        tr_free( msgs->pex );
1757        msgs->pexCount = 0;
1758        tr_free( msgs );
1759    }
1760}
1761
1762tr_publisher_tag
1763tr_peerMsgsSubscribe( tr_peermsgs       * peer,
1764                      tr_delivery_func    func,
1765                      void              * userData )
1766{
1767    return tr_publisherSubscribe( peer->publisher, func, userData );
1768}
1769
1770void
1771tr_peerMsgsUnsubscribe( tr_peermsgs       * peer,
1772                        tr_publisher_tag    tag )
1773{
1774    tr_publisherUnsubscribe( peer->publisher, tag );
1775}
1776
1777int
1778tr_peerMsgsIsPieceFastAllowed( const tr_peermsgs * peer,
1779                               uint32_t            index )
1780{
1781    return tr_bitfieldHas( peer->clientAllowedPieces, index );
1782}
1783
1784int
1785tr_peerMsgsIsPieceSuggested( const tr_peermsgs * peer,
1786                             uint32_t            index )
1787{
1788    return tr_bitfieldHas( peer->clientSuggestedPieces, index );
1789}
1790
Note: See TracBrowser for help on using the repository browser.