source: trunk/libtransmission/torrent.h @ 9549

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

(trunk libT) jch's patches 0001 through 0004 for ticket #2576, IPv6 support for DHT (BEP #32)

  • 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 9549 2009-11-24 01:59:51Z charles $
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    time_t                     dhtAnnounce6At;
185    tr_bool                    dhtAnnounceInProgress;
186    tr_bool                    dhtAnnounce6InProgress;
187
188    uint64_t                   downloadedCur;
189    uint64_t                   downloadedPrev;
190    uint64_t                   uploadedCur;
191    uint64_t                   uploadedPrev;
192    uint64_t                   corruptCur;
193    uint64_t                   corruptPrev;
194
195    uint64_t                   etaDLSpeedCalculatedAt;
196    double                     etaDLSpeed;
197    uint64_t                   etaULSpeedCalculatedAt;
198    double                     etaULSpeed;
199
200    time_t                     addedDate;
201    time_t                     activityDate;
202    time_t                     doneDate;
203    time_t                     startDate;
204    time_t                     anyDate;
205
206    tr_torrent_completeness_func *   completeness_func;
207    void *                     completeness_func_user_data;
208
209    tr_torrent_ratio_limit_hit_func * ratio_limit_hit_func;
210    void *                     ratio_limit_hit_func_user_data;
211
212    tr_bool                    isRunning;
213    tr_bool                    isDeleting;
214    tr_bool                    needsSeedRatioCheck;
215    tr_bool                    startAfterVerify;
216    tr_bool                    isDirty;
217
218    uint16_t                   maxConnectedPeers;
219
220    tr_verify_state            verifyState;
221
222    time_t                     lastStatTime;
223    tr_stat                    stats;
224
225    tr_torrent *               next;
226
227    int                        uniqueId;
228
229    struct tr_bandwidth      * bandwidth;
230
231    struct tr_torrent_peers  * torrentPeers;
232
233    double                     desiredRatio;
234    tr_ratiolimit              ratioLimitMode;
235
236    uint64_t                   preVerifyTotal;
237};
238
239/* get the index of this piece's first block */
240static TR_INLINE tr_block_index_t
241tr_torPieceFirstBlock( const tr_torrent * tor, const tr_piece_index_t piece )
242{
243    return piece * tor->blockCountInPiece;
244}
245
246/* what piece index is this block in? */
247static TR_INLINE tr_piece_index_t
248tr_torBlockPiece( const tr_torrent * tor, const tr_block_index_t block )
249{
250    return block / tor->blockCountInPiece;
251}
252
253/* how many blocks are in this piece? */
254static TR_INLINE uint32_t
255tr_torPieceCountBlocks( const tr_torrent * tor, const tr_piece_index_t piece )
256{
257    return piece == tor->info.pieceCount - 1 ? tor->blockCountInLastPiece
258                                             : tor->blockCountInPiece;
259}
260
261/* how many bytes are in this piece? */
262static TR_INLINE uint32_t
263tr_torPieceCountBytes( const tr_torrent * tor, const tr_piece_index_t piece )
264{
265    return piece == tor->info.pieceCount - 1 ? tor->lastPieceSize
266                                             : tor->info.pieceSize;
267}
268
269/* how many bytes are in this block? */
270static TR_INLINE uint32_t
271tr_torBlockCountBytes( const tr_torrent * tor, const tr_block_index_t block )
272{
273    return block == tor->blockCount - 1 ? tor->lastBlockSize
274                                        : tor->blockSize;
275}
276
277static TR_INLINE void tr_torrentLock( const tr_torrent * tor )
278{
279    tr_globalLock( tor->session );
280}
281
282static TR_INLINE void tr_torrentUnlock( const tr_torrent * tor )
283{
284    tr_globalUnlock( tor->session );
285}
286
287static TR_INLINE tr_bool
288tr_torrentExists( const tr_session * session, const uint8_t *   torrentHash )
289{
290    return tr_torrentFindFromHash( (tr_session*)session, torrentHash ) != NULL;
291}
292
293static TR_INLINE tr_bool
294tr_torrentIsSeed( const tr_torrent * tor )
295{
296    return tor->completeness != TR_LEECH;
297}
298
299static TR_INLINE tr_bool tr_torrentIsPrivate( const tr_torrent * tor )
300{
301    return ( tor != NULL ) && tor->info.isPrivate;
302}
303
304static TR_INLINE tr_bool tr_torrentAllowsPex( const tr_torrent * tor )
305{
306    return ( tor != NULL )
307        && ( tor->session->isPexEnabled )
308        && ( !tr_torrentIsPrivate( tor ) );
309}
310
311static TR_INLINE tr_bool tr_torrentAllowsDHT( const tr_torrent * tor )
312{
313    return ( tor != NULL )
314        && ( tr_sessionAllowsDHT( tor->session ) )
315        && ( !tr_torrentIsPrivate( tor ) );
316}
317
318static TR_INLINE tr_bool tr_torrentIsPieceChecked( const tr_torrent  * tor,
319                                                   tr_piece_index_t    i )
320{
321    return tr_bitfieldHasFast( &tor->checkedPieces, i );
322}
323
324/***
325****
326***/
327
328enum
329{
330    TORRENT_MAGIC_NUMBER = 95549
331};
332
333static TR_INLINE tr_bool tr_isTorrent( const tr_torrent * tor )
334{
335    return ( tor != NULL )
336        && ( tor->magicNumber == TORRENT_MAGIC_NUMBER )
337        && ( tr_isSession( tor->session ) );
338}
339
340/* set a flag indicating that the torrent's .resume file
341 * needs to be saved when the torrent is closed */
342static TR_INLINE void tr_torrentSetDirty( tr_torrent * tor )
343{
344    assert( tr_isTorrent( tor ) );
345
346    tor->isDirty = TRUE;
347}
348
349static TR_INLINE const char * tr_torrentName( const tr_torrent * tor )
350{
351    assert( tr_isTorrent( tor ) );
352
353    return tor->info.name;
354}
355
356/**
357 * Tell the tr_torrent that one of its files has become complete
358 */
359void tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNo );
360
361
362/**
363 * @brief Like tr_torrentFindFile(), but splits the filename into base and subpath;
364 *
365 * If the file is found, "tr_buildPath( base, subpath, NULL )"
366 * will generate the complete filename.
367 *
368 * @return true if the file is found, false otherwise.
369 *
370 * @param base if the torrent is found, this will be either
371 *             tor->downloadDir or tor->incompleteDir
372 * @param subpath on success, this pointer is assigned a newly-allocated
373 *                string holding the second half of the filename.
374 */
375tr_bool tr_torrentFindFile2( const tr_torrent *, tr_file_index_t fileNo,
376                             const char ** base, char ** subpath );
377
378
379/* Returns a newly-allocated version of the tr_file.name string
380 * that's been modified to denote that it's not a complete file yet.
381 * In the current implementation this is done by appending ".part"
382 * a la Firefox. */
383char* tr_torrentBuildPartial( const tr_torrent *, tr_file_index_t fileNo );
384
385
386#endif
Note: See TracBrowser for help on using the repository browser.