source: trunk/libtransmission/torrent.h @ 8910

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

(trunk libT) fix #2162: .resume file doesn't get saved often enough when its contents change

  • Property svn:keywords set to Date Rev Author Id
File size: 10.6 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 8910 2009-08-13 14:47:56Z 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_bitfield */
24
25struct tr_bandwidth;
26struct tr_ratecontrol;
27struct tr_torrent_peers;
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_torrentResetTransferStats( tr_torrent * );
55
56void        tr_torrentSetHasPiece( tr_torrent *     tor,
57                                   tr_piece_index_t pieceIndex,
58                                   tr_bool          has );
59
60void        tr_torrentChangeMyPort( tr_torrent * session );
61
62tr_torrent* tr_torrentFindFromHash( tr_session *    session,
63                                    const uint8_t * hash );
64
65tr_torrent* tr_torrentFindFromHashString( tr_session * session,
66                                          const char * hashString );
67
68tr_torrent* tr_torrentFindFromObfuscatedHash( tr_session    * session,
69                                              const uint8_t * hash );
70
71tr_bool     tr_torrentIsPieceTransferAllowed( const tr_torrent * torrent,
72                                              tr_direction       direction );
73
74
75
76#define tr_block( a, b ) _tr_block( tor, a, b )
77tr_block_index_t _tr_block( const tr_torrent * tor,
78                            tr_piece_index_t   index,
79                            uint32_t           offset );
80
81tr_bool          tr_torrentReqIsValid( const tr_torrent * tor,
82                                       tr_piece_index_t   index,
83                                       uint32_t           offset,
84                                       uint32_t           length );
85
86uint64_t         tr_pieceOffset( const tr_torrent * tor,
87                                 tr_piece_index_t   index,
88                                 uint32_t           offset,
89                                 uint32_t           length );
90
91void             tr_torrentInitFilePriority( tr_torrent       * tor,
92                                             tr_file_index_t    fileIndex,
93                                             tr_priority_t      priority );
94
95int              tr_torrentCountUncheckedPieces( const tr_torrent * );
96
97tr_bool          tr_torrentIsFileChecked( const tr_torrent  * tor,
98                                          tr_file_index_t     file );
99
100void             tr_torrentSetPieceChecked( tr_torrent       * tor,
101                                            tr_piece_index_t   piece,
102                                            tr_bool            isChecked );
103
104void             tr_torrentSetFileChecked( tr_torrent       * tor,
105                                           tr_file_index_t    file,
106                                           tr_bool            isChecked );
107
108void             tr_torrentUncheck( tr_torrent * tor );
109
110int              tr_torrentPromoteTracker( tr_torrent   * tor,
111                                           int            trackerIndex );
112
113time_t*          tr_torrentGetMTimes( const tr_torrent  * tor,
114                                      size_t            * setmeCount );
115
116tr_torrent*      tr_torrentNext( tr_session  * session,
117                                 tr_torrent  * current );
118
119void             tr_torrentCheckSeedRatio( tr_torrent * tor );
120
121/** save a torrent's .resume file if it's changed since the last time it was saved */
122void             tr_torrentSave( tr_torrent * tor );
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 to download */
161    char * downloadDir;
162
163    /* How many bytes we ask for per request */
164    uint32_t                   blockSize;
165    tr_block_index_t           blockCount;
166
167    uint32_t                   lastBlockSize;
168    uint32_t                   lastPieceSize;
169
170    uint32_t                   blockCountInPiece;
171    uint32_t                   blockCountInLastPiece;
172
173    struct tr_completion       completion;
174
175    struct tr_bitfield         checkedPieces;
176    tr_completeness            completeness;
177
178    struct tr_tracker *        tracker;
179    struct tr_publisher_tag *  trackerSubscription;
180
181    time_t                     dhtAnnounceAt;
182    tr_bool                    dhtAnnounceInProgress;
183
184    uint64_t                   downloadedCur;
185    uint64_t                   downloadedPrev;
186    uint64_t                   uploadedCur;
187    uint64_t                   uploadedPrev;
188    uint64_t                   corruptCur;
189    uint64_t                   corruptPrev;
190
191    uint64_t                   etaSpeedCalculatedAt;
192    double                     etaSpeed;
193
194    time_t                     addedDate;
195    time_t                     activityDate;
196    time_t                     doneDate;
197    time_t                     startDate;
198    time_t                     anyDate;
199
200    tr_torrent_completeness_func *   completeness_func;
201    void *                     completeness_func_user_data;
202
203    tr_torrent_ratio_limit_hit_func * ratio_limit_hit_func;
204    void *                     ratio_limit_hit_func_user_data;
205
206    tr_bool                    isRunning;
207    tr_bool                    isDeleting;
208    tr_bool                    needsSeedRatioCheck;
209    tr_bool                    startAfterVerify;
210    tr_bool                    isDirty;
211
212    uint16_t                   maxConnectedPeers;
213
214    tr_verify_state            verifyState;
215
216    time_t                     lastStatTime;
217    tr_stat                    stats;
218
219    tr_torrent *               next;
220
221    int                        uniqueId;
222
223    struct tr_bandwidth      * bandwidth;
224
225    struct tr_torrent_peers  * torrentPeers;
226
227    double                     desiredRatio;
228    tr_ratiolimit              ratioLimitMode;
229};
230
231/* get the index of this piece's first block */
232static TR_INLINE tr_block_index_t
233tr_torPieceFirstBlock( const tr_torrent * tor, const tr_piece_index_t piece )
234{
235    return piece * tor->blockCountInPiece;
236}
237
238/* what piece index is this block in? */
239static TR_INLINE tr_piece_index_t
240tr_torBlockPiece( const tr_torrent * tor, const tr_block_index_t block )
241{
242    return block / tor->blockCountInPiece;
243}
244
245/* how many blocks are in this piece? */
246static TR_INLINE uint32_t
247tr_torPieceCountBlocks( const tr_torrent * tor, const tr_piece_index_t piece )
248{
249    return piece == tor->info.pieceCount - 1 ? tor->blockCountInLastPiece
250                                             : tor->blockCountInPiece;
251}
252
253/* how many bytes are in this piece? */
254static TR_INLINE uint32_t
255tr_torPieceCountBytes( const tr_torrent * tor, const tr_piece_index_t piece )
256{
257    return piece == tor->info.pieceCount - 1 ? tor->lastPieceSize
258                                             : tor->info.pieceSize;
259}
260
261/* how many bytes are in this block? */
262static TR_INLINE uint32_t
263tr_torBlockCountBytes( const tr_torrent * tor, const tr_block_index_t block )
264{
265    return block == tor->blockCount - 1 ? tor->lastBlockSize
266                                        : tor->blockSize;
267}
268
269static TR_INLINE void tr_torrentLock( const tr_torrent * tor )
270{
271    tr_globalLock( tor->session );
272}
273
274static TR_INLINE void tr_torrentUnlock( const tr_torrent * tor )
275{
276    tr_globalUnlock( tor->session );
277}
278
279static TR_INLINE tr_bool
280tr_torrentExists( const tr_session * session, const uint8_t *   torrentHash )
281{
282    return tr_torrentFindFromHash( (tr_session*)session, torrentHash ) != NULL;
283}
284
285static TR_INLINE tr_bool
286tr_torrentIsSeed( const tr_torrent * tor )
287{
288    return tor->completeness != TR_LEECH;
289}
290
291static TR_INLINE tr_bool tr_torrentIsPrivate( const tr_torrent * tor )
292{
293    return ( tor != NULL ) && tor->info.isPrivate;
294}
295
296static TR_INLINE tr_bool tr_torrentAllowsPex( const tr_torrent * tor )
297{
298    return ( tor != NULL )
299        && ( tor->session->isPexEnabled )
300        && ( !tr_torrentIsPrivate( tor ) );
301}
302
303static TR_INLINE tr_bool tr_torrentAllowsDHT( const tr_torrent * tor )
304{
305    return ( tor != NULL )
306        && ( tr_sessionAllowsDHT( tor->session ) )
307        && ( !tr_torrentIsPrivate( tor ) );
308}
309
310static TR_INLINE tr_bool tr_torrentIsPieceChecked( const tr_torrent  * tor,
311                                                   tr_piece_index_t    i )
312{
313    return tr_bitfieldHasFast( &tor->checkedPieces, i );
314}
315
316/***
317****
318***/
319
320enum
321{
322    TORRENT_MAGIC_NUMBER = 95549
323};
324
325static inline tr_bool tr_isTorrent( const tr_torrent * tor )
326{
327    return ( tor != NULL )
328        && ( tor->magicNumber == TORRENT_MAGIC_NUMBER )
329        && ( tr_isSession( tor->session ) );
330}
331
332/* set a flag indicating that the torrent's .resume file
333 * needs to be saved when the torrent is closed */
334static inline void tr_torrentSetDirty( tr_torrent * tor )
335{
336    assert( tr_isTorrent( tor ) );
337
338    tor->isDirty = TRUE;
339}
340
341#endif
Note: See TracBrowser for help on using the repository browser.