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

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

Remove debugging messages.

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