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

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

Add assertions to libevent callbacks.

They should never be called with a UTP socket.

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