source: trunk/libtransmission/peer-mgr.h @ 11903

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

Modify peer-io to work with UTP sockets.

This is not supposed to work yet -- it just adds new fields to the data
structures to get the UTP code to compile.

  • Property svn:keywords set to Date Rev Author Id
File size: 7.4 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-mgr.h 11903 2011-02-18 00:23:51Z jch $
11 */
12
13#ifndef __TRANSMISSION__
14#error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_PEER_MGR_H
18#define TR_PEER_MGR_H
19
20#include <inttypes.h> /* uint16_t */
21
22#ifdef WIN32
23 #include <winsock2.h> /* struct in_addr */
24#endif
25
26#include "bitfield.h"
27#include "bitset.h"
28#include "history.h"
29#include "net.h"
30#include "peer-common.h" /* struct peer_request */
31
32/**
33 * @addtogroup peers Peers
34 * @{
35 */
36
37struct UTPSocket;
38struct tr_peer_stat;
39struct tr_torrent;
40typedef struct tr_peerMgr tr_peerMgr;
41
42/* added_f's bitwise-or'ed flags */
43enum
44{
45    /* true if the peer supports encryption */
46    ADDED_F_ENCRYPTION_FLAG = 1,
47
48    /* true if the peer is a seed or partial seed */
49    ADDED_F_SEED_FLAG = 2,
50
51    /* true if the peer supports uTP */
52    ADDED_F_UTP_FLAGS = 4,
53
54    /* true if the peer has holepunch support */
55    ADDED_F_HOLEPUNCH = 8,
56
57    /* true if the peer telling us about this peer
58     * initiated the connection (implying that it is connectible) */ 
59   ADDED_F_CONNECTABLE = 16 
60};
61
62typedef struct tr_pex
63{
64    tr_address addr;
65    tr_port    port; /* this field is in network byte order */
66    uint8_t    flags;
67}
68tr_pex;
69
70
71struct tr_bandwidth;
72struct tr_peerIo;
73struct tr_peermsgs;
74
75enum
76{
77    ENCRYPTION_PREFERENCE_UNKNOWN,
78    ENCRYPTION_PREFERENCE_YES,
79    ENCRYPTION_PREFERENCE_NO
80};
81
82/* opaque forward declaration */
83struct peer_atom;
84
85/**
86 * State information about a connected peer.
87 *
88 * @see struct peer_atom
89 * @see tr_peermsgs
90 */
91typedef struct tr_peer
92{
93    tr_bool                  peerIsChoked;
94    tr_bool                  peerIsInterested;
95    tr_bool                  clientIsChoked;
96    tr_bool                  clientIsInterested;
97    tr_bool                  doPurge;
98
99    /* number of bad pieces they've contributed to */
100    uint8_t                  strikes;
101
102    uint8_t                  encryption_preference;
103    tr_port                  dht_port;
104
105    /* how many requests the peer has made that we haven't responded to yet */
106    int                      pendingReqsToClient;
107
108    /* how many requests we've made and are currently awaiting a response for */
109    int                      pendingReqsToPeer;
110
111    struct tr_peerIo       * io;
112    struct peer_atom       * atom;
113
114    struct tr_bitfield     * blame;
115    struct tr_bitset         have;
116
117    /** how complete the peer's copy of the torrent is. [0.0...1.0] */
118    float                    progress;
119
120    /* the client name from the `v' string in LTEP's handshake dictionary */
121    char                   * client;
122
123    time_t                   chokeChangedAt;
124
125    tr_recentHistory       * blocksSentToClient;
126    tr_recentHistory       * blocksSentToPeer;
127
128    tr_recentHistory       * cancelsSentToClient;
129    tr_recentHistory       * cancelsSentToPeer;
130
131    struct tr_peermsgs     * msgs;
132}
133tr_peer;
134
135static inline tr_bool
136tr_isPex( const tr_pex * pex )
137{
138    return pex && tr_isAddress( &pex->addr );
139}
140
141const tr_address * tr_peerAddress( const tr_peer * );
142
143int tr_pexCompare( const void * a, const void * b );
144
145tr_peerMgr* tr_peerMgrNew( tr_session * );
146
147void tr_peerMgrFree( tr_peerMgr * manager );
148
149tr_bool tr_peerMgrPeerIsSeed( const tr_torrent * tor,
150                              const tr_address * addr );
151
152void tr_peerMgrGetNextRequests( tr_torrent          * torrent,
153                                tr_peer             * peer,
154                                int                   numwant,
155                                tr_block_index_t    * setme,
156                                int                 * numgot );
157
158tr_bool tr_peerMgrDidPeerRequest( const tr_torrent  * torrent,
159                                  const tr_peer     * peer,
160                                  tr_block_index_t    block );
161
162void tr_peerMgrRebuildRequests( tr_torrent * torrent );
163
164void tr_peerMgrAddIncoming( tr_peerMgr  * manager,
165                            tr_address  * addr,
166                            tr_port       port,
167                            int           socket,
168                            struct UTPSocket *utp_socket );
169
170tr_pex * tr_peerMgrCompactToPex( const void    * compact,
171                                 size_t          compactLen,
172                                 const uint8_t * added_f,
173                                 size_t          added_f_len,
174                                 size_t        * setme_pex_count );
175
176tr_pex * tr_peerMgrCompact6ToPex( const void    * compact,
177                                  size_t          compactLen,
178                                  const uint8_t * added_f,
179                                  size_t          added_f_len,
180                                  size_t        * pexCount );
181
182tr_pex * tr_peerMgrArrayToPex( const void * array,
183                               size_t       arrayLen,
184                               size_t      * setme_pex_count );
185
186/**
187 * @param seedProbability [0..100] for likelihood that the peer is a seed; -1 for unknown
188 */
189void tr_peerMgrAddPex( tr_torrent     * tor,
190                       uint8_t          from,
191                       const tr_pex   * pex,
192                       int8_t           seedProbability );
193
194void tr_peerMgrMarkAllAsSeeds( tr_torrent * tor );
195
196void tr_peerMgrSetBlame( tr_torrent        * tor,
197                         tr_piece_index_t    pieceIndex,
198                         int                 success );
199
200enum
201{
202    TR_PEERS_CONNECTED,
203    TR_PEERS_ALL
204};
205
206int  tr_peerMgrGetPeers( tr_torrent      * tor,
207                         tr_pex         ** setme_pex,
208                         uint8_t           address_type,
209                         uint8_t           peer_list_mode,
210                         int               max_peer_count );
211
212void tr_peerMgrStartTorrent( tr_torrent * tor );
213
214void tr_peerMgrStopTorrent( tr_torrent * tor );
215
216void tr_peerMgrAddTorrent( tr_peerMgr         * manager,
217                           struct tr_torrent  * tor );
218
219void tr_peerMgrRemoveTorrent( tr_torrent * tor );
220
221void tr_peerMgrTorrentAvailability( const tr_torrent * tor,
222                                    int8_t           * tab,
223                                    unsigned int       tabCount );
224
225struct tr_bitfield* tr_peerMgrGetAvailable( const tr_torrent * tor );
226
227void tr_peerMgrOnBlocklistChanged( tr_peerMgr * manager );
228
229void tr_peerMgrTorrentStats( tr_torrent * tor,
230                             int * setmePeersKnown,
231                             int * setmePeersConnected,
232                             int * setmeSeedsConnected,
233                             int * setmeWebseedsSendingToUs,
234                             int * setmePeersSendingToUs,
235                             int * setmePeersGettingFromUs,
236                             int * setmePeersFrom ); /* TR_PEER_FROM__MAX */
237
238struct tr_peer_stat* tr_peerMgrPeerStats( const tr_torrent * tor,
239                                          int              * setmeCount );
240
241int tr_peerMgrGetWebseedSpeed_Bps( const tr_torrent * tor, uint64_t now );
242
243double* tr_peerMgrWebSpeeds_KBps( const tr_torrent * tor );
244
245
246int tr_peerGetPieceSpeed_Bps( const tr_peer    * peer,
247                              uint64_t           now,
248                              tr_direction       direction );
249
250void tr_peerMgrClearInterest( tr_torrent * tor );
251
252/* @} */
253
254#endif
Note: See TracBrowser for help on using the repository browser.