source: trunk/libtransmission/torrent.h @ 11522

Last change on this file since 11522 was 11522, checked in by charles, 11 years ago

(trunk) one of the periodic, banal "remove-trailing-spaces from lines of source code" cleanup commits

  • Property svn:keywords set to Date Rev Author Id
File size: 13.2 KB
Line 
1/*
2 * This file Copyright (C) 2009-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: torrent.h 11522 2010-12-12 16:43:19Z 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 "session.h" /* tr_sessionLock(), tr_sessionUnlock() */
22#include "utils.h" /* TR_GNUC_PRINTF */
23
24struct tr_bandwidth;
25struct tr_torrent_tiers;
26struct tr_magnet_info;
27
28/**
29***  Package-visible ctor API
30**/
31
32void        tr_ctorSetSave( tr_ctor * ctor,
33                            tr_bool   saveMetadataInOurTorrentsDir );
34
35int         tr_ctorGetSave( const tr_ctor * ctor );
36
37void        tr_ctorInitTorrentPriorities( const tr_ctor * ctor, tr_torrent * tor );
38
39void        tr_ctorInitTorrentWanted( const tr_ctor * ctor, tr_torrent * tor );
40
41/**
42***
43**/
44
45/* just like tr_torrentSetFileDLs but doesn't trigger a fastresume save */
46void        tr_torrentInitFileDLs( tr_torrent              * tor,
47                                   const tr_file_index_t   * files,
48                                   tr_file_index_t          fileCount,
49                                   tr_bool                  do_download );
50
51void        tr_torrentRecheckCompleteness( tr_torrent * );
52
53void        tr_torrentSetHasPiece( tr_torrent *     tor,
54                                   tr_piece_index_t pieceIndex,
55                                   tr_bool          has );
56
57void        tr_torrentChangeMyPort( tr_torrent * session );
58
59tr_torrent* tr_torrentFindFromHashString( tr_session * session,
60                                          const char * hashString );
61
62tr_torrent* tr_torrentFindFromObfuscatedHash( tr_session    * session,
63                                              const uint8_t * hash );
64
65tr_bool     tr_torrentIsPieceTransferAllowed( const tr_torrent * torrent,
66                                              tr_direction       direction );
67
68
69
70#define tr_block( a, b ) _tr_block( tor, a, b )
71tr_block_index_t _tr_block( const tr_torrent * tor,
72                            tr_piece_index_t   index,
73                            uint32_t           offset );
74
75tr_bool          tr_torrentReqIsValid( const tr_torrent * tor,
76                                       tr_piece_index_t   index,
77                                       uint32_t           offset,
78                                       uint32_t           length );
79
80uint64_t         tr_pieceOffset( const tr_torrent * tor,
81                                 tr_piece_index_t   index,
82                                 uint32_t           offset,
83                                 uint32_t           length );
84
85void             tr_torrentInitFilePriority( tr_torrent       * tor,
86                                             tr_file_index_t    fileIndex,
87                                             tr_priority_t      priority );
88
89void             tr_torrentSetPieceChecked( tr_torrent       * tor,
90                                            tr_piece_index_t   piece );
91
92void             tr_torrentSetChecked( tr_torrent * tor, time_t when );
93
94tr_torrent*      tr_torrentNext( tr_session  * session,
95                                 tr_torrent  * current );
96
97void             tr_torrentCheckSeedLimit( tr_torrent * tor );
98
99/** save a torrent's .resume file if it's changed since the last time it was saved */
100void             tr_torrentSave( tr_torrent * tor );
101
102void             tr_torrentSetLocalError( tr_torrent * tor, const char * fmt, ... ) TR_GNUC_PRINTF( 2, 3 );
103
104
105
106typedef enum
107{
108    TR_VERIFY_NONE,
109    TR_VERIFY_WAIT,
110    TR_VERIFY_NOW
111}
112tr_verify_state;
113
114void             tr_torrentSetVerifyState( tr_torrent      * tor,
115                                           tr_verify_state   state );
116
117tr_torrent_activity tr_torrentGetActivity( tr_torrent * tor );
118
119struct tr_incomplete_metadata;
120
121/** @brief Torrent object */
122struct tr_torrent
123{
124    tr_session *             session;
125    tr_info                  info;
126
127    int                      magicNumber;
128
129    tr_stat_errtype          error;
130    char                     errorString[128];
131    char                     errorTracker[128];
132
133    uint8_t                  obfuscatedHash[SHA_DIGEST_LENGTH];
134
135    /* Used when the torrent has been created with a magnet link
136     * and we're in the process of downloading the metainfo from
137     * other peers */
138    struct tr_incomplete_metadata  * incompleteMetadata;
139
140    /* If the initiator of the connection receives a handshake in which the
141     * peer_id does not match the expected peerid, then the initiator is
142     * expected to drop the connection. Note that the initiator presumably
143     * received the peer information from the tracker, which includes the
144     * peer_id that was registered by the peer. The peer_id from the tracker
145     * and in the handshake are expected to match.
146     */
147    uint8_t * peer_id;
148
149    /* Where the files will be when it's complete */
150    char * downloadDir;
151
152    /* Where the files are when the torrent is incomplete */
153    char * incompleteDir;
154
155    /* Length, in bytes, of the "info" dict in the .torrent file. */
156    int infoDictLength;
157
158    /* Offset, in bytes, of the beginning of the "info" dict in the .torrent file.
159     *
160     * Used by the torrent-magnet code for serving metainfo to peers.
161     * This field is lazy-generated and might not be initialized yet. */
162    int infoDictOffset;
163
164    /* Where the files are now.
165     * This pointer will be equal to downloadDir or incompleteDir */
166    const char * currentDir;
167
168    /* How many bytes we ask for per request */
169    uint32_t                   blockSize;
170    tr_block_index_t           blockCount;
171
172    uint32_t                   lastBlockSize;
173    uint32_t                   lastPieceSize;
174
175    uint16_t                   blockCountInPiece;
176    uint16_t                   blockCountInLastPiece;
177
178    struct tr_completion       completion;
179
180    tr_completeness            completeness;
181
182    struct tr_torrent_tiers  * tiers;
183
184    time_t                     dhtAnnounceAt;
185    time_t                     dhtAnnounce6At;
186    tr_bool                    dhtAnnounceInProgress;
187    tr_bool                    dhtAnnounce6InProgress;
188
189    time_t                     lpdAnnounceAt;
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_KBps;
200    uint64_t                   etaULSpeedCalculatedAt;
201    double                     etaULSpeed_KBps;
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_metadata_func  * metadata_func;
210    void                      * metadata_func_user_data;
211
212    tr_torrent_completeness_func  * completeness_func;
213    void                          *  completeness_func_user_data;
214
215    tr_torrent_ratio_limit_hit_func  * ratio_limit_hit_func;
216    void                             * ratio_limit_hit_func_user_data;
217
218    tr_torrent_idle_limit_hit_func  * idle_limit_hit_func;
219    void                            * idle_limit_hit_func_user_data;
220
221    tr_bool                    isRunning;
222    tr_bool                    isStopping;
223    tr_bool                    isDeleting;
224    tr_bool                    startAfterVerify;
225    tr_bool                    isDirty;
226
227    tr_bool                    infoDictOffsetIsCached;
228
229    uint16_t                   maxConnectedPeers;
230
231    tr_verify_state            verifyState;
232
233    time_t                     lastStatTime;
234    tr_stat                    stats;
235
236    tr_torrent *               next;
237
238    int                        uniqueId;
239
240    struct tr_bandwidth      * bandwidth;
241
242    struct tr_torrent_peers  * torrentPeers;
243
244    double                     desiredRatio;
245    tr_ratiolimit              ratioLimitMode;
246
247    uint16_t                   idleLimitMinutes;
248    tr_idlelimit               idleLimitMode;
249    tr_bool                    finishedSeedingByIdle;
250};
251
252/* get the index of this piece's first block */
253static inline tr_block_index_t
254tr_torPieceFirstBlock( const tr_torrent * tor, const tr_piece_index_t piece )
255{
256    return piece * tor->blockCountInPiece;
257}
258
259/* what piece index is this block in? */
260static inline tr_piece_index_t
261tr_torBlockPiece( const tr_torrent * tor, const tr_block_index_t block )
262{
263    return block / tor->blockCountInPiece;
264}
265
266/* how many blocks are in this piece? */
267static inline uint16_t
268tr_torPieceCountBlocks( const tr_torrent * tor, const tr_piece_index_t piece )
269{
270    if( piece + 1 == tor->info.pieceCount )
271        return tor->blockCountInLastPiece;
272    else
273        return tor->blockCountInPiece;
274}
275
276/* how many bytes are in this piece? */
277static inline uint32_t
278tr_torPieceCountBytes( const tr_torrent * tor, const tr_piece_index_t piece )
279{
280    return piece == tor->info.pieceCount - 1 ? tor->lastPieceSize
281                                             : tor->info.pieceSize;
282}
283
284/* how many bytes are in this block? */
285static inline uint32_t
286tr_torBlockCountBytes( const tr_torrent * tor, const tr_block_index_t block )
287{
288    return block == tor->blockCount - 1 ? tor->lastBlockSize
289                                        : tor->blockSize;
290}
291
292static inline void tr_torrentLock( const tr_torrent * tor )
293{
294    tr_sessionLock( tor->session );
295}
296
297static inline void tr_torrentUnlock( const tr_torrent * tor )
298{
299    tr_sessionUnlock( tor->session );
300}
301
302static inline tr_bool
303tr_torrentExists( const tr_session * session, const uint8_t *   torrentHash )
304{
305    return tr_torrentFindFromHash( (tr_session*)session, torrentHash ) != NULL;
306}
307
308static inline tr_bool
309tr_torrentIsSeed( const tr_torrent * tor )
310{
311    return tor->completeness != TR_LEECH;
312}
313
314static inline tr_bool tr_torrentIsPrivate( const tr_torrent * tor )
315{
316    return ( tor != NULL ) && tor->info.isPrivate;
317}
318
319static inline tr_bool tr_torrentAllowsPex( const tr_torrent * tor )
320{
321    return ( tor != NULL )
322        && ( tor->session->isPexEnabled )
323        && ( !tr_torrentIsPrivate( tor ) );
324}
325
326static inline tr_bool tr_torrentAllowsDHT( const tr_torrent * tor )
327{
328    return ( tor != NULL )
329        && ( tr_sessionAllowsDHT( tor->session ) )
330        && ( !tr_torrentIsPrivate( tor ) );
331}
332
333static inline tr_bool tr_torrentAllowsLPD( const tr_torrent * tor )
334{
335    return ( tor != NULL )
336        && ( tr_sessionAllowsLPD( tor->session ) )
337        && ( !tr_torrentIsPrivate( tor ) );
338}
339
340/***
341****
342***/
343
344enum
345{
346    TORRENT_MAGIC_NUMBER = 95549
347};
348
349static inline tr_bool tr_isTorrent( const tr_torrent * tor )
350{
351    return ( tor != NULL )
352        && ( tor->magicNumber == TORRENT_MAGIC_NUMBER )
353        && ( tr_isSession( tor->session ) );
354}
355
356/* set a flag indicating that the torrent's .resume file
357 * needs to be saved when the torrent is closed */
358static inline
359void tr_torrentSetDirty( tr_torrent * tor )
360{
361    assert( tr_isTorrent( tor ) );
362
363    tor->isDirty = TRUE;
364}
365
366static inline
367const char * tr_torrentName( const tr_torrent * tor )
368{
369    assert( tr_isTorrent( tor ) );
370
371    return tor->info.name;
372}
373
374uint32_t tr_getBlockSize( uint32_t pieceSize );
375
376/**
377 * Tell the tr_torrent that one of its files has become complete
378 */
379void tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNo );
380
381
382/**
383 * @brief Like tr_torrentFindFile(), but splits the filename into base and subpath;
384 *
385 * If the file is found, "tr_buildPath( base, subpath, NULL )"
386 * will generate the complete filename.
387 *
388 * @return true if the file is found, false otherwise.
389 *
390 * @param base if the torrent is found, this will be either
391 *             tor->downloadDir or tor->incompleteDir
392 * @param subpath on success, this pointer is assigned a newly-allocated
393 *                string holding the second half of the filename.
394 */
395tr_bool tr_torrentFindFile2( const tr_torrent *, tr_file_index_t fileNo,
396                             const char ** base, char ** subpath );
397
398
399/* Returns a newly-allocated version of the tr_file.name string
400 * that's been modified to denote that it's not a complete file yet.
401 * In the current implementation this is done by appending ".part"
402 * a la Firefox. */
403char* tr_torrentBuildPartial( const tr_torrent *, tr_file_index_t fileNo );
404
405/* for when the info dict has been fundamentally changed wrt files,
406 * piece size, etc. such as in BEP 9 where peers exchange metadata */
407void tr_torrentGotNewInfoDict( tr_torrent * tor );
408
409void tr_torrentSetSpeedLimit_Bps  ( tr_torrent *, tr_direction, int Bps );
410int tr_torrentGetSpeedLimit_Bps  ( const tr_torrent *, tr_direction );
411
412/**
413 * @return true if this piece needs to be tested
414 */
415tr_bool tr_torrentPieceNeedsCheck( const tr_torrent * tor, tr_piece_index_t pieceIndex );
416
417/**
418 * @brief Test a piece against its info dict checksum
419 * @return true if the piece's passes the checksum test
420 */
421tr_bool tr_torrentCheckPiece( tr_torrent * tor, tr_piece_index_t pieceIndex );
422
423uint64_t tr_torrentGetCurrentSizeOnDisk( const tr_torrent * tor );
424
425
426#endif
Note: See TracBrowser for help on using the repository browser.