source: trunk/libtransmission/bandwidth.c @ 7159

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

(libT) slightly more accurate reporting of piece data vs. raw data

File size: 9.7 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 "iobuf.h"
21#include "ptrarray.h"
22#include "utils.h"
23
24/***
25****
26***/
27
28enum
29{
30    HISTORY_MSEC = 2000,
31    INTERVAL_MSEC = HISTORY_MSEC,
32    GRANULARITY_MSEC = 250,
33    HISTORY_SIZE = ( INTERVAL_MSEC / GRANULARITY_MSEC ),
34    MAGIC_NUMBER = 43143
35};
36
37struct bratecontrol
38{
39    int newest;
40    struct { uint64_t date, size; } transfers[HISTORY_SIZE];
41};
42
43static float
44getSpeed( const struct bratecontrol * r )
45{
46    const uint64_t interval_msec = HISTORY_MSEC;
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    unsigned int isLimited : 1;
88    unsigned int honorParentLimits : 1;
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#define DEBUG_DIRECTION TR_UP
245#endif
246
247void
248tr_bandwidthAllocate( tr_bandwidth  * b,
249                      tr_direction    dir,
250                      int             period_msec )
251{
252    double clamped = 0;
253
254    assert( isBandwidth( b ) );
255    assert( isDirection( dir ) );
256
257    if( b->band[dir].isLimited )
258    {
259        const double currentSpeed = tr_bandwidthGetPieceSpeed( b, dir ); /* KiB/s */
260        const double desiredSpeed = b->band[dir].desiredSpeed;           /* KiB/s */
261        const double seconds_per_pulse = period_msec / 1000.0;
262        const double current_bytes_per_pulse = currentSpeed * 1024.0 * seconds_per_pulse;
263        const double desired_bytes_per_pulse = desiredSpeed * 1024.0 * seconds_per_pulse;
264        const double pulses_per_history = (double)HISTORY_MSEC / period_msec;
265        const double min = desired_bytes_per_pulse * 0.85;
266        const double max = desired_bytes_per_pulse * 1.15;
267        const double next_pulse_bytes = desired_bytes_per_pulse * ( pulses_per_history + 1 )
268                                      - ( current_bytes_per_pulse * pulses_per_history );
269
270        /* clamp the return value to lessen oscillation */
271        clamped = next_pulse_bytes;
272        clamped = MAX( clamped, min );
273        clamped = MIN( clamped, max );
274
275        b->band[dir].bytesLeft = clamped;
276
277#ifdef DEBUG_DIRECTION
278        if( dir == DEBUG_DIRECTION )
279                fprintf( stderr, "bandwidth %p currentPieceSpeed(%5.2f of %5.2f) desiredSpeed(%5.2f), allocating %5.2f (unclamped: %5.2f)\n",
280                         b, currentSpeed, tr_bandwidthGetRawSpeed( b, dir ), desiredSpeed,
281                         clamped/1024.0, next_pulse_bytes/1024.0 );
282#endif
283    }
284
285    /* notify the io buffers that there's more bandwidth available */
286    if( !b->band[dir].isLimited || ( clamped > 0.001 ) )
287    {
288        int i, n=0;
289        short what = dir==TR_UP ? EV_WRITE : EV_READ;
290        struct tr_iobuf ** iobufs = (struct tr_iobuf**) tr_ptrArrayPeek( b->iobufs, &n );
291#ifdef DEBUG_DIRECTION
292if( ( dir == DEBUG_DIRECTION ) && ( n > 1 ) )
293fprintf( stderr, "bandwidth %p has %d iobufs\n", b, n );
294#endif
295        for( i=0; i<n; ++i )
296            tr_iobuf_enable( iobufs[i], what );
297    }
298
299    /* all children should reallocate too */
300    if( 1 ) {
301        int i, n=0;
302        struct tr_bandwidth ** children = (struct tr_bandwidth**) tr_ptrArrayPeek( b->children, &n );
303        for( i=0; i<n; ++i )
304            tr_bandwidthAllocate( children[i], dir, period_msec );
305    }
306}
307
308/***
309****
310***/
311
312void
313tr_bandwidthAddBuffer( tr_bandwidth        * b,
314                       struct tr_iobuf     * iobuf )
315{
316    assert( isBandwidth( b ) );
317    assert( iobuf );
318
319    tr_ptrArrayInsertSorted( b->iobufs, iobuf, comparePointers );
320}
321
322void
323tr_bandwidthRemoveBuffer( tr_bandwidth        * b,
324                          struct tr_iobuf     * iobuf )
325{
326    assert( isBandwidth( b ) );
327    assert( iobuf );
328
329    tr_ptrArrayRemoveSorted( b->iobufs, iobuf, comparePointers );
330}
331
332/***
333****
334***/
335
336size_t
337tr_bandwidthClamp( const tr_bandwidth  * b,
338                   tr_direction          dir,
339                   size_t                byteCount )
340{
341    assert( isBandwidth( b ) );
342    assert( isDirection( dir ) );
343
344    if( b )
345    {
346        if( b->band[dir].isLimited )
347            byteCount = MIN( byteCount, b->band[dir].bytesLeft );
348
349        if( b->parent && b->band[dir].honorParentLimits )
350            byteCount = tr_bandwidthClamp( b->parent, dir, byteCount );
351    }
352
353    return byteCount;
354}
355
356double
357tr_bandwidthGetRawSpeed( const tr_bandwidth * b, tr_direction dir )
358{
359    assert( isBandwidth( b ) );
360    assert( isDirection( dir ) );
361
362    return getSpeed( &b->band[dir].raw );
363}
364
365double
366tr_bandwidthGetPieceSpeed( const tr_bandwidth * b, tr_direction dir )
367{
368    assert( isBandwidth( b ) );
369    assert( isDirection( dir ) );
370
371    return getSpeed( &b->band[dir].piece );
372}
373
374void
375tr_bandwidthUsed( tr_bandwidth  * b,
376                  tr_direction    dir,
377                  size_t          byteCount,
378                  int             isPieceData )
379{
380    struct tr_band * band;
381    size_t oldBytesLeft;
382
383    assert( isBandwidth( b ) );
384    assert( isDirection( dir ) );
385
386    band = &b->band[dir];
387
388    oldBytesLeft = band->bytesLeft;
389
390    if( band->isLimited && isPieceData )
391        band->bytesLeft -= MIN( band->bytesLeft, byteCount );
392
393#ifdef DEBUG_DIRECTION
394if( ( dir == DEBUG_DIRECTION ) && ( band->isLimited ) )
395fprintf( stderr, "%p consumed %5zu bytes of %5s data... was %6zu, now %6zu left\n",
396         b, byteCount, (isPieceData?"piece":"raw"), oldBytesLeft, band->bytesLeft );
397#endif
398
399    bytesUsed( &band->raw, byteCount );
400
401    if( isPieceData )
402        bytesUsed( &band->piece, byteCount );
403
404    if( b->parent != NULL )
405        tr_bandwidthUsed( b->parent, dir, byteCount, isPieceData );
406}
Note: See TracBrowser for help on using the repository browser.