source: trunk/libtransmission/session.h @ 12918

Last change on this file since 12918 was 12640, checked in by jordan, 10 years ago

Add a mechanism for enabling/disabling the stalled minutes feature. This is a pre-existing feature in the Mac client.

  • Property svn:keywords set to Date Rev Author Id
File size: 9.6 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: session.h 12640 2011-08-07 19:24:33Z jordan $
11 */
12
13#ifndef __TRANSMISSION__
14 #error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_INTERNAL_H
18#define TR_INTERNAL_H 1
19
20#define TR_NAME "Transmission"
21
22#ifndef UNUSED
23 #ifdef __GNUC__
24  #define UNUSED __attribute__ ( ( unused ) )
25 #else
26  #define UNUSED
27 #endif
28#endif
29
30#include "bandwidth.h"
31#include "bencode.h"
32#include "bitfield.h"
33#include "utils.h"
34
35typedef enum { TR_NET_OK, TR_NET_ERROR, TR_NET_WAIT } tr_tristate_t;
36
37enum
38{
39  PEER_ID_LEN = 20
40};
41
42void tr_peerIdInit( uint8_t * setme );
43
44struct event_base;
45struct evdns_base;
46
47struct tr_address;
48struct tr_announcer;
49struct tr_announcer_udp;
50struct tr_bindsockets;
51struct tr_cache;
52struct tr_fdInfo;
53
54typedef void ( tr_web_config_func )( tr_session * session, void * curl_pointer, const char * url, void * user_data );
55
56struct tr_turtle_info
57{
58    /* TR_UP and TR_DOWN speed limits */
59    int speedLimit_Bps[2];
60
61    /* is turtle mode on right now? */
62    bool isEnabled;
63
64    /* does turtle mode turn itself on and off at given times? */
65    bool isClockEnabled;
66
67    /* when clock mode is on, minutes after midnight to turn on turtle mode */
68    int beginMinute;
69
70    /* when clock mode is on, minutes after midnight to turn off turtle mode */
71    int endMinute;
72
73    /* only use clock mode on these days of the week */
74    tr_sched_day days;
75
76    /* called when isEnabled changes */
77    tr_altSpeedFunc * callback;
78
79    /* the callback's user_data argument */
80    void * callbackUserData;
81
82    /* the callback's changedByUser argument.
83     * indicates whether the change came from the user or from the clock. */
84    bool changedByUser;
85
86    /* bitfield of all the minutes in a week.
87     * Each bit's value indicates whether the scheduler wants turtle
88     * limits on or off at that given minute in the week. */
89    tr_bitfield minutes;
90};
91
92/** @brief handle to an active libtransmission session */
93struct tr_session
94{
95    bool                         isPortRandom;
96    bool                         isPexEnabled;
97    bool                         isDHTEnabled;
98    bool                         isUTPEnabled;
99    bool                         isLPDEnabled;
100    bool                         isBlocklistEnabled;
101    bool                         isPrefetchEnabled;
102    bool                         isTorrentDoneScriptEnabled;
103    bool                         isClosed;
104    bool                         isIncompleteFileNamingEnabled;
105    bool                         isRatioLimited;
106    bool                         isIdleLimited;
107    bool                         isIncompleteDirEnabled;
108    bool                         pauseAddedTorrent;
109    bool                         deleteSourceTorrent;
110    bool                         scrapePausedTorrents;
111
112    tr_benc                      removedTorrents;
113
114    bool                         stalledEnabled;
115    bool                         queueEnabled[2];
116    int                          queueSize[2];
117    int                          queueStalledMinutes;
118
119    int                          umask;
120
121    int                          speedLimit_Bps[2];
122    bool                         speedLimitEnabled[2];
123
124    struct tr_turtle_info        turtle;
125
126    struct tr_fdInfo           * fdInfo;
127
128    int                          magicNumber;
129
130    tr_encryption_mode           encryptionMode;
131
132    tr_preallocation_mode        preallocationMode;
133
134    struct event_base          * event_base;
135    struct evdns_base          * evdns_base;
136    struct tr_event_handle     * events;
137
138    uint16_t                     peerLimit;
139    uint16_t                     peerLimitPerTorrent;
140
141    int                          uploadSlotsPerTorrent;
142
143    /* The UDP sockets used for the DHT and uTP. */
144    tr_port                      udp_port;
145    int                          udp_socket;
146    int                          udp6_socket;
147    unsigned char *              udp6_bound;
148    struct event                 *udp_event;
149    struct event                 *udp6_event;
150
151    /* The open port on the local machine for incoming peer requests */
152    tr_port                      private_peer_port;
153
154    /**
155     * The open port on the public device for incoming peer requests.
156     * This is usually the same as private_peer_port but can differ
157     * if the public device is a router and it decides to use a different
158     * port than the one requested by Transmission.
159     */
160    tr_port                      public_peer_port;
161
162    tr_port                      randomPortLow;
163    tr_port                      randomPortHigh;
164
165    int                          peerSocketTOS;
166    char *                       peer_congestion_algorithm;
167
168    int                          torrentCount;
169    tr_torrent *                 torrentList;
170
171    char *                       torrentDoneScript;
172
173    char *                       tag;
174    char *                       configDir;
175    char *                       downloadDir;
176    char *                       resumeDir;
177    char *                       torrentDir;
178    char *                       incompleteDir;
179
180    char *                       blocklist_url;
181
182    struct tr_list *             blocklists;
183    struct tr_peerMgr *          peerMgr;
184    struct tr_shared *           shared;
185
186    struct tr_cache *            cache;
187
188    struct tr_lock *             lock;
189
190    struct tr_web *              web;
191
192    struct tr_rpc_server *       rpcServer;
193    tr_rpc_func                  rpc_func;
194    void *                       rpc_func_user_data;
195
196    struct tr_stats_handle     * sessionStats;
197
198    struct tr_announcer        * announcer;
199    struct tr_announcer_udp    * announcer_udp;
200
201    tr_benc                    * metainfoLookup;
202
203    struct event               * nowTimer;
204    struct event               * saveTimer;
205
206    /* monitors the "global pool" speeds */
207    struct tr_bandwidth          bandwidth;
208
209    float                        desiredRatio;
210
211    uint16_t                     idleLimitMinutes;
212
213    struct tr_bindinfo         * public_ipv4;
214    struct tr_bindinfo         * public_ipv6;
215
216    uint8_t peer_id[PEER_ID_LEN+1];
217};
218
219static inline tr_port
220tr_sessionGetPublicPeerPort( const tr_session * session )
221{
222    return session->public_peer_port;
223}
224
225static inline const uint8_t*
226tr_getPeerId( tr_session * session )
227{
228    return session->peer_id;
229}
230
231bool         tr_sessionAllowsDHT( const tr_session * session );
232
233bool         tr_sessionAllowsLPD( const tr_session * session );
234
235const char * tr_sessionFindTorrentFile( const tr_session * session,
236                                        const char *       hashString );
237
238void         tr_sessionSetTorrentFile( tr_session * session,
239                                       const char * hashString,
240                                       const char * filename );
241
242bool         tr_sessionIsAddressBlocked( const tr_session        * session,
243                                         const struct tr_address * addr );
244
245void         tr_sessionLock( tr_session * );
246
247void         tr_sessionUnlock( tr_session * );
248
249bool         tr_sessionIsLocked( const tr_session * );
250
251const struct tr_address*  tr_sessionGetPublicAddress( const tr_session  * session,
252                                                      int                 tr_af_type,
253                                                      bool              * is_default_value );
254
255
256struct tr_bindsockets * tr_sessionGetBindSockets( tr_session * );
257
258int tr_sessionCountTorrents( const tr_session * session );
259
260enum
261{
262    SESSION_MAGIC_NUMBER = 3845,
263};
264
265static inline bool tr_isSession( const tr_session * session )
266{
267    return ( session != NULL ) && ( session->magicNumber == SESSION_MAGIC_NUMBER );
268}
269
270static inline bool tr_isPreallocationMode( tr_preallocation_mode m  )
271{
272    return ( m == TR_PREALLOCATE_NONE )
273        || ( m == TR_PREALLOCATE_SPARSE )
274        || ( m == TR_PREALLOCATE_FULL );
275}
276
277static inline bool tr_isEncryptionMode( tr_encryption_mode m )
278{
279    return ( m == TR_CLEAR_PREFERRED )
280        || ( m == TR_ENCRYPTION_PREFERRED )
281        || ( m == TR_ENCRYPTION_REQUIRED );
282}
283
284static inline bool tr_isPriority( tr_priority_t p )
285{
286    return ( p == TR_PRI_LOW )
287        || ( p == TR_PRI_NORMAL )
288        || ( p == TR_PRI_HIGH );
289}
290
291/***
292****
293***/
294
295static inline unsigned int toSpeedBytes ( unsigned int KBps ) { return KBps * tr_speed_K; }
296static inline double       toSpeedKBps  ( unsigned int Bps )  { return Bps / (double)tr_speed_K; }
297
298static inline uint64_t toMemBytes ( unsigned int MB ) { uint64_t B = tr_mem_K * tr_mem_K; B *= MB; return B; }
299static inline int      toMemMB    ( uint64_t B )      { return B / ( tr_mem_K * tr_mem_K ); }
300
301/**
302**/
303
304int  tr_sessionGetSpeedLimit_Bps( const tr_session *, tr_direction );
305int  tr_sessionGetAltSpeed_Bps  ( const tr_session *, tr_direction );
306int  tr_sessionGetRawSpeed_Bps  ( const tr_session *, tr_direction );
307int  tr_sessionGetPieceSpeed_Bps( const tr_session *, tr_direction );
308
309void tr_sessionSetSpeedLimit_Bps( tr_session *, tr_direction, int Bps );
310void tr_sessionSetAltSpeed_Bps  ( tr_session *, tr_direction, int Bps );
311
312bool  tr_sessionGetActiveSpeedLimit_Bps( const tr_session  * session,
313                                         tr_direction        dir,
314                                         int               * setme );
315
316tr_torrent * tr_sessionGetNextQueuedSeed( tr_session * session );
317tr_torrent * tr_sessionGetNextQueuedTorrent( tr_session * session, tr_direction );
318
319int tr_sessionCountQueueFreeSlots( tr_session * session, tr_direction );
320
321
322#endif
Note: See TracBrowser for help on using the repository browser.