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

Last change on this file since 13154 was 13154, checked in by jordan, 9 years ago

(trunk libT) #4700 "compilation fails on FreeBSD because it can't find alloca.h" -- fixed.

  • Property svn:keywords set to Date Rev Author Id
File size: 71.5 KB
Line 
1/*
2 * This file Copyright (C) Mnemosyne LLC
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 13154 2012-01-10 19:18:18Z jordan $
11 */
12
13#include <assert.h>
14#include <errno.h>
15#include <stdarg.h>
16#include <stdlib.h>
17#include <string.h>
18
19#include <event2/buffer.h>
20#include <event2/bufferevent.h>
21#include <event2/event.h>
22
23#include "transmission.h"
24#include "bencode.h"
25#include "cache.h"
26#include "completion.h"
27#include "crypto.h" /* tr_sha1() */
28#include "peer-io.h"
29#include "peer-mgr.h"
30#include "peer-msgs.h"
31#include "session.h"
32#include "torrent.h"
33#include "torrent-magnet.h"
34#include "tr-dht.h"
35#include "utils.h"
36#include "version.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
55    BT_FEXT_SUGGEST         = 13,
56    BT_FEXT_HAVE_ALL        = 14,
57    BT_FEXT_HAVE_NONE       = 15,
58    BT_FEXT_REJECT          = 16,
59    BT_FEXT_ALLOWED_FAST    = 17,
60
61    BT_LTEP                 = 20,
62
63    LTEP_HANDSHAKE          = 0,
64
65    UT_PEX_ID               = 1,
66    UT_METADATA_ID          = 3,
67
68    MAX_PEX_PEER_COUNT      = 50,
69
70    MIN_CHOKE_PERIOD_SEC    = 10,
71
72    /* idle seconds before we send a keepalive */
73    KEEPALIVE_INTERVAL_SECS = 100,
74
75    PEX_INTERVAL_SECS       = 90, /* sec between sendPex() calls */
76
77    REQQ                    = 512,
78
79    METADATA_REQQ           = 64,
80
81    /* used in lowering the outMessages queue period */
82    IMMEDIATE_PRIORITY_INTERVAL_SECS = 0,
83    HIGH_PRIORITY_INTERVAL_SECS = 2,
84    LOW_PRIORITY_INTERVAL_SECS = 10,
85
86    /* number of pieces we'll allow in our fast set */
87    MAX_FAST_SET_SIZE = 3,
88
89    /* defined in BEP #9 */
90    METADATA_MSG_TYPE_REQUEST = 0,
91    METADATA_MSG_TYPE_DATA = 1,
92    METADATA_MSG_TYPE_REJECT = 2
93};
94
95enum
96{
97    AWAITING_BT_LENGTH,
98    AWAITING_BT_ID,
99    AWAITING_BT_MESSAGE,
100    AWAITING_BT_PIECE
101};
102
103/**
104***
105**/
106
107struct peer_request
108{
109    uint32_t    index;
110    uint32_t    offset;
111    uint32_t    length;
112};
113
114static void
115blockToReq( const tr_torrent     * tor,
116            tr_block_index_t       block,
117            struct peer_request  * setme )
118{
119    tr_torrentGetBlockLocation( tor, block, &setme->index,
120                                            &setme->offset,
121                                            &setme->length );
122}
123
124/**
125***
126**/
127
128/* this is raw, unchanged data from the peer regarding
129 * the current message that it's sending us. */
130struct tr_incoming
131{
132    uint8_t                id;
133    uint32_t               length; /* includes the +1 for id length */
134    struct peer_request    blockReq; /* metadata for incoming blocks */
135    struct evbuffer *      block; /* piece data for incoming blocks */
136};
137
138/**
139 * Low-level communication state information about a connected peer.
140 *
141 * This structure remembers the low-level protocol states that we're
142 * in with this peer, such as active requests, pex messages, and so on.
143 * Its fields are all private to peer-msgs.c.
144 *
145 * Data not directly involved with sending & receiving messages is
146 * stored in tr_peer, where it can be accessed by both peermsgs and
147 * the peer manager.
148 *
149 * @see struct peer_atom
150 * @see tr_peer
151 */
152struct tr_peermsgs
153{
154    bool            peerSupportsPex;
155    bool            peerSupportsMetadataXfer;
156    bool            clientSentLtepHandshake;
157    bool            peerSentLtepHandshake;
158
159    /*bool          haveFastSet;*/
160
161    int             desiredRequestCount;
162
163    int             prefetchCount;
164
165    /* how long the outMessages batch should be allowed to grow before
166     * it's flushed -- some messages (like requests >:) should be sent
167     * very quickly; others aren't as urgent. */
168    int8_t          outMessagesBatchPeriod;
169
170    uint8_t         state;
171    uint8_t         ut_pex_id;
172    uint8_t         ut_metadata_id;
173    uint16_t        pexCount;
174    uint16_t        pexCount6;
175
176    size_t          metadata_size_hint;
177#if 0
178    size_t                 fastsetSize;
179    tr_piece_index_t       fastset[MAX_FAST_SET_SIZE];
180#endif
181
182    tr_peer *              peer;
183
184    tr_torrent *           torrent;
185
186    tr_peer_callback      * callback;
187    void                  * callbackData;
188
189    struct evbuffer *      outMessages; /* all the non-piece messages */
190
191    struct peer_request    peerAskedFor[REQQ];
192
193    int                    peerAskedForMetadata[METADATA_REQQ];
194    int                    peerAskedForMetadataCount;
195
196    tr_pex               * pex;
197    tr_pex               * pex6;
198
199    /*time_t                 clientSentPexAt;*/
200    time_t                 clientSentAnythingAt;
201
202    /* when we started batching the outMessages */
203    time_t                outMessagesBatchedAt;
204
205    struct tr_incoming    incoming;
206
207    /* if the peer supports the Extension Protocol in BEP 10 and
208       supplied a reqq argument, it's stored here. Otherwise, the
209       value is zero and should be ignored. */
210    int64_t               reqq;
211
212    struct event        * pexTimer;
213};
214
215/**
216***
217**/
218
219static inline tr_session*
220getSession( struct tr_peermsgs * msgs )
221{
222    return msgs->torrent->session;
223}
224
225/**
226***
227**/
228
229static void
230myDebug( const char * file, int line,
231         const struct tr_peermsgs * msgs,
232         const char * fmt, ... )
233{
234    FILE * fp = tr_getLog( );
235
236    if( fp )
237    {
238        va_list           args;
239        char              timestr[64];
240        struct evbuffer * buf = evbuffer_new( );
241        char *            base = tr_basename( file );
242
243        evbuffer_add_printf( buf, "[%s] %s - %s [%s]: ",
244                             tr_getLogTimeStr( timestr, sizeof( timestr ) ),
245                             tr_torrentName( msgs->torrent ),
246                             tr_peerIoGetAddrStr( msgs->peer->io ),
247                             msgs->peer->client );
248        va_start( args, fmt );
249        evbuffer_add_vprintf( buf, fmt, args );
250        va_end( args );
251        evbuffer_add_printf( buf, " (%s:%d)\n", base, line );
252        fputs( (const char*)evbuffer_pullup( buf, -1 ), fp );
253
254        tr_free( base );
255        evbuffer_free( buf );
256    }
257}
258
259#define dbgmsg( msgs, ... ) \
260    do { \
261        if( tr_deepLoggingIsActive( ) ) \
262            myDebug( __FILE__, __LINE__, msgs, __VA_ARGS__ ); \
263    } while( 0 )
264
265/**
266***
267**/
268
269static void
270pokeBatchPeriod( tr_peermsgs * msgs, int interval )
271{
272    if( msgs->outMessagesBatchPeriod > interval )
273    {
274        msgs->outMessagesBatchPeriod = interval;
275        dbgmsg( msgs, "lowering batch interval to %d seconds", interval );
276    }
277}
278
279static void
280dbgOutMessageLen( tr_peermsgs * msgs )
281{
282    dbgmsg( msgs, "outMessage size is now %zu", evbuffer_get_length( msgs->outMessages ) );
283}
284
285static void
286protocolSendReject( tr_peermsgs * msgs, const struct peer_request * req )
287{
288    struct evbuffer * out = msgs->outMessages;
289
290    assert( tr_peerIoSupportsFEXT( msgs->peer->io ) );
291
292    evbuffer_add_uint32( out, sizeof( uint8_t ) + 3 * sizeof( uint32_t ) );
293    evbuffer_add_uint8 ( out, BT_FEXT_REJECT );
294    evbuffer_add_uint32( out, req->index );
295    evbuffer_add_uint32( out, req->offset );
296    evbuffer_add_uint32( out, req->length );
297
298    dbgmsg( msgs, "rejecting %u:%u->%u...", req->index, req->offset, req->length );
299    dbgOutMessageLen( msgs );
300}
301
302static void
303protocolSendRequest( tr_peermsgs * msgs, const struct peer_request * req )
304{
305    struct evbuffer * out = msgs->outMessages;
306
307    evbuffer_add_uint32( out, sizeof( uint8_t ) + 3 * sizeof( uint32_t ) );
308    evbuffer_add_uint8 ( out, BT_REQUEST );
309    evbuffer_add_uint32( out, req->index );
310    evbuffer_add_uint32( out, req->offset );
311    evbuffer_add_uint32( out, req->length );
312
313    dbgmsg( msgs, "requesting %u:%u->%u...", req->index, req->offset, req->length );
314    dbgOutMessageLen( msgs );
315    pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
316}
317
318static void
319protocolSendCancel( tr_peermsgs * msgs, const struct peer_request * req )
320{
321    struct evbuffer * out = msgs->outMessages;
322
323    evbuffer_add_uint32( out, sizeof( uint8_t ) + 3 * sizeof( uint32_t ) );
324    evbuffer_add_uint8 ( out, BT_CANCEL );
325    evbuffer_add_uint32( out, req->index );
326    evbuffer_add_uint32( out, req->offset );
327    evbuffer_add_uint32( out, req->length );
328
329    dbgmsg( msgs, "cancelling %u:%u->%u...", req->index, req->offset, req->length );
330    dbgOutMessageLen( msgs );
331    pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
332}
333
334static void
335protocolSendPort(tr_peermsgs *msgs, uint16_t port)
336{
337    struct evbuffer * out = msgs->outMessages;
338
339    dbgmsg( msgs, "sending Port %u", port);
340    evbuffer_add_uint32( out, 3 );
341    evbuffer_add_uint8 ( out, BT_PORT );
342    evbuffer_add_uint16( out, port);
343}
344
345static void
346protocolSendHave( tr_peermsgs * msgs, uint32_t index )
347{
348    struct evbuffer * out = msgs->outMessages;
349
350    evbuffer_add_uint32( out, sizeof(uint8_t) + sizeof(uint32_t) );
351    evbuffer_add_uint8 ( out, BT_HAVE );
352    evbuffer_add_uint32( out, index );
353
354    dbgmsg( msgs, "sending Have %u", index );
355    dbgOutMessageLen( msgs );
356    pokeBatchPeriod( msgs, LOW_PRIORITY_INTERVAL_SECS );
357}
358
359#if 0
360static void
361protocolSendAllowedFast( tr_peermsgs * msgs, uint32_t pieceIndex )
362{
363    tr_peerIo       * io  = msgs->peer->io;
364    struct evbuffer * out = msgs->outMessages;
365
366    assert( tr_peerIoSupportsFEXT( msgs->peer->io ) );
367
368    evbuffer_add_uint32( io, out, sizeof(uint8_t) + sizeof(uint32_t) );
369    evbuffer_add_uint8 ( io, out, BT_FEXT_ALLOWED_FAST );
370    evbuffer_add_uint32( io, out, pieceIndex );
371
372    dbgmsg( msgs, "sending Allowed Fast %u...", pieceIndex );
373    dbgOutMessageLen( msgs );
374}
375#endif
376
377static void
378protocolSendChoke( tr_peermsgs * msgs, int choke )
379{
380    struct evbuffer * out = msgs->outMessages;
381
382    evbuffer_add_uint32( out, sizeof( uint8_t ) );
383    evbuffer_add_uint8 ( out, choke ? BT_CHOKE : BT_UNCHOKE );
384
385    dbgmsg( msgs, "sending %s...", choke ? "Choke" : "Unchoke" );
386    dbgOutMessageLen( msgs );
387    pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
388}
389
390static void
391protocolSendHaveAll( tr_peermsgs * msgs )
392{
393    struct evbuffer * out = msgs->outMessages;
394
395    assert( tr_peerIoSupportsFEXT( msgs->peer->io ) );
396
397    evbuffer_add_uint32( out, sizeof( uint8_t ) );
398    evbuffer_add_uint8 ( out, BT_FEXT_HAVE_ALL );
399
400    dbgmsg( msgs, "sending HAVE_ALL..." );
401    dbgOutMessageLen( msgs );
402    pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
403}
404
405static void
406protocolSendHaveNone( tr_peermsgs * msgs )
407{
408    struct evbuffer * out = msgs->outMessages;
409
410    assert( tr_peerIoSupportsFEXT( msgs->peer->io ) );
411
412    evbuffer_add_uint32( out, sizeof( uint8_t ) );
413    evbuffer_add_uint8 ( out, BT_FEXT_HAVE_NONE );
414
415    dbgmsg( msgs, "sending HAVE_NONE..." );
416    dbgOutMessageLen( msgs );
417    pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
418}
419
420/**
421***  EVENTS
422**/
423
424static void
425publish( tr_peermsgs * msgs, tr_peer_event * e )
426{
427    assert( msgs->peer );
428    assert( msgs->peer->msgs == msgs );
429
430    if( msgs->callback != NULL )
431        msgs->callback( msgs->peer, e, msgs->callbackData );
432}
433
434static void
435fireError( tr_peermsgs * msgs, int err )
436{
437    tr_peer_event e = TR_PEER_EVENT_INIT;
438    e.eventType = TR_PEER_ERROR;
439    e.err = err;
440    publish( msgs, &e );
441}
442
443static void
444fireGotBlock( tr_peermsgs * msgs, const struct peer_request * req )
445{
446    tr_peer_event e = TR_PEER_EVENT_INIT;
447    e.eventType = TR_PEER_CLIENT_GOT_BLOCK;
448    e.pieceIndex = req->index;
449    e.offset = req->offset;
450    e.length = req->length;
451    publish( msgs, &e );
452}
453
454static void
455fireGotRej( tr_peermsgs * msgs, const struct peer_request * req )
456{
457    tr_peer_event e = TR_PEER_EVENT_INIT;
458    e.eventType = TR_PEER_CLIENT_GOT_REJ;
459    e.pieceIndex = req->index;
460    e.offset = req->offset;
461    e.length = req->length;
462    publish( msgs, &e );
463}
464
465static void
466fireGotChoke( tr_peermsgs * msgs )
467{
468    tr_peer_event e = TR_PEER_EVENT_INIT;
469    e.eventType = TR_PEER_CLIENT_GOT_CHOKE;
470    publish( msgs, &e );
471}
472
473static void
474fireClientGotHaveAll( tr_peermsgs * msgs )
475{
476    tr_peer_event e = TR_PEER_EVENT_INIT;
477    e.eventType = TR_PEER_CLIENT_GOT_HAVE_ALL;
478    publish( msgs, &e );
479}
480
481static void
482fireClientGotHaveNone( tr_peermsgs * msgs )
483{
484    tr_peer_event e = TR_PEER_EVENT_INIT;
485    e.eventType = TR_PEER_CLIENT_GOT_HAVE_NONE;
486    publish( msgs, &e );
487}
488
489static void
490fireClientGotData( tr_peermsgs * msgs, uint32_t length, int wasPieceData )
491{
492    tr_peer_event e = TR_PEER_EVENT_INIT;
493
494    e.length = length;
495    e.eventType = TR_PEER_CLIENT_GOT_DATA;
496    e.wasPieceData = wasPieceData;
497    publish( msgs, &e );
498}
499
500static void
501fireClientGotSuggest( tr_peermsgs * msgs, uint32_t pieceIndex )
502{
503    tr_peer_event e = TR_PEER_EVENT_INIT;
504    e.eventType = TR_PEER_CLIENT_GOT_SUGGEST;
505    e.pieceIndex = pieceIndex;
506    publish( msgs, &e );
507}
508
509static void
510fireClientGotPort( tr_peermsgs * msgs, tr_port port )
511{
512    tr_peer_event e = TR_PEER_EVENT_INIT;
513    e.eventType = TR_PEER_CLIENT_GOT_PORT;
514    e.port = port;
515    publish( msgs, &e );
516}
517
518static void
519fireClientGotAllowedFast( tr_peermsgs * msgs, uint32_t pieceIndex )
520{
521    tr_peer_event e = TR_PEER_EVENT_INIT;
522    e.eventType = TR_PEER_CLIENT_GOT_ALLOWED_FAST;
523    e.pieceIndex = pieceIndex;
524    publish( msgs, &e );
525}
526
527static void
528fireClientGotBitfield( tr_peermsgs * msgs, tr_bitfield * bitfield )
529{
530    tr_peer_event e = TR_PEER_EVENT_INIT;
531    e.eventType = TR_PEER_CLIENT_GOT_BITFIELD;
532    e.bitfield = bitfield;
533    publish( msgs, &e );
534}
535
536static void
537fireClientGotHave( tr_peermsgs * msgs, tr_piece_index_t index )
538{
539    tr_peer_event e = TR_PEER_EVENT_INIT;
540    e.eventType = TR_PEER_CLIENT_GOT_HAVE;
541    e.pieceIndex = index;
542    publish( msgs, &e );
543}
544
545static void
546firePeerGotData( tr_peermsgs * msgs, uint32_t length, bool wasPieceData )
547{
548    tr_peer_event e = TR_PEER_EVENT_INIT;
549
550    e.length = length;
551    e.eventType = TR_PEER_PEER_GOT_DATA;
552    e.wasPieceData = wasPieceData;
553
554    publish( msgs, &e );
555}
556
557/**
558***  ALLOWED FAST SET
559***  For explanation, see http://www.bittorrent.org/beps/bep_0006.html
560**/
561
562#if 0
563size_t
564tr_generateAllowedSet( tr_piece_index_t * setmePieces,
565                       size_t             desiredSetSize,
566                       size_t             pieceCount,
567                       const uint8_t    * infohash,
568                       const tr_address * addr )
569{
570    size_t setSize = 0;
571
572    assert( setmePieces );
573    assert( desiredSetSize <= pieceCount );
574    assert( desiredSetSize );
575    assert( pieceCount );
576    assert( infohash );
577    assert( addr );
578
579    if( addr->type == TR_AF_INET )
580    {
581        uint8_t w[SHA_DIGEST_LENGTH + 4], *walk=w;
582        uint8_t x[SHA_DIGEST_LENGTH];
583
584        uint32_t ui32 = ntohl( htonl( addr->addr.addr4.s_addr ) & 0xffffff00 );   /* (1) */
585        memcpy( w, &ui32, sizeof( uint32_t ) );
586        walk += sizeof( uint32_t );
587        memcpy( walk, infohash, SHA_DIGEST_LENGTH );                 /* (2) */
588        walk += SHA_DIGEST_LENGTH;
589        tr_sha1( x, w, walk-w, NULL );                               /* (3) */
590        assert( sizeof( w ) == walk-w );
591
592        while( setSize<desiredSetSize )
593        {
594            int i;
595            for( i=0; i<5 && setSize<desiredSetSize; ++i )           /* (4) */
596            {
597                size_t k;
598                uint32_t j = i * 4;                                  /* (5) */
599                uint32_t y = ntohl( *( uint32_t* )( x + j ) );       /* (6) */
600                uint32_t index = y % pieceCount;                     /* (7) */
601
602                for( k=0; k<setSize; ++k )                           /* (8) */
603                    if( setmePieces[k] == index )
604                        break;
605
606                if( k == setSize )
607                    setmePieces[setSize++] = index;                  /* (9) */
608            }
609
610            tr_sha1( x, x, sizeof( x ), NULL );                      /* (3) */
611        }
612    }
613
614    return setSize;
615}
616
617static void
618updateFastSet( tr_peermsgs * msgs UNUSED )
619{
620    const bool fext = tr_peerIoSupportsFEXT( msgs->peer->io );
621    const int peerIsNeedy = msgs->peer->progress < 0.10;
622
623    if( fext && peerIsNeedy && !msgs->haveFastSet )
624    {
625        size_t i;
626        const struct tr_address * addr = tr_peerIoGetAddress( msgs->peer->io, NULL );
627        const tr_info * inf = &msgs->torrent->info;
628        const size_t numwant = MIN( MAX_FAST_SET_SIZE, inf->pieceCount );
629
630        /* build the fast set */
631        msgs->fastsetSize = tr_generateAllowedSet( msgs->fastset, numwant, inf->pieceCount, inf->hash, addr );
632        msgs->haveFastSet = 1;
633
634        /* send it to the peer */
635        for( i=0; i<msgs->fastsetSize; ++i )
636            protocolSendAllowedFast( msgs, msgs->fastset[i] );
637    }
638}
639#endif
640
641/**
642***  INTEREST
643**/
644
645static void
646sendInterest( tr_peermsgs * msgs, bool clientIsInterested )
647{
648    struct evbuffer * out = msgs->outMessages;
649
650    assert( msgs );
651    assert( tr_isBool( clientIsInterested ) );
652
653    msgs->peer->clientIsInterested = clientIsInterested;
654    dbgmsg( msgs, "Sending %s", clientIsInterested ? "Interested" : "Not Interested" );
655    evbuffer_add_uint32( out, sizeof( uint8_t ) );
656    evbuffer_add_uint8 ( out, clientIsInterested ? BT_INTERESTED : BT_NOT_INTERESTED );
657
658    pokeBatchPeriod( msgs, HIGH_PRIORITY_INTERVAL_SECS );
659    dbgOutMessageLen( msgs );
660}
661
662static void
663updateInterest( tr_peermsgs * msgs UNUSED )
664{
665    /* FIXME -- might need to poke the mgr on startup */
666}
667
668void
669tr_peerMsgsSetInterested( tr_peermsgs * msgs, bool clientIsInterested )
670{
671    assert( tr_isBool( clientIsInterested ) );
672
673    if( clientIsInterested != msgs->peer->clientIsInterested )
674        sendInterest( msgs, clientIsInterested );
675}
676
677static bool
678popNextMetadataRequest( tr_peermsgs * msgs, int * piece )
679{
680    if( msgs->peerAskedForMetadataCount == 0 )
681        return false;
682
683    *piece = msgs->peerAskedForMetadata[0];
684
685    tr_removeElementFromArray( msgs->peerAskedForMetadata, 0, sizeof( int ),
686                               msgs->peerAskedForMetadataCount-- );
687
688    return true;
689}
690
691static bool
692popNextRequest( tr_peermsgs * msgs, struct peer_request * setme )
693{
694    if( msgs->peer->pendingReqsToClient == 0 )
695        return false;
696
697    *setme = msgs->peerAskedFor[0];
698
699    tr_removeElementFromArray( msgs->peerAskedFor, 0, sizeof( struct peer_request ),
700                               msgs->peer->pendingReqsToClient-- );
701
702    return true;
703}
704
705static void
706cancelAllRequestsToClient( tr_peermsgs * msgs )
707{
708    struct peer_request req;
709    const int mustSendCancel = tr_peerIoSupportsFEXT( msgs->peer->io );
710
711    while( popNextRequest( msgs, &req ))
712        if( mustSendCancel )
713            protocolSendReject( msgs, &req );
714}
715
716void
717tr_peerMsgsSetChoke( tr_peermsgs * msgs, bool peerIsChoked )
718{
719    const time_t now = tr_time( );
720    const time_t fibrillationTime = now - MIN_CHOKE_PERIOD_SEC;
721
722    assert( msgs );
723    assert( msgs->peer );
724    assert( tr_isBool( peerIsChoked ) );
725
726    if( msgs->peer->chokeChangedAt > fibrillationTime )
727    {
728        dbgmsg( msgs, "Not changing choke to %d to avoid fibrillation", peerIsChoked );
729    }
730    else if( msgs->peer->peerIsChoked != peerIsChoked )
731    {
732        msgs->peer->peerIsChoked = peerIsChoked;
733        if( peerIsChoked )
734            cancelAllRequestsToClient( msgs );
735        protocolSendChoke( msgs, peerIsChoked );
736        msgs->peer->chokeChangedAt = now;
737    }
738}
739
740/**
741***
742**/
743
744void
745tr_peerMsgsHave( tr_peermsgs * msgs, uint32_t index )
746{
747    protocolSendHave( msgs, index );
748
749    /* since we have more pieces now, we might not be interested in this peer */
750    updateInterest( msgs );
751}
752
753/**
754***
755**/
756
757static bool
758reqIsValid( const tr_peermsgs * peer,
759            uint32_t            index,
760            uint32_t            offset,
761            uint32_t            length )
762{
763    return tr_torrentReqIsValid( peer->torrent, index, offset, length );
764}
765
766static bool
767requestIsValid( const tr_peermsgs * msgs, const struct peer_request * req )
768{
769    return reqIsValid( msgs, req->index, req->offset, req->length );
770}
771
772void
773tr_peerMsgsCancel( tr_peermsgs * msgs, tr_block_index_t block )
774{
775    struct peer_request req;
776/*fprintf( stderr, "SENDING CANCEL MESSAGE FOR BLOCK %zu\n\t\tFROM PEER %p ------------------------------------\n", (size_t)block, msgs->peer );*/
777    blockToReq( msgs->torrent, block, &req );
778    protocolSendCancel( msgs, &req );
779}
780
781/**
782***
783**/
784
785static void
786sendLtepHandshake( tr_peermsgs * msgs )
787{
788    tr_benc val;
789    bool allow_pex;
790    bool allow_metadata_xfer;
791    struct evbuffer * payload;
792    struct evbuffer * out = msgs->outMessages;
793    const unsigned char * ipv6 = tr_globalIPv6();
794
795    if( msgs->clientSentLtepHandshake )
796        return;
797
798    dbgmsg( msgs, "sending an ltep handshake" );
799    msgs->clientSentLtepHandshake = 1;
800
801    /* decide if we want to advertise metadata xfer support (BEP 9) */
802    if( tr_torrentIsPrivate( msgs->torrent ) )
803        allow_metadata_xfer = 0;
804    else
805        allow_metadata_xfer = 1;
806
807    /* decide if we want to advertise pex support */
808    if( !tr_torrentAllowsPex( msgs->torrent ) )
809        allow_pex = 0;
810    else if( msgs->peerSentLtepHandshake )
811        allow_pex = msgs->peerSupportsPex ? 1 : 0;
812    else
813        allow_pex = 1;
814
815    tr_bencInitDict( &val, 8 );
816    tr_bencDictAddInt( &val, "e", getSession(msgs)->encryptionMode != TR_CLEAR_PREFERRED );
817    if( ipv6 != NULL )
818        tr_bencDictAddRaw( &val, "ipv6", ipv6, 16 );
819    if( allow_metadata_xfer && tr_torrentHasMetadata( msgs->torrent )
820                            && ( msgs->torrent->infoDictLength > 0 ) )
821        tr_bencDictAddInt( &val, "metadata_size", msgs->torrent->infoDictLength );
822    tr_bencDictAddInt( &val, "p", tr_sessionGetPublicPeerPort( getSession(msgs) ) );
823    tr_bencDictAddInt( &val, "reqq", REQQ );
824    tr_bencDictAddInt( &val, "upload_only", tr_torrentIsSeed( msgs->torrent ) );
825    tr_bencDictAddStr( &val, "v", TR_NAME " " USERAGENT_PREFIX );
826    if( allow_metadata_xfer || allow_pex ) {
827        tr_benc * m  = tr_bencDictAddDict( &val, "m", 2 );
828        if( allow_metadata_xfer )
829            tr_bencDictAddInt( m, "ut_metadata", UT_METADATA_ID );
830        if( allow_pex )
831            tr_bencDictAddInt( m, "ut_pex", UT_PEX_ID );
832    }
833
834    payload = tr_bencToBuf( &val, TR_FMT_BENC );
835
836    evbuffer_add_uint32( out, 2 * sizeof( uint8_t ) + evbuffer_get_length( payload ) );
837    evbuffer_add_uint8 ( out, BT_LTEP );
838    evbuffer_add_uint8 ( out, LTEP_HANDSHAKE );
839    evbuffer_add_buffer( out, payload );
840    pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
841    dbgOutMessageLen( msgs );
842
843    /* cleanup */
844    evbuffer_free( payload );
845    tr_bencFree( &val );
846}
847
848static void
849parseLtepHandshake( tr_peermsgs * msgs, int len, struct evbuffer * inbuf )
850{
851    int64_t   i;
852    tr_benc   val, * sub;
853    uint8_t * tmp = tr_new( uint8_t, len );
854    const uint8_t *addr;
855    size_t addr_len;
856    tr_pex pex;
857    int8_t seedProbability = -1;
858
859    memset( &pex, 0, sizeof( tr_pex ) );
860
861    tr_peerIoReadBytes( msgs->peer->io, inbuf, tmp, len );
862    msgs->peerSentLtepHandshake = 1;
863
864    if( tr_bencLoad( tmp, len, &val, NULL ) || !tr_bencIsDict( &val ) )
865    {
866        dbgmsg( msgs, "GET  extended-handshake, couldn't get dictionary" );
867        tr_free( tmp );
868        return;
869    }
870
871    dbgmsg( msgs, "here is the handshake: [%*.*s]", len, len,  tmp );
872
873    /* does the peer prefer encrypted connections? */
874    if( tr_bencDictFindInt( &val, "e", &i ) ) {
875        msgs->peer->encryption_preference = i ? ENCRYPTION_PREFERENCE_YES
876                                              : ENCRYPTION_PREFERENCE_NO;
877        if( i )
878            pex.flags |= ADDED_F_ENCRYPTION_FLAG;
879    }
880
881    /* check supported messages for utorrent pex */
882    msgs->peerSupportsPex = 0;
883    msgs->peerSupportsMetadataXfer = 0;
884
885    if( tr_bencDictFindDict( &val, "m", &sub ) ) {
886        if( tr_bencDictFindInt( sub, "ut_pex", &i ) ) {
887            msgs->peerSupportsPex = i != 0;
888            msgs->ut_pex_id = (uint8_t) i;
889            dbgmsg( msgs, "msgs->ut_pex is %d", (int)msgs->ut_pex_id );
890        }
891        if( tr_bencDictFindInt( sub, "ut_metadata", &i ) ) {
892            msgs->peerSupportsMetadataXfer = i != 0;
893            msgs->ut_metadata_id = (uint8_t) i;
894            dbgmsg( msgs, "msgs->ut_metadata_id is %d", (int)msgs->ut_metadata_id );
895        }
896        if( tr_bencDictFindInt( sub, "ut_holepunch", &i ) ) {
897            /* Mysterious µTorrent extension that we don't grok.  However,
898               it implies support for µTP, so use it to indicate that. */
899            tr_peerMgrSetUtpFailed( msgs->torrent,
900                                    tr_peerIoGetAddress( msgs->peer->io, NULL ),
901                                    false );
902        }
903    }
904
905    /* look for metainfo size (BEP 9) */
906    if( tr_bencDictFindInt( &val, "metadata_size", &i ) ) {
907        tr_torrentSetMetadataSizeHint( msgs->torrent, i );
908        msgs->metadata_size_hint = (size_t) i;
909    }
910
911    /* look for upload_only (BEP 21) */
912    if( tr_bencDictFindInt( &val, "upload_only", &i ) )
913        seedProbability = i==0 ? 0 : 100;
914
915    /* get peer's listening port */
916    if( tr_bencDictFindInt( &val, "p", &i ) ) {
917        pex.port = htons( (uint16_t)i );
918        fireClientGotPort( msgs, pex.port );
919        dbgmsg( msgs, "peer's port is now %d", (int)i );
920    }
921
922    if( tr_peerIoIsIncoming( msgs->peer->io )
923        && tr_bencDictFindRaw( &val, "ipv4", &addr, &addr_len )
924        && ( addr_len == 4 ) )
925    {
926        pex.addr.type = TR_AF_INET;
927        memcpy( &pex.addr.addr.addr4, addr, 4 );
928        tr_peerMgrAddPex( msgs->torrent, TR_PEER_FROM_LTEP, &pex, seedProbability );
929    }
930
931    if( tr_peerIoIsIncoming( msgs->peer->io )
932        && tr_bencDictFindRaw( &val, "ipv6", &addr, &addr_len )
933        && ( addr_len == 16 ) )
934    {
935        pex.addr.type = TR_AF_INET6;
936        memcpy( &pex.addr.addr.addr6, addr, 16 );
937        tr_peerMgrAddPex( msgs->torrent, TR_PEER_FROM_LTEP, &pex, seedProbability );
938    }
939
940    /* get peer's maximum request queue size */
941    if( tr_bencDictFindInt( &val, "reqq", &i ) )
942        msgs->reqq = i;
943
944    tr_bencFree( &val );
945    tr_free( tmp );
946}
947
948static void
949parseUtMetadata( tr_peermsgs * msgs, int msglen, struct evbuffer * inbuf )
950{
951    tr_benc dict;
952    char * msg_end;
953    char * benc_end;
954    int64_t msg_type = -1;
955    int64_t piece = -1;
956    int64_t total_size = 0;
957    uint8_t * tmp = tr_new( uint8_t, msglen );
958
959    tr_peerIoReadBytes( msgs->peer->io, inbuf, tmp, msglen );
960    msg_end = (char*)tmp + msglen;
961
962    if( !tr_bencLoad( tmp, msglen, &dict, &benc_end ) )
963    {
964        tr_bencDictFindInt( &dict, "msg_type", &msg_type );
965        tr_bencDictFindInt( &dict, "piece", &piece );
966        tr_bencDictFindInt( &dict, "total_size", &total_size );
967        tr_bencFree( &dict );
968    }
969
970    dbgmsg( msgs, "got ut_metadata msg: type %d, piece %d, total_size %d",
971            (int)msg_type, (int)piece, (int)total_size );
972
973    if( msg_type == METADATA_MSG_TYPE_REJECT )
974    {
975        /* NOOP */
976    }
977
978    if( ( msg_type == METADATA_MSG_TYPE_DATA )
979        && ( !tr_torrentHasMetadata( msgs->torrent ) )
980        && ( msg_end - benc_end <= METADATA_PIECE_SIZE )
981        && ( piece * METADATA_PIECE_SIZE + (msg_end - benc_end) <= total_size ) )
982    {
983        const int pieceLen = msg_end - benc_end;
984        tr_torrentSetMetadataPiece( msgs->torrent, piece, benc_end, pieceLen );
985    }
986
987    if( msg_type == METADATA_MSG_TYPE_REQUEST )
988    {
989        if( ( piece >= 0 )
990            && tr_torrentHasMetadata( msgs->torrent )
991            && !tr_torrentIsPrivate( msgs->torrent )
992            && ( msgs->peerAskedForMetadataCount < METADATA_REQQ ) )
993        {
994            msgs->peerAskedForMetadata[msgs->peerAskedForMetadataCount++] = piece;
995        }
996        else
997        {
998            tr_benc tmp;
999            struct evbuffer * payload;
1000            struct evbuffer * out = msgs->outMessages;
1001
1002            /* build the rejection message */
1003            tr_bencInitDict( &tmp, 2 );
1004            tr_bencDictAddInt( &tmp, "msg_type", METADATA_MSG_TYPE_REJECT );
1005            tr_bencDictAddInt( &tmp, "piece", piece );
1006            payload = tr_bencToBuf( &tmp, TR_FMT_BENC );
1007
1008            /* write it out as a LTEP message to our outMessages buffer */
1009            evbuffer_add_uint32( out, 2 * sizeof( uint8_t ) + evbuffer_get_length( payload ) );
1010            evbuffer_add_uint8 ( out, BT_LTEP );
1011            evbuffer_add_uint8 ( out, msgs->ut_metadata_id );
1012            evbuffer_add_buffer( out, payload );
1013            pokeBatchPeriod( msgs, HIGH_PRIORITY_INTERVAL_SECS );
1014            dbgOutMessageLen( msgs );
1015
1016            /* cleanup */
1017            evbuffer_free( payload );
1018            tr_bencFree( &tmp );
1019        }
1020    }
1021
1022    tr_free( tmp );
1023}
1024
1025static void
1026parseUtPex( tr_peermsgs * msgs, int msglen, struct evbuffer * inbuf )
1027{
1028    int loaded = 0;
1029    uint8_t * tmp = tr_new( uint8_t, msglen );
1030    tr_benc val;
1031    tr_torrent * tor = msgs->torrent;
1032    const uint8_t * added;
1033    size_t added_len;
1034
1035    tr_peerIoReadBytes( msgs->peer->io, inbuf, tmp, msglen );
1036
1037    if( tr_torrentAllowsPex( tor )
1038      && ( ( loaded = !tr_bencLoad( tmp, msglen, &val, NULL ) ) ) )
1039    {
1040        if( tr_bencDictFindRaw( &val, "added", &added, &added_len ) )
1041        {
1042            tr_pex * pex;
1043            size_t i, n;
1044            size_t added_f_len = 0;
1045            const uint8_t * added_f = NULL;
1046
1047            tr_bencDictFindRaw( &val, "added.f", &added_f, &added_f_len );
1048            pex = tr_peerMgrCompactToPex( added, added_len, added_f, added_f_len, &n );
1049
1050            n = MIN( n, MAX_PEX_PEER_COUNT );
1051            for( i=0; i<n; ++i )
1052            {
1053                int seedProbability = -1;
1054                if( i < added_f_len ) seedProbability = ( added_f[i] & ADDED_F_SEED_FLAG ) ? 100 : 0;
1055                tr_peerMgrAddPex( tor, TR_PEER_FROM_PEX, pex+i, seedProbability );
1056            }
1057
1058            tr_free( pex );
1059        }
1060
1061        if( tr_bencDictFindRaw( &val, "added6", &added, &added_len ) )
1062        {
1063            tr_pex * pex;
1064            size_t i, n;
1065            size_t added_f_len = 0;
1066            const uint8_t * added_f = NULL;
1067
1068            tr_bencDictFindRaw( &val, "added6.f", &added_f, &added_f_len );
1069            pex = tr_peerMgrCompact6ToPex( added, added_len, added_f, added_f_len, &n );
1070
1071            n = MIN( n, MAX_PEX_PEER_COUNT );
1072            for( i=0; i<n; ++i )
1073            {
1074                int seedProbability = -1;
1075                if( i < added_f_len ) seedProbability = ( added_f[i] & ADDED_F_SEED_FLAG ) ? 100 : 0;
1076                tr_peerMgrAddPex( tor, TR_PEER_FROM_PEX, pex+i, seedProbability );
1077            }
1078
1079            tr_free( pex );
1080        }
1081    }
1082
1083    if( loaded )
1084        tr_bencFree( &val );
1085    tr_free( tmp );
1086}
1087
1088static void sendPex( tr_peermsgs * msgs );
1089
1090static void
1091parseLtep( tr_peermsgs * msgs, int msglen, struct evbuffer  * inbuf )
1092{
1093    uint8_t ltep_msgid;
1094
1095    tr_peerIoReadUint8( msgs->peer->io, inbuf, &ltep_msgid );
1096    msglen--;
1097
1098    if( ltep_msgid == LTEP_HANDSHAKE )
1099    {
1100        dbgmsg( msgs, "got ltep handshake" );
1101        parseLtepHandshake( msgs, msglen, inbuf );
1102        if( tr_peerIoSupportsLTEP( msgs->peer->io ) )
1103        {
1104            sendLtepHandshake( msgs );
1105            sendPex( msgs );
1106        }
1107    }
1108    else if( ltep_msgid == UT_PEX_ID )
1109    {
1110        dbgmsg( msgs, "got ut pex" );
1111        msgs->peerSupportsPex = 1;
1112        parseUtPex( msgs, msglen, inbuf );
1113    }
1114    else if( ltep_msgid == UT_METADATA_ID )
1115    {
1116        dbgmsg( msgs, "got ut metadata" );
1117        msgs->peerSupportsMetadataXfer = 1;
1118        parseUtMetadata( msgs, msglen, inbuf );
1119    }
1120    else
1121    {
1122        dbgmsg( msgs, "skipping unknown ltep message (%d)", (int)ltep_msgid );
1123        evbuffer_drain( inbuf, msglen );
1124    }
1125}
1126
1127static int
1128readBtLength( tr_peermsgs * msgs, struct evbuffer * inbuf, size_t inlen )
1129{
1130    uint32_t len;
1131
1132    if( inlen < sizeof( len ) )
1133        return READ_LATER;
1134
1135    tr_peerIoReadUint32( msgs->peer->io, inbuf, &len );
1136
1137    if( len == 0 ) /* peer sent us a keepalive message */
1138        dbgmsg( msgs, "got KeepAlive" );
1139    else
1140    {
1141        msgs->incoming.length = len;
1142        msgs->state = AWAITING_BT_ID;
1143    }
1144
1145    return READ_NOW;
1146}
1147
1148static int readBtMessage( tr_peermsgs *, struct evbuffer *, size_t );
1149
1150static int
1151readBtId( tr_peermsgs * msgs, struct evbuffer * inbuf, size_t inlen )
1152{
1153    uint8_t id;
1154
1155    if( inlen < sizeof( uint8_t ) )
1156        return READ_LATER;
1157
1158    tr_peerIoReadUint8( msgs->peer->io, inbuf, &id );
1159    msgs->incoming.id = id;
1160    dbgmsg( msgs, "msgs->incoming.id is now %d; msgs->incoming.length is %zu", id, (size_t)msgs->incoming.length );
1161
1162    if( id == BT_PIECE )
1163    {
1164        msgs->state = AWAITING_BT_PIECE;
1165        return READ_NOW;
1166    }
1167    else if( msgs->incoming.length != 1 )
1168    {
1169        msgs->state = AWAITING_BT_MESSAGE;
1170        return READ_NOW;
1171    }
1172    else return readBtMessage( msgs, inbuf, inlen - 1 );
1173}
1174
1175static void
1176updatePeerProgress( tr_peermsgs * msgs )
1177{
1178    tr_peerUpdateProgress( msgs->torrent, msgs->peer );
1179
1180    /*updateFastSet( msgs );*/
1181    updateInterest( msgs );
1182}
1183
1184static void
1185prefetchPieces( tr_peermsgs *msgs )
1186{
1187    int i;
1188
1189    if( !getSession(msgs)->isPrefetchEnabled )
1190        return;
1191
1192    /* Maintain 12 prefetched blocks per unchoked peer */
1193    for( i=msgs->prefetchCount; i<msgs->peer->pendingReqsToClient && i<12; ++i )
1194    {
1195        const struct peer_request * req = msgs->peerAskedFor + i;
1196        if( requestIsValid( msgs, req ) )
1197        {
1198            tr_cachePrefetchBlock( getSession(msgs)->cache, msgs->torrent, req->index, req->offset, req->length );
1199            ++msgs->prefetchCount;
1200        }
1201    }
1202}
1203
1204static void
1205peerMadeRequest( tr_peermsgs * msgs, const struct peer_request * req )
1206{
1207    const bool fext = tr_peerIoSupportsFEXT( msgs->peer->io );
1208    const int reqIsValid = requestIsValid( msgs, req );
1209    const int clientHasPiece = reqIsValid && tr_cpPieceIsComplete( &msgs->torrent->completion, req->index );
1210    const int peerIsChoked = msgs->peer->peerIsChoked;
1211
1212    int allow = false;
1213
1214    if( !reqIsValid )
1215        dbgmsg( msgs, "rejecting an invalid request." );
1216    else if( !clientHasPiece )
1217        dbgmsg( msgs, "rejecting request for a piece we don't have." );
1218    else if( peerIsChoked )
1219        dbgmsg( msgs, "rejecting request from choked peer" );
1220    else if( msgs->peer->pendingReqsToClient + 1 >= REQQ )
1221        dbgmsg( msgs, "rejecting request ... reqq is full" );
1222    else
1223        allow = true;
1224
1225    if( allow ) {
1226        msgs->peerAskedFor[msgs->peer->pendingReqsToClient++] = *req;
1227        prefetchPieces( msgs );
1228    } else if( fext ) {
1229        protocolSendReject( msgs, req );
1230    }
1231}
1232
1233static bool
1234messageLengthIsCorrect( const tr_peermsgs * msg, uint8_t id, uint32_t len )
1235{
1236    switch( id )
1237    {
1238        case BT_CHOKE:
1239        case BT_UNCHOKE:
1240        case BT_INTERESTED:
1241        case BT_NOT_INTERESTED:
1242        case BT_FEXT_HAVE_ALL:
1243        case BT_FEXT_HAVE_NONE:
1244            return len == 1;
1245
1246        case BT_HAVE:
1247        case BT_FEXT_SUGGEST:
1248        case BT_FEXT_ALLOWED_FAST:
1249            return len == 5;
1250
1251        case BT_BITFIELD:
1252            if( tr_torrentHasMetadata( msg->torrent ) )
1253                return len == ( msg->torrent->info.pieceCount + 7u ) / 8u + 1u;
1254            /* we don't know the piece count yet,
1255               so we can only guess whether to send true or false */
1256            if( msg->metadata_size_hint > 0 )
1257                return len <= msg->metadata_size_hint;
1258            return true;
1259
1260        case BT_REQUEST:
1261        case BT_CANCEL:
1262        case BT_FEXT_REJECT:
1263            return len == 13;
1264
1265        case BT_PIECE:
1266            return len > 9 && len <= 16393;
1267
1268        case BT_PORT:
1269            return len == 3;
1270
1271        case BT_LTEP:
1272            return len >= 2;
1273
1274        default:
1275            return false;
1276    }
1277}
1278
1279static int clientGotBlock( tr_peermsgs *               msgs,
1280                           struct evbuffer *           block,
1281                           const struct peer_request * req );
1282
1283static int
1284readBtPiece( tr_peermsgs      * msgs,
1285             struct evbuffer  * inbuf,
1286             size_t             inlen,
1287             size_t           * setme_piece_bytes_read )
1288{
1289    struct peer_request * req = &msgs->incoming.blockReq;
1290
1291    assert( evbuffer_get_length( inbuf ) >= inlen );
1292    dbgmsg( msgs, "In readBtPiece" );
1293
1294    if( !req->length )
1295    {
1296        if( inlen < 8 )
1297            return READ_LATER;
1298
1299        tr_peerIoReadUint32( msgs->peer->io, inbuf, &req->index );
1300        tr_peerIoReadUint32( msgs->peer->io, inbuf, &req->offset );
1301        req->length = msgs->incoming.length - 9;
1302        dbgmsg( msgs, "got incoming block header %u:%u->%u", req->index, req->offset, req->length );
1303        return READ_NOW;
1304    }
1305    else
1306    {
1307        int err;
1308        size_t n;
1309        size_t nLeft;
1310        struct evbuffer * block_buffer;
1311
1312        if( msgs->incoming.block == NULL )
1313            msgs->incoming.block = evbuffer_new( );
1314        block_buffer = msgs->incoming.block;
1315
1316        /* read in another chunk of data */
1317        nLeft = req->length - evbuffer_get_length( block_buffer );
1318        n = MIN( nLeft, inlen );
1319
1320        tr_peerIoReadBytesToBuf( msgs->peer->io, inbuf, block_buffer, n );
1321
1322        fireClientGotData( msgs, n, true );
1323        *setme_piece_bytes_read += n;
1324        dbgmsg( msgs, "got %zu bytes for block %u:%u->%u ... %d remain",
1325               n, req->index, req->offset, req->length,
1326               (int)( req->length - evbuffer_get_length( block_buffer ) ) );
1327        if( evbuffer_get_length( block_buffer ) < req->length )
1328            return READ_LATER;
1329
1330        /* pass the block along... */
1331        err = clientGotBlock( msgs, block_buffer, req );
1332        evbuffer_drain( block_buffer, evbuffer_get_length( block_buffer ) );
1333
1334        /* cleanup */
1335        req->length = 0;
1336        msgs->state = AWAITING_BT_LENGTH;
1337        return err ? READ_ERR : READ_NOW;
1338    }
1339}
1340
1341static void updateDesiredRequestCount( tr_peermsgs * msgs );
1342
1343static int
1344readBtMessage( tr_peermsgs * msgs, struct evbuffer * inbuf, size_t inlen )
1345{
1346    uint32_t      ui32;
1347    uint32_t      msglen = msgs->incoming.length;
1348    const uint8_t id = msgs->incoming.id;
1349#ifndef NDEBUG
1350    const size_t  startBufLen = evbuffer_get_length( inbuf );
1351#endif
1352    const bool fext = tr_peerIoSupportsFEXT( msgs->peer->io );
1353
1354    --msglen; /* id length */
1355
1356    dbgmsg( msgs, "got BT id %d, len %d, buffer size is %zu", (int)id, (int)msglen, inlen );
1357
1358    if( inlen < msglen )
1359        return READ_LATER;
1360
1361    if( !messageLengthIsCorrect( msgs, id, msglen + 1 ) )
1362    {
1363        dbgmsg( msgs, "bad packet - BT message #%d with a length of %d", (int)id, (int)msglen );
1364        fireError( msgs, EMSGSIZE );
1365        return READ_ERR;
1366    }
1367
1368    switch( id )
1369    {
1370        case BT_CHOKE:
1371            dbgmsg( msgs, "got Choke" );
1372            msgs->peer->clientIsChoked = 1;
1373            if( !fext )
1374                fireGotChoke( msgs );
1375            break;
1376
1377        case BT_UNCHOKE:
1378            dbgmsg( msgs, "got Unchoke" );
1379            msgs->peer->clientIsChoked = 0;
1380            updateDesiredRequestCount( msgs );
1381            break;
1382
1383        case BT_INTERESTED:
1384            dbgmsg( msgs, "got Interested" );
1385            msgs->peer->peerIsInterested = 1;
1386            break;
1387
1388        case BT_NOT_INTERESTED:
1389            dbgmsg( msgs, "got Not Interested" );
1390            msgs->peer->peerIsInterested = 0;
1391            break;
1392
1393        case BT_HAVE:
1394            tr_peerIoReadUint32( msgs->peer->io, inbuf, &ui32 );
1395            dbgmsg( msgs, "got Have: %u", ui32 );
1396            if( tr_torrentHasMetadata( msgs->torrent )
1397                    && ( ui32 >= msgs->torrent->info.pieceCount ) )
1398            {
1399                fireError( msgs, ERANGE );
1400                return READ_ERR;
1401            }
1402
1403            /* a peer can send the same HAVE message twice... */
1404            if( !tr_bitfieldHas( &msgs->peer->have, ui32 ) ) {
1405                tr_bitfieldAdd( &msgs->peer->have, ui32 );
1406                fireClientGotHave( msgs, ui32 );
1407            }
1408            updatePeerProgress( msgs );
1409            break;
1410
1411        case BT_BITFIELD: {
1412            uint8_t * tmp = tr_new( uint8_t, msglen );
1413            dbgmsg( msgs, "got a bitfield" );
1414            tr_peerIoReadBytes( msgs->peer->io, inbuf, tmp, msglen );
1415            tr_bitfieldSetRaw( &msgs->peer->have, tmp, msglen, tr_torrentHasMetadata( msgs->torrent ) );
1416            fireClientGotBitfield( msgs, &msgs->peer->have );
1417            updatePeerProgress( msgs );
1418            tr_free( tmp );
1419            break;
1420        }
1421
1422        case BT_REQUEST:
1423        {
1424            struct peer_request r;
1425            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.index );
1426            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.offset );
1427            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.length );
1428            dbgmsg( msgs, "got Request: %u:%u->%u", r.index, r.offset, r.length );
1429            peerMadeRequest( msgs, &r );
1430            break;
1431        }
1432
1433        case BT_CANCEL:
1434        {
1435            int i;
1436            struct peer_request r;
1437            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.index );
1438            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.offset );
1439            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.length );
1440            tr_historyAdd( &msgs->peer->cancelsSentToClient, tr_time( ), 1 );
1441            dbgmsg( msgs, "got a Cancel %u:%u->%u", r.index, r.offset, r.length );
1442
1443            for( i=0; i<msgs->peer->pendingReqsToClient; ++i ) {
1444                const struct peer_request * req = msgs->peerAskedFor + i;
1445                if( ( req->index == r.index ) && ( req->offset == r.offset ) && ( req->length == r.length ) )
1446                    break;
1447            }
1448
1449            if( i < msgs->peer->pendingReqsToClient )
1450                tr_removeElementFromArray( msgs->peerAskedFor, i, sizeof( struct peer_request ),
1451                                           msgs->peer->pendingReqsToClient-- );
1452            break;
1453        }
1454
1455        case BT_PIECE:
1456            assert( 0 ); /* handled elsewhere! */
1457            break;
1458
1459        case BT_PORT:
1460            dbgmsg( msgs, "Got a BT_PORT" );
1461            tr_peerIoReadUint16( msgs->peer->io, inbuf, &msgs->peer->dht_port );
1462            if( msgs->peer->dht_port > 0 )
1463                tr_dhtAddNode( getSession(msgs),
1464                               tr_peerAddress( msgs->peer ),
1465                               msgs->peer->dht_port, 0 );
1466            break;
1467
1468        case BT_FEXT_SUGGEST:
1469            dbgmsg( msgs, "Got a BT_FEXT_SUGGEST" );
1470            tr_peerIoReadUint32( msgs->peer->io, inbuf, &ui32 );
1471            if( fext )
1472                fireClientGotSuggest( msgs, ui32 );
1473            else {
1474                fireError( msgs, EMSGSIZE );
1475                return READ_ERR;
1476            }
1477            break;
1478
1479        case BT_FEXT_ALLOWED_FAST:
1480            dbgmsg( msgs, "Got a BT_FEXT_ALLOWED_FAST" );
1481            tr_peerIoReadUint32( msgs->peer->io, inbuf, &ui32 );
1482            if( fext )
1483                fireClientGotAllowedFast( msgs, ui32 );
1484            else {
1485                fireError( msgs, EMSGSIZE );
1486                return READ_ERR;
1487            }
1488            break;
1489
1490        case BT_FEXT_HAVE_ALL:
1491            dbgmsg( msgs, "Got a BT_FEXT_HAVE_ALL" );
1492            if( fext ) {
1493                tr_bitfieldSetHasAll( &msgs->peer->have );
1494assert( tr_bitfieldHasAll( &msgs->peer->have ) );
1495                fireClientGotHaveAll( msgs );
1496                updatePeerProgress( msgs );
1497            } else {
1498                fireError( msgs, EMSGSIZE );
1499                return READ_ERR;
1500            }
1501            break;
1502
1503        case BT_FEXT_HAVE_NONE:
1504            dbgmsg( msgs, "Got a BT_FEXT_HAVE_NONE" );
1505            if( fext ) {
1506                tr_bitfieldSetHasNone( &msgs->peer->have );
1507                fireClientGotHaveNone( msgs );
1508                updatePeerProgress( msgs );
1509            } else {
1510                fireError( msgs, EMSGSIZE );
1511                return READ_ERR;
1512            }
1513            break;
1514
1515        case BT_FEXT_REJECT:
1516        {
1517            struct peer_request r;
1518            dbgmsg( msgs, "Got a BT_FEXT_REJECT" );
1519            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.index );
1520            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.offset );
1521            tr_peerIoReadUint32( msgs->peer->io, inbuf, &r.length );
1522            if( fext )
1523                fireGotRej( msgs, &r );
1524            else {
1525                fireError( msgs, EMSGSIZE );
1526                return READ_ERR;
1527            }
1528            break;
1529        }
1530
1531        case BT_LTEP:
1532            dbgmsg( msgs, "Got a BT_LTEP" );
1533            parseLtep( msgs, msglen, inbuf );
1534            break;
1535
1536        default:
1537            dbgmsg( msgs, "peer sent us an UNKNOWN: %d", (int)id );
1538            tr_peerIoDrain( msgs->peer->io, inbuf, msglen );
1539            break;
1540    }
1541
1542    assert( msglen + 1 == msgs->incoming.length );
1543    assert( evbuffer_get_length( inbuf ) == startBufLen - msglen );
1544
1545    msgs->state = AWAITING_BT_LENGTH;
1546    return READ_NOW;
1547}
1548
1549/* returns 0 on success, or an errno on failure */
1550static int
1551clientGotBlock( tr_peermsgs                * msgs,
1552                struct evbuffer            * data,
1553                const struct peer_request  * req )
1554{
1555    int err;
1556    tr_torrent * tor = msgs->torrent;
1557    const tr_block_index_t block = _tr_block( tor, req->index, req->offset );
1558
1559    assert( msgs );
1560    assert( req );
1561
1562    if( req->length != tr_torBlockCountBytes( msgs->torrent, block ) ) {
1563        dbgmsg( msgs, "wrong block size -- expected %u, got %d",
1564                tr_torBlockCountBytes( msgs->torrent, block ), req->length );
1565        return EMSGSIZE;
1566    }
1567
1568    dbgmsg( msgs, "got block %u:%u->%u", req->index, req->offset, req->length );
1569
1570    if( !tr_peerMgrDidPeerRequest( msgs->torrent, msgs->peer, block ) ) {
1571        dbgmsg( msgs, "we didn't ask for this message..." );
1572        return 0;
1573    }
1574    if( tr_cpPieceIsComplete( &msgs->torrent->completion, req->index ) ) {
1575        dbgmsg( msgs, "we did ask for this message, but the piece is already complete..." );
1576        return 0;
1577    }
1578
1579    /**
1580    ***  Save the block
1581    **/
1582
1583    if(( err = tr_cacheWriteBlock( getSession(msgs)->cache, tor, req->index, req->offset, req->length, data )))
1584        return err;
1585
1586    tr_bitfieldAdd( &msgs->peer->blame, req->index );
1587    fireGotBlock( msgs, req );
1588    return 0;
1589}
1590
1591static int peerPulse( void * vmsgs );
1592
1593static void
1594didWrite( tr_peerIo * io UNUSED, size_t bytesWritten, int wasPieceData, void * vmsgs )
1595{
1596    tr_peermsgs * msgs = vmsgs;
1597    firePeerGotData( msgs, bytesWritten, wasPieceData );
1598
1599    if ( tr_isPeerIo( io ) && io->userData )
1600        peerPulse( msgs );
1601}
1602
1603static ReadState
1604canRead( tr_peerIo * io, void * vmsgs, size_t * piece )
1605{
1606    ReadState         ret;
1607    tr_peermsgs *     msgs = vmsgs;
1608    struct evbuffer * in = tr_peerIoGetReadBuffer( io );
1609    const size_t      inlen = evbuffer_get_length( in );
1610
1611    dbgmsg( msgs, "canRead: inlen is %zu, msgs->state is %d", inlen, msgs->state );
1612
1613    if( !inlen )
1614    {
1615        ret = READ_LATER;
1616    }
1617    else if( msgs->state == AWAITING_BT_PIECE )
1618    {
1619        ret = readBtPiece( msgs, in, inlen, piece );
1620    }
1621    else switch( msgs->state )
1622    {
1623        case AWAITING_BT_LENGTH:
1624            ret = readBtLength ( msgs, in, inlen ); break;
1625
1626        case AWAITING_BT_ID:
1627            ret = readBtId     ( msgs, in, inlen ); break;
1628
1629        case AWAITING_BT_MESSAGE:
1630            ret = readBtMessage( msgs, in, inlen ); break;
1631
1632        default:
1633            ret = READ_ERR;
1634            assert( 0 );
1635    }
1636
1637    dbgmsg( msgs, "canRead: ret is %d", (int)ret );
1638
1639    /* log the raw data that was read */
1640    if( ( ret != READ_ERR ) && ( evbuffer_get_length( in ) != inlen ) )
1641        fireClientGotData( msgs, inlen - evbuffer_get_length( in ), false );
1642
1643    return ret;
1644}
1645
1646int
1647tr_peerMsgsIsReadingBlock( const tr_peermsgs * msgs, tr_block_index_t block )
1648{
1649    if( msgs->state != AWAITING_BT_PIECE )
1650        return false;
1651
1652    return block == _tr_block( msgs->torrent,
1653                               msgs->incoming.blockReq.index,
1654                               msgs->incoming.blockReq.offset );
1655}
1656
1657/**
1658***
1659**/
1660
1661static void
1662updateDesiredRequestCount( tr_peermsgs * msgs )
1663{
1664    const tr_torrent * const torrent = msgs->torrent;
1665
1666    /* there are lots of reasons we might not want to request any blocks... */
1667    if( tr_torrentIsSeed( torrent ) || !tr_torrentHasMetadata( torrent )
1668                                    || msgs->peer->clientIsChoked
1669                                    || !msgs->peer->clientIsInterested )
1670    {
1671        msgs->desiredRequestCount = 0;
1672    }
1673    else
1674    {
1675        int estimatedBlocksInPeriod;
1676        int rate_Bps;
1677        int irate_Bps;
1678        const int floor = 4;
1679        const int seconds = REQUEST_BUF_SECS;
1680        const uint64_t now = tr_time_msec( );
1681
1682        /* Get the rate limit we should use.
1683         * FIXME: this needs to consider all the other peers as well... */
1684        rate_Bps = tr_peerGetPieceSpeed_Bps( msgs->peer, now, TR_PEER_TO_CLIENT );
1685        if( tr_torrentUsesSpeedLimit( torrent, TR_PEER_TO_CLIENT ) )
1686            rate_Bps = MIN( rate_Bps, tr_torrentGetSpeedLimit_Bps( torrent, TR_PEER_TO_CLIENT ) );
1687
1688        /* honor the session limits, if enabled */
1689        if( tr_torrentUsesSessionLimits( torrent ) )
1690            if( tr_sessionGetActiveSpeedLimit_Bps( torrent->session, TR_PEER_TO_CLIENT, &irate_Bps ) )
1691                rate_Bps = MIN( rate_Bps, irate_Bps );
1692
1693        /* use this desired rate to figure out how
1694         * many requests we should send to this peer */
1695        estimatedBlocksInPeriod = ( rate_Bps * seconds ) / torrent->blockSize;
1696        msgs->desiredRequestCount = MAX( floor, estimatedBlocksInPeriod );
1697
1698        /* honor the peer's maximum request count, if specified */
1699        if( msgs->reqq > 0 )
1700            if( msgs->desiredRequestCount > msgs->reqq )
1701                msgs->desiredRequestCount = msgs->reqq;
1702    }
1703}
1704
1705static void
1706updateMetadataRequests( tr_peermsgs * msgs, time_t now )
1707{
1708    int piece;
1709
1710    if( msgs->peerSupportsMetadataXfer
1711        && tr_torrentGetNextMetadataRequest( msgs->torrent, now, &piece ) )
1712    {
1713        tr_benc tmp;
1714        struct evbuffer * payload;
1715        struct evbuffer * out = msgs->outMessages;
1716
1717        /* build the data message */
1718        tr_bencInitDict( &tmp, 3 );
1719        tr_bencDictAddInt( &tmp, "msg_type", METADATA_MSG_TYPE_REQUEST );
1720        tr_bencDictAddInt( &tmp, "piece", piece );
1721        payload = tr_bencToBuf( &tmp, TR_FMT_BENC );
1722
1723        dbgmsg( msgs, "requesting metadata piece #%d", piece );
1724
1725        /* write it out as a LTEP message to our outMessages buffer */
1726        evbuffer_add_uint32( out, 2 * sizeof( uint8_t ) + evbuffer_get_length( payload ) );
1727        evbuffer_add_uint8 ( out, BT_LTEP );
1728        evbuffer_add_uint8 ( out, msgs->ut_metadata_id );
1729        evbuffer_add_buffer( out, payload );
1730        pokeBatchPeriod( msgs, HIGH_PRIORITY_INTERVAL_SECS );
1731        dbgOutMessageLen( msgs );
1732
1733        /* cleanup */
1734        evbuffer_free( payload );
1735        tr_bencFree( &tmp );
1736    }
1737}
1738
1739static void
1740updateBlockRequests( tr_peermsgs * msgs )
1741{
1742    if( tr_torrentIsPieceTransferAllowed( msgs->torrent, TR_PEER_TO_CLIENT )
1743        && ( msgs->desiredRequestCount > 0 )
1744        && ( msgs->peer->pendingReqsToPeer <= ( msgs->desiredRequestCount * 0.66 ) ) )
1745    {
1746        int i;
1747        int n;
1748        const int numwant = msgs->desiredRequestCount - msgs->peer->pendingReqsToPeer;
1749        tr_block_index_t * blocks = tr_new( tr_block_index_t, numwant );
1750
1751        tr_peerMgrGetNextRequests( msgs->torrent, msgs->peer, numwant, blocks, &n, false );
1752
1753        for( i=0; i<n; ++i )
1754        {
1755            struct peer_request req;
1756            blockToReq( msgs->torrent, blocks[i], &req );
1757            protocolSendRequest( msgs, &req );
1758        }
1759
1760        tr_free( blocks );
1761    }
1762}
1763
1764static size_t
1765fillOutputBuffer( tr_peermsgs * msgs, time_t now )
1766{
1767    int piece;
1768    size_t bytesWritten = 0;
1769    struct peer_request req;
1770    const bool haveMessages = evbuffer_get_length( msgs->outMessages ) != 0;
1771    const bool fext = tr_peerIoSupportsFEXT( msgs->peer->io );
1772
1773    /**
1774    ***  Protocol messages
1775    **/
1776
1777    if( haveMessages && !msgs->outMessagesBatchedAt ) /* fresh batch */
1778    {
1779        dbgmsg( msgs, "started an outMessages batch (length is %zu)", evbuffer_get_length( msgs->outMessages ) );
1780        msgs->outMessagesBatchedAt = now;
1781    }
1782    else if( haveMessages && ( ( now - msgs->outMessagesBatchedAt ) >= msgs->outMessagesBatchPeriod ) )
1783    {
1784        const size_t len = evbuffer_get_length( msgs->outMessages );
1785        /* flush the protocol messages */
1786        dbgmsg( msgs, "flushing outMessages... to %p (length is %zu)", msgs->peer->io, len );
1787        tr_peerIoWriteBuf( msgs->peer->io, msgs->outMessages, false );
1788        msgs->clientSentAnythingAt = now;
1789        msgs->outMessagesBatchedAt = 0;
1790        msgs->outMessagesBatchPeriod = LOW_PRIORITY_INTERVAL_SECS;
1791        bytesWritten +=  len;
1792    }
1793
1794    /**
1795    ***  Metadata Pieces
1796    **/
1797
1798    if( ( tr_peerIoGetWriteBufferSpace( msgs->peer->io, now ) >= METADATA_PIECE_SIZE )
1799        && popNextMetadataRequest( msgs, &piece ) )
1800    {
1801        char * data;
1802        int dataLen;
1803        bool ok = false;
1804
1805        data = tr_torrentGetMetadataPiece( msgs->torrent, piece, &dataLen );
1806        if( ( dataLen > 0 ) && ( data != NULL ) )
1807        {
1808            tr_benc tmp;
1809            struct evbuffer * payload;
1810            struct evbuffer * out = msgs->outMessages;
1811
1812            /* build the data message */
1813            tr_bencInitDict( &tmp, 3 );
1814            tr_bencDictAddInt( &tmp, "msg_type", METADATA_MSG_TYPE_DATA );
1815            tr_bencDictAddInt( &tmp, "piece", piece );
1816            tr_bencDictAddInt( &tmp, "total_size", msgs->torrent->infoDictLength );
1817            payload = tr_bencToBuf( &tmp, TR_FMT_BENC );
1818
1819            /* write it out as a LTEP message to our outMessages buffer */
1820            evbuffer_add_uint32( out, 2 * sizeof( uint8_t ) + evbuffer_get_length( payload ) + dataLen );
1821            evbuffer_add_uint8 ( out, BT_LTEP );
1822            evbuffer_add_uint8 ( out, msgs->ut_metadata_id );
1823            evbuffer_add_buffer( out, payload );
1824            evbuffer_add       ( out, data, dataLen );
1825            pokeBatchPeriod( msgs, HIGH_PRIORITY_INTERVAL_SECS );
1826            dbgOutMessageLen( msgs );
1827
1828            evbuffer_free( payload );
1829            tr_bencFree( &tmp );
1830            tr_free( data );
1831
1832            ok = true;
1833        }
1834
1835        if( !ok ) /* send a rejection message */
1836        {
1837            tr_benc tmp;
1838            struct evbuffer * payload;
1839            struct evbuffer * out = msgs->outMessages;
1840
1841            /* build the rejection message */
1842            tr_bencInitDict( &tmp, 2 );
1843            tr_bencDictAddInt( &tmp, "msg_type", METADATA_MSG_TYPE_REJECT );
1844            tr_bencDictAddInt( &tmp, "piece", piece );
1845            payload = tr_bencToBuf( &tmp, TR_FMT_BENC );
1846
1847            /* write it out as a LTEP message to our outMessages buffer */
1848            evbuffer_add_uint32( out, 2 * sizeof( uint8_t ) + evbuffer_get_length( payload ) );
1849            evbuffer_add_uint8 ( out, BT_LTEP );
1850            evbuffer_add_uint8 ( out, msgs->ut_metadata_id );
1851            evbuffer_add_buffer( out, payload );
1852            pokeBatchPeriod( msgs, HIGH_PRIORITY_INTERVAL_SECS );
1853            dbgOutMessageLen( msgs );
1854
1855            evbuffer_free( payload );
1856            tr_bencFree( &tmp );
1857        }
1858    }
1859
1860    /**
1861    ***  Data Blocks
1862    **/
1863
1864    if( ( tr_peerIoGetWriteBufferSpace( msgs->peer->io, now ) >= msgs->torrent->blockSize )
1865        && popNextRequest( msgs, &req ) )
1866    {
1867        --msgs->prefetchCount;
1868
1869        if( requestIsValid( msgs, &req )
1870            && tr_cpPieceIsComplete( &msgs->torrent->completion, req.index ) )
1871        {
1872            int err;
1873            const uint32_t msglen = 4 + 1 + 4 + 4 + req.length;
1874            struct evbuffer * out;
1875            struct evbuffer_iovec iovec[1];
1876
1877            out = evbuffer_new( );
1878            evbuffer_expand( out, msglen );
1879
1880            evbuffer_add_uint32( out, sizeof( uint8_t ) + 2 * sizeof( uint32_t ) + req.length );
1881            evbuffer_add_uint8 ( out, BT_PIECE );
1882            evbuffer_add_uint32( out, req.index );
1883            evbuffer_add_uint32( out, req.offset );
1884
1885            evbuffer_reserve_space( out, req.length, iovec, 1 );
1886            err = tr_cacheReadBlock( getSession(msgs)->cache, msgs->torrent, req.index, req.offset, req.length, iovec[0].iov_base );
1887            iovec[0].iov_len = req.length;
1888            evbuffer_commit_space( out, iovec, 1 );
1889
1890            /* check the piece if it needs checking... */
1891            if( !err && tr_torrentPieceNeedsCheck( msgs->torrent, req.index ) )
1892                if(( err = !tr_torrentCheckPiece( msgs->torrent, req.index )))
1893                    tr_torrentSetLocalError( msgs->torrent, _( "Please Verify Local Data! Piece #%zu is corrupt." ), (size_t)req.index );
1894
1895            if( err )
1896            {
1897                if( fext )
1898                    protocolSendReject( msgs, &req );
1899            }
1900            else
1901            {
1902                const size_t n = evbuffer_get_length( out );
1903                dbgmsg( msgs, "sending block %u:%u->%u", req.index, req.offset, req.length );
1904                assert( n == msglen );
1905                tr_peerIoWriteBuf( msgs->peer->io, out, true );
1906                bytesWritten += n;
1907                msgs->clientSentAnythingAt = now;
1908                tr_historyAdd( &msgs->peer->blocksSentToPeer, tr_time( ), 1 );
1909            }
1910
1911            evbuffer_free( out );
1912
1913            if( err )
1914            {
1915                bytesWritten = 0;
1916                msgs = NULL;
1917            }
1918        }
1919        else if( fext ) /* peer needs a reject message */
1920        {
1921            protocolSendReject( msgs, &req );
1922        }
1923
1924        if( msgs != NULL )
1925            prefetchPieces( msgs );
1926    }
1927
1928    /**
1929    ***  Keepalive
1930    **/
1931
1932    if( ( msgs != NULL )
1933        && ( msgs->clientSentAnythingAt != 0 )
1934        && ( ( now - msgs->clientSentAnythingAt ) > KEEPALIVE_INTERVAL_SECS ) )
1935    {
1936        dbgmsg( msgs, "sending a keepalive message" );
1937        evbuffer_add_uint32( msgs->outMessages, 0 );
1938        pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
1939    }
1940
1941    return bytesWritten;
1942}
1943
1944static int
1945peerPulse( void * vmsgs )
1946{
1947    tr_peermsgs * msgs = vmsgs;
1948    const time_t  now = tr_time( );
1949
1950    if ( tr_isPeerIo( msgs->peer->io ) ) {
1951        updateDesiredRequestCount( msgs );
1952        updateBlockRequests( msgs );
1953        updateMetadataRequests( msgs, now );
1954    }
1955
1956    for( ;; )
1957        if( fillOutputBuffer( msgs, now ) < 1 )
1958            break;
1959
1960    return true; /* loop forever */
1961}
1962
1963void
1964tr_peerMsgsPulse( tr_peermsgs * msgs )
1965{
1966    if( msgs != NULL )
1967        peerPulse( msgs );
1968}
1969
1970static void
1971gotError( tr_peerIo * io UNUSED, short what, void * vmsgs )
1972{
1973    if( what & BEV_EVENT_TIMEOUT )
1974        dbgmsg( vmsgs, "libevent got a timeout, what=%hd", what );
1975    if( what & ( BEV_EVENT_EOF | BEV_EVENT_ERROR ) )
1976        dbgmsg( vmsgs, "libevent got an error! what=%hd, errno=%d (%s)",
1977               what, errno, tr_strerror( errno ) );
1978    fireError( vmsgs, ENOTCONN );
1979}
1980
1981static void
1982sendBitfield( tr_peermsgs * msgs )
1983{
1984    size_t byte_count = 0;
1985    struct evbuffer * out = msgs->outMessages;
1986    void * bytes = tr_cpCreatePieceBitfield( &msgs->torrent->completion, &byte_count );
1987
1988    evbuffer_add_uint32( out, sizeof( uint8_t ) + byte_count );
1989    evbuffer_add_uint8 ( out, BT_BITFIELD );
1990    evbuffer_add       ( out, bytes, byte_count );
1991    dbgmsg( msgs, "sending bitfield... outMessage size is now %zu", evbuffer_get_length( out ) );
1992    pokeBatchPeriod( msgs, IMMEDIATE_PRIORITY_INTERVAL_SECS );
1993
1994    tr_free( bytes );
1995}
1996
1997static void
1998tellPeerWhatWeHave( tr_peermsgs * msgs )
1999{
2000    const bool fext = tr_peerIoSupportsFEXT( msgs->peer->io );
2001
2002    if( fext && tr_cpHasAll( &msgs->torrent->completion ) )
2003    {
2004        protocolSendHaveAll( msgs );
2005    }
2006    else if( fext && tr_cpHasNone( &msgs->torrent->completion ) )
2007    {
2008        protocolSendHaveNone( msgs );
2009    }
2010    else if( !tr_cpHasNone( &msgs->torrent->completion ) )
2011    {
2012        sendBitfield( msgs );
2013    }
2014}
2015
2016/**
2017***
2018**/
2019
2020/* some peers give us error messages if we send
2021   more than this many peers in a single pex message
2022   http://wiki.theory.org/BitTorrentPeerExchangeConventions */
2023#define MAX_PEX_ADDED 50
2024#define MAX_PEX_DROPPED 50
2025
2026typedef struct
2027{
2028    tr_pex *  added;
2029    tr_pex *  dropped;
2030    tr_pex *  elements;
2031    int       addedCount;
2032    int       droppedCount;
2033    int       elementCount;
2034}
2035PexDiffs;
2036
2037static void
2038pexAddedCb( void * vpex, void * userData )
2039{
2040    PexDiffs * diffs = userData;
2041    tr_pex *   pex = vpex;
2042
2043    if( diffs->addedCount < MAX_PEX_ADDED )
2044    {
2045        diffs->added[diffs->addedCount++] = *pex;
2046        diffs->elements[diffs->elementCount++] = *pex;
2047    }
2048}
2049
2050static inline void
2051pexDroppedCb( void * vpex, void * userData )
2052{
2053    PexDiffs * diffs = userData;
2054    tr_pex *   pex = vpex;
2055
2056    if( diffs->droppedCount < MAX_PEX_DROPPED )
2057    {
2058        diffs->dropped[diffs->droppedCount++] = *pex;
2059    }
2060}
2061
2062static inline void
2063pexElementCb( void * vpex, void * userData )
2064{
2065    PexDiffs * diffs = userData;
2066    tr_pex * pex = vpex;
2067
2068    diffs->elements[diffs->elementCount++] = *pex;
2069}
2070
2071typedef void ( tr_set_func )( void * element, void * userData );
2072
2073/**
2074 * @brief find the differences and commonalities in two sorted sets
2075 * @param a the first set
2076 * @param aCount the number of elements in the set 'a'
2077 * @param b the second set
2078 * @param bCount the number of elements in the set 'b'
2079 * @param compare the sorting method for both sets
2080 * @param elementSize the sizeof the element in the two sorted sets
2081 * @param in_a called for items in set 'a' but not set 'b'
2082 * @param in_b called for items in set 'b' but not set 'a'
2083 * @param in_both called for items that are in both sets
2084 * @param userData user data passed along to in_a, in_b, and in_both
2085 */
2086static void
2087tr_set_compare( const void * va, size_t aCount,
2088                const void * vb, size_t bCount,
2089                int compare( const void * a, const void * b ),
2090                size_t elementSize,
2091                tr_set_func in_a_cb,
2092                tr_set_func in_b_cb,
2093                tr_set_func in_both_cb,
2094                void * userData )
2095{
2096    const uint8_t * a = va;
2097    const uint8_t * b = vb;
2098    const uint8_t * aend = a + elementSize * aCount;
2099    const uint8_t * bend = b + elementSize * bCount;
2100
2101    while( a != aend || b != bend )
2102    {
2103        if( a == aend )
2104        {
2105            ( *in_b_cb )( (void*)b, userData );
2106            b += elementSize;
2107        }
2108        else if( b == bend )
2109        {
2110            ( *in_a_cb )( (void*)a, userData );
2111            a += elementSize;
2112        }
2113        else
2114        {
2115            const int val = ( *compare )( a, b );
2116
2117            if( !val )
2118            {
2119                ( *in_both_cb )( (void*)a, userData );
2120                a += elementSize;
2121                b += elementSize;
2122            }
2123            else if( val < 0 )
2124            {
2125                ( *in_a_cb )( (void*)a, userData );
2126                a += elementSize;
2127            }
2128            else if( val > 0 )
2129            {
2130                ( *in_b_cb )( (void*)b, userData );
2131                b += elementSize;
2132            }
2133        }
2134    }
2135}
2136
2137
2138static void
2139sendPex( tr_peermsgs * msgs )
2140{
2141    if( msgs->peerSupportsPex && tr_torrentAllowsPex( msgs->torrent ) )
2142    {
2143        PexDiffs diffs;
2144        PexDiffs diffs6;
2145        tr_pex * newPex = NULL;
2146        tr_pex * newPex6 = NULL;
2147        const int newCount = tr_peerMgrGetPeers( msgs->torrent, &newPex, TR_AF_INET, TR_PEERS_CONNECTED, MAX_PEX_PEER_COUNT );
2148        const int newCount6 = tr_peerMgrGetPeers( msgs->torrent, &newPex6, TR_AF_INET6, TR_PEERS_CONNECTED, MAX_PEX_PEER_COUNT );
2149
2150        /* build the diffs */
2151        diffs.added = tr_new( tr_pex, newCount );
2152        diffs.addedCount = 0;
2153        diffs.dropped = tr_new( tr_pex, msgs->pexCount );
2154        diffs.droppedCount = 0;
2155        diffs.elements = tr_new( tr_pex, newCount + msgs->pexCount );
2156        diffs.elementCount = 0;
2157        tr_set_compare( msgs->pex, msgs->pexCount,
2158                        newPex, newCount,
2159                        tr_pexCompare, sizeof( tr_pex ),
2160                        pexDroppedCb, pexAddedCb, pexElementCb, &diffs );
2161        diffs6.added = tr_new( tr_pex, newCount6 );
2162        diffs6.addedCount = 0;
2163        diffs6.dropped = tr_new( tr_pex, msgs->pexCount6 );
2164        diffs6.droppedCount = 0;
2165        diffs6.elements = tr_new( tr_pex, newCount6 + msgs->pexCount6 );
2166        diffs6.elementCount = 0;
2167        tr_set_compare( msgs->pex6, msgs->pexCount6,
2168                        newPex6, newCount6,
2169                        tr_pexCompare, sizeof( tr_pex ),
2170                        pexDroppedCb, pexAddedCb, pexElementCb, &diffs6 );
2171        dbgmsg(
2172            msgs,
2173            "pex: old peer count %d+%d, new peer count %d+%d, "
2174            "added %d+%d, removed %d+%d",
2175            msgs->pexCount, msgs->pexCount6, newCount, newCount6,
2176            diffs.addedCount, diffs6.addedCount,
2177            diffs.droppedCount, diffs6.droppedCount );
2178
2179        if( !diffs.addedCount && !diffs.droppedCount && !diffs6.addedCount &&
2180            !diffs6.droppedCount )
2181        {
2182            tr_free( diffs.elements );
2183            tr_free( diffs6.elements );
2184        }
2185        else
2186        {
2187            int  i;
2188            tr_benc val;
2189            uint8_t * tmp, *walk;
2190            struct evbuffer * payload;
2191            struct evbuffer * out = msgs->outMessages;
2192
2193            /* update peer */
2194            tr_free( msgs->pex );
2195            msgs->pex = diffs.elements;
2196            msgs->pexCount = diffs.elementCount;
2197            tr_free( msgs->pex6 );
2198            msgs->pex6 = diffs6.elements;
2199            msgs->pexCount6 = diffs6.elementCount;
2200
2201            /* build the pex payload */
2202            tr_bencInitDict( &val, 3 ); /* ipv6 support: left as 3:
2203                                         * speed vs. likelihood? */
2204
2205            if( diffs.addedCount > 0)
2206            {
2207                /* "added" */
2208                tmp = walk = tr_new( uint8_t, diffs.addedCount * 6 );
2209                for( i = 0; i < diffs.addedCount; ++i ) {
2210                    memcpy( walk, &diffs.added[i].addr.addr, 4 ); walk += 4;
2211                    memcpy( walk, &diffs.added[i].port, 2 ); walk += 2;
2212                }
2213                assert( ( walk - tmp ) == diffs.addedCount * 6 );
2214                tr_bencDictAddRaw( &val, "added", tmp, walk - tmp );
2215                tr_free( tmp );
2216
2217                /* "added.f"
2218                 * unset each holepunch flag because we don't support it. */
2219                tmp = walk = tr_new( uint8_t, diffs.addedCount );
2220                for( i = 0; i < diffs.addedCount; ++i )
2221                    *walk++ = diffs.added[i].flags & ~ADDED_F_HOLEPUNCH;
2222                assert( ( walk - tmp ) == diffs.addedCount );
2223                tr_bencDictAddRaw( &val, "added.f", tmp, walk - tmp );
2224                tr_free( tmp );
2225            }
2226
2227            if( diffs.droppedCount > 0 )
2228            {
2229                /* "dropped" */
2230                tmp = walk = tr_new( uint8_t, diffs.droppedCount * 6 );
2231                for( i = 0; i < diffs.droppedCount; ++i ) {
2232                    memcpy( walk, &diffs.dropped[i].addr.addr, 4 ); walk += 4;
2233                    memcpy( walk, &diffs.dropped[i].port, 2 ); walk += 2;
2234                }
2235                assert( ( walk - tmp ) == diffs.droppedCount * 6 );
2236                tr_bencDictAddRaw( &val, "dropped", tmp, walk - tmp );
2237                tr_free( tmp );
2238            }
2239
2240            if( diffs6.addedCount > 0 )
2241            {
2242                /* "added6" */
2243                tmp = walk = tr_new( uint8_t, diffs6.addedCount * 18 );
2244                for( i = 0; i < diffs6.addedCount; ++i ) {
2245                    memcpy( walk, &diffs6.added[i].addr.addr.addr6.s6_addr, 16 );
2246                    walk += 16;
2247                    memcpy( walk, &diffs6.added[i].port, 2 );
2248                    walk += 2;
2249                }
2250                assert( ( walk - tmp ) == diffs6.addedCount * 18 );
2251                tr_bencDictAddRaw( &val, "added6", tmp, walk - tmp );
2252                tr_free( tmp );
2253
2254                /* "added6.f"
2255                 * unset each holepunch flag because we don't support it. */
2256                tmp = walk = tr_new( uint8_t, diffs6.addedCount );
2257                for( i = 0; i < diffs6.addedCount; ++i )
2258                    *walk++ = diffs6.added[i].flags & ~ADDED_F_HOLEPUNCH;
2259                assert( ( walk - tmp ) == diffs6.addedCount );
2260                tr_bencDictAddRaw( &val, "added6.f", tmp, walk - tmp );
2261                tr_free( tmp );
2262            }
2263
2264            if( diffs6.droppedCount > 0 )
2265            {
2266                /* "dropped6" */
2267                tmp = walk = tr_new( uint8_t, diffs6.droppedCount * 18 );
2268                for( i = 0; i < diffs6.droppedCount; ++i ) {
2269                    memcpy( walk, &diffs6.dropped[i].addr.addr.addr6.s6_addr, 16 );
2270                    walk += 16;
2271                    memcpy( walk, &diffs6.dropped[i].port, 2 );
2272                    walk += 2;
2273                }
2274                assert( ( walk - tmp ) == diffs6.droppedCount * 18);
2275                tr_bencDictAddRaw( &val, "dropped6", tmp, walk - tmp );
2276                tr_free( tmp );
2277            }
2278
2279            /* write the pex message */
2280            payload = tr_bencToBuf( &val, TR_FMT_BENC );
2281            evbuffer_add_uint32( out, 2 * sizeof( uint8_t ) + evbuffer_get_length( payload ) );
2282            evbuffer_add_uint8 ( out, BT_LTEP );
2283            evbuffer_add_uint8 ( out, msgs->ut_pex_id );
2284            evbuffer_add_buffer( out, payload );
2285            pokeBatchPeriod( msgs, HIGH_PRIORITY_INTERVAL_SECS );
2286            dbgmsg( msgs, "sending a pex message; outMessage size is now %zu", evbuffer_get_length( out ) );
2287            dbgOutMessageLen( msgs );
2288
2289            evbuffer_free( payload );
2290            tr_bencFree( &val );
2291        }
2292
2293        /* cleanup */
2294        tr_free( diffs.added );
2295        tr_free( diffs.dropped );
2296        tr_free( newPex );
2297        tr_free( diffs6.added );
2298        tr_free( diffs6.dropped );
2299        tr_free( newPex6 );
2300
2301        /*msgs->clientSentPexAt = tr_time( );*/
2302    }
2303}
2304
2305static void
2306pexPulse( int foo UNUSED, short bar UNUSED, void * vmsgs )
2307{
2308    struct tr_peermsgs * msgs = vmsgs;
2309
2310    sendPex( msgs );
2311
2312    assert( msgs->pexTimer != NULL );
2313    tr_timerAdd( msgs->pexTimer, PEX_INTERVAL_SECS, 0 );
2314}
2315
2316/**
2317***
2318**/
2319
2320tr_peermsgs*
2321tr_peerMsgsNew( struct tr_torrent    * torrent,
2322                struct tr_peer       * peer,
2323                tr_peer_callback     * callback,
2324                void                 * callbackData )
2325{
2326    tr_peermsgs * m;
2327
2328    assert( peer );
2329    assert( peer->io );
2330
2331    m = tr_new0( tr_peermsgs, 1 );
2332    m->callback = callback;
2333    m->callbackData = callbackData;
2334    m->peer = peer;
2335    m->torrent = torrent;
2336    m->peer->clientIsChoked = 1;
2337    m->peer->peerIsChoked = 1;
2338    m->peer->clientIsInterested = 0;
2339    m->peer->peerIsInterested = 0;
2340    m->state = AWAITING_BT_LENGTH;
2341    m->outMessages = evbuffer_new( );
2342    m->outMessagesBatchedAt = 0;
2343    m->outMessagesBatchPeriod = LOW_PRIORITY_INTERVAL_SECS;
2344    peer->msgs = m;
2345
2346    if( tr_torrentAllowsPex( torrent ) ) {
2347        m->pexTimer = evtimer_new( torrent->session->event_base, pexPulse, m );
2348        tr_timerAdd( m->pexTimer, PEX_INTERVAL_SECS, 0 );
2349    }
2350
2351    if( tr_peerIoSupportsUTP( peer->io ) ) {
2352        const tr_address * addr = tr_peerIoGetAddress( peer->io, NULL );
2353        tr_peerMgrSetUtpSupported( torrent, addr );
2354        tr_peerMgrSetUtpFailed( torrent, addr, false );
2355    }
2356
2357    if( tr_peerIoSupportsLTEP( peer->io ) )
2358        sendLtepHandshake( m );
2359
2360    tellPeerWhatWeHave( m );
2361
2362    if( tr_dhtEnabled( torrent->session ) && tr_peerIoSupportsDHT( peer->io ))
2363    {
2364        /* Only send PORT over IPv6 when the IPv6 DHT is running (BEP-32). */
2365        const struct tr_address *addr = tr_peerIoGetAddress( peer->io, NULL );
2366        if( addr->type == TR_AF_INET || tr_globalIPv6() ) {
2367            protocolSendPort( m, tr_dhtPort( torrent->session ) );
2368        }
2369    }
2370
2371    tr_peerIoSetIOFuncs( m->peer->io, canRead, didWrite, gotError, m );
2372    updateDesiredRequestCount( m );
2373
2374    return m;
2375}
2376
2377void
2378tr_peerMsgsFree( tr_peermsgs* msgs )
2379{
2380    if( msgs )
2381    {
2382        if( msgs->pexTimer != NULL )
2383            event_free( msgs->pexTimer );
2384
2385        if( msgs->incoming.block != NULL )
2386            evbuffer_free( msgs->incoming.block );
2387
2388        evbuffer_free( msgs->outMessages );
2389        tr_free( msgs->pex6 );
2390        tr_free( msgs->pex );
2391
2392        memset( msgs, ~0, sizeof( tr_peermsgs ) );
2393        tr_free( msgs );
2394    }
2395}
Note: See TracBrowser for help on using the repository browser.