source: trunk/libtransmission/peer-io.c @ 11933

Last change on this file since 11933 was 11933, checked in by jch, 11 years ago

Implement outgoing uTP connections.

  • Property svn:keywords set to Date Rev Author Id
File size: 32.2 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-io.c 11933 2011-02-18 00:36:19Z jch $
11 */
12
13#include <assert.h>
14#include <errno.h>
15#include <limits.h> /* INT_MAX */
16#include <string.h>
17#include <stdio.h>
18#include <unistd.h>
19
20#ifdef WIN32
21 #include <winsock2.h>
22#else
23 #include <arpa/inet.h> /* inet_ntoa */
24#endif
25
26#include <event2/event.h>
27#include <event2/bufferevent.h>
28#include <libutp/utp.h>
29
30#include "transmission.h"
31#include "session.h"
32#include "bandwidth.h"
33#include "crypto.h"
34#include "list.h"
35#include "net.h"
36#include "peer-common.h" /* MAX_BLOCK_SIZE */
37#include "peer-io.h"
38#include "trevent.h" /* tr_runInEventThread() */
39#include "utils.h"
40
41#define MAGIC_NUMBER 206745
42
43#ifdef WIN32
44 #define EAGAIN       WSAEWOULDBLOCK
45 #define EINTR        WSAEINTR
46 #define EINPROGRESS  WSAEINPROGRESS
47 #define EPIPE        WSAECONNRESET
48#endif
49
50/* The amount of read bufferring that we allow for uTP sockets. */
51
52#define UTP_READ_BUFFER_SIZE (256 * 1024)
53
54static size_t
55guessPacketOverhead( size_t d )
56{
57    /**
58     * http://sd.wareonearth.com/~phil/net/overhead/
59     *
60     * TCP over Ethernet:
61     * Assuming no header compression (e.g. not PPP)
62     * Add 20 IPv4 header or 40 IPv6 header (no options)
63     * Add 20 TCP header
64     * Add 12 bytes optional TCP timestamps
65     * Max TCP Payload data rates over ethernet are thus:
66     *  (1500-40)/(38+1500) = 94.9285 %  IPv4, minimal headers
67     *  (1500-52)/(38+1500) = 94.1482 %  IPv4, TCP timestamps
68     *  (1500-52)/(42+1500) = 93.9040 %  802.1q, IPv4, TCP timestamps
69     *  (1500-60)/(38+1500) = 93.6281 %  IPv6, minimal headers
70     *  (1500-72)/(38+1500) = 92.8479 %  IPv6, TCP timestamps
71     *  (1500-72)/(42+1500) = 92.6070 %  802.1q, IPv6, ICP timestamps
72     */
73    const double assumed_payload_data_rate = 94.0;
74
75    return (unsigned int)( d * ( 100.0 / assumed_payload_data_rate ) - d );
76}
77
78/**
79***
80**/
81
82#define dbgmsg( io, ... ) \
83    do { \
84        if( tr_deepLoggingIsActive( ) ) \
85            tr_deepLog( __FILE__, __LINE__, tr_peerIoGetAddrStr( io ), __VA_ARGS__ ); \
86    } while( 0 )
87
88struct tr_datatype
89{
90    tr_bool  isPieceData;
91    size_t   length;
92};
93
94
95/***
96****
97***/
98
99static void
100didWriteWrapper( tr_peerIo * io, unsigned int bytes_transferred )
101{
102     while( bytes_transferred && tr_isPeerIo( io ) )
103     {
104        struct tr_datatype * next = io->outbuf_datatypes->data;
105
106        const unsigned int payload = MIN( next->length, bytes_transferred );
107        /* For uTP sockets, the overhead is computed in utp_on_overhead. */
108        const unsigned int overhead =
109            io->socket ? guessPacketOverhead( payload ) : 0;
110        const uint64_t now = tr_sessionGetTimeMsec( io->session );
111
112        tr_bandwidthUsed( &io->bandwidth, TR_UP, payload, next->isPieceData, now );
113
114        if( overhead > 0 )
115            tr_bandwidthUsed( &io->bandwidth, TR_UP, overhead, FALSE, now );
116
117        if( io->didWrite )
118            io->didWrite( io, payload, next->isPieceData, io->userData );
119
120        if( tr_isPeerIo( io ) )
121        {
122            bytes_transferred -= payload;
123            next->length -= payload;
124            if( !next->length ) {
125                tr_list_pop_front( &io->outbuf_datatypes );
126                tr_free( next );
127            }
128        }
129    }
130}
131
132static void
133canReadWrapper( tr_peerIo * io )
134{
135    tr_bool err = 0;
136    tr_bool done = 0;
137    tr_session * session;
138
139    dbgmsg( io, "canRead" );
140
141    assert( tr_isPeerIo( io ) );
142    assert( tr_isSession( io->session ) );
143    tr_peerIoRef( io );
144
145    session = io->session;
146
147    /* try to consume the input buffer */
148    if( io->canRead )
149    {
150        const uint64_t now = tr_sessionGetTimeMsec( io->session );
151
152        tr_sessionLock( session );
153
154        while( !done && !err )
155        {
156            size_t piece = 0;
157            const size_t oldLen = evbuffer_get_length( io->inbuf );
158            const int ret = io->canRead( io, io->userData, &piece );
159            const size_t used = oldLen - evbuffer_get_length( io->inbuf );
160            const unsigned int overhead = guessPacketOverhead( used );
161
162            assert( tr_isPeerIo( io ) );
163
164            if( piece || (piece!=used) )
165            {
166                if( piece )
167                    tr_bandwidthUsed( &io->bandwidth, TR_DOWN, piece, TRUE, now );
168
169                if( used != piece )
170                    tr_bandwidthUsed( &io->bandwidth, TR_DOWN, used - piece, FALSE, now );
171            }
172
173            if( overhead > 0 )
174                tr_bandwidthUsed( &io->bandwidth, TR_UP, overhead, FALSE, now );
175
176            switch( ret )
177            {
178                case READ_NOW:
179                    if( evbuffer_get_length( io->inbuf ) )
180                        continue;
181                    done = 1;
182                    break;
183
184                case READ_LATER:
185                    done = 1;
186                    break;
187
188                case READ_ERR:
189                    err = 1;
190                    break;
191            }
192
193            assert( tr_isPeerIo( io ) );
194        }
195
196        tr_sessionUnlock( session );
197    }
198
199    assert( tr_isPeerIo( io ) );
200    tr_peerIoUnref( io );
201}
202
203tr_bool
204tr_isPeerIo( const tr_peerIo * io )
205{
206    return ( io != NULL )
207        && ( io->magicNumber == MAGIC_NUMBER )
208        && ( io->refCount >= 0 )
209        && ( tr_isBandwidth( &io->bandwidth ) )
210        && ( tr_isAddress( &io->addr ) );
211}
212
213static void
214event_read_cb( int fd, short event UNUSED, void * vio )
215{
216    int res;
217    int e;
218    tr_peerIo * io = vio;
219
220    /* Limit the input buffer to 256K, so it doesn't grow too large */
221    unsigned int howmuch;
222    unsigned int curlen;
223    const tr_direction dir = TR_DOWN;
224    const unsigned int max = 256 * 1024;
225
226    assert( tr_isPeerIo( io ) );
227    assert( io->socket >= 0 );
228
229    io->pendingEvents &= ~EV_READ;
230
231    curlen = evbuffer_get_length( io->inbuf );
232    howmuch = curlen >= max ? 0 : max - curlen;
233    howmuch = tr_bandwidthClamp( &io->bandwidth, TR_DOWN, howmuch );
234
235    dbgmsg( io, "libevent says this peer is ready to read" );
236
237    /* if we don't have any bandwidth left, stop reading */
238    if( howmuch < 1 ) {
239        tr_peerIoSetEnabled( io, dir, FALSE );
240        return;
241    }
242
243    EVUTIL_SET_SOCKET_ERROR( 0 );
244    res = evbuffer_read( io->inbuf, fd, (int)howmuch );
245    e = EVUTIL_SOCKET_ERROR( );
246
247    if( res > 0 )
248    {
249        tr_peerIoSetEnabled( io, dir, TRUE );
250
251        /* Invoke the user callback - must always be called last */
252        canReadWrapper( io );
253    }
254    else
255    {
256        char errstr[512];
257        short what = BEV_EVENT_READING;
258
259        if( res == 0 ) /* EOF */
260            what |= BEV_EVENT_EOF;
261        else if( res == -1 ) {
262            if( e == EAGAIN || e == EINTR ) {
263                tr_peerIoSetEnabled( io, dir, TRUE );
264                return;
265            }
266            what |= BEV_EVENT_ERROR;
267        }
268
269        tr_net_strerror( errstr, sizeof( errstr ), e );
270        dbgmsg( io, "event_read_cb got an error. res is %d, what is %hd, errno is %d (%s)", res, what, e, errstr );
271
272        if( io->gotError != NULL )
273            io->gotError( io, what, io->userData );
274    }
275}
276
277static int
278tr_evbuffer_write( tr_peerIo * io, int fd, size_t howmuch )
279{
280    int e;
281    int n;
282    char errstr[256];
283
284    EVUTIL_SET_SOCKET_ERROR( 0 );
285    n = evbuffer_write_atmost( io->outbuf, fd, howmuch );
286    e = EVUTIL_SOCKET_ERROR( );
287    dbgmsg( io, "wrote %d to peer (%s)", n, (n==-1?tr_net_strerror(errstr,sizeof(errstr),e):"") );
288
289    return n;
290}
291
292static void
293event_write_cb( int fd, short event UNUSED, void * vio )
294{
295    int res = 0;
296    int e;
297    short what = BEV_EVENT_WRITING;
298    tr_peerIo * io = vio;
299    size_t howmuch;
300    const tr_direction dir = TR_UP;
301
302    assert( tr_isPeerIo( io ) );
303    assert( io->socket >= 0 );
304
305    io->pendingEvents &= ~EV_WRITE;
306
307    dbgmsg( io, "libevent says this peer is ready to write" );
308
309    /* Write as much as possible, since the socket is non-blocking, write() will
310     * return if it can't write any more data without blocking */
311    howmuch = tr_bandwidthClamp( &io->bandwidth, dir, evbuffer_get_length( io->outbuf ) );
312
313    /* if we don't have any bandwidth left, stop writing */
314    if( howmuch < 1 ) {
315        tr_peerIoSetEnabled( io, dir, FALSE );
316        return;
317    }
318
319    EVUTIL_SET_SOCKET_ERROR( 0 );
320    res = tr_evbuffer_write( io, fd, howmuch );
321    e = EVUTIL_SOCKET_ERROR( );
322
323    if (res == -1) {
324        if (!e || e == EAGAIN || e == EINTR || e == EINPROGRESS)
325            goto reschedule;
326        /* error case */
327        what |= BEV_EVENT_ERROR;
328    } else if (res == 0) {
329        /* eof case */
330        what |= BEV_EVENT_EOF;
331    }
332    if (res <= 0)
333        goto error;
334
335    if( evbuffer_get_length( io->outbuf ) )
336        tr_peerIoSetEnabled( io, dir, TRUE );
337
338    didWriteWrapper( io, res );
339    return;
340
341 reschedule:
342    if( evbuffer_get_length( io->outbuf ) )
343        tr_peerIoSetEnabled( io, dir, TRUE );
344    return;
345
346 error:
347
348    dbgmsg( io, "event_write_cb got an error. res is %d, what is %hd, errno is %d (%s)", res, what, e, strerror( e ) );
349
350    if( io->gotError != NULL )
351        io->gotError( io, what, io->userData );
352}
353
354/**
355***
356**/
357
358static void
359maybeSetCongestionAlgorithm( int socket, const char * algorithm )
360{
361    if( algorithm && *algorithm )
362    {
363        const int rc = tr_netSetCongestionControl( socket, algorithm );
364
365        if( rc < 0 )
366            tr_ninf( "Net", "Can't set congestion control algorithm '%s': %s",
367                     algorithm, tr_strerror( errno ));
368    }
369}
370
371/* UTP callbacks */
372
373static void
374utp_on_read(void *closure, const unsigned char *buf, size_t buflen)
375{
376    int rc;
377    tr_peerIo *io = (tr_peerIo *)closure;
378    assert( tr_isPeerIo( io ) );
379
380    tr_ndbg( "UTP", "On read: %ld", (long)buflen );
381
382    rc = evbuffer_add( io->inbuf, buf, buflen );
383    if( rc < 0 ) {
384        tr_nerr( "UTP", "On read evbuffer_add" );
385        return;
386    }
387
388    tr_peerIoSetEnabled( io, TR_DOWN, TRUE );
389    canReadWrapper( io );
390}
391
392static void
393utp_on_write(void *closure, unsigned char *buf, size_t buflen)
394{
395    tr_peerIo *io = (tr_peerIo *)closure;
396    int rc;
397
398    assert( tr_isPeerIo( io ) );
399    tr_ndbg( "UTP", "On write: %ld", (long)buflen );
400
401    rc = evbuffer_remove( io->outbuf, buf, buflen );
402    if( rc < (long)buflen ) {
403        tr_nerr( "UTP", "Short write: %d < %ld", rc, (long)buflen);
404    }
405}
406
407static size_t
408utp_get_rb_size(void *closure)
409{
410    tr_peerIo *io = (tr_peerIo *)closure;
411    size_t bytes;
412    assert( tr_isPeerIo( io ) );
413
414    if( io->read_enabled )
415        bytes =
416            tr_bandwidthClamp( &io->bandwidth, TR_DOWN, UTP_READ_BUFFER_SIZE );
417    else
418        bytes = 0;
419
420    tr_ndbg( "UTP", "Get RB size %ld", (long)bytes);
421
422    return UTP_READ_BUFFER_SIZE - bytes;
423}
424
425static void
426utp_on_state_change(void *closure, int state)
427{
428    tr_peerIo *io = (tr_peerIo *)closure;
429    assert( tr_isPeerIo( io ) );
430
431    tr_ndbg( "UTP", "On state change: %d", state );
432
433    if( state == UTP_STATE_CONNECT || state == UTP_STATE_WRITABLE ) {
434        size_t count = evbuffer_get_length( io->outbuf );
435        if( count > 0 )
436            UTP_Write( io->utp_socket, count );
437    } else if( state == UTP_STATE_EOF ) {
438        if( io->gotError )
439            io->gotError( io, BEV_EVENT_EOF, io->userData );
440    } else if( state == UTP_STATE_DESTROYING ) {
441        tr_nerr( "UTP", "Impossible state UTP_STATE_DESTROYING" );
442        return;
443    } else {
444        tr_nerr( "UTP", "Unknown state %d", state );
445    }
446}
447
448static void
449utp_on_error(void *closure, int errcode)
450{
451    tr_peerIo *io = (tr_peerIo *)closure;
452    assert( tr_isPeerIo( io ) );
453
454    tr_ndbg( "UTP", "Error callback: %s", tr_strerror( errcode ) );
455
456    if( io->gotError ) {
457        errno = errcode;
458        io->gotError( io, BEV_EVENT_ERROR, io->userData );
459    }
460}
461
462static void
463utp_on_overhead(void *closure, bool send, size_t count, int type)
464{
465    tr_peerIo *io = (tr_peerIo *)closure;
466    assert( tr_isPeerIo( io ) );
467
468    tr_ndbg( "UTP", "On overhead: %d %ld %d", (int)send, (long)count, type );
469    tr_bandwidthUsed( &io->bandwidth, send ? TR_UP : TR_DOWN,
470                      count, FALSE, tr_time_msec() );
471}
472
473static struct UTPFunctionTable utp_function_table = {
474    .on_read = utp_on_read,
475    .on_write = utp_on_write,
476    .get_rb_size = utp_get_rb_size,
477    .on_state = utp_on_state_change,
478    .on_error = utp_on_error,
479    .on_overhead = utp_on_overhead
480};
481
482/* Dummy UTP callbacks. */
483/* We switch a UTP socket to use these after the associated peerIo has been
484   destroyed -- see io_dtor. */
485
486static void
487dummy_read( void * closure UNUSED, const unsigned char *buf UNUSED, size_t buflen UNUSED )
488{
489    /* This cannot happen, as far as I'm aware. */
490    tr_nerr( "UTP", "On_read called on closed socket" );
491
492}
493
494static void
495dummy_write(void * closure UNUSED, unsigned char *buf, size_t buflen)
496{
497    /* This can very well happen if we've shut down a peer connection that
498       had unflushed buffers.  Complain and send zeroes. */
499    tr_ndbg( "UTP", "On_write called on closed socket" );
500    memset( buf, 0, buflen );
501}
502
503static size_t
504dummy_get_rb_size( void * closure UNUSED )
505{
506    return 0;
507}
508
509static void
510dummy_on_state_change(void * closure UNUSED, int state UNUSED )
511{
512    return;
513}
514
515static void
516dummy_on_error( void * closure UNUSED, int errcode UNUSED )
517{
518    return;
519}
520
521static void
522dummy_on_overhead( void *closure UNUSED, bool send UNUSED, size_t count UNUSED, int type UNUSED )
523{
524    return;
525}
526
527static struct UTPFunctionTable dummy_utp_function_table = {
528    .on_read = dummy_read,
529    .on_write = dummy_write,
530    .get_rb_size = dummy_get_rb_size,
531    .on_state = dummy_on_state_change,
532    .on_error = dummy_on_error,
533    .on_overhead = dummy_on_overhead
534};
535
536static tr_peerIo*
537tr_peerIoNew( tr_session       * session,
538              tr_bandwidth     * parent,
539              const tr_address * addr,
540              tr_port            port,
541              const uint8_t    * torrentHash,
542              tr_bool            isIncoming,
543              tr_bool            isSeed,
544              int                socket,
545              struct UTPSocket * utp_socket)
546{
547    tr_peerIo * io;
548
549    assert( session != NULL );
550    assert( session->events != NULL );
551    assert( tr_isBool( isIncoming ) );
552    assert( tr_isBool( isSeed ) );
553    assert( tr_amInEventThread( session ) );
554    assert( (socket < 0) == (utp_socket != NULL) );
555
556    if( socket >= 0 ) {
557        tr_netSetTOS( socket, session->peerSocketTOS );
558        maybeSetCongestionAlgorithm( socket, session->peer_congestion_algorithm );
559    }
560
561    io = tr_new0( tr_peerIo, 1 );
562    io->magicNumber = MAGIC_NUMBER;
563    io->refCount = 1;
564    io->crypto = tr_cryptoNew( torrentHash, isIncoming );
565    io->session = session;
566    io->addr = *addr;
567    io->isSeed = isSeed;
568    io->port = port;
569    io->socket = socket;
570    io->utp_socket = utp_socket;
571    io->isIncoming = isIncoming != 0;
572    io->timeCreated = tr_time( );
573    io->inbuf = evbuffer_new( );
574    io->outbuf = evbuffer_new( );
575    tr_bandwidthConstruct( &io->bandwidth, session, parent );
576    tr_bandwidthSetPeer( &io->bandwidth, io );
577    dbgmsg( io, "bandwidth is %p; its parent is %p", &io->bandwidth, parent );
578
579    if( io->socket >= 0 ) {
580        io->event_read = event_new( session->event_base,
581                                    io->socket, EV_READ, event_read_cb, io );
582        io->event_write = event_new( session->event_base,
583                                     io->socket, EV_WRITE, event_write_cb, io );
584    } else {
585        tr_ndbg( "UTP", "New %s connection",
586                 isIncoming ? "incoming" : "outgoing" );
587        UTP_SetSockopt( utp_socket, SO_RCVBUF, UTP_READ_BUFFER_SIZE );
588        UTP_SetCallbacks( utp_socket,
589                          &utp_function_table,
590                          io );
591        if( !isIncoming )
592            UTP_Connect( utp_socket );
593    }
594
595    io->write_enabled = 1;
596    io->read_enabled = 1;
597
598    return io;
599}
600
601tr_peerIo*
602tr_peerIoNewIncoming( tr_session        * session,
603                      tr_bandwidth      * parent,
604                      const tr_address  * addr,
605                      tr_port             port,
606                      int                 fd,
607                      struct UTPSocket  * utp_socket )
608{
609    assert( session );
610    assert( tr_isAddress( addr ) );
611
612    return tr_peerIoNew( session, parent, addr, port, NULL, TRUE, FALSE, 
613                         fd, utp_socket );
614}
615
616tr_peerIo*
617tr_peerIoNewOutgoing( tr_session        * session,
618                      tr_bandwidth      * parent,
619                      const tr_address  * addr,
620                      tr_port             port,
621                      const uint8_t     * torrentHash,
622                      tr_bool             isSeed,
623                      tr_bool             utp )
624{
625    int fd = -1;
626    struct UTPSocket *utp_socket = NULL;
627
628    assert( session );
629    assert( tr_isAddress( addr ) );
630    assert( torrentHash );
631
632    if( !utp ) {
633        fd = tr_netOpenPeerSocket( session, addr, port, isSeed );
634        dbgmsg( NULL, "tr_netOpenPeerSocket returned fd %d", fd );
635    } else {
636        utp_socket =
637            tr_netOpenPeerUTPSocket( session, addr, port, isSeed );
638    }
639
640    if( fd < 0 && utp_socket == NULL )
641        return NULL;
642
643    return tr_peerIoNew( session, parent, addr, port,
644                         torrentHash, FALSE, isSeed, fd, utp_socket );
645}
646
647/***
648****
649***/
650
651static void
652event_enable( tr_peerIo * io, short event )
653{
654    assert( tr_amInEventThread( io->session ) );
655    assert( io->session != NULL );
656    assert( io->session->events != NULL );
657
658    if( io->socket < 0 )
659        return;
660
661    assert( io->session->events != NULL );
662    assert( event_initialized( io->event_read ) );
663    assert( event_initialized( io->event_write ) );
664
665    if( ( event & EV_READ ) && ! ( io->pendingEvents & EV_READ ) )
666    {
667        dbgmsg( io, "enabling libevent ready-to-read polling" );
668        event_add( io->event_read, NULL );
669        io->pendingEvents |= EV_READ;
670    }
671
672    if( ( event & EV_WRITE ) && ! ( io->pendingEvents & EV_WRITE ) )
673    {
674        dbgmsg( io, "enabling libevent ready-to-write polling" );
675        event_add( io->event_write, NULL );
676        io->pendingEvents |= EV_WRITE;
677    }
678}
679
680static void
681event_disable( struct tr_peerIo * io, short event )
682{
683    assert( tr_amInEventThread( io->session ) );
684    assert( io->session != NULL );
685
686    if( io->socket < 0 )
687        return;
688
689    assert( io->session->events != NULL );
690    assert( event_initialized( io->event_read ) );
691    assert( event_initialized( io->event_write ) );
692
693    if( ( event & EV_READ ) && ( io->pendingEvents & EV_READ ) )
694    {
695        dbgmsg( io, "disabling libevent ready-to-read polling" );
696        event_del( io->event_read );
697        io->pendingEvents &= ~EV_READ;
698    }
699
700    if( ( event & EV_WRITE ) && ( io->pendingEvents & EV_WRITE ) )
701    {
702        dbgmsg( io, "disabling libevent ready-to-write polling" );
703        event_del( io->event_write );
704        io->pendingEvents &= ~EV_WRITE;
705    }
706}
707
708void
709tr_peerIoSetEnabled( tr_peerIo    * io,
710                     tr_direction   dir,
711                     tr_bool        isEnabled )
712{
713    const short event = dir == TR_UP ? EV_WRITE : EV_READ;
714
715    assert( tr_isPeerIo( io ) );
716    assert( tr_isDirection( dir ) );
717    assert( tr_amInEventThread( io->session ) );
718    assert( io->session->events != NULL );
719
720    if( isEnabled )
721        event_enable( io, event );
722    else
723        event_disable( io, event );
724
725    if( dir == TR_UP )
726        io->write_enabled = isEnabled;
727    else if( dir == TR_DOWN ) {
728        io->read_enabled = isEnabled;
729        if( io->utp_socket && isEnabled )
730            UTP_RBDrained(io->utp_socket);
731    }
732}
733
734/***
735****
736***/
737
738static void
739io_dtor( void * vio )
740{
741    tr_peerIo * io = vio;
742
743    assert( tr_isPeerIo( io ) );
744    assert( tr_amInEventThread( io->session ) );
745    assert( io->session->events != NULL );
746
747    dbgmsg( io, "in tr_peerIo destructor" );
748    event_disable( io, EV_READ | EV_WRITE );
749    tr_bandwidthDestruct( &io->bandwidth );
750    evbuffer_free( io->outbuf );
751    evbuffer_free( io->inbuf );
752    if( io->socket >= 0 ) {
753        event_free( io->event_read );
754        event_free( io->event_write );
755        tr_netClose( io->session, io->socket );
756    }
757    if( io->utp_socket != NULL ) {
758        tr_ndbg( "UTP", "Destroying connection");
759        UTP_SetCallbacks( io->utp_socket,
760                          &dummy_utp_function_table,
761                          NULL );
762        UTP_Close( io->utp_socket );
763    }
764    tr_cryptoFree( io->crypto );
765    tr_list_free( &io->outbuf_datatypes, tr_free );
766
767    memset( io, ~0, sizeof( tr_peerIo ) );
768    tr_free( io );
769}
770
771static void
772tr_peerIoFree( tr_peerIo * io )
773{
774    if( io )
775    {
776        dbgmsg( io, "in tr_peerIoFree" );
777        io->canRead = NULL;
778        io->didWrite = NULL;
779        io->gotError = NULL;
780        tr_runInEventThread( io->session, io_dtor, io );
781    }
782}
783
784void
785tr_peerIoRefImpl( const char * file, int line, tr_peerIo * io )
786{
787    assert( tr_isPeerIo( io ) );
788
789    dbgmsg( io, "%s:%d is incrementing the IO's refcount from %d to %d",
790                file, line, io->refCount, io->refCount+1 );
791
792    ++io->refCount;
793}
794
795void
796tr_peerIoUnrefImpl( const char * file, int line, tr_peerIo * io )
797{
798    assert( tr_isPeerIo( io ) );
799
800    dbgmsg( io, "%s:%d is decrementing the IO's refcount from %d to %d",
801                file, line, io->refCount, io->refCount-1 );
802
803    if( !--io->refCount )
804        tr_peerIoFree( io );
805}
806
807const tr_address*
808tr_peerIoGetAddress( const tr_peerIo * io, tr_port   * port )
809{
810    assert( tr_isPeerIo( io ) );
811
812    if( port )
813        *port = io->port;
814
815    return &io->addr;
816}
817
818const char*
819tr_peerIoAddrStr( const tr_address * addr, tr_port port )
820{
821    static char buf[512];
822
823    if( addr->type == TR_AF_INET )
824        tr_snprintf( buf, sizeof( buf ), "%s:%u", tr_ntop_non_ts( addr ), ntohs( port ) );
825    else
826        tr_snprintf( buf, sizeof( buf ), "[%s]:%u", tr_ntop_non_ts( addr ), ntohs( port ) );
827    return buf;
828}
829
830const char* tr_peerIoGetAddrStr( const tr_peerIo * io )
831{
832    return tr_isPeerIo( io ) ? tr_peerIoAddrStr( &io->addr, io->port ) : "error";
833}
834
835void
836tr_peerIoSetIOFuncs( tr_peerIo        * io,
837                     tr_can_read_cb     readcb,
838                     tr_did_write_cb    writecb,
839                     tr_net_error_cb    errcb,
840                     void             * userData )
841{
842    io->canRead = readcb;
843    io->didWrite = writecb;
844    io->gotError = errcb;
845    io->userData = userData;
846}
847
848void
849tr_peerIoClear( tr_peerIo * io )
850{
851    tr_peerIoSetIOFuncs( io, NULL, NULL, NULL, NULL );
852    tr_peerIoSetEnabled( io, TR_UP, FALSE );
853    tr_peerIoSetEnabled( io, TR_DOWN, FALSE );
854}
855
856int
857tr_peerIoReconnect( tr_peerIo * io )
858{
859    short int pendingEvents;
860    tr_session * session;
861
862    assert( tr_isPeerIo( io ) );
863    assert( !tr_peerIoIsIncoming( io ) );
864
865    session = tr_peerIoGetSession( io );
866
867    pendingEvents = io->pendingEvents;
868    event_disable( io, EV_READ | EV_WRITE );
869
870    if( io->socket >= 0 ) {
871        tr_netClose( session, io->socket );
872        io->socket = -1;
873        event_free( io->event_read );
874        event_free( io->event_write );
875    }
876    if( io->utp_socket != NULL ) {
877        UTP_SetCallbacks( io->utp_socket,
878                          &dummy_utp_function_table,
879                          NULL );
880        UTP_Close(io->utp_socket);
881        io->utp_socket = NULL;
882    }
883
884    io->socket = tr_netOpenPeerSocket( session, &io->addr, io->port, io->isSeed );
885    io->event_read = event_new( session->event_base, io->socket, EV_READ, event_read_cb, io );
886    io->event_write = event_new( session->event_base, io->socket, EV_WRITE, event_write_cb, io );
887
888    if( io->socket >= 0 )
889    {
890        event_enable( io, pendingEvents );
891        tr_netSetTOS( io->socket, session->peerSocketTOS );
892        maybeSetCongestionAlgorithm( io->socket, session->peer_congestion_algorithm );
893        return 0;
894    }
895
896    return -1;
897}
898
899/**
900***
901**/
902
903void
904tr_peerIoSetTorrentHash( tr_peerIo *     io,
905                         const uint8_t * hash )
906{
907    assert( tr_isPeerIo( io ) );
908
909    tr_cryptoSetTorrentHash( io->crypto, hash );
910}
911
912const uint8_t*
913tr_peerIoGetTorrentHash( tr_peerIo * io )
914{
915    assert( tr_isPeerIo( io ) );
916    assert( io->crypto );
917
918    return tr_cryptoGetTorrentHash( io->crypto );
919}
920
921int
922tr_peerIoHasTorrentHash( const tr_peerIo * io )
923{
924    assert( tr_isPeerIo( io ) );
925    assert( io->crypto );
926
927    return tr_cryptoHasTorrentHash( io->crypto );
928}
929
930/**
931***
932**/
933
934void
935tr_peerIoSetPeersId( tr_peerIo *     io,
936                     const uint8_t * peer_id )
937{
938    assert( tr_isPeerIo( io ) );
939
940    if( ( io->peerIdIsSet = peer_id != NULL ) )
941        memcpy( io->peerId, peer_id, 20 );
942    else
943        memset( io->peerId, 0, 20 );
944}
945
946/**
947***
948**/
949
950static unsigned int
951getDesiredOutputBufferSize( const tr_peerIo * io, uint64_t now )
952{
953    /* this is all kind of arbitrary, but what seems to work well is
954     * being large enough to hold the next 20 seconds' worth of input,
955     * or a few blocks, whichever is bigger.
956     * It's okay to tweak this as needed */
957    const unsigned int currentSpeed_Bps = tr_bandwidthGetPieceSpeed_Bps( &io->bandwidth, now, TR_UP );
958    const unsigned int period = 15u; /* arbitrary */
959    /* the 3 is arbitrary; the .5 is to leave room for messages */
960    static const unsigned int ceiling =  (unsigned int)( MAX_BLOCK_SIZE * 3.5 );
961    return MAX( ceiling, currentSpeed_Bps*period );
962}
963
964size_t
965tr_peerIoGetWriteBufferSpace( const tr_peerIo * io, uint64_t now )
966{
967    const size_t desiredLen = getDesiredOutputBufferSize( io, now );
968    const size_t currentLen = evbuffer_get_length( io->outbuf );
969    size_t freeSpace = 0;
970
971    if( desiredLen > currentLen )
972        freeSpace = desiredLen - currentLen;
973
974    return freeSpace;
975}
976
977/**
978***
979**/
980
981void
982tr_peerIoSetEncryption( tr_peerIo * io, uint32_t encryptionMode )
983{
984    assert( tr_isPeerIo( io ) );
985    assert( encryptionMode == PEER_ENCRYPTION_NONE
986         || encryptionMode == PEER_ENCRYPTION_RC4 );
987
988    io->encryptionMode = encryptionMode;
989}
990
991/**
992***
993**/
994
995static void
996addDatatype( tr_peerIo * io, size_t byteCount, tr_bool isPieceData )
997{
998    struct tr_datatype * d;
999
1000    d = tr_new( struct tr_datatype, 1 );
1001    d->isPieceData = isPieceData != 0;
1002    d->length = byteCount;
1003    tr_list_append( &io->outbuf_datatypes, d );
1004}
1005
1006static struct evbuffer_iovec *
1007evbuffer_peek_all( struct evbuffer * buf, size_t * setme_vecCount )
1008{
1009    const size_t byteCount = evbuffer_get_length( buf );
1010    const int vecCount = evbuffer_peek( buf, byteCount, NULL, NULL, 0 );
1011    struct evbuffer_iovec * iovec = tr_new0( struct evbuffer_iovec, vecCount );
1012    const int n = evbuffer_peek( buf, byteCount, NULL, iovec, vecCount );
1013    assert( n == vecCount );
1014    *setme_vecCount = n;
1015    return iovec;
1016}
1017
1018static void
1019maybeEncryptBuffer( tr_peerIo * io, struct evbuffer * buf )
1020{
1021    if( io->encryptionMode == PEER_ENCRYPTION_RC4 )
1022    {
1023        size_t i, n;
1024        struct evbuffer_iovec * iovec = evbuffer_peek_all( buf, &n );
1025
1026        for( i=0; i<n; ++i )
1027            tr_cryptoEncrypt( io->crypto, iovec[i].iov_len, iovec[i].iov_base, iovec[i].iov_base );
1028
1029        tr_free( iovec );
1030    }
1031}
1032
1033void
1034tr_peerIoWriteBuf( tr_peerIo * io, struct evbuffer * buf, tr_bool isPieceData )
1035{
1036    const size_t byteCount = evbuffer_get_length( buf );
1037    maybeEncryptBuffer( io, buf );
1038    evbuffer_add_buffer( io->outbuf, buf );
1039    addDatatype( io, byteCount, isPieceData );
1040    if( io->utp_socket )
1041        UTP_Write( io->utp_socket, byteCount );
1042}
1043
1044void
1045tr_peerIoWriteBytes( tr_peerIo * io, const void * bytes, size_t byteCount, tr_bool isPieceData )
1046{
1047    struct evbuffer * buf = evbuffer_new( );
1048    evbuffer_add( buf, bytes, byteCount );
1049    tr_peerIoWriteBuf( io, buf, isPieceData );
1050    evbuffer_free( buf );
1051}
1052
1053/***
1054****
1055***/
1056
1057void
1058evbuffer_add_uint8( struct evbuffer * outbuf, uint8_t byte )
1059{
1060    evbuffer_add( outbuf, &byte, 1 );
1061}
1062
1063void
1064evbuffer_add_uint16( struct evbuffer * outbuf, uint16_t addme_hs )
1065{
1066    const uint16_t ns = htons( addme_hs );
1067    evbuffer_add( outbuf, &ns, sizeof( ns ) );
1068}
1069
1070void
1071evbuffer_add_uint32( struct evbuffer * outbuf, uint32_t addme_hl )
1072{
1073    const uint32_t nl = htonl( addme_hl );
1074    evbuffer_add( outbuf, &nl, sizeof( nl ) );
1075}
1076
1077/***
1078****
1079***/
1080
1081void
1082tr_peerIoReadBytes( tr_peerIo * io, struct evbuffer * inbuf, void * bytes, size_t byteCount )
1083{
1084    assert( tr_isPeerIo( io ) );
1085    assert( evbuffer_get_length( inbuf )  >= byteCount );
1086
1087    switch( io->encryptionMode )
1088    {
1089        case PEER_ENCRYPTION_NONE:
1090            evbuffer_remove( inbuf, bytes, byteCount );
1091            break;
1092
1093        case PEER_ENCRYPTION_RC4:
1094            evbuffer_remove( inbuf, bytes, byteCount );
1095            tr_cryptoDecrypt( io->crypto, byteCount, bytes, bytes );
1096            break;
1097
1098        default:
1099            assert( 0 );
1100    }
1101}
1102
1103void
1104tr_peerIoReadUint16( tr_peerIo        * io,
1105                     struct evbuffer  * inbuf,
1106                     uint16_t         * setme )
1107{
1108    uint16_t tmp;
1109    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint16_t ) );
1110    *setme = ntohs( tmp );
1111}
1112
1113void tr_peerIoReadUint32( tr_peerIo        * io,
1114                          struct evbuffer  * inbuf,
1115                          uint32_t         * setme )
1116{
1117    uint32_t tmp;
1118    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint32_t ) );
1119    *setme = ntohl( tmp );
1120}
1121
1122void
1123tr_peerIoDrain( tr_peerIo       * io,
1124                struct evbuffer * inbuf,
1125                size_t            byteCount )
1126{
1127    void * buf = tr_sessionGetBuffer( io->session );
1128    const size_t buflen = SESSION_BUFFER_SIZE;
1129
1130    while( byteCount > 0 )
1131    {
1132        const size_t thisPass = MIN( byteCount, buflen );
1133        tr_peerIoReadBytes( io, inbuf, buf, thisPass );
1134        byteCount -= thisPass;
1135    }
1136
1137    tr_sessionReleaseBuffer( io->session );
1138}
1139
1140/***
1141****
1142***/
1143
1144static int
1145tr_peerIoTryRead( tr_peerIo * io, size_t howmuch )
1146{
1147    int res = 0;
1148
1149    if(( howmuch = tr_bandwidthClamp( &io->bandwidth, TR_DOWN, howmuch )))
1150    {
1151        int e;
1152
1153        EVUTIL_SET_SOCKET_ERROR( 0 );
1154        res = evbuffer_read( io->inbuf, io->socket, (int)howmuch );
1155        e = EVUTIL_SOCKET_ERROR( );
1156
1157        dbgmsg( io, "read %d from peer (%s)", res, (res==-1?strerror(e):"") );
1158
1159        if( evbuffer_get_length( io->inbuf ) )
1160            canReadWrapper( io );
1161
1162        if( ( res <= 0 ) && ( io->gotError ) && ( e != EAGAIN ) && ( e != EINTR ) && ( e != EINPROGRESS ) )
1163        {
1164            char errstr[512];
1165            short what = BEV_EVENT_READING | BEV_EVENT_ERROR;
1166            if( res == 0 )
1167                what |= BEV_EVENT_EOF;
1168            tr_net_strerror( errstr, sizeof( errstr ), e );
1169            dbgmsg( io, "tr_peerIoTryRead got an error. res is %d, what is %hd, errno is %d (%s)", res, what, e, errstr );
1170            io->gotError( io, what, io->userData );
1171        }
1172    }
1173
1174    return res;
1175}
1176
1177static int
1178tr_peerIoTryWrite( tr_peerIo * io, size_t howmuch )
1179{
1180    int n = 0;
1181
1182    if(( howmuch = tr_bandwidthClamp( &io->bandwidth, TR_UP, howmuch )))
1183    {
1184        int e;
1185        EVUTIL_SET_SOCKET_ERROR( 0 );
1186        n = tr_evbuffer_write( io, io->socket, howmuch );
1187        e = EVUTIL_SOCKET_ERROR( );
1188
1189        if( n > 0 )
1190            didWriteWrapper( io, n );
1191
1192        if( ( n < 0 ) && ( io->gotError ) && e && ( e != EPIPE ) && ( e != EAGAIN ) && ( e != EINTR ) && ( e != EINPROGRESS ) )
1193        {
1194            char errstr[512];
1195            const short what = BEV_EVENT_WRITING | BEV_EVENT_ERROR;
1196
1197            tr_net_strerror( errstr, sizeof( errstr ), e );
1198            dbgmsg( io, "tr_peerIoTryWrite got an error. res is %d, what is %hd, errno is %d (%s)", n, what, e, errstr );
1199
1200            if( io->gotError != NULL )
1201                io->gotError( io, what, io->userData );
1202        }
1203    }
1204
1205    return n;
1206}
1207
1208int
1209tr_peerIoFlush( tr_peerIo  * io, tr_direction dir, size_t limit )
1210{
1211    int bytesUsed = 0;
1212
1213    assert( tr_isPeerIo( io ) );
1214    assert( tr_isDirection( dir ) );
1215
1216    if( dir == TR_DOWN )
1217        bytesUsed = tr_peerIoTryRead( io, limit );
1218    else
1219        bytesUsed = tr_peerIoTryWrite( io, limit );
1220
1221    dbgmsg( io, "flushing peer-io, direction %d, limit %zu, bytesUsed %d", (int)dir, limit, bytesUsed );
1222    return bytesUsed;
1223}
1224
1225int
1226tr_peerIoFlushOutgoingProtocolMsgs( tr_peerIo * io )
1227{
1228    size_t byteCount = 0;
1229    tr_list * it;
1230
1231    /* count up how many bytes are used by non-piece-data messages
1232       at the front of our outbound queue */
1233    for( it=io->outbuf_datatypes; it!=NULL; it=it->next )
1234    {
1235        struct tr_datatype * d = it->data;
1236
1237        if( d->isPieceData )
1238            break;
1239
1240        byteCount += d->length;
1241    }
1242
1243    return tr_peerIoFlush( io, TR_UP, byteCount );
1244}
Note: See TracBrowser for help on using the repository browser.