457 lines
15 KiB
C++
457 lines
15 KiB
C++
/**
|
|
* @file lltexturefetch.h
|
|
* @brief Object for managing texture fetches.
|
|
*
|
|
* $LicenseInfo:firstyear=2000&license=viewerlgpl$
|
|
* Second Life Viewer Source Code
|
|
* Copyright (C) 2012-2013, 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$
|
|
*/
|
|
|
|
#ifndef LL_LLTEXTUREFETCH_H
|
|
#define LL_LLTEXTUREFETCH_H
|
|
|
|
#include <vector>
|
|
#include <map>
|
|
|
|
#include "lldir.h"
|
|
#include "llimage.h"
|
|
#include "lluuid.h"
|
|
#include "llworkerthread.h"
|
|
#include "lltextureinfo.h"
|
|
#include "llimageworker.h"
|
|
#include "httprequest.h"
|
|
#include "httpoptions.h"
|
|
#include "httpheaders.h"
|
|
#include "httphandler.h"
|
|
#include "lltrace.h"
|
|
#include "llviewertexture.h"
|
|
|
|
class LLViewerTexture;
|
|
class LLTextureFetchWorker;
|
|
class LLImageDecodeThread;
|
|
class LLHost;
|
|
class LLViewerAssetStats;
|
|
class LLTextureCache;
|
|
class LLTextureFetchTester;
|
|
|
|
// Interface class
|
|
|
|
class LLTextureFetch : public LLWorkerThread
|
|
{
|
|
friend class LLTextureFetchWorker;
|
|
|
|
public:
|
|
static std::string getStateString(S32 state);
|
|
|
|
LLTextureFetch(LLTextureCache* cache, bool threaded, bool qa_mode);
|
|
~LLTextureFetch();
|
|
|
|
class TFRequest;
|
|
|
|
// Threads: Tmain
|
|
/*virtual*/ size_t update(F32 max_time_ms);
|
|
|
|
// called in the main thread after the TextureCacheThread shuts down.
|
|
// Threads: Tmain
|
|
void shutDownTextureCacheThread();
|
|
|
|
//called in the main thread after the ImageDecodeThread shuts down.
|
|
// Threads: Tmain
|
|
void shutDownImageDecodeThread();
|
|
|
|
// Threads: T* (but Tmain mostly)
|
|
S32 createRequest(FTType f_type, const std::string& url, const LLUUID& id, const LLHost& host, F32 priority,
|
|
S32 w, S32 h, S32 c, S32 discard, bool needs_aux, bool can_use_http);
|
|
|
|
// Requests that a fetch operation be deleted from the queue.
|
|
// If @cancel is true, also stops any I/O operations pending.
|
|
// Actual delete will be scheduled and performed later.
|
|
//
|
|
// Note: This *looks* like an override/variant of the
|
|
// base class's deleteRequest() but is functionally quite
|
|
// different.
|
|
//
|
|
// Threads: T*
|
|
void deleteRequest(const LLUUID& id, bool cancel);
|
|
|
|
void deleteAllRequests();
|
|
|
|
// Threads: T*
|
|
// keep in mind that if fetcher isn't done, it still might need original raw image
|
|
bool getRequestFinished(const LLUUID& id, S32& discard_level,
|
|
LLPointer<LLImageRaw>& raw, LLPointer<LLImageRaw>& aux,
|
|
LLCore::HttpStatus& last_http_get_status);
|
|
|
|
// Threads: T*
|
|
bool updateRequestPriority(const LLUUID& id, F32 priority);
|
|
|
|
// <FS:Ansariel> OpenSim compatibility
|
|
// Threads: T*
|
|
bool receiveImageHeader(const LLHost& host, const LLUUID& id, U8 codec, U16 packets, U32 totalbytes, U16 data_size, U8* data);
|
|
|
|
// Threads: T*
|
|
bool receiveImagePacket(const LLHost& host, const LLUUID& id, U16 packet_num, U16 data_size, U8* data);
|
|
// </FS:Ansariel>
|
|
|
|
// Threads: T* (but not safe)
|
|
void setTextureBandwidth(F32 bandwidth) { mTextureBandwidth = bandwidth; }
|
|
|
|
// Threads: T* (but not safe)
|
|
F32 getTextureBandwidth() { return mTextureBandwidth; }
|
|
|
|
// Threads: T*
|
|
bool isFromLocalCache(const LLUUID& id);
|
|
|
|
// get the current fetch state, if any, from the given UUID
|
|
S32 getFetchState(const LLUUID& id);
|
|
|
|
// @return Fetch state of given image and associates statistics
|
|
// See also getStateString
|
|
// Threads: T*
|
|
S32 getFetchState(const LLUUID& id, F32& decode_progress_p, F32& requested_priority_p,
|
|
U32& fetch_priority_p, F32& fetch_dtime_p, F32& request_dtime_p, bool& can_use_http);
|
|
|
|
// Debug utility - generally not safe
|
|
void dump();
|
|
|
|
// Threads: T*
|
|
S32 getNumRequests();
|
|
|
|
// Threads: T*
|
|
S32 getNumHTTPRequests();
|
|
|
|
// Threads: T*
|
|
U32 getTotalNumHTTPRequests();
|
|
|
|
// Threads: T*
|
|
size_t getPending();
|
|
|
|
// Threads: T*
|
|
void lockQueue() { mQueueMutex.lock(); }
|
|
|
|
// Threads: T*
|
|
void unlockQueue() { mQueueMutex.unlock(); }
|
|
|
|
// Threads: T*
|
|
LLTextureFetchWorker* getWorker(const LLUUID& id);
|
|
|
|
// Threads: T*
|
|
// Locks: Mfq
|
|
LLTextureFetchWorker* getWorkerAfterLock(const LLUUID& id);
|
|
|
|
// Commands available to other threads to control metrics gathering operations.
|
|
|
|
// Threads: T*
|
|
void commandSetRegion(U64 region_handle);
|
|
|
|
// Threads: T*
|
|
void commandSendMetrics(const std::string & caps_url,
|
|
const LLUUID & session_id,
|
|
const LLUUID & agent_id,
|
|
LLSD& stats_sd);
|
|
|
|
// Threads: T*
|
|
void commandDataBreak();
|
|
|
|
// Threads: T*
|
|
LLCore::HttpRequest & getHttpRequest() { return *mHttpRequest; }
|
|
|
|
// Threads: T*
|
|
LLCore::HttpRequest::policy_t getPolicyClass() const { return mHttpPolicyClass; }
|
|
|
|
// Return a pointer to the shared metrics headers definition.
|
|
// Does not increment the reference count, caller is required
|
|
// to do that to hold a reference for any length of time.
|
|
//
|
|
// Threads: T*
|
|
LLCore::HttpHeaders::ptr_t getMetricsHeaders() const { return mHttpMetricsHeaders; }
|
|
|
|
// Threads: T*
|
|
LLCore::HttpRequest::policy_t getMetricsPolicyClass() const { return mHttpMetricsPolicyClass; }
|
|
|
|
bool isQAMode() const { return mQAMode; }
|
|
|
|
// ----------------------------------
|
|
// HTTP resource waiting methods
|
|
|
|
// Threads: T*
|
|
void addHttpWaiter(const LLUUID & tid);
|
|
|
|
// Threads: T*
|
|
void removeHttpWaiter(const LLUUID & tid);
|
|
|
|
// Threads: T*
|
|
bool isHttpWaiter(const LLUUID & tid);
|
|
|
|
// If there are slots, release one or more LLTextureFetchWorker
|
|
// requests from resource wait state (WAIT_HTTP_RESOURCE) to
|
|
// active (SEND_HTTP_REQ).
|
|
//
|
|
// Because this will modify state of many workers, you may not
|
|
// hold any Mw lock while calling. This makes it a little
|
|
// inconvenient to use but that's the rule.
|
|
//
|
|
// Threads: T*
|
|
// Locks: -Mw (must not hold any worker when called)
|
|
void releaseHttpWaiters();
|
|
|
|
// Threads: T*
|
|
void cancelHttpWaiters();
|
|
|
|
// Threads: T*
|
|
int getHttpWaitersCount();
|
|
// ----------------------------------
|
|
// Stats management
|
|
|
|
// Add given counts to the global totals for the states/requests
|
|
// Threads: T*
|
|
void updateStateStats(U32 cache_read, U32 cache_write, U32 res_wait);
|
|
|
|
// Return the global counts
|
|
// Threads: T*
|
|
void getStateStats(U32 * cache_read, U32 * cache_write, U32 * res_wait);
|
|
|
|
// ----------------------------------
|
|
|
|
protected:
|
|
// <FS:Ansariel> OpenSim compatibility
|
|
// Threads: T* (but Ttf in practice)
|
|
void addToNetworkQueue(LLTextureFetchWorker* worker);
|
|
|
|
// Threads: T*
|
|
void removeFromNetworkQueue(LLTextureFetchWorker* worker, bool cancel);
|
|
// </FS:Ansariel>
|
|
|
|
// Threads: T*
|
|
void addToHTTPQueue(const LLUUID& id);
|
|
|
|
// XXX possible delete
|
|
// Threads: T*
|
|
void removeFromHTTPQueue(const LLUUID& id, S32Bytes received_size);
|
|
|
|
// Identical to @deleteRequest but with different arguments
|
|
// (caller already has the worker pointer).
|
|
//
|
|
// Threads: T*
|
|
void removeRequest(LLTextureFetchWorker* worker, bool cancel);
|
|
|
|
// Overrides from the LLThread tree
|
|
// Locks: Ct
|
|
bool runCondition();
|
|
|
|
private:
|
|
// <FS:Ansariel> OpenSim compatibility
|
|
// Threads: Tmain
|
|
void sendRequestListToSimulators();
|
|
// </FS:Ansariel>
|
|
|
|
// Threads: Ttf
|
|
/*virtual*/ void startThread(void);
|
|
|
|
// Threads: Ttf
|
|
/*virtual*/ void endThread(void);
|
|
|
|
// Threads: Ttf
|
|
/*virtual*/ void threadedUpdate(void);
|
|
|
|
// Threads: Ttf
|
|
void commonUpdate();
|
|
|
|
// Metrics command helpers
|
|
/**
|
|
* Enqueues a command request at the end of the command queue
|
|
* and wakes up the thread as needed.
|
|
*
|
|
* Takes ownership of the TFRequest object.
|
|
*
|
|
* Method locks the command queue.
|
|
*
|
|
* Threads: T*
|
|
*/
|
|
void cmdEnqueue(TFRequest *);
|
|
|
|
/**
|
|
* Returns the first TFRequest object in the command queue or
|
|
* NULL if none is present.
|
|
*
|
|
* Caller acquires ownership of the object and must dispose of it.
|
|
*
|
|
* Method locks the command queue.
|
|
*
|
|
* Threads: T*
|
|
*/
|
|
TFRequest * cmdDequeue();
|
|
|
|
/**
|
|
* Processes the first command in the queue disposing of the
|
|
* request on completion. Successive calls are needed to perform
|
|
* additional commands.
|
|
*
|
|
* Method locks the command queue.
|
|
*
|
|
* Threads: Ttf
|
|
*/
|
|
void cmdDoWork();
|
|
|
|
public:
|
|
LLUUID mDebugID;
|
|
S32 mDebugCount;
|
|
bool mDebugPause;
|
|
// <FS:Ansariel> OpenSim compatibility
|
|
S32 mPacketCount;
|
|
S32 mBadPacketCount;
|
|
// </FS:Ansariel>
|
|
|
|
static LLTrace::CountStatHandle<F64> sCacheHit;
|
|
static LLTrace::CountStatHandle<F64> sCacheAttempt;
|
|
static LLTrace::SampleStatHandle<F32Seconds> sCacheReadLatency;
|
|
static LLTrace::SampleStatHandle<F32Seconds> sTexDecodeLatency;
|
|
static LLTrace::SampleStatHandle<F32Seconds> sCacheWriteLatency;
|
|
static LLTrace::SampleStatHandle<F32Seconds> sTexFetchLatency;
|
|
static LLTrace::EventStatHandle<LLUnit<F32, LLUnits::Percent> > sCacheHitRate;
|
|
|
|
private:
|
|
LLMutex mQueueMutex; //to protect mRequestMap and mCommands only
|
|
LLMutex mNetworkQueueMutex; //to protect mNetworkQueue, mHTTPTextureQueue and mCancelQueue. // <FS:Ansariel> OpenSim compatibility
|
|
|
|
LLTextureCache* mTextureCache;
|
|
|
|
// Map of all requests by UUID
|
|
typedef std::map<LLUUID,LLTextureFetchWorker*> map_t;
|
|
map_t mRequestMap; // Mfq
|
|
|
|
// Set of requests that require network data
|
|
typedef std::set<LLUUID> queue_t;
|
|
queue_t mNetworkQueue; // Mfnq // <FS:Ansariel> OpenSim compatibility
|
|
queue_t mHTTPTextureQueue; // Mfnq
|
|
typedef std::map<LLHost,std::set<LLUUID> > cancel_queue_t;
|
|
cancel_queue_t mCancelQueue; // Mfnq // <FS:Ansariel> OpenSim compatibility
|
|
F32 mTextureBandwidth; // <none>
|
|
F32 mMaxBandwidth; // Mfnq
|
|
LLTextureInfo mTextureInfo;
|
|
LLTextureInfo mTextureInfoMainThread;
|
|
|
|
// XXX possible delete
|
|
U32Bits mHTTPTextureBits; // Mfnq
|
|
|
|
// XXX possible delete
|
|
//debug use
|
|
U32 mTotalHTTPRequests;
|
|
|
|
// Out-of-band cross-thread command queue. This command queue
|
|
// is logically tied to LLQueuedThread's list of
|
|
// QueuedRequest instances and so must be covered by the
|
|
// same locks.
|
|
typedef std::vector<TFRequest *> command_queue_t;
|
|
command_queue_t mCommands; // Mfq
|
|
|
|
// If true, modifies some behaviors that help with QA tasks.
|
|
const bool mQAMode;
|
|
|
|
// Interfaces and objects into the core http library used
|
|
// to make our HTTP requests. These replace the various
|
|
// LLCurl interfaces used in the past.
|
|
LLCore::HttpRequest * mHttpRequest; // Ttf
|
|
LLCore::HttpOptions::ptr_t mHttpOptions; // Ttf
|
|
LLCore::HttpOptions::ptr_t mHttpOptionsWithHeaders; // Ttf
|
|
LLCore::HttpHeaders::ptr_t mHttpHeaders; // Ttf
|
|
LLCore::HttpRequest::policy_t mHttpPolicyClass; // T*
|
|
LLCore::HttpHeaders::ptr_t mHttpMetricsHeaders; // Ttf
|
|
LLCore::HttpRequest::policy_t mHttpMetricsPolicyClass; // T*
|
|
S32 mHttpHighWater; // Ttf
|
|
S32 mHttpLowWater; // Ttf
|
|
|
|
// We use a resource semaphore to keep HTTP requests in
|
|
// WAIT_HTTP_RESOURCE2 if there aren't sufficient slots in the
|
|
// transport. This keeps them near where they can be cheaply
|
|
// reprioritized rather than dumping them all across a thread
|
|
// where it's more expensive to get at them. Requests in either
|
|
// SEND_HTTP_REQ or WAIT_HTTP_REQ charge against the semaphore
|
|
// and tracking state transitions is critical to liveness.
|
|
//
|
|
// Originally implemented as a traditional semaphore (heading towards
|
|
// zero), it now is an outstanding request count that is allowed to
|
|
// exceed the high water level (but not go below zero).
|
|
LLAtomicS32 mHttpSemaphore; // Ttf
|
|
|
|
typedef std::set<LLUUID> wait_http_res_queue_t;
|
|
wait_http_res_queue_t mHttpWaitResource; // Mfnq
|
|
|
|
// Cumulative stats on the states/requests issued by
|
|
// textures running through here.
|
|
U32 mTotalCacheReadCount; // Mfq
|
|
U32 mTotalCacheWriteCount; // Mfq
|
|
U32 mTotalResourceWaitCount; // Mfq
|
|
|
|
public:
|
|
// A probabilistically-correct indicator that the current
|
|
// attempt to log metrics follows a break in the metrics stream
|
|
// reporting due to either startup or a problem POSTing data.
|
|
static volatile bool svMetricsDataBreak;
|
|
|
|
public:
|
|
//debug use
|
|
enum e_tex_source
|
|
{
|
|
FROM_ALL = 0,
|
|
FROM_HTTP_ONLY,
|
|
INVALID_SOURCE
|
|
};
|
|
|
|
static LLTextureFetchTester* sTesterp;
|
|
|
|
private:
|
|
e_tex_source mFetchSource;
|
|
e_tex_source mOriginFetchSource;
|
|
|
|
// Retry logic
|
|
//LLAdaptiveRetryPolicy mFetchRetryPolicy;
|
|
|
|
public:
|
|
void setLoadSource(e_tex_source source) {mFetchSource = source;}
|
|
void resetLoadSource() {mFetchSource = mOriginFetchSource;}
|
|
bool canLoadFromCache() { return mFetchSource != FROM_HTTP_ONLY;}
|
|
};
|
|
|
|
//debug use
|
|
class LLViewerFetchedTexture;
|
|
|
|
class LLTextureFetchTester : public LLMetricPerformanceTesterBasic
|
|
{
|
|
public:
|
|
LLTextureFetchTester();
|
|
~LLTextureFetchTester();
|
|
|
|
void updateStats(const std::map<S32, F32> states_timers, const F32 fetch_time, const F32 other_states_time, const S32 file_size);
|
|
|
|
protected:
|
|
/*virtual*/ void outputTestRecord(LLSD* sd);
|
|
|
|
private:
|
|
|
|
F32 mTextureFetchTime;
|
|
F32 mSkippedStatesTime;
|
|
S32 mFileSize;
|
|
|
|
std::map<S32, F32> mStateTimersMap;
|
|
};
|
|
#endif // LL_LLTEXTUREFETCH_H
|
|
|