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

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

Don't use read_enabled in get_rb_size.

We're no longer maintaining read_enabled, as there are simpler ways of
doing the same. Additionally, we used RBDrained incorrectly.

  • Property svn:keywords set to Date Rev Author Id
File size: 31.5 KB
Line 
1/*
2 * This file Copyright (C) Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2. Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: peer-io.c 11936 2011-02-18 00:36:27Z 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    rc = evbuffer_add( io->inbuf, buf, buflen );
381    if( rc < 0 ) {
382        tr_nerr( "UTP", "On read evbuffer_add" );
383        return;
384    }
385
386    tr_peerIoSetEnabled( io, TR_DOWN, TRUE );
387    canReadWrapper( io );
388}
389
390static void
391utp_on_write(void *closure, unsigned char *buf, size_t buflen)
392{
393    tr_peerIo *io = (tr_peerIo *)closure;
394    int rc;
395    assert( tr_isPeerIo( io ) );
396
397    rc = evbuffer_remove( io->outbuf, buf, buflen );
398    if( rc < (long)buflen ) {
399        tr_nerr( "UTP", "Short write: %d < %ld", rc, (long)buflen);
400    }
401}
402
403static size_t
404utp_get_rb_size(void *closure)
405{
406    tr_peerIo *io = (tr_peerIo *)closure;
407    size_t bytes;
408    assert( tr_isPeerIo( io ) );
409
410    bytes = tr_bandwidthClamp( &io->bandwidth, TR_DOWN, UTP_READ_BUFFER_SIZE );
411
412    return UTP_READ_BUFFER_SIZE - bytes;
413}
414
415static void
416utp_on_state_change(void *closure, int state)
417{
418    tr_peerIo *io = (tr_peerIo *)closure;
419    assert( tr_isPeerIo( io ) );
420
421    if( state == UTP_STATE_CONNECT || state == UTP_STATE_WRITABLE ) {
422        size_t count = evbuffer_get_length( io->outbuf );
423        if( count > 0 )
424            UTP_Write( io->utp_socket, count );
425    } else if( state == UTP_STATE_EOF ) {
426        if( io->gotError )
427            io->gotError( io, BEV_EVENT_EOF, io->userData );
428    } else if( state == UTP_STATE_DESTROYING ) {
429        tr_nerr( "UTP", "Impossible state UTP_STATE_DESTROYING" );
430        return;
431    } else {
432        tr_nerr( "UTP", "Unknown state %d", state );
433    }
434}
435
436static void
437utp_on_error(void *closure, int errcode)
438{
439    tr_peerIo *io = (tr_peerIo *)closure;
440    assert( tr_isPeerIo( io ) );
441
442    if( io->gotError ) {
443        errno = errcode;
444        io->gotError( io, BEV_EVENT_ERROR, io->userData );
445    }
446}
447
448static void
449utp_on_overhead(void *closure, bool send, size_t count, int type)
450{
451    tr_peerIo *io = (tr_peerIo *)closure;
452    assert( tr_isPeerIo( io ) );
453
454    tr_bandwidthUsed( &io->bandwidth, send ? TR_UP : TR_DOWN,
455                      count, FALSE, tr_time_msec() );
456}
457
458static struct UTPFunctionTable utp_function_table = {
459    .on_read = utp_on_read,
460    .on_write = utp_on_write,
461    .get_rb_size = utp_get_rb_size,
462    .on_state = utp_on_state_change,
463    .on_error = utp_on_error,
464    .on_overhead = utp_on_overhead
465};
466
467/* Dummy UTP callbacks. */
468/* We switch a UTP socket to use these after the associated peerIo has been
469   destroyed -- see io_dtor. */
470
471static void
472dummy_read( void * closure UNUSED, const unsigned char *buf UNUSED, size_t buflen UNUSED )
473{
474    /* This cannot happen, as far as I'm aware. */
475    tr_nerr( "UTP", "On_read called on closed socket" );
476
477}
478
479static void
480dummy_write(void * closure UNUSED, unsigned char *buf, size_t buflen)
481{
482    /* This can very well happen if we've shut down a peer connection that
483       had unflushed buffers.  Complain and send zeroes. */
484    tr_ndbg( "UTP", "On_write called on closed socket" );
485    memset( buf, 0, buflen );
486}
487
488static size_t
489dummy_get_rb_size( void * closure UNUSED )
490{
491    return 0;
492}
493
494static void
495dummy_on_state_change(void * closure UNUSED, int state UNUSED )
496{
497    return;
498}
499
500static void
501dummy_on_error( void * closure UNUSED, int errcode UNUSED )
502{
503    return;
504}
505
506static void
507dummy_on_overhead( void *closure UNUSED, bool send UNUSED, size_t count UNUSED, int type UNUSED )
508{
509    return;
510}
511
512static struct UTPFunctionTable dummy_utp_function_table = {
513    .on_read = dummy_read,
514    .on_write = dummy_write,
515    .get_rb_size = dummy_get_rb_size,
516    .on_state = dummy_on_state_change,
517    .on_error = dummy_on_error,
518    .on_overhead = dummy_on_overhead
519};
520
521static tr_peerIo*
522tr_peerIoNew( tr_session       * session,
523              tr_bandwidth     * parent,
524              const tr_address * addr,
525              tr_port            port,
526              const uint8_t    * torrentHash,
527              tr_bool            isIncoming,
528              tr_bool            isSeed,
529              int                socket,
530              struct UTPSocket * utp_socket)
531{
532    tr_peerIo * io;
533
534    assert( session != NULL );
535    assert( session->events != NULL );
536    assert( tr_isBool( isIncoming ) );
537    assert( tr_isBool( isSeed ) );
538    assert( tr_amInEventThread( session ) );
539    assert( (socket < 0) == (utp_socket != NULL) );
540
541    if( socket >= 0 ) {
542        tr_netSetTOS( socket, session->peerSocketTOS );
543        maybeSetCongestionAlgorithm( socket, session->peer_congestion_algorithm );
544    }
545
546    io = tr_new0( tr_peerIo, 1 );
547    io->magicNumber = MAGIC_NUMBER;
548    io->refCount = 1;
549    io->crypto = tr_cryptoNew( torrentHash, isIncoming );
550    io->session = session;
551    io->addr = *addr;
552    io->isSeed = isSeed;
553    io->port = port;
554    io->socket = socket;
555    io->utp_socket = utp_socket;
556    io->isIncoming = isIncoming != 0;
557    io->timeCreated = tr_time( );
558    io->inbuf = evbuffer_new( );
559    io->outbuf = evbuffer_new( );
560    tr_bandwidthConstruct( &io->bandwidth, session, parent );
561    tr_bandwidthSetPeer( &io->bandwidth, io );
562    dbgmsg( io, "bandwidth is %p; its parent is %p", &io->bandwidth, parent );
563
564    if( io->socket >= 0 ) {
565        io->event_read = event_new( session->event_base,
566                                    io->socket, EV_READ, event_read_cb, io );
567        io->event_write = event_new( session->event_base,
568                                     io->socket, EV_WRITE, event_write_cb, io );
569    } else {
570        tr_ndbg( "UTP", "New %s connection",
571                 isIncoming ? "incoming" : "outgoing" );
572        UTP_SetSockopt( utp_socket, SO_RCVBUF, UTP_READ_BUFFER_SIZE );
573        UTP_SetCallbacks( utp_socket,
574                          &utp_function_table,
575                          io );
576        if( !isIncoming )
577            UTP_Connect( utp_socket );
578    }
579
580    return io;
581}
582
583tr_peerIo*
584tr_peerIoNewIncoming( tr_session        * session,
585                      tr_bandwidth      * parent,
586                      const tr_address  * addr,
587                      tr_port             port,
588                      int                 fd,
589                      struct UTPSocket  * utp_socket )
590{
591    assert( session );
592    assert( tr_isAddress( addr ) );
593
594    return tr_peerIoNew( session, parent, addr, port, NULL, TRUE, FALSE, 
595                         fd, utp_socket );
596}
597
598tr_peerIo*
599tr_peerIoNewOutgoing( tr_session        * session,
600                      tr_bandwidth      * parent,
601                      const tr_address  * addr,
602                      tr_port             port,
603                      const uint8_t     * torrentHash,
604                      tr_bool             isSeed,
605                      tr_bool             utp )
606{
607    int fd = -1;
608    struct UTPSocket *utp_socket = NULL;
609
610    assert( session );
611    assert( tr_isAddress( addr ) );
612    assert( torrentHash );
613
614    if( !utp ) {
615        fd = tr_netOpenPeerSocket( session, addr, port, isSeed );
616        dbgmsg( NULL, "tr_netOpenPeerSocket returned fd %d", fd );
617    } else {
618        utp_socket =
619            tr_netOpenPeerUTPSocket( session, addr, port, isSeed );
620    }
621
622    if( fd < 0 && utp_socket == NULL )
623        return NULL;
624
625    return tr_peerIoNew( session, parent, addr, port,
626                         torrentHash, FALSE, isSeed, fd, utp_socket );
627}
628
629/***
630****
631***/
632
633static void
634event_enable( tr_peerIo * io, short event )
635{
636    assert( tr_amInEventThread( io->session ) );
637    assert( io->session != NULL );
638    assert( io->session->events != NULL );
639
640    if( io->socket < 0 )
641        return;
642
643    assert( io->session->events != NULL );
644    assert( event_initialized( io->event_read ) );
645    assert( event_initialized( io->event_write ) );
646
647    if( ( event & EV_READ ) && ! ( io->pendingEvents & EV_READ ) )
648    {
649        dbgmsg( io, "enabling libevent ready-to-read polling" );
650        event_add( io->event_read, NULL );
651        io->pendingEvents |= EV_READ;
652    }
653
654    if( ( event & EV_WRITE ) && ! ( io->pendingEvents & EV_WRITE ) )
655    {
656        dbgmsg( io, "enabling libevent ready-to-write polling" );
657        event_add( io->event_write, NULL );
658        io->pendingEvents |= EV_WRITE;
659    }
660}
661
662static void
663event_disable( struct tr_peerIo * io, short event )
664{
665    assert( tr_amInEventThread( io->session ) );
666    assert( io->session != NULL );
667
668    if( io->socket < 0 )
669        return;
670
671    assert( io->session->events != NULL );
672    assert( event_initialized( io->event_read ) );
673    assert( event_initialized( io->event_write ) );
674
675    if( ( event & EV_READ ) && ( io->pendingEvents & EV_READ ) )
676    {
677        dbgmsg( io, "disabling libevent ready-to-read polling" );
678        event_del( io->event_read );
679        io->pendingEvents &= ~EV_READ;
680    }
681
682    if( ( event & EV_WRITE ) && ( io->pendingEvents & EV_WRITE ) )
683    {
684        dbgmsg( io, "disabling libevent ready-to-write polling" );
685        event_del( io->event_write );
686        io->pendingEvents &= ~EV_WRITE;
687    }
688}
689
690void
691tr_peerIoSetEnabled( tr_peerIo    * io,
692                     tr_direction   dir,
693                     tr_bool        isEnabled )
694{
695    const short event = dir == TR_UP ? EV_WRITE : EV_READ;
696
697    assert( tr_isPeerIo( io ) );
698    assert( tr_isDirection( dir ) );
699    assert( tr_amInEventThread( io->session ) );
700    assert( io->session->events != NULL );
701
702    if( isEnabled )
703        event_enable( io, event );
704    else
705        event_disable( io, event );
706}
707
708/***
709****
710***/
711
712static void
713io_dtor( void * vio )
714{
715    tr_peerIo * io = vio;
716
717    assert( tr_isPeerIo( io ) );
718    assert( tr_amInEventThread( io->session ) );
719    assert( io->session->events != NULL );
720
721    dbgmsg( io, "in tr_peerIo destructor" );
722    event_disable( io, EV_READ | EV_WRITE );
723    tr_bandwidthDestruct( &io->bandwidth );
724    evbuffer_free( io->outbuf );
725    evbuffer_free( io->inbuf );
726    if( io->socket >= 0 ) {
727        event_free( io->event_read );
728        event_free( io->event_write );
729        tr_netClose( io->session, io->socket );
730    }
731    if( io->utp_socket != NULL ) {
732        tr_ndbg( "UTP", "Destroying connection");
733        UTP_SetCallbacks( io->utp_socket,
734                          &dummy_utp_function_table,
735                          NULL );
736        UTP_Close( io->utp_socket );
737    }
738    tr_cryptoFree( io->crypto );
739    tr_list_free( &io->outbuf_datatypes, tr_free );
740
741    memset( io, ~0, sizeof( tr_peerIo ) );
742    tr_free( io );
743}
744
745static void
746tr_peerIoFree( tr_peerIo * io )
747{
748    if( io )
749    {
750        dbgmsg( io, "in tr_peerIoFree" );
751        io->canRead = NULL;
752        io->didWrite = NULL;
753        io->gotError = NULL;
754        tr_runInEventThread( io->session, io_dtor, io );
755    }
756}
757
758void
759tr_peerIoRefImpl( const char * file, int line, tr_peerIo * io )
760{
761    assert( tr_isPeerIo( io ) );
762
763    dbgmsg( io, "%s:%d is incrementing the IO's refcount from %d to %d",
764                file, line, io->refCount, io->refCount+1 );
765
766    ++io->refCount;
767}
768
769void
770tr_peerIoUnrefImpl( const char * file, int line, tr_peerIo * io )
771{
772    assert( tr_isPeerIo( io ) );
773
774    dbgmsg( io, "%s:%d is decrementing the IO's refcount from %d to %d",
775                file, line, io->refCount, io->refCount-1 );
776
777    if( !--io->refCount )
778        tr_peerIoFree( io );
779}
780
781const tr_address*
782tr_peerIoGetAddress( const tr_peerIo * io, tr_port   * port )
783{
784    assert( tr_isPeerIo( io ) );
785
786    if( port )
787        *port = io->port;
788
789    return &io->addr;
790}
791
792const char*
793tr_peerIoAddrStr( const tr_address * addr, tr_port port )
794{
795    static char buf[512];
796
797    if( addr->type == TR_AF_INET )
798        tr_snprintf( buf, sizeof( buf ), "%s:%u", tr_ntop_non_ts( addr ), ntohs( port ) );
799    else
800        tr_snprintf( buf, sizeof( buf ), "[%s]:%u", tr_ntop_non_ts( addr ), ntohs( port ) );
801    return buf;
802}
803
804const char* tr_peerIoGetAddrStr( const tr_peerIo * io )
805{
806    return tr_isPeerIo( io ) ? tr_peerIoAddrStr( &io->addr, io->port ) : "error";
807}
808
809void
810tr_peerIoSetIOFuncs( tr_peerIo        * io,
811                     tr_can_read_cb     readcb,
812                     tr_did_write_cb    writecb,
813                     tr_net_error_cb    errcb,
814                     void             * userData )
815{
816    io->canRead = readcb;
817    io->didWrite = writecb;
818    io->gotError = errcb;
819    io->userData = userData;
820}
821
822void
823tr_peerIoClear( tr_peerIo * io )
824{
825    tr_peerIoSetIOFuncs( io, NULL, NULL, NULL, NULL );
826    tr_peerIoSetEnabled( io, TR_UP, FALSE );
827    tr_peerIoSetEnabled( io, TR_DOWN, FALSE );
828}
829
830int
831tr_peerIoReconnect( tr_peerIo * io )
832{
833    short int pendingEvents;
834    tr_session * session;
835
836    assert( tr_isPeerIo( io ) );
837    assert( !tr_peerIoIsIncoming( io ) );
838
839    session = tr_peerIoGetSession( io );
840
841    pendingEvents = io->pendingEvents;
842    event_disable( io, EV_READ | EV_WRITE );
843
844    if( io->socket >= 0 ) {
845        tr_netClose( session, io->socket );
846        io->socket = -1;
847        event_free( io->event_read );
848        event_free( io->event_write );
849    }
850    if( io->utp_socket != NULL ) {
851        UTP_SetCallbacks( io->utp_socket,
852                          &dummy_utp_function_table,
853                          NULL );
854        UTP_Close(io->utp_socket);
855        io->utp_socket = NULL;
856    }
857
858    io->socket = tr_netOpenPeerSocket( session, &io->addr, io->port, io->isSeed );
859    io->event_read = event_new( session->event_base, io->socket, EV_READ, event_read_cb, io );
860    io->event_write = event_new( session->event_base, io->socket, EV_WRITE, event_write_cb, io );
861
862    if( io->socket >= 0 )
863    {
864        event_enable( io, pendingEvents );
865        tr_netSetTOS( io->socket, session->peerSocketTOS );
866        maybeSetCongestionAlgorithm( io->socket, session->peer_congestion_algorithm );
867        return 0;
868    }
869
870    return -1;
871}
872
873/**
874***
875**/
876
877void
878tr_peerIoSetTorrentHash( tr_peerIo *     io,
879                         const uint8_t * hash )
880{
881    assert( tr_isPeerIo( io ) );
882
883    tr_cryptoSetTorrentHash( io->crypto, hash );
884}
885
886const uint8_t*
887tr_peerIoGetTorrentHash( tr_peerIo * io )
888{
889    assert( tr_isPeerIo( io ) );
890    assert( io->crypto );
891
892    return tr_cryptoGetTorrentHash( io->crypto );
893}
894
895int
896tr_peerIoHasTorrentHash( const tr_peerIo * io )
897{
898    assert( tr_isPeerIo( io ) );
899    assert( io->crypto );
900
901    return tr_cryptoHasTorrentHash( io->crypto );
902}
903
904/**
905***
906**/
907
908void
909tr_peerIoSetPeersId( tr_peerIo *     io,
910                     const uint8_t * peer_id )
911{
912    assert( tr_isPeerIo( io ) );
913
914    if( ( io->peerIdIsSet = peer_id != NULL ) )
915        memcpy( io->peerId, peer_id, 20 );
916    else
917        memset( io->peerId, 0, 20 );
918}
919
920/**
921***
922**/
923
924static unsigned int
925getDesiredOutputBufferSize( const tr_peerIo * io, uint64_t now )
926{
927    /* this is all kind of arbitrary, but what seems to work well is
928     * being large enough to hold the next 20 seconds' worth of input,
929     * or a few blocks, whichever is bigger.
930     * It's okay to tweak this as needed */
931    const unsigned int currentSpeed_Bps = tr_bandwidthGetPieceSpeed_Bps( &io->bandwidth, now, TR_UP );
932    const unsigned int period = 15u; /* arbitrary */
933    /* the 3 is arbitrary; the .5 is to leave room for messages */
934    static const unsigned int ceiling =  (unsigned int)( MAX_BLOCK_SIZE * 3.5 );
935    return MAX( ceiling, currentSpeed_Bps*period );
936}
937
938size_t
939tr_peerIoGetWriteBufferSpace( const tr_peerIo * io, uint64_t now )
940{
941    const size_t desiredLen = getDesiredOutputBufferSize( io, now );
942    const size_t currentLen = evbuffer_get_length( io->outbuf );
943    size_t freeSpace = 0;
944
945    if( desiredLen > currentLen )
946        freeSpace = desiredLen - currentLen;
947
948    return freeSpace;
949}
950
951/**
952***
953**/
954
955void
956tr_peerIoSetEncryption( tr_peerIo * io, uint32_t encryptionMode )
957{
958    assert( tr_isPeerIo( io ) );
959    assert( encryptionMode == PEER_ENCRYPTION_NONE
960         || encryptionMode == PEER_ENCRYPTION_RC4 );
961
962    io->encryptionMode = encryptionMode;
963}
964
965/**
966***
967**/
968
969static void
970addDatatype( tr_peerIo * io, size_t byteCount, tr_bool isPieceData )
971{
972    struct tr_datatype * d;
973
974    d = tr_new( struct tr_datatype, 1 );
975    d->isPieceData = isPieceData != 0;
976    d->length = byteCount;
977    tr_list_append( &io->outbuf_datatypes, d );
978}
979
980static struct evbuffer_iovec *
981evbuffer_peek_all( struct evbuffer * buf, size_t * setme_vecCount )
982{
983    const size_t byteCount = evbuffer_get_length( buf );
984    const int vecCount = evbuffer_peek( buf, byteCount, NULL, NULL, 0 );
985    struct evbuffer_iovec * iovec = tr_new0( struct evbuffer_iovec, vecCount );
986    const int n = evbuffer_peek( buf, byteCount, NULL, iovec, vecCount );
987    assert( n == vecCount );
988    *setme_vecCount = n;
989    return iovec;
990}
991
992static void
993maybeEncryptBuffer( tr_peerIo * io, struct evbuffer * buf )
994{
995    if( io->encryptionMode == PEER_ENCRYPTION_RC4 )
996    {
997        size_t i, n;
998        struct evbuffer_iovec * iovec = evbuffer_peek_all( buf, &n );
999
1000        for( i=0; i<n; ++i )
1001            tr_cryptoEncrypt( io->crypto, iovec[i].iov_len, iovec[i].iov_base, iovec[i].iov_base );
1002
1003        tr_free( iovec );
1004    }
1005}
1006
1007void
1008tr_peerIoWriteBuf( tr_peerIo * io, struct evbuffer * buf, tr_bool isPieceData )
1009{
1010    const size_t byteCount = evbuffer_get_length( buf );
1011    maybeEncryptBuffer( io, buf );
1012    evbuffer_add_buffer( io->outbuf, buf );
1013    addDatatype( io, byteCount, isPieceData );
1014    if( io->utp_socket )
1015        UTP_Write( io->utp_socket, byteCount );
1016}
1017
1018void
1019tr_peerIoWriteBytes( tr_peerIo * io, const void * bytes, size_t byteCount, tr_bool isPieceData )
1020{
1021    struct evbuffer * buf = evbuffer_new( );
1022    evbuffer_add( buf, bytes, byteCount );
1023    tr_peerIoWriteBuf( io, buf, isPieceData );
1024    evbuffer_free( buf );
1025}
1026
1027/***
1028****
1029***/
1030
1031void
1032evbuffer_add_uint8( struct evbuffer * outbuf, uint8_t byte )
1033{
1034    evbuffer_add( outbuf, &byte, 1 );
1035}
1036
1037void
1038evbuffer_add_uint16( struct evbuffer * outbuf, uint16_t addme_hs )
1039{
1040    const uint16_t ns = htons( addme_hs );
1041    evbuffer_add( outbuf, &ns, sizeof( ns ) );
1042}
1043
1044void
1045evbuffer_add_uint32( struct evbuffer * outbuf, uint32_t addme_hl )
1046{
1047    const uint32_t nl = htonl( addme_hl );
1048    evbuffer_add( outbuf, &nl, sizeof( nl ) );
1049}
1050
1051/***
1052****
1053***/
1054
1055void
1056tr_peerIoReadBytes( tr_peerIo * io, struct evbuffer * inbuf, void * bytes, size_t byteCount )
1057{
1058    assert( tr_isPeerIo( io ) );
1059    assert( evbuffer_get_length( inbuf )  >= byteCount );
1060
1061    switch( io->encryptionMode )
1062    {
1063        case PEER_ENCRYPTION_NONE:
1064            evbuffer_remove( inbuf, bytes, byteCount );
1065            break;
1066
1067        case PEER_ENCRYPTION_RC4:
1068            evbuffer_remove( inbuf, bytes, byteCount );
1069            tr_cryptoDecrypt( io->crypto, byteCount, bytes, bytes );
1070            break;
1071
1072        default:
1073            assert( 0 );
1074    }
1075}
1076
1077void
1078tr_peerIoReadUint16( tr_peerIo        * io,
1079                     struct evbuffer  * inbuf,
1080                     uint16_t         * setme )
1081{
1082    uint16_t tmp;
1083    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint16_t ) );
1084    *setme = ntohs( tmp );
1085}
1086
1087void tr_peerIoReadUint32( tr_peerIo        * io,
1088                          struct evbuffer  * inbuf,
1089                          uint32_t         * setme )
1090{
1091    uint32_t tmp;
1092    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint32_t ) );
1093    *setme = ntohl( tmp );
1094}
1095
1096void
1097tr_peerIoDrain( tr_peerIo       * io,
1098                struct evbuffer * inbuf,
1099                size_t            byteCount )
1100{
1101    void * buf = tr_sessionGetBuffer( io->session );
1102    const size_t buflen = SESSION_BUFFER_SIZE;
1103
1104    while( byteCount > 0 )
1105    {
1106        const size_t thisPass = MIN( byteCount, buflen );
1107        tr_peerIoReadBytes( io, inbuf, buf, thisPass );
1108        byteCount -= thisPass;
1109    }
1110
1111    tr_sessionReleaseBuffer( io->session );
1112}
1113
1114/***
1115****
1116***/
1117
1118static int
1119tr_peerIoTryRead( tr_peerIo * io, size_t howmuch )
1120{
1121    int res = 0;
1122
1123    if(( howmuch = tr_bandwidthClamp( &io->bandwidth, TR_DOWN, howmuch )))
1124    {
1125        int e;
1126
1127        EVUTIL_SET_SOCKET_ERROR( 0 );
1128        res = evbuffer_read( io->inbuf, io->socket, (int)howmuch );
1129        e = EVUTIL_SOCKET_ERROR( );
1130
1131        dbgmsg( io, "read %d from peer (%s)", res, (res==-1?strerror(e):"") );
1132
1133        if( evbuffer_get_length( io->inbuf ) )
1134            canReadWrapper( io );
1135
1136        if( ( res <= 0 ) && ( io->gotError ) && ( e != EAGAIN ) && ( e != EINTR ) && ( e != EINPROGRESS ) )
1137        {
1138            char errstr[512];
1139            short what = BEV_EVENT_READING | BEV_EVENT_ERROR;
1140            if( res == 0 )
1141                what |= BEV_EVENT_EOF;
1142            tr_net_strerror( errstr, sizeof( errstr ), e );
1143            dbgmsg( io, "tr_peerIoTryRead got an error. res is %d, what is %hd, errno is %d (%s)", res, what, e, errstr );
1144            io->gotError( io, what, io->userData );
1145        }
1146    }
1147
1148    return res;
1149}
1150
1151static int
1152tr_peerIoTryWrite( tr_peerIo * io, size_t howmuch )
1153{
1154    int n = 0;
1155
1156    if(( howmuch = tr_bandwidthClamp( &io->bandwidth, TR_UP, howmuch )))
1157    {
1158        int e;
1159        EVUTIL_SET_SOCKET_ERROR( 0 );
1160        n = tr_evbuffer_write( io, io->socket, howmuch );
1161        e = EVUTIL_SOCKET_ERROR( );
1162
1163        if( n > 0 )
1164            didWriteWrapper( io, n );
1165
1166        if( ( n < 0 ) && ( io->gotError ) && e && ( e != EPIPE ) && ( e != EAGAIN ) && ( e != EINTR ) && ( e != EINPROGRESS ) )
1167        {
1168            char errstr[512];
1169            const short what = BEV_EVENT_WRITING | BEV_EVENT_ERROR;
1170
1171            tr_net_strerror( errstr, sizeof( errstr ), e );
1172            dbgmsg( io, "tr_peerIoTryWrite got an error. res is %d, what is %hd, errno is %d (%s)", n, what, e, errstr );
1173
1174            if( io->gotError != NULL )
1175                io->gotError( io, what, io->userData );
1176        }
1177    }
1178
1179    return n;
1180}
1181
1182int
1183tr_peerIoFlush( tr_peerIo  * io, tr_direction dir, size_t limit )
1184{
1185    int bytesUsed = 0;
1186
1187    assert( tr_isPeerIo( io ) );
1188    assert( tr_isDirection( dir ) );
1189
1190    if( dir == TR_DOWN )
1191        bytesUsed = tr_peerIoTryRead( io, limit );
1192    else
1193        bytesUsed = tr_peerIoTryWrite( io, limit );
1194
1195    dbgmsg( io, "flushing peer-io, direction %d, limit %zu, bytesUsed %d", (int)dir, limit, bytesUsed );
1196    return bytesUsed;
1197}
1198
1199int
1200tr_peerIoFlushOutgoingProtocolMsgs( tr_peerIo * io )
1201{
1202    size_t byteCount = 0;
1203    tr_list * it;
1204
1205    /* count up how many bytes are used by non-piece-data messages
1206       at the front of our outbound queue */
1207    for( it=io->outbuf_datatypes; it!=NULL; it=it->next )
1208    {
1209        struct tr_datatype * d = it->data;
1210
1211        if( d->isPieceData )
1212            break;
1213
1214        byteCount += d->length;
1215    }
1216
1217    return tr_peerIoFlush( io, TR_UP, byteCount );
1218}
Note: See TracBrowser for help on using the repository browser.