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

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

implement bandwidth limiting for uploads to uTP peers

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