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

Last change on this file since 10800 was 10800, checked in by charles, 12 years ago

(trunk) #3256 "libtransmission/publish.[ch] should be replaced" -- apply publish.diff for 2.10

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