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

Last change on this file since 11943 was 11943, checked in by jordan, 11 years ago

call UTP_RBDrained when our read buffer is empty

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