source: branches/1.4x/libtransmission/bandwidth.c @ 7375

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

(1.4x libT) copy the bandwidth randomization code back from trunk

File size: 9.6 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.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:$
11 */
12
13#include <assert.h>
14#include <limits.h>
15
16#include "event.h"
17
18#include "transmission.h"
19#include "bandwidth.h"
20#include "crypto.h"
21#include "iobuf.h"
22#include "ptrarray.h"
23#include "utils.h"
24
25/***
26****
27***/
28
29enum
30{
31    HISTORY_MSEC = 2000,
32    INTERVAL_MSEC = HISTORY_MSEC,
33    GRANULARITY_MSEC = 50,
34    HISTORY_SIZE = ( INTERVAL_MSEC / GRANULARITY_MSEC ),
35    MAGIC_NUMBER = 43143
36};
37
38struct bratecontrol
39{
40    int newest;
41    struct { uint64_t date, size; } transfers[HISTORY_SIZE];
42};
43
44static float
45getSpeed( const struct bratecontrol * r, int interval_msec )
46{
47    uint64_t       bytes = 0;
48    const uint64_t cutoff = tr_date ( ) - interval_msec;
49    int            i = r->newest;
50
51    for( ;; )
52    {
53        if( r->transfers[i].date <= cutoff )
54            break;
55
56        bytes += r->transfers[i].size;
57
58        if( --i == -1 ) i = HISTORY_SIZE - 1; /* circular history */
59        if( i == r->newest ) break; /* we've come all the way around */
60    }
61
62    return ( bytes / 1024.0 ) * ( 1000.0 / interval_msec );
63}
64
65static void
66bytesUsed( struct bratecontrol * r, size_t size )
67{
68    const uint64_t now = tr_date ( );
69
70    if( r->transfers[r->newest].date + GRANULARITY_MSEC >= now )
71        r->transfers[r->newest].size += size;
72    else
73    {
74        if( ++r->newest == HISTORY_SIZE ) r->newest = 0;
75        r->transfers[r->newest].date = now;
76        r->transfers[r->newest].size = size;
77    }
78}
79
80/******
81*******
82*******
83******/
84
85struct tr_band
86{
87    tr_bool isLimited;
88    tr_bool honorParentLimits;
89    size_t bytesLeft;
90    double desiredSpeed;
91    struct bratecontrol raw;
92    struct bratecontrol piece;
93};
94
95struct tr_bandwidth
96{
97    struct tr_band band[2];
98    struct tr_bandwidth * parent;
99    int magicNumber;
100    tr_session * session;
101    tr_ptrArray * children; /* struct tr_bandwidth */
102    tr_ptrArray * iobufs; /* struct tr_iobuf */
103};
104
105/***
106****
107***/
108
109static int
110comparePointers( const void * a, const void * b )
111{
112    return a - b;
113}
114
115static int
116isBandwidth( const tr_bandwidth * b )
117{
118    return ( b != NULL ) && ( b->magicNumber == MAGIC_NUMBER );
119}
120
121static int
122isDirection( const tr_direction dir )
123{
124    return ( dir == TR_UP ) || ( dir == TR_DOWN );
125}
126
127/***
128****
129***/
130
131tr_bandwidth*
132tr_bandwidthNew( tr_session * session, tr_bandwidth * parent )
133{
134    tr_bandwidth * b = tr_new0( tr_bandwidth, 1 );
135    b->session = session;
136    b->children = tr_ptrArrayNew( );
137    b->iobufs = tr_ptrArrayNew( );
138    b->magicNumber = MAGIC_NUMBER;
139    b->band[TR_UP].honorParentLimits = 1;
140    b->band[TR_DOWN].honorParentLimits = 1;
141    tr_bandwidthSetParent( b, parent );
142    return b;
143}
144
145void
146tr_bandwidthFree( tr_bandwidth * b )
147{
148    assert( isBandwidth( b ) );
149
150    tr_bandwidthSetParent( b, NULL );
151    tr_ptrArrayFree( b->iobufs, NULL );
152    tr_ptrArrayFree( b->children, NULL );
153    b->magicNumber = 0xDEAD;
154    tr_free( b );
155}
156
157/***
158****
159***/
160
161void
162tr_bandwidthSetParent( tr_bandwidth  * b,
163                       tr_bandwidth  * parent )
164{
165    assert( isBandwidth( b ) );
166    assert( b != parent );
167
168    if( b->parent )
169    {
170        assert( isBandwidth( b->parent ) );
171
172        tr_ptrArrayRemoveSorted( b->parent->children, b, comparePointers );
173        b->parent= NULL;
174    }
175
176    if( parent )
177    {
178        assert( isBandwidth( parent ) );
179        assert( parent->parent != b );
180
181        tr_ptrArrayInsertSorted( parent->children, b, comparePointers );
182        b->parent = parent;
183    }
184}
185
186void
187tr_bandwidthHonorParentLimits( tr_bandwidth  * b,
188                               tr_direction    dir,
189                               int             honorParentLimits )
190{
191    assert( isBandwidth( b ) );
192    assert( isDirection( dir ) );
193
194    b->band[dir].honorParentLimits = honorParentLimits != 0;
195}
196
197/***
198****
199***/
200
201void
202tr_bandwidthSetDesiredSpeed( tr_bandwidth  * b,
203                             tr_direction    dir,
204                             double          desiredSpeed )
205{
206    assert( isBandwidth( b ) );
207    assert( isDirection( dir ) );
208
209    b->band[dir].desiredSpeed = desiredSpeed; 
210}
211
212double
213tr_bandwidthGetDesiredSpeed( const tr_bandwidth  * b,
214                             tr_direction          dir )
215{
216    assert( isBandwidth( b ) );
217    assert( isDirection( dir ) );
218
219    return b->band[dir].desiredSpeed;
220}
221
222void
223tr_bandwidthSetLimited( tr_bandwidth  * b,
224                        tr_direction    dir,
225                        int             isLimited )
226{
227    assert( isBandwidth( b ) );
228    assert( isDirection( dir ) );
229
230    b->band[dir].isLimited = isLimited != 0;
231}
232
233int
234tr_bandwidthIsLimited( const tr_bandwidth  * b,
235                       tr_direction          dir )
236{
237    assert( isBandwidth( b ) );
238    assert( isDirection( dir ) );
239
240    return b->band[dir].isLimited != 0;
241}
242
243#if 0
244#warning do not check the code in with this enabled
245#define DEBUG_DIRECTION TR_UP
246#endif
247
248static void
249allocateBandwidth( tr_bandwidth  * b,
250                   tr_direction    dir,
251                   int             period_msec,
252                   tr_ptrArray   * addme_buffers )
253{
254    assert( isBandwidth( b ) );
255    assert( isDirection( dir ) );
256
257    if( b->band[dir].isLimited )
258    {
259        const double desiredSpeed = b->band[dir].desiredSpeed;
260        const double nextPulseSpeed = desiredSpeed;
261        b->band[dir].bytesLeft = MAX( 0.0, nextPulseSpeed * 1024.0 * period_msec / 1000.0 );
262
263#ifdef DEBUG_DIRECTION
264        if( dir == DEBUG_DIRECTION )
265                fprintf( stderr, "bandwidth %p currentPieceSpeed(%5.2f of %5.2f) desiredSpeed(%5.2f), allocating %5.2f\n",
266                         b, currentSpeed, tr_bandwidthGetRawSpeed( b, dir ), desiredSpeed,
267                         b->band[dir].bytesLeft/1024.0 );
268#endif
269    }
270
271    /* notify the io buffers that there's more bandwidth available */
272    {
273        int i;
274        const int n = tr_ptrArraySize( b->iobufs );
275        for( i=0; i<n; ++i )
276            tr_ptrArrayAppend( addme_buffers, tr_ptrArrayNth( b->iobufs, i ) );
277    }
278
279#ifdef DEBUG_DIRECTION
280if( ( dir == DEBUG_DIRECTION ) && ( n > 1 ) )
281fprintf( stderr, "bandwidth %p has %d iobufs\n", b, n );
282#endif
283
284    /* all children should reallocate too */
285    if( 1 ) {
286        int i, n=0;
287        struct tr_bandwidth ** children = (struct tr_bandwidth**) tr_ptrArrayPeek( b->children, &n );
288        for( i=0; i<n; ++i )
289            tr_bandwidthAllocate( children[i], dir, period_msec );
290    }
291}
292
293void
294tr_bandwidthAllocate( tr_bandwidth  * b,
295                      tr_direction    dir,
296                      int             period_msec )
297{
298    int n;
299    tr_ptrArray * tmp;
300    struct tr_iobuf ** buffers;
301    const short what = dir==TR_UP ? EV_WRITE : EV_READ;
302
303    tmp = tr_ptrArrayNew( );
304    allocateBandwidth( b, dir, period_msec, tmp );
305    buffers = (struct tr_iobuf**) tr_ptrArrayPeek( tmp, &n );
306
307    /* notify the io buffers in a random order s.t. no
308       particular peer gets to hog all the bandwidth */
309    while( n > 0 ) {
310        const int i = tr_cryptoRandInt( n );
311        tr_iobuf_enable( buffers[i], what );
312        buffers[i] = buffers[n-1];
313        --n;
314    }
315
316    tr_ptrArrayFree( tmp, NULL );
317}
318
319/***
320****
321***/
322
323void
324tr_bandwidthAddBuffer( tr_bandwidth        * b,
325                       struct tr_iobuf     * iobuf )
326{
327    assert( isBandwidth( b ) );
328    assert( iobuf );
329
330    tr_ptrArrayInsertSorted( b->iobufs, iobuf, comparePointers );
331}
332
333void
334tr_bandwidthRemoveBuffer( tr_bandwidth        * b,
335                          struct tr_iobuf     * iobuf )
336{
337    assert( isBandwidth( b ) );
338    assert( iobuf );
339
340    tr_ptrArrayRemoveSorted( b->iobufs, iobuf, comparePointers );
341}
342
343/***
344****
345***/
346
347size_t
348tr_bandwidthClamp( const tr_bandwidth  * b,
349                   tr_direction          dir,
350                   size_t                byteCount )
351{
352    assert( isBandwidth( b ) );
353    assert( isDirection( dir ) );
354
355    if( b )
356    {
357        if( b->band[dir].isLimited )
358            byteCount = MIN( byteCount, b->band[dir].bytesLeft );
359
360        if( b->parent && b->band[dir].honorParentLimits )
361            byteCount = tr_bandwidthClamp( b->parent, dir, byteCount );
362    }
363
364    return byteCount;
365}
366
367double
368tr_bandwidthGetRawSpeed( const tr_bandwidth * b, tr_direction dir )
369{
370    assert( isBandwidth( b ) );
371    assert( isDirection( dir ) );
372
373    return getSpeed( &b->band[dir].raw, HISTORY_MSEC );
374}
375
376double
377tr_bandwidthGetPieceSpeed( const tr_bandwidth * b, tr_direction dir )
378{
379    assert( isBandwidth( b ) );
380    assert( isDirection( dir ) );
381
382    return getSpeed( &b->band[dir].piece, HISTORY_MSEC );
383}
384
385void
386tr_bandwidthUsed( tr_bandwidth  * b,
387                  tr_direction    dir,
388                  size_t          byteCount,
389                  int             isPieceData )
390{
391    struct tr_band * band;
392    size_t oldBytesLeft;
393
394    assert( isBandwidth( b ) );
395    assert( isDirection( dir ) );
396
397    band = &b->band[dir];
398
399    oldBytesLeft = band->bytesLeft;
400
401    if( band->isLimited && isPieceData )
402        band->bytesLeft -= MIN( band->bytesLeft, byteCount );
403
404#ifdef DEBUG_DIRECTION
405if( ( dir == DEBUG_DIRECTION ) && ( band->isLimited ) )
406fprintf( stderr, "%p consumed %5zu bytes of %5s data... was %6zu, now %6zu left\n",
407         b, byteCount, (isPieceData?"piece":"raw"), oldBytesLeft, band->bytesLeft );
408#endif
409
410    bytesUsed( &band->raw, byteCount );
411
412    if( isPieceData )
413        bytesUsed( &band->piece, byteCount );
414
415    if( b->parent != NULL )
416        tr_bandwidthUsed( b->parent, dir, byteCount, isPieceData );
417}
Note: See TracBrowser for help on using the repository browser.