source: trunk/libtransmission/torrent.h @ 10550

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

(trunk) minor transmission.h API cleanup.

  1. remove tr_sessionGetActiveTorrentCount()
  2. make tr_sessionCountTorrents() package-visible instead of public.
  3. make tr_torrentGetActivity() private instead of public.
  • Property svn:keywords set to Date Rev Author Id
File size: 12.8 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 10550 2010-04-29 23:08:11Z 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                                   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
89int              tr_torrentCountUncheckedPieces( const tr_torrent * );
90
91tr_bool          tr_torrentIsFileChecked( const tr_torrent  * tor,
92                                          tr_file_index_t     file );
93
94void             tr_torrentSetPieceChecked( tr_torrent       * tor,
95                                            tr_piece_index_t   piece,
96                                            tr_bool            isChecked );
97
98void             tr_torrentSetFileChecked( tr_torrent       * tor,
99                                           tr_file_index_t    file,
100                                           tr_bool            isChecked );
101
102void             tr_torrentUncheck( tr_torrent * tor );
103
104int              tr_torrentPromoteTracker( tr_torrent   * tor,
105                                           int            trackerIndex );
106
107time_t*          tr_torrentGetMTimes( const tr_torrent  * tor,
108                                      size_t            * setmeCount );
109
110tr_torrent*      tr_torrentNext( tr_session  * session,
111                                 tr_torrent  * current );
112
113void             tr_torrentCheckSeedRatio( tr_torrent * tor );
114
115/** save a torrent's .resume file if it's changed since the last time it was saved */
116void             tr_torrentSave( tr_torrent * tor );
117
118void             tr_torrentSetLocalError( tr_torrent * tor, const char * fmt, ... ) TR_GNUC_PRINTF( 2, 3 );
119
120
121
122typedef enum
123{
124    TR_VERIFY_NONE,
125    TR_VERIFY_WAIT,
126    TR_VERIFY_NOW
127}
128tr_verify_state;
129
130void             tr_torrentSetVerifyState( tr_torrent      * tor,
131                                           tr_verify_state   state );
132
133struct tr_incomplete_metadata;
134
135/** @brief Torrent object */
136struct tr_torrent
137{
138    tr_session *             session;
139    tr_info                  info;
140
141    int                      magicNumber;
142
143    tr_stat_errtype          error;
144    char                     errorString[128];
145
146    uint8_t                  obfuscatedHash[SHA_DIGEST_LENGTH];
147
148    /* Used when the torrent has been created with a magnet link
149     * and we're in the process of downloading the metainfo from
150     * other peers */
151    struct tr_incomplete_metadata  * incompleteMetadata;
152
153    /* If the initiator of the connection receives a handshake in which the
154     * peer_id does not match the expected peerid, then the initiator is
155     * expected to drop the connection. Note that the initiator presumably
156     * received the peer information from the tracker, which includes the
157     * peer_id that was registered by the peer. The peer_id from the tracker
158     * and in the handshake are expected to match.
159     */
160    uint8_t * peer_id;
161
162    /* Where the files will be when it's complete */
163    char * downloadDir;
164
165    /* Where the files are when the torrent is incomplete */
166    char * incompleteDir;
167
168    /* Length, in bytes, of the "info" dict in the .torrent file */
169    int infoDictLength;
170
171    /* Offset, in bytes, of the beginning of the "info" dict in the .torrent file */
172    int infoDictOffset;
173
174    /* Where the files are now.
175     * This pointer will be equal to downloadDir or incompleteDir */
176    const char * currentDir;
177
178    /* How many bytes we ask for per request */
179    uint32_t                   blockSize;
180    tr_block_index_t           blockCount;
181
182    uint32_t                   lastBlockSize;
183    uint32_t                   lastPieceSize;
184
185    uint32_t                   blockCountInPiece;
186    uint32_t                   blockCountInLastPiece;
187
188    struct tr_completion       completion;
189
190    struct tr_bitfield         checkedPieces;
191    tr_completeness            completeness;
192
193    struct tr_torrent_tiers  * tiers;
194    struct tr_publisher_tag  * tiersSubscription;
195
196    time_t                     dhtAnnounceAt;
197    time_t                     dhtAnnounce6At;
198    tr_bool                    dhtAnnounceInProgress;
199    tr_bool                    dhtAnnounce6InProgress;
200
201    uint64_t                   downloadedCur;
202    uint64_t                   downloadedPrev;
203    uint64_t                   uploadedCur;
204    uint64_t                   uploadedPrev;
205    uint64_t                   corruptCur;
206    uint64_t                   corruptPrev;
207
208    uint64_t                   etaDLSpeedCalculatedAt;
209    double                     etaDLSpeed;
210    uint64_t                   etaULSpeedCalculatedAt;
211    double                     etaULSpeed;
212
213    time_t                     addedDate;
214    time_t                     activityDate;
215    time_t                     doneDate;
216    time_t                     startDate;
217    time_t                     anyDate;
218
219    tr_torrent_metadata_func  * metadata_func;
220    void                      * metadata_func_user_data;
221
222    tr_torrent_completeness_func  * completeness_func;
223    void                          *  completeness_func_user_data;
224
225    tr_torrent_ratio_limit_hit_func  * ratio_limit_hit_func;
226    void                             * ratio_limit_hit_func_user_data;
227
228    tr_bool                    isRunning;
229    tr_bool                    isDeleting;
230    tr_bool                    startAfterVerify;
231    tr_bool                    isDirty;
232
233    uint16_t                   maxConnectedPeers;
234
235    tr_verify_state            verifyState;
236
237    time_t                     lastStatTime;
238    tr_stat                    stats;
239
240    tr_torrent *               next;
241
242    int                        uniqueId;
243
244    struct tr_bandwidth      * bandwidth;
245
246    struct tr_torrent_peers  * torrentPeers;
247
248    double                     desiredRatio;
249    tr_ratiolimit              ratioLimitMode;
250
251    uint64_t                   preVerifyTotal;
252};
253
254/* get the index of this piece's first block */
255static inline tr_block_index_t
256tr_torPieceFirstBlock( const tr_torrent * tor, const tr_piece_index_t piece )
257{
258    return piece * tor->blockCountInPiece;
259}
260
261/* what piece index is this block in? */
262static inline tr_piece_index_t
263tr_torBlockPiece( const tr_torrent * tor, const tr_block_index_t block )
264{
265    return block / tor->blockCountInPiece;
266}
267
268/* how many blocks are in this piece? */
269static inline uint32_t
270tr_torPieceCountBlocks( const tr_torrent * tor, const tr_piece_index_t piece )
271{
272    return piece == tor->info.pieceCount - 1 ? tor->blockCountInLastPiece
273                                             : 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_torrentIsPieceChecked( const tr_torrent  * tor,
334                                                   tr_piece_index_t    i )
335{
336    return tr_bitfieldHasFast( &tor->checkedPieces, i );
337}
338
339/***
340****
341***/
342
343enum
344{
345    TORRENT_MAGIC_NUMBER = 95549
346};
347
348static inline tr_bool tr_isTorrent( const tr_torrent * tor )
349{
350    return ( tor != NULL )
351        && ( tor->magicNumber == TORRENT_MAGIC_NUMBER )
352        && ( tr_isSession( tor->session ) );
353}
354
355/* set a flag indicating that the torrent's .resume file
356 * needs to be saved when the torrent is closed */
357static inline
358void tr_torrentSetDirty( tr_torrent * tor )
359{
360    assert( tr_isTorrent( tor ) );
361
362    tor->isDirty = TRUE;
363}
364
365static inline
366const char * tr_torrentName( const tr_torrent * tor )
367{
368    assert( tr_isTorrent( tor ) );
369
370    return tor->info.name;
371}
372
373/**
374 * Tell the tr_torrent that one of its files has become complete
375 */
376void tr_torrentFileCompleted( tr_torrent * tor, tr_file_index_t fileNo );
377
378
379/**
380 * @brief Like tr_torrentFindFile(), but splits the filename into base and subpath;
381 *
382 * If the file is found, "tr_buildPath( base, subpath, NULL )"
383 * will generate the complete filename.
384 *
385 * @return true if the file is found, false otherwise.
386 *
387 * @param base if the torrent is found, this will be either
388 *             tor->downloadDir or tor->incompleteDir
389 * @param subpath on success, this pointer is assigned a newly-allocated
390 *                string holding the second half of the filename.
391 */
392tr_bool tr_torrentFindFile2( const tr_torrent *, tr_file_index_t fileNo,
393                             const char ** base, char ** subpath );
394
395
396/* Returns a newly-allocated version of the tr_file.name string
397 * that's been modified to denote that it's not a complete file yet.
398 * In the current implementation this is done by appending ".part"
399 * a la Firefox. */
400char* tr_torrentBuildPartial( const tr_torrent *, tr_file_index_t fileNo );
401
402/* for when the info dict has been fundamentally changed wrt files,
403 * piece size, etc. such as in BEP 9 where peers exchange metadata */
404void tr_torrentGotNewInfoDict( tr_torrent * tor );
405
406#endif
Note: See TracBrowser for help on using the repository browser.