source: trunk/libtransmission/torrent.h @ 14169

Last change on this file since 14169 was 14169, checked in by jordan, 8 years ago

add inline wrapper functions to tr_torrent to decouple the rest of the code from tr_completion

  • Property svn:keywords set to Date Rev Author Id
File size: 15.7 KB
Line 
1/*
2 * This file Copyright (C) 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 14169 2013-08-18 13:06:39Z jordan $
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 "bandwidth.h" /* tr_bandwidth */
21#include "completion.h" /* tr_completion */
22#include "session.h" /* tr_sessionLock (), tr_sessionUnlock () */
23#include "utils.h" /* TR_GNUC_PRINTF */
24
25struct tr_torrent_tiers;
26struct tr_magnet_info;
27
28/**
29***  Package-visible ctor API
30**/
31
32void        tr_torrentFree (tr_torrent * tor);
33
34void        tr_ctorSetSave (tr_ctor * ctor,
35                            bool      saveMetadataInOurTorrentsDir);
36
37int         tr_ctorGetSave (const tr_ctor * ctor);
38
39void        tr_ctorInitTorrentPriorities (const tr_ctor * ctor, tr_torrent * tor);
40
41void        tr_ctorInitTorrentWanted (const tr_ctor * ctor, tr_torrent * tor);
42
43/**
44***
45**/
46
47/* just like tr_torrentSetFileDLs but doesn't trigger a fastresume save */
48void        tr_torrentInitFileDLs (tr_torrent              * tor,
49                                   const tr_file_index_t   * files,
50                                   tr_file_index_t           fileCount,
51                                   bool                      do_download);
52
53void        tr_torrentRecheckCompleteness (tr_torrent *);
54
55void        tr_torrentSetHasPiece (tr_torrent *     tor,
56                                   tr_piece_index_t pieceIndex,
57                                   bool             has);
58
59void        tr_torrentChangeMyPort (tr_torrent * session);
60
61tr_torrent* tr_torrentFindFromHashString (tr_session * session,
62                                          const char * hashString);
63
64tr_torrent* tr_torrentFindFromObfuscatedHash (tr_session    * session,
65                                              const uint8_t * hash);
66
67bool        tr_torrentIsPieceTransferAllowed (const tr_torrent  * torrent,
68                                              tr_direction        direction);
69
70
71
72#define tr_block(a, b) _tr_block (tor, a, b)
73tr_block_index_t _tr_block (const tr_torrent * tor,
74                            tr_piece_index_t   index,
75                            uint32_t           offset);
76
77bool             tr_torrentReqIsValid (const tr_torrent * tor,
78                                       tr_piece_index_t   index,
79                                       uint32_t           offset,
80                                       uint32_t           length);
81
82uint64_t         tr_pieceOffset (const tr_torrent * tor,
83                                 tr_piece_index_t   index,
84                                 uint32_t           offset,
85                                 uint32_t           length);
86
87void             tr_torrentGetBlockLocation (const tr_torrent * tor,
88                                             tr_block_index_t   block,
89                                             tr_piece_index_t * piece,
90                                             uint32_t         * offset,
91                                             uint32_t         * length);
92
93void             tr_torGetFileBlockRange (const tr_torrent        * tor,
94                                          const tr_file_index_t     file,
95                                          tr_block_index_t        * first,
96                                          tr_block_index_t        * last);
97
98void             tr_torGetPieceBlockRange (const tr_torrent        * tor,
99                                           const tr_piece_index_t    piece,
100                                           tr_block_index_t        * first,
101                                           tr_block_index_t        * last);
102
103void             tr_torrentInitFilePriority (tr_torrent       * tor,
104                                             tr_file_index_t    fileIndex,
105                                             tr_priority_t      priority);
106
107void             tr_torrentSetPieceChecked (tr_torrent       * tor,
108                                            tr_piece_index_t   piece);
109
110void             tr_torrentSetChecked (tr_torrent * tor, time_t when);
111
112void             tr_torrentCheckSeedLimit (tr_torrent * tor);
113
114/** save a torrent's .resume file if it's changed since the last time it was saved */
115void             tr_torrentSave (tr_torrent * tor);
116
117void             tr_torrentSetLocalError (tr_torrent * tor, const char * fmt, ...) TR_GNUC_PRINTF (2, 3);
118
119
120
121typedef enum
122{
123    TR_VERIFY_NONE,
124    TR_VERIFY_WAIT,
125    TR_VERIFY_NOW
126}
127tr_verify_state;
128
129void             tr_torrentSetVerifyState (tr_torrent      * tor,
130                                           tr_verify_state   state);
131
132tr_torrent_activity tr_torrentGetActivity (const tr_torrent * tor);
133
134struct tr_incomplete_metadata;
135
136/** @brief Torrent object */
137struct tr_torrent
138{
139    tr_session *             session;
140    tr_info                  info;
141
142    int                      magicNumber;
143
144    tr_stat_errtype          error;
145    char                     errorString[128];
146    char                     errorTracker[128];
147
148    uint8_t                  obfuscatedHash[SHA_DIGEST_LENGTH];
149
150    /* Used when the torrent has been created with a magnet link
151     * and we're in the process of downloading the metainfo from
152     * other peers */
153    struct tr_incomplete_metadata  * incompleteMetadata;
154
155    /* If the initiator of the connection receives a handshake in which the
156     * peer_id does not match the expected peerid, then the initiator is
157     * expected to drop the connection. Note that the initiator presumably
158     * received the peer information from the tracker, which includes the
159     * peer_id that was registered by the peer. The peer_id from the tracker
160     * and in the handshake are expected to match.
161     */
162    unsigned char peer_id[PEER_ID_LEN+1];
163
164    time_t peer_id_creation_time;
165
166    /* Where the files will be when it's complete */
167    char * downloadDir;
168
169    /* Where the files are when the torrent is incomplete */
170    char * incompleteDir;
171
172    /* Length, in bytes, of the "info" dict in the .torrent file. */
173    int infoDictLength;
174
175    /* Offset, in bytes, of the beginning of the "info" dict in the .torrent file.
176     *
177     * Used by the torrent-magnet code for serving metainfo to peers.
178     * This field is lazy-generated and might not be initialized yet. */
179    int infoDictOffset;
180
181    /* Where the files are now.
182     * This pointer will be equal to downloadDir or incompleteDir */
183    const char * currentDir;
184
185    /* How many bytes we ask for per request */
186    uint32_t                   blockSize;
187    tr_block_index_t           blockCount;
188
189    uint32_t                   lastBlockSize;
190    uint32_t                   lastPieceSize;
191
192    uint16_t                   blockCountInPiece;
193    uint16_t                   blockCountInLastPiece;
194
195    struct tr_completion       completion;
196
197    tr_completeness            completeness;
198
199    struct tr_torrent_tiers  * tiers;
200
201    time_t                     dhtAnnounceAt;
202    time_t                     dhtAnnounce6At;
203    bool                       dhtAnnounceInProgress;
204    bool                       dhtAnnounce6InProgress;
205
206    time_t                     lpdAnnounceAt;
207
208    uint64_t                   downloadedCur;
209    uint64_t                   downloadedPrev;
210    uint64_t                   uploadedCur;
211    uint64_t                   uploadedPrev;
212    uint64_t                   corruptCur;
213    uint64_t                   corruptPrev;
214
215    uint64_t                   etaDLSpeedCalculatedAt;
216    unsigned int               etaDLSpeed_Bps;
217    uint64_t                   etaULSpeedCalculatedAt;
218    unsigned int               etaULSpeed_Bps;
219
220    time_t                     addedDate;
221    time_t                     activityDate;
222    time_t                     doneDate;
223    time_t                     startDate;
224    time_t                     anyDate;
225
226    int                        secondsDownloading;
227    int                        secondsSeeding;
228
229    int                        queuePosition;
230
231    tr_torrent_metadata_func  * metadata_func;
232    void                      * metadata_func_user_data;
233
234    tr_torrent_completeness_func  * completeness_func;
235    void                          *  completeness_func_user_data;
236
237    tr_torrent_ratio_limit_hit_func  * ratio_limit_hit_func;
238    void                             * ratio_limit_hit_func_user_data;
239
240    tr_torrent_idle_limit_hit_func  * idle_limit_hit_func;
241    void                            * idle_limit_hit_func_user_data;
242
243    void * queue_started_user_data;
244    void (* queue_started_callback)(tr_torrent *, void * queue_started_user_data);
245
246    bool                       isRunning;
247    bool                       isStopping;
248    bool                       isDeleting;
249    bool                       startAfterVerify;
250    bool                       isDirty;
251    bool                       isQueued;
252
253    bool                       infoDictOffsetIsCached;
254
255    uint16_t                   maxConnectedPeers;
256
257    tr_verify_state            verifyState;
258
259    time_t                     lastStatTime;
260    tr_stat                    stats;
261
262    tr_torrent *               next;
263
264    int                        uniqueId;
265
266    struct tr_bandwidth        bandwidth;
267
268    struct tr_swarm          * swarm;
269
270    float                      desiredRatio;
271    tr_ratiolimit              ratioLimitMode;
272
273    uint16_t                   idleLimitMinutes;
274    tr_idlelimit               idleLimitMode;
275    bool                       finishedSeedingByIdle;
276};
277
278static inline tr_torrent*
279tr_torrentNext (tr_session * session, tr_torrent * current)
280{
281    return current ? current->next : session->torrentList;
282}
283
284/* what piece index is this block in? */
285static inline tr_piece_index_t
286tr_torBlockPiece (const tr_torrent * tor, const tr_block_index_t block)
287{
288    return block / tor->blockCountInPiece;
289}
290
291/* how many bytes are in this piece? */
292static inline uint32_t
293tr_torPieceCountBytes (const tr_torrent * tor, const tr_piece_index_t piece)
294{
295    return piece + 1 == tor->info.pieceCount ? tor->lastPieceSize
296                                             : tor->info.pieceSize;
297}
298
299/* how many bytes are in this block? */
300static inline uint32_t
301tr_torBlockCountBytes (const tr_torrent * tor, const tr_block_index_t block)
302{
303    return block + 1 == tor->blockCount ? tor->lastBlockSize
304                                        : tor->blockSize;
305}
306
307static inline void tr_torrentLock (const tr_torrent * tor) 
308{ 
309  tr_sessionLock (tor->session); 
310} 
311static inline bool tr_torrentIsLocked (const tr_torrent * tor)
312{
313  return tr_sessionIsLocked (tor->session);
314}
315static inline void tr_torrentUnlock (const tr_torrent * tor)
316{
317  tr_sessionUnlock (tor->session);
318}
319
320static inline bool
321tr_torrentExists (const tr_session * session, const uint8_t *   torrentHash)
322{
323    return tr_torrentFindFromHash ((tr_session*)session, torrentHash) != NULL;
324}
325
326static inline tr_completeness
327tr_torrentGetCompleteness (const tr_torrent * tor)
328{
329    return tor->completeness;
330}
331
332static inline bool
333tr_torrentIsSeed (const tr_torrent * tor)
334{
335    return tr_torrentGetCompleteness(tor) != TR_LEECH;
336}
337
338static inline bool tr_torrentIsPrivate (const tr_torrent * tor)
339{
340    return (tor != NULL) && tor->info.isPrivate;
341}
342
343static inline bool tr_torrentAllowsPex (const tr_torrent * tor)
344{
345    return (tor != NULL)
346        && (tor->session->isPexEnabled)
347        && (!tr_torrentIsPrivate (tor));
348}
349
350static inline bool tr_torrentAllowsDHT (const tr_torrent * tor)
351{
352    return (tor != NULL)
353        && (tr_sessionAllowsDHT (tor->session))
354        && (!tr_torrentIsPrivate (tor));
355}
356
357static inline bool tr_torrentAllowsLPD (const tr_torrent * tor)
358{
359    return (tor != NULL)
360        && (tr_sessionAllowsLPD (tor->session))
361        && (!tr_torrentIsPrivate (tor));
362}
363
364/***
365****
366***/
367
368enum
369{
370    TORRENT_MAGIC_NUMBER = 95549
371};
372
373static inline bool tr_isTorrent (const tr_torrent * tor)
374{
375    return (tor != NULL)
376        && (tor->magicNumber == TORRENT_MAGIC_NUMBER)
377        && (tr_isSession (tor->session));
378}
379
380/* set a flag indicating that the torrent's .resume file
381 * needs to be saved when the torrent is closed */
382static inline
383void tr_torrentSetDirty (tr_torrent * tor)
384{
385    assert (tr_isTorrent (tor));
386
387    tor->isDirty = true;
388}
389
390uint32_t tr_getBlockSize (uint32_t pieceSize);
391
392/**
393 * Tell the tr_torrent that it's gotten a block
394 */
395void tr_torrentGotBlock (tr_torrent * tor, tr_block_index_t blockIndex);
396
397
398
399/**
400 * @brief Like tr_torrentFindFile (), but splits the filename into base and subpath;
401 *
402 * If the file is found, "tr_buildPath (base, subpath, NULL)"
403 * will generate the complete filename.
404 *
405 * @return true if the file is found, false otherwise.
406 *
407 * @param base if the torrent is found, this will be either
408 *             tor->downloadDir or tor->incompleteDir
409 * @param subpath on success, this pointer is assigned a newly-allocated
410 *                string holding the second half of the filename.
411 */
412bool tr_torrentFindFile2 (const tr_torrent *, tr_file_index_t fileNo,
413                          const char ** base, char ** subpath, time_t * mtime);
414
415
416/* Returns a newly-allocated version of the tr_file.name string
417 * that's been modified to denote that it's not a complete file yet.
418 * In the current implementation this is done by appending ".part"
419 * a la Firefox. */
420char* tr_torrentBuildPartial (const tr_torrent *, tr_file_index_t fileNo);
421
422/* for when the info dict has been fundamentally changed wrt files,
423 * piece size, etc. such as in BEP 9 where peers exchange metadata */
424void tr_torrentGotNewInfoDict (tr_torrent * tor);
425
426void tr_torrentSetSpeedLimit_Bps (tr_torrent *, tr_direction, unsigned int Bps);
427unsigned int tr_torrentGetSpeedLimit_Bps (const tr_torrent *, tr_direction);
428
429/**
430 * @return true if this piece needs to be tested
431 */
432bool tr_torrentPieceNeedsCheck (const tr_torrent * tor, tr_piece_index_t pieceIndex);
433
434/**
435 * @brief Test a piece against its info dict checksum
436 * @return true if the piece's passes the checksum test
437 */
438bool tr_torrentCheckPiece (tr_torrent * tor, tr_piece_index_t pieceIndex);
439
440time_t tr_torrentGetFileMTime (const tr_torrent * tor, tr_file_index_t i);
441
442uint64_t tr_torrentGetCurrentSizeOnDisk (const tr_torrent * tor);
443
444bool tr_torrentIsStalled (const tr_torrent * tor);
445
446const unsigned char * tr_torrentGetPeerId (tr_torrent * tor);
447
448static inline uint64_t
449tr_torrentGetLeftUntilDone (const tr_torrent * tor)
450{
451  return tr_cpLeftUntilDone (&tor->completion);
452}
453
454static inline bool
455tr_torrentHasAll (const tr_torrent * tor)
456{
457  return tr_cpHasAll (&tor->completion);
458}
459
460static inline bool
461tr_torrentHasNone (const tr_torrent * tor)
462{
463  return tr_cpHasNone (&tor->completion);
464}
465
466static inline bool
467tr_torrentPieceIsComplete (const tr_torrent * tor, tr_piece_index_t i)
468{
469  return tr_cpPieceIsComplete (&tor->completion, i);
470}
471
472static inline bool
473tr_torrentBlockIsComplete (const tr_torrent * tor, tr_block_index_t i)
474{
475  return tr_cpBlockIsComplete (&tor->completion, i);
476}
477
478static inline size_t
479tr_torrentMissingBlocksInPiece (const tr_torrent * tor, tr_piece_index_t i)
480{
481  return tr_cpMissingBlocksInPiece (&tor->completion, i);
482}
483
484static inline size_t
485tr_torrentMissingBytesInPiece (const tr_torrent * tor, tr_piece_index_t i)
486{
487  return tr_cpMissingBytesInPiece (&tor->completion, i);
488}
489
490static inline void *
491tr_torrentCreatePieceBitfield (const tr_torrent * tor, size_t * byte_count)
492{
493  return tr_cpCreatePieceBitfield (&tor->completion, byte_count);
494}
495
496static inline uint64_t
497tr_torrentHaveTotal (const tr_torrent * tor)
498{
499  return tr_cpHaveTotal (&tor->completion);
500}
501
502
503static inline bool
504tr_torrentIsQueued (const tr_torrent * tor)
505{
506  return tor->isQueued;
507}
508
509static inline tr_direction
510tr_torrentGetQueueDirection (const tr_torrent * tor)
511{
512  return tr_torrentIsSeed (tor) ? TR_UP : TR_DOWN;
513}
514
515#endif
Note: See TracBrowser for help on using the repository browser.