source: trunk/libtransmission/torrent.h @ 9540

Last change on this file since 9540 was 9540, checked in by livings124, 12 years ago

a couple of more swarm speed removals

  • Property svn:keywords set to Date Rev Author Id
File size: 12.1 KB
Line 
1/*
2 * This file Copyright (C) 2009 Charles Kerr <charles@transmissionbt.com>
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: torrent.h 9540 2009-11-22 01:12:44Z livings124 $
11 */
12
13#ifndef __TRANSMISSION__
14 #error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_TORRENT_H
18#define TR_TORRENT_H 1
19
20#include "completion.h" /* tr_completion */
21#include "ratecontrol.h" /* tr_ratecontrol */
22#include "session.h" /* tr_globalLock(), tr_globalUnlock() */
23#include "utils.h" /* TR_GNUC_PRINTF */
24
25struct tr_bandwidth;
26struct tr_ratecontrol;
27struct tr_torrent_tiers;
28
29/**
30***  Package-visible ctor API
31**/
32
33void        tr_ctorSetSave( tr_ctor * ctor,
34                            tr_bool   saveMetadataInOurTorrentsDir );
35
36int         tr_ctorGetSave( const tr_ctor * ctor );
37
38void        tr_ctorInitTorrentPriorities( const tr_ctor * ctor, tr_torrent * tor );
39
40void        tr_ctorInitTorrentWanted( const tr_ctor * ctor, tr_torrent * tor );
41
42/**
43***
44**/
45
46/* just like tr_torrentSetFileDLs but doesn't trigger a fastresume save */
47void        tr_torrentInitFileDLs( tr_torrent *      tor,
48                                   tr_file_index_t * files,
49                                   tr_file_index_t   fileCount,
50                                   tr_bool           do_download );
51
52void        tr_torrentRecheckCompleteness( tr_torrent * );
53
54void        tr_torrentSetHasPiece( tr_torrent *     tor,
55                                   tr_piece_index_t pieceIndex,
56                                   tr_bool          has );
57
58void        tr_torrentChangeMyPort( tr_torrent * session );
59
60tr_torrent* tr_torrentFindFromHashString( tr_session * session,
61                                          const char * hashString );
62
63tr_torrent* tr_torrentFindFromObfuscatedHash( tr_session    * session,
64                                              const uint8_t * hash );
65
66tr_bool     tr_torrentIsPieceTransferAllowed( const tr_torrent * torrent,
67                                              tr_direction       direction );
68
69
70
71#define tr_block( a, b ) _tr_block( tor, a, b )
72tr_block_index_t _tr_block( const tr_torrent * tor,
73                            tr_piece_index_t   index,
74                            uint32_t           offset );
75
76tr_bool          tr_torrentReqIsValid( const tr_torrent * tor,
77                                       tr_piece_index_t   index,
78                                       uint32_t           offset,
79                                       uint32_t           length );
80
81uint64_t         tr_pieceOffset( const tr_torrent * tor,
82                                 tr_piece_index_t   index,
83                                 uint32_t           offset,
84                                 uint32_t           length );
85
86void             tr_torrentInitFilePriority( tr_torrent       * tor,
87                                             tr_file_index_t    fileIndex,
88                                             tr_priority_t      priority );
89
90int              tr_torrentCountUncheckedPieces( const tr_torrent * );
91
92tr_bool          tr_torrentIsFileChecked( const tr_torrent  * tor,
93                                          tr_file_index_t     file );
94
95void             tr_torrentSetPieceChecked( tr_torrent       * tor,
96                                            tr_piece_index_t   piece,
97                                            tr_bool            isChecked );
98
99void             tr_torrentSetFileChecked( tr_torrent       * tor,
100                                           tr_file_index_t    file,
101                                           tr_bool            isChecked );
102
103void             tr_torrentUncheck( tr_torrent * tor );
104
105int              tr_torrentPromoteTracker( tr_torrent   * tor,
106                                           int            trackerIndex );
107
108time_t*          tr_torrentGetMTimes( const tr_torrent  * tor,
109                                      size_t            * setmeCount );
110
111tr_torrent*      tr_torrentNext( tr_session  * session,
112                                 tr_torrent  * current );
113
114void             tr_torrentCheckSeedRatio( tr_torrent * tor );
115
116/** save a torrent's .resume file if it's changed since the last time it was saved */
117void             tr_torrentSave( tr_torrent * tor );
118
119void             tr_torrentSetLocalError( tr_torrent * tor, const char * fmt, ... ) TR_GNUC_PRINTF( 2, 3 );
120
121
122
123typedef enum
124{
125    TR_VERIFY_NONE,
126    TR_VERIFY_WAIT,
127    TR_VERIFY_NOW
128}
129tr_verify_state;
130
131void             tr_torrentSetVerifyState( tr_torrent      * tor,
132                                           tr_verify_state   state );
133
134struct tr_torrent
135{
136    tr_session *             session;
137    tr_info                  info;
138
139    int                      magicNumber;
140
141    tr_stat_errtype          error;
142    char                     errorString[128];
143
144    uint8_t                  obfuscatedHash[SHA_DIGEST_LENGTH];
145
146    /* If the initiator of the connection receives a handshake in which the
147     * peer_id does not match the expected peerid, then the initiator is
148     * expected to drop the connection. Note that the initiator presumably
149     * received the peer information from the tracker, which includes the
150     * peer_id that was registered by the peer. The peer_id from the tracker
151     * and in the handshake are expected to match.
152     */
153    uint8_t * peer_id;
154
155    /* Where the files will be when it's complete */
156    char * downloadDir;
157
158    /* Where the files are when the torrent is incomplete */
159    char * incompleteDir;
160
161    /* Where the files are now.
162     * This pointer will be equal to downloadDir or incompleteDir */
163    const char * currentDir;
164
165    /* How many bytes we ask for per request */
166    uint32_t                   blockSize;
167    tr_block_index_t           blockCount;
168
169    uint32_t                   lastBlockSize;
170    uint32_t                   lastPieceSize;
171
172    uint32_t                   blockCountInPiece;
173    uint32_t                   blockCountInLastPiece;
174
175    struct tr_completion       completion;
176
177    struct tr_bitfield         checkedPieces;
178    tr_completeness            completeness;
179
180    struct tr_torrent_tiers  * tiers;
181    struct tr_publisher_tag  * tiersSubscription;
182
183    time_t                     dhtAnnounceAt;
184    tr_bool                    dhtAnnounceInProgress;
185
186    uint64_t                   downloadedCur;
187    uint64_t                   downloadedPrev;
188    uint64_t                   uploadedCur;
189    uint64_t                   uploadedPrev;
190    uint64_t                   corruptCur;
191    uint64_t                   corruptPrev;
192
193    uint64_t                   etaDLSpeedCalculatedAt;
194    double                     etaDLSpeed;
195    uint64_t                   etaULSpeedCalculatedAt;
196    double                     etaULSpeed;
197
198    time_t                     addedDate;
199    time_t                     activityDate;
200    time_t                     doneDate;
201    time_t                     startDate;
202    time_t                     anyDate;
203
204    tr_torrent_completeness_func *   completeness_func;
205    void *                     completeness_func_user_data;
206
207    tr_torrent_ratio_limit_hit_func * ratio_limit_hit_func;
208    void *                     ratio_limit_hit_func_user_data;
209
210    tr_bool                    isRunning;
211    tr_bool                    isDeleting;
212    tr_bool                    needsSeedRatioCheck;
213    tr_bool                    startAfterVerify;
214    tr_bool                    isDirty;
215
216    uint16_t                   maxConnectedPeers;
217
218    tr_verify_state            verifyState;
219
220    time_t                     lastStatTime;
221    tr_stat                    stats;
222
223    tr_torrent *               next;
224
225    int                        uniqueId;
226
227    struct tr_bandwidth      * bandwidth;
228
229    struct tr_torrent_peers  * torrentPeers;
230
231    double                     desiredRatio;
232    tr_ratiolimit              ratioLimitMode;
233
234    uint64_t                   preVerifyTotal;
235};
236
237/* get the index of this piece's first block */
238static TR_INLINE tr_block_index_t
239tr_torPieceFirstBlock( const tr_torrent * tor, const tr_piece_index_t piece )
240{
241    return piece * tor->blockCountInPiece;
242}
243
244/* what piece index is this block in? */
245static TR_INLINE tr_piece_index_t
246tr_torBlockPiece( const tr_torrent * tor, const tr_block_index_t block )
247{
248    return block / tor->blockCountInPiece;
249}
250
251/* how many blocks are in this piece? */
252static TR_INLINE uint32_t
253tr_torPieceCountBlocks( const tr_torrent * tor, const tr_piece_index_t piece )
254{
255    return piece == tor->info.pieceCount - 1 ? tor->blockCountInLastPiece
256                                             : tor->blockCountInPiece;
257}
258
259/* how many bytes are in this piece? */
260static TR_INLINE uint32_t
261tr_torPieceCountBytes( const tr_torrent * tor, const tr_piece_index_t piece )
262{
263    return piece == tor->info.pieceCount - 1 ? tor->lastPieceSize
264                                             : tor->info.pieceSize;
265}
266
267/* how many bytes are in this block? */
268static TR_INLINE uint32_t
269tr_torBlockCountBytes( const tr_torrent * tor, const tr_block_index_t block )
270{
271    return block == tor->blockCount - 1 ? tor->lastBlockSize
272                                        : tor->blockSize;
273}
274
275static TR_INLINE void tr_torrentLock( const tr_torrent * tor )
276{
277    tr_globalLock( tor->session );
278}
279
280static TR_INLINE void tr_torrentUnlock( const tr_torrent * tor )
281{
282    tr_globalUnlock( tor->session );
283}
284
285static TR_INLINE tr_bool
286tr_torrentExists( const tr_session * session, const uint8_t *   torrentHash )
287{
288    return tr_torrentFindFromHash( (tr_session*)session, torrentHash ) != NULL;
289}
290
291static TR_INLINE tr_bool
292tr_torrentIsSeed( const tr_torrent * tor )
293{
294    return tor->completeness != TR_LEECH;
295}
296
297static TR_INLINE tr_bool tr_torrentIsPrivate( const tr_torrent * tor )
298{
299    return ( tor != NULL ) && tor->info.isPrivate;
300}
301
302static TR_INLINE tr_bool tr_torrentAllowsPex( const tr_torrent * tor )
303{
304    return ( tor != NULL )
305        && ( tor->session->isPexEnabled )
306        && ( !tr_torrentIsPrivate( tor ) );
307}
308
309static TR_INLINE tr_bool tr_torrentAllowsDHT( const tr_torrent * tor )
310{
311    return ( tor != NULL )
312        && ( tr_sessionAllowsDHT( tor->session ) )
313        && ( !tr_torrentIsPrivate( tor ) );
314}
315
316static TR_INLINE tr_bool tr_torrentIsPieceChecked( const tr_torrent  * tor,
317                                                   tr_piece_index_t    i )
318{
319    return tr_bitfieldHasFast( &tor->checkedPieces, i );
320}
321
322/***
323****
324***/
325
326enum
327{
328    TORRENT_MAGIC_NUMBER = 95549
329};
330
331static TR_INLINE tr_bool tr_isTorrent( const tr_torrent * tor )
332{
333    return ( tor != NULL )
334        && ( tor->magicNumber == TORRENT_MAGIC_NUMBER )
335        && ( tr_isSession( tor->session ) );
336}
337
338/* set a flag indicating that the torrent's .resume file
339 * needs to be saved when the torrent is closed */
340static TR_INLINE void tr_torrentSetDirty( tr_torrent * tor )
341{
342    assert( tr_isTorrent( tor ) );
343
344    tor->isDirty = TRUE;
345}
346
347static TR_INLINE const char * tr_torrentName( const tr_torrent * tor )
348{
349    assert( tr_isTorrent( tor ) );
350
351    return tor->info.name;
352}
353
354/**
355 * Tell the tr_torrent that one of its files has become complete
356 */
357void tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNo );
358
359
360/**
361 * @brief Like tr_torrentFindFile(), but splits the filename into base and subpath;
362 *
363 * If the file is found, "tr_buildPath( base, subpath, NULL )"
364 * will generate the complete filename.
365 *
366 * @return true if the file is found, false otherwise.
367 *
368 * @param base if the torrent is found, this will be either
369 *             tor->downloadDir or tor->incompleteDir
370 * @param subpath on success, this pointer is assigned a newly-allocated
371 *                string holding the second half of the filename.
372 */
373tr_bool tr_torrentFindFile2( const tr_torrent *, tr_file_index_t fileNo,
374                             const char ** base, char ** subpath );
375
376
377/* Returns a newly-allocated version of the tr_file.name string
378 * that's been modified to denote that it's not a complete file yet.
379 * In the current implementation this is done by appending ".part"
380 * a la Firefox. */
381char* tr_torrentBuildPartial( const tr_torrent *, tr_file_index_t fileNo );
382
383
384#endif
Note: See TracBrowser for help on using the repository browser.