source: trunk/libtransmission/session.h @ 12281

Last change on this file since 12281 was 12281, checked in by jordan, 11 years ago

(trunk libT) save 48 bytes per tr_torrent object. whoo!

  • Property svn:keywords set to Date Rev Author Id
File size: 9.5 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 12281 2011-03-31 16:08:31Z 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 );
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
111    tr_benc                      removedTorrents;
112
113    int                          umask;
114
115    int                          speedLimit_Bps[2];
116    bool                         speedLimitEnabled[2];
117
118    struct tr_turtle_info        turtle;
119
120    struct tr_fdInfo           * fdInfo;
121
122    int                          magicNumber;
123
124    tr_encryption_mode           encryptionMode;
125
126    tr_preallocation_mode        preallocationMode;
127
128    struct event_base          * event_base;
129    struct evdns_base          * evdns_base;
130    struct tr_event_handle     * events;
131
132    uint16_t                     peerLimitPerTorrent;
133
134    int                          uploadSlotsPerTorrent;
135
136    /* The UDP sockets used for the DHT and uTP. */
137    tr_port                      udp_port;
138    int                          udp_socket;
139    int                          udp6_socket;
140    unsigned char *              udp6_bound;
141    struct event                 *udp_event;
142    struct event                 *udp6_event;
143
144    /* The open port on the local machine for incoming peer requests */
145    tr_port                      private_peer_port;
146
147    /**
148     * The open port on the public device for incoming peer requests.
149     * This is usually the same as private_peer_port but can differ
150     * if the public device is a router and it decides to use a different
151     * port than the one requested by Transmission.
152     */
153    tr_port                      public_peer_port;
154
155    tr_port                      randomPortLow;
156    tr_port                      randomPortHigh;
157
158    int                          peerSocketTOS;
159    char *                       peer_congestion_algorithm;
160
161    int                          torrentCount;
162    tr_torrent *                 torrentList;
163
164    char *                       torrentDoneScript;
165
166    char *                       tag;
167    char *                       configDir;
168    char *                       downloadDir;
169    char *                       resumeDir;
170    char *                       torrentDir;
171    char *                       incompleteDir;
172
173    char *                       blocklist_url;
174
175    struct tr_list *             blocklists;
176    struct tr_peerMgr *          peerMgr;
177    struct tr_shared *           shared;
178
179    struct tr_cache *            cache;
180
181    struct tr_lock *             lock;
182
183    struct tr_web *              web;
184
185    struct tr_rpc_server *       rpcServer;
186    tr_rpc_func                  rpc_func;
187    void *                       rpc_func_user_data;
188
189    struct tr_stats_handle     * sessionStats;
190
191    struct tr_announcer        * announcer;
192    struct tr_announcer_udp    * announcer_udp;
193
194    tr_benc                    * metainfoLookup;
195
196    struct event               * nowTimer;
197    struct event               * saveTimer;
198
199    /* monitors the "global pool" speeds */
200    struct tr_bandwidth          bandwidth;
201
202    float                        desiredRatio;
203
204    uint16_t                     idleLimitMinutes;
205
206    struct tr_bindinfo         * public_ipv4;
207    struct tr_bindinfo         * public_ipv6;
208
209    /* a page-aligned buffer for use by the libtransmission thread.
210     * @see SESSION_BUFFER_SIZE */
211    void * buffer;
212
213    bool bufferInUse;
214
215    tr_web_config_func          * curl_easy_config_func;
216
217    uint8_t peer_id[PEER_ID_LEN+1];
218};
219
220static inline tr_port
221tr_sessionGetPublicPeerPort( const tr_session * session )
222{
223    return session->public_peer_port;
224}
225
226static inline const uint8_t*
227tr_getPeerId( tr_session * session )
228{
229    return session->peer_id;
230}
231
232bool         tr_sessionAllowsDHT( const tr_session * session );
233
234bool         tr_sessionAllowsLPD( const tr_session * session );
235
236const char * tr_sessionFindTorrentFile( const tr_session * session,
237                                        const char *       hashString );
238
239void         tr_sessionSetTorrentFile( tr_session * session,
240                                       const char * hashString,
241                                       const char * filename );
242
243bool         tr_sessionIsAddressBlocked( const tr_session        * session,
244                                         const struct tr_address * addr );
245
246void         tr_sessionLock( tr_session * );
247
248void         tr_sessionUnlock( tr_session * );
249
250bool         tr_sessionIsLocked( const tr_session * );
251
252const struct tr_address*  tr_sessionGetPublicAddress( const tr_session  * session,
253                                                      int                 tr_af_type,
254                                                      bool              * is_default_value );
255
256
257struct tr_bindsockets * tr_sessionGetBindSockets( tr_session * );
258
259int tr_sessionCountTorrents( const tr_session * session );
260
261enum
262{
263    SESSION_MAGIC_NUMBER = 3845,
264
265    /* @see tr_session.buffer */
266    SESSION_BUFFER_SIZE = (16*1024)
267};
268
269void* tr_sessionGetBuffer( tr_session * session );
270
271void tr_sessionReleaseBuffer( tr_session * session );
272
273static inline bool tr_isSession( const tr_session * session )
274{
275    return ( session != NULL ) && ( session->magicNumber == SESSION_MAGIC_NUMBER );
276}
277
278static inline bool tr_isPreallocationMode( tr_preallocation_mode m  )
279{
280    return ( m == TR_PREALLOCATE_NONE )
281        || ( m == TR_PREALLOCATE_SPARSE )
282        || ( m == TR_PREALLOCATE_FULL );
283}
284
285static inline bool tr_isEncryptionMode( tr_encryption_mode m )
286{
287    return ( m == TR_CLEAR_PREFERRED )
288        || ( m == TR_ENCRYPTION_PREFERRED )
289        || ( m == TR_ENCRYPTION_REQUIRED );
290}
291
292static inline bool tr_isPriority( tr_priority_t p )
293{
294    return ( p == TR_PRI_LOW )
295        || ( p == TR_PRI_NORMAL )
296        || ( p == TR_PRI_HIGH );
297}
298
299/***
300****
301***/
302
303static inline unsigned int toSpeedBytes ( unsigned int KBps ) { return KBps * tr_speed_K; }
304static inline double       toSpeedKBps  ( unsigned int Bps )  { return Bps / (double)tr_speed_K; }
305
306static inline uint64_t toMemBytes ( unsigned int MB ) { uint64_t B = tr_mem_K * tr_mem_K; B *= MB; return B; }
307static inline int      toMemMB    ( uint64_t B )      { return B / ( tr_mem_K * tr_mem_K ); }
308
309/**
310**/
311
312int  tr_sessionGetSpeedLimit_Bps( const tr_session *, tr_direction );
313int  tr_sessionGetAltSpeed_Bps  ( const tr_session *, tr_direction );
314int  tr_sessionGetRawSpeed_Bps  ( const tr_session *, tr_direction );
315int  tr_sessionGetPieceSpeed_Bps( const tr_session *, tr_direction );
316
317void tr_sessionSetSpeedLimit_Bps( tr_session *, tr_direction, int Bps );
318void tr_sessionSetAltSpeed_Bps  ( tr_session *, tr_direction, int Bps );
319
320bool  tr_sessionGetActiveSpeedLimit_Bps( const tr_session  * session,
321                                         tr_direction        dir,
322                                         int               * setme );
323
324#endif
Note: See TracBrowser for help on using the repository browser.