source: trunk/libtransmission/torrent.h @ 9397

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

smooth out the upload eta the same way as the download eta

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