source: branches/1.9x/libtransmission/peer-io.h @ 10583

Last change on this file since 10583 was 10583, checked in by charles, 12 years ago

(1.9x libT) backport r10524 for #2842 "crashes on ARM-based Synology NAS"

  • Property svn:keywords set to Date Rev Author Id
File size: 11.7 KB
Line 
1/*
2 * This file Copyright (C) 2007-2010 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.h 10583 2010-05-01 04:37:52Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14#error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_PEER_IO_H
18#define TR_PEER_IO_H
19
20/**
21***
22**/
23
24#include <assert.h>
25
26#include <event.h>
27
28#include "transmission.h"
29#include "bandwidth.h"
30#include "list.h" /* tr_list */
31#include "net.h" /* tr_address */
32
33struct evbuffer;
34struct tr_bandwidth;
35struct tr_crypto;
36struct tr_peerIo;
37
38/**
39 * @addtogroup networked_io Networked IO
40 * @{
41 */
42
43typedef enum
44{
45    READ_NOW,
46    READ_LATER,
47    READ_ERR
48}
49ReadState;
50
51typedef ReadState ( *tr_can_read_cb  )( struct tr_peerIo * io,
52                                        void             * user_data,
53                                        size_t           * setme_piece_byte_count );
54
55typedef void      ( *tr_did_write_cb )( struct tr_peerIo * io,
56                                        size_t             bytesWritten,
57                                        int                wasPieceData,
58                                        void             * userData );
59
60typedef void      ( *tr_net_error_cb )( struct tr_peerIo * io,
61                                        short              what,
62                                        void             * userData );
63
64typedef struct tr_peerIo
65{
66    tr_bool               isEncrypted;
67    tr_bool               isIncoming;
68    tr_bool               peerIdIsSet;
69    tr_bool               extendedProtocolSupported;
70    tr_bool               fastExtensionSupported;
71    tr_bool               dhtSupported;
72
73    /* we create the socket in a nonblocking way, so this flag is initially
74     * false and then set to true when libevent says that the socket is ready
75     * for reading or writing */
76    tr_bool               hasFinishedConnecting;
77
78    tr_priority_t         priority;
79
80    int                   pendingEvents;
81
82    int                   magicNumber;
83
84    uint8_t               encryptionMode;
85    tr_bool               isSeed;
86
87    tr_port               port;
88    int                   socket;
89
90    int                   refCount;
91
92    uint8_t               peerId[SHA_DIGEST_LENGTH];
93    time_t                timeCreated;
94
95    tr_session          * session;
96
97    tr_address            addr;
98
99    tr_can_read_cb        canRead;
100    tr_did_write_cb       didWrite;
101    tr_net_error_cb       gotError;
102    void *                userData;
103
104    struct tr_bandwidth   bandwidth;
105    struct tr_crypto    * crypto;
106
107    struct evbuffer     * inbuf;
108    struct evbuffer     * outbuf;
109    struct tr_list      * outbuf_datatypes; /* struct tr_datatype */
110
111    struct event          event_read;
112    struct event          event_write;
113}
114tr_peerIo;
115
116/**
117***
118**/
119
120tr_peerIo*  tr_peerIoNewOutgoing( tr_session              * session,
121                                  struct tr_bandwidth     * parent,
122                                  const struct tr_address * addr,
123                                  tr_port                   port,
124                                  const  uint8_t          * torrentHash,
125                                  tr_bool                   isSeed );
126
127tr_peerIo*  tr_peerIoNewIncoming( tr_session              * session,
128                                  struct tr_bandwidth     * parent,
129                                  const struct tr_address * addr,
130                                  tr_port                   port,
131                                  int                       socket );
132
133void tr_peerIoRefImpl           ( const char              * file,
134                                  int                       line,
135                                  tr_peerIo               * io );
136
137#define tr_peerIoRef(io) tr_peerIoRefImpl( __FILE__, __LINE__, (io) );
138
139void tr_peerIoUnrefImpl         ( const char              * file,
140                                  int                       line,
141                                  tr_peerIo               * io );
142
143#define tr_peerIoUnref(io) tr_peerIoUnrefImpl( __FILE__, __LINE__, (io) );
144
145tr_bool     tr_isPeerIo         ( const tr_peerIo         * io );
146
147
148/**
149***
150**/
151
152void        tr_peerIoEnableLTEP( tr_peerIo * io, tr_bool flag );
153
154static inline tr_bool tr_peerIoSupportsLTEP( const tr_peerIo * io )
155{
156    assert( tr_isPeerIo( io ) );
157
158    return io->extendedProtocolSupported;
159}
160
161void        tr_peerIoEnableFEXT( tr_peerIo * io, tr_bool flag );
162
163static inline tr_bool tr_peerIoSupportsFEXT( const tr_peerIo * io )
164{
165    assert( tr_isPeerIo( io ) );
166
167    return io->fastExtensionSupported;
168}
169
170void        tr_peerIoEnableDHT( tr_peerIo * io, tr_bool flag );
171
172static inline tr_bool tr_peerIoSupportsDHT( const tr_peerIo * io )
173{
174    assert( tr_isPeerIo( io ) );
175
176    return io->dhtSupported;
177}
178
179/**
180***
181**/
182
183static inline tr_session* tr_peerIoGetSession ( tr_peerIo * io )
184{
185    assert( tr_isPeerIo( io ) );
186    assert( io->session );
187
188    return io->session;
189}
190
191const char* tr_peerIoAddrStr( const struct tr_address * addr,
192                              tr_port                   port );
193
194static inline const char* tr_peerIoGetAddrStr( const tr_peerIo * io )
195{
196    return tr_isPeerIo( io ) ? tr_peerIoAddrStr( &io->addr, io->port ) : "error";
197}
198
199const struct tr_address * tr_peerIoGetAddress( const tr_peerIo * io,
200                                               tr_port         * port );
201
202const uint8_t*       tr_peerIoGetTorrentHash( tr_peerIo * io );
203
204int                  tr_peerIoHasTorrentHash( const tr_peerIo * io );
205
206void                 tr_peerIoSetTorrentHash( tr_peerIo *     io,
207                                              const uint8_t * hash );
208
209int                  tr_peerIoReconnect( tr_peerIo * io );
210
211static inline tr_bool tr_peerIoIsIncoming( const tr_peerIo * io )
212{
213    return io->isIncoming;
214}
215
216static inline int    tr_peerIoGetAge( const tr_peerIo * io )
217{
218    return time( NULL ) - io->timeCreated;
219}
220
221
222/**
223***
224**/
225
226void                 tr_peerIoSetPeersId( tr_peerIo *     io,
227                                          const uint8_t * peer_id );
228
229static inline const uint8_t* tr_peerIoGetPeersId( const tr_peerIo * io )
230{
231    assert( tr_isPeerIo( io ) );
232    assert( io->peerIdIsSet );
233
234    return io->peerId;
235}
236
237/**
238***
239**/
240
241void    tr_peerIoSetIOFuncs      ( tr_peerIo        * io,
242                                   tr_can_read_cb     readcb,
243                                   tr_did_write_cb    writecb,
244                                   tr_net_error_cb    errcb,
245                                   void             * user_data );
246
247void    tr_peerIoClear           ( tr_peerIo        * io );
248
249/**
250***
251**/
252
253void    tr_peerIoWrite          ( tr_peerIo         * io,
254                                  const void        * writeme,
255                                  size_t              writemeLen,
256                                  tr_bool             isPieceData );
257
258void    tr_peerIoWriteBuf       ( tr_peerIo         * io,
259                                  struct evbuffer   * buf,
260                                  tr_bool             isPieceData );
261
262/**
263***
264**/
265
266static inline struct tr_crypto * tr_peerIoGetCrypto( tr_peerIo * io )
267{
268    return io->crypto;
269}
270
271typedef enum
272{
273    /* these match the values in MSE's crypto_select */
274    PEER_ENCRYPTION_NONE  = ( 1 << 0 ),
275    PEER_ENCRYPTION_RC4   = ( 1 << 1 )
276}
277EncryptionMode;
278
279void      tr_peerIoSetEncryption( tr_peerIo * io,
280                                  int         encryptionMode );
281
282static inline tr_bool tr_peerIoIsEncrypted( const tr_peerIo * io )
283{
284    return ( io != NULL ) && ( io->encryptionMode == PEER_ENCRYPTION_RC4 );
285}
286
287static inline void tr_peerIoWriteBytes( tr_peerIo        * io UNUSED,
288                                           struct evbuffer  * outbuf,
289                                           const void       * bytes,
290                                           size_t             byteCount )
291{
292    evbuffer_add( outbuf, bytes, byteCount );
293}
294
295static inline void  tr_peerIoWriteUint8( tr_peerIo        * io,
296                                            struct evbuffer  * outbuf,
297                                            uint8_t            writeme )
298{
299    tr_peerIoWriteBytes( io, outbuf, &writeme, sizeof( uint8_t ) );
300}
301
302static inline void tr_peerIoWriteUint16( tr_peerIo        * io,
303                                            struct evbuffer  * outbuf,
304                                            uint16_t           writeme )
305{
306    const uint16_t tmp = htons( writeme );
307    tr_peerIoWriteBytes( io, outbuf, &tmp, sizeof( uint16_t ) );
308}
309
310static inline void tr_peerIoWriteUint32( tr_peerIo        * io,
311                                            struct evbuffer  * outbuf,
312                                            uint32_t           writeme )
313{
314    const uint32_t tmp = htonl( writeme );
315    tr_peerIoWriteBytes( io, outbuf, &tmp, sizeof( uint32_t ) );
316}
317
318void tr_peerIoReadBytes( tr_peerIo        * io,
319                         struct evbuffer  * inbuf,
320                         void             * bytes,
321                         size_t             byteCount );
322
323static inline void tr_peerIoReadUint8( tr_peerIo        * io,
324                                          struct evbuffer  * inbuf,
325                                          uint8_t          * setme )
326{
327    tr_peerIoReadBytes( io, inbuf, setme, sizeof( uint8_t ) );
328}
329
330static inline void tr_peerIoReadUint16( tr_peerIo        * io,
331                                           struct evbuffer  * inbuf,
332                                           uint16_t         * setme )
333{
334    uint16_t tmp;
335    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint16_t ) );
336    *setme = ntohs( tmp );
337}
338
339static inline void tr_peerIoReadUint32( tr_peerIo        * io,
340                                           struct evbuffer  * inbuf,
341                                           uint32_t         * setme )
342{
343    uint32_t tmp;
344    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint32_t ) );
345    *setme = ntohl( tmp );
346}
347
348void      tr_peerIoDrain( tr_peerIo        * io,
349                          struct evbuffer  * inbuf,
350                          size_t             byteCount );
351
352/**
353***
354**/
355
356size_t    tr_peerIoGetWriteBufferSpace( const tr_peerIo * io, uint64_t now );
357
358static inline void tr_peerIoSetParent( tr_peerIo            * io,
359                                          struct tr_bandwidth  * parent )
360{
361    assert( tr_isPeerIo( io ) );
362
363    tr_bandwidthSetParent( &io->bandwidth, parent );
364}
365
366void      tr_peerIoBandwidthUsed( tr_peerIo           * io,
367                                  tr_direction          direction,
368                                  size_t                byteCount,
369                                  int                   isPieceData );
370
371static inline tr_bool tr_peerIoHasBandwidthLeft( const tr_peerIo  * io,
372                                                    tr_direction       dir )
373{
374    assert( tr_isPeerIo( io ) );
375
376    return !io->hasFinishedConnecting
377        || ( tr_bandwidthClamp( &io->bandwidth, dir, 1024 ) > 0 );
378}
379
380static inline double tr_peerIoGetPieceSpeed( const tr_peerIo * io, uint64_t now, tr_direction dir )
381{
382    assert( tr_isPeerIo( io ) );
383    assert( tr_isDirection( dir ) );
384
385    return tr_bandwidthGetPieceSpeed( &io->bandwidth, now, dir );
386}
387
388/**
389***
390**/
391
392void      tr_peerIoSetEnabled( tr_peerIo    * io,
393                               tr_direction   dir,
394                               tr_bool        isEnabled );
395
396int       tr_peerIoFlush( tr_peerIo     * io,
397                          tr_direction    dir,
398                          size_t          byteLimit );
399
400int       tr_peerIoFlushOutgoingProtocolMsgs( tr_peerIo * io );
401
402/**
403***
404**/
405
406static inline struct evbuffer * tr_peerIoGetReadBuffer( tr_peerIo * io )
407{
408    return io->inbuf;
409}
410
411/* @} */
412
413#endif
Note: See TracBrowser for help on using the repository browser.