summaryrefslogtreecommitdiff
path: root/indra/newview/llviewerthrottle.cpp
blob: 8482bc603beb4d983a524b634511b5304bf6a52c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
/**
 * @file llviewerthrottle.cpp
 * @brief LLViewerThrottle class implementation
 *
 * $LicenseInfo:firstyear=2002&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#include "llviewerprecompiledheaders.h"
#include "llviewerthrottle.h"

#include "llviewercontrol.h"
#include "message.h"
#include "llagent.h"
#include "llframetimer.h"
#include "llviewerstats.h"
#include "lldatapacker.h"

using namespace LLOldEvents;

// consts

// The viewer is allowed to set the under-the-hood bandwidth to 50%
// greater than the prefs UI shows, under the assumption that the
// viewer won't receive all the different message types at once.
// I didn't design this, don't know who did. JC
const F32 MAX_FRACTIONAL = 1.5f;
const F32 MIN_FRACTIONAL = 0.2f;

const F32 MIN_BANDWIDTH = 50.f;
const F32 MAX_BANDWIDTH = 6000.f;
const F32 STEP_FRACTIONAL = 0.1f;
const LLUnit<F32, LLUnits::Percent> TIGHTEN_THROTTLE_THRESHOLD(3.0f); // packet loss % per s
const LLUnit<F32, LLUnits::Percent> EASE_THROTTLE_THRESHOLD(0.5f); // packet loss % per s
const F32 DYNAMIC_UPDATE_DURATION = 5.0f; // seconds

LLViewerThrottle gViewerThrottle;

// static
const std:: string LLViewerThrottle::sNames[TC_EOF] = {
                            "Resend",
                            "Land",
                            "Wind",
                            "Cloud",
                            "Task",
                            "Texture",
                            "Asset"
                            };


// Bandwidth settings for different bit rates, they're interpolated/extrapolated.
//                                Resend Land Wind Cloud Task Texture Asset
const F32 BW_PRESET_50[TC_EOF]   = {   5,  10,   3,   3,  10,  10,   9 };
const F32 BW_PRESET_300[TC_EOF]  = {  30,  40,   9,   9,  86,  86,  40 };
const F32 BW_PRESET_500[TC_EOF]  = {  50,  70,  14,  14, 136, 136,  80 };
const F32 BW_PRESET_1000[TC_EOF] = { 100, 100,  20,  20, 310, 310, 140 };

LLViewerThrottleGroup::LLViewerThrottleGroup()
{
    S32 i;
    for (i = 0; i < TC_EOF; i++)
    {
        mThrottles[i] = 0.f;
    }
    mThrottleTotal = 0.f;
}


LLViewerThrottleGroup::LLViewerThrottleGroup(const F32 settings[TC_EOF])
{
    mThrottleTotal = 0.f;
    S32 i;
    for (i = 0; i < TC_EOF; i++)
    {
        mThrottles[i] = settings[i];
        mThrottleTotal += settings[i];
    }
}


LLViewerThrottleGroup LLViewerThrottleGroup::operator*(const F32 frac) const
{
    LLViewerThrottleGroup res;
    res.mThrottleTotal = 0.f;

    S32 i;
    for (i = 0; i < TC_EOF; i++)
    {
        res.mThrottles[i] = mThrottles[i] * frac;
        res.mThrottleTotal += res.mThrottles[i];
    }

    return res;
}


LLViewerThrottleGroup LLViewerThrottleGroup::operator+(const LLViewerThrottleGroup &b) const
{
    LLViewerThrottleGroup res;
    res.mThrottleTotal = 0.f;

    S32 i;
    for (i = 0; i < TC_EOF; i++)
    {
        res.mThrottles[i] = mThrottles[i] + b.mThrottles[i];
        res.mThrottleTotal += res.mThrottles[i];
    }

    return res;
}


LLViewerThrottleGroup LLViewerThrottleGroup::operator-(const LLViewerThrottleGroup &b) const
{
    LLViewerThrottleGroup res;
    res.mThrottleTotal = 0.f;

    S32 i;
    for (i = 0; i < TC_EOF; i++)
    {
        res.mThrottles[i] = mThrottles[i] - b.mThrottles[i];
        res.mThrottleTotal += res.mThrottles[i];
    }

    return res;
}


void LLViewerThrottleGroup::sendToSim() const
{
    LL_INFOS() << "Sending throttle settings, total BW " << mThrottleTotal << LL_ENDL;
    LLMessageSystem* msg = gMessageSystem;

    msg->newMessageFast(_PREHASH_AgentThrottle);
    msg->nextBlockFast(_PREHASH_AgentData);
    msg->addUUIDFast(_PREHASH_AgentID, gAgent.getID());
    msg->addUUIDFast(_PREHASH_SessionID, gAgent.getSessionID());
    msg->addU32Fast(_PREHASH_CircuitCode, msg->mOurCircuitCode);

    msg->nextBlockFast(_PREHASH_Throttle);
    msg->addU32Fast(_PREHASH_GenCounter, 0);

    // Pack up the throttle data
    U8 tmp[64];
    LLDataPackerBinaryBuffer dp(tmp, MAX_THROTTLE_SIZE);
    S32 i;
    for (i = 0; i < TC_EOF; i++)
    {
        //sim wants BPS, not KBPS
        dp.packF32(mThrottles[i] * 1024.0f, "Throttle");
    }
    S32 len = dp.getCurrentSize();
    msg->addBinaryDataFast(_PREHASH_Throttles, tmp, len);

    gAgent.sendReliableMessage();
}


void LLViewerThrottleGroup::dump()
{
    S32 i;
    for (i = 0; i < TC_EOF; i++)
    {
        LL_DEBUGS("Throttle") << LLViewerThrottle::sNames[i] << ": " << mThrottles[i] << LL_ENDL;
    }
    LL_DEBUGS("Throttle") << "Total: " << mThrottleTotal << LL_ENDL;
}

class LLBPSListener : public LLSimpleListener
{
public:
    virtual bool handleEvent(LLPointer<LLEvent> event, const LLSD& userdata)
    {
        gViewerThrottle.setMaxBandwidth((F32) event->getValue().asReal()*1024);
        return true;
    }
};

LLViewerThrottle::LLViewerThrottle() :
    mMaxBandwidth(0.f),
    mCurrentBandwidth(0.f),
    mThrottleFrac(1.f)
{
    // Need to be pushed on in bandwidth order
    mPresets.push_back(LLViewerThrottleGroup(BW_PRESET_50));
    mPresets.push_back(LLViewerThrottleGroup(BW_PRESET_300));
    mPresets.push_back(LLViewerThrottleGroup(BW_PRESET_500));
    mPresets.push_back(LLViewerThrottleGroup(BW_PRESET_1000));
}


void LLViewerThrottle::setMaxBandwidth(F32 kbits_per_second, BOOL from_event)
{
    if (!from_event)
    {
        gSavedSettings.setF32("ThrottleBandwidthKBPS", kbits_per_second);
    }
    gViewerThrottle.load();

    if (gAgent.getRegion())
    {
        gViewerThrottle.sendToSim();
    }
}

void LLViewerThrottle::load()
{
    mMaxBandwidth = gSavedSettings.getF32("ThrottleBandwidthKBPS")*1024;
    resetDynamicThrottle();
    mCurrent.dump();
}


void LLViewerThrottle::save() const
{
    gSavedSettings.setF32("ThrottleBandwidthKBPS", mMaxBandwidth/1024);
}


void LLViewerThrottle::sendToSim() const
{
    mCurrent.sendToSim();
}


LLViewerThrottleGroup LLViewerThrottle::getThrottleGroup(const F32 bandwidth_kbps)
{
    //Clamp the bandwidth users can set.
    F32 set_bandwidth = llclamp(bandwidth_kbps, MIN_BANDWIDTH, MAX_BANDWIDTH);

    S32 count = mPresets.size();

    S32 i;
    for (i = 0; i < count; i++)
    {
        if (mPresets[i].getTotal() > set_bandwidth)
        {
            break;
        }
    }

    if (i == 0)
    {
        // We return the minimum if it's less than the minimum
        return mPresets[0];
    }
    else if (i == count)
    {
        // Higher than the highest preset, we extrapolate out based on the
        // last two presets.  This allows us to keep certain throttle channels from
        // growing in bandwidth
        F32 delta_bw = set_bandwidth - mPresets[count-1].getTotal();
        LLViewerThrottleGroup delta_throttle = mPresets[count - 1] - mPresets[count - 2];
        F32 delta_total = delta_throttle.getTotal();
        F32 delta_frac = delta_bw / delta_total;
        delta_throttle = delta_throttle * delta_frac;
        return mPresets[count-1] + delta_throttle;
    }
    else
    {
        // In between two presets, just interpolate
        F32 delta_bw = set_bandwidth - mPresets[i - 1].getTotal();
        LLViewerThrottleGroup delta_throttle = mPresets[i] - mPresets[i - 1];
        F32 delta_total = delta_throttle.getTotal();
        F32 delta_frac = delta_bw / delta_total;
        delta_throttle = delta_throttle * delta_frac;
        return mPresets[i - 1] + delta_throttle;
    }
}


// static
void LLViewerThrottle::resetDynamicThrottle()
{
    mThrottleFrac = MAX_FRACTIONAL;

    mCurrentBandwidth = mMaxBandwidth*MAX_FRACTIONAL;
    mCurrent = getThrottleGroup(mCurrentBandwidth / 1024.0f);
}

void LLViewerThrottle::updateDynamicThrottle()
{
    if (mUpdateTimer.getElapsedTimeF32() < DYNAMIC_UPDATE_DURATION)
    {
        return;
    }
    mUpdateTimer.reset();

    LLUnit<F32, LLUnits::Percent> mean_packets_lost = LLViewerStats::instance().getRecording().getMean(LLStatViewer::PACKETS_LOST_PERCENT);
    if (mean_packets_lost > TIGHTEN_THROTTLE_THRESHOLD)
    {
        if (mThrottleFrac <= MIN_FRACTIONAL || mCurrentBandwidth / 1024.0f <= MIN_BANDWIDTH)
        {
            return;
        }
        mThrottleFrac -= STEP_FRACTIONAL;
        mThrottleFrac = llmax(MIN_FRACTIONAL, mThrottleFrac);
        mCurrentBandwidth = mMaxBandwidth * mThrottleFrac;
        mCurrent = getThrottleGroup(mCurrentBandwidth / 1024.0f);
        mCurrent.sendToSim();
        LL_INFOS() << "Tightening network throttle to " << mCurrentBandwidth << LL_ENDL;
    }
    else if (mean_packets_lost <= EASE_THROTTLE_THRESHOLD)
    {
        if (mThrottleFrac >= MAX_FRACTIONAL || mCurrentBandwidth / 1024.0f >= MAX_BANDWIDTH)
        {
            return;
        }
        mThrottleFrac += STEP_FRACTIONAL;
        mThrottleFrac = llmin(MAX_FRACTIONAL, mThrottleFrac);
        mCurrentBandwidth = mMaxBandwidth * mThrottleFrac;
        mCurrent = getThrottleGroup(mCurrentBandwidth/1024.0f);
        mCurrent.sendToSim();
        LL_INFOS() << "Easing network throttle to " << mCurrentBandwidth << LL_ENDL;
    }
}